REST API›Identity›Know Your Business (KYB)

GET

List KYB Documents

List documents belonging to the authenticated user with optional filtering and pagination.

Query Params

  • ids string
    Comma-separated list of up to 100 document UUIDs to filter by
  • type string enum
    Type of document being uploaded
    governmentIdcommercialRegisterarticlesOfAssociationcertificateOfIncorporationcertificateOfGoodStandingcertificateOfTrustcertificateOfIncumbencycertificateOfIncumbencyOrShareRegisterproofOfPrincipalPlaceOfBusinessactiveTradeLicenseresolutionToOpenBitgoUaeAccountresolutionToOpenBitgoSingaporeAccountproofOfAuthorizedSignatoriesmemorandumOfAssociationmemorandumAndArticlesOfAssociationbylawsOrOperatingAgreementoperatingAgreementw8w9evidenceOfLegalStatusevidenceOfActiveStatusproofOfJfsaLicenseproofOfGamingLicenseorganizationDocumentpartnershipAgreementarticlesOfOrganizationbusinessLicenseOrRegistrationevidenceOfGovernmentOrStateOwnershipsecFilingsAsEvidenceOfPublicTradingStatusfoundingTreatyOrEquivalentproofOfAddresssourceOfWealthsingaporeSupportingDocumentcaseRequiredDocumentscorrespondentAccountCertificationauthorizedSignerForm
  • status string enum
    Current status of the document
    awaitingUploaduploadedacceptedrejected
  • enterpriseId string
    Narrows results to documents attributed to the given enterprise; always scoped to the authenticated user

    1 to 255 characters

  • forUserId string
    Narrows results to documents created for the given BitGo public user ID; always scoped to the authenticated user

    matches ^[a-zA-Z0-9]{32}$

  • limit integer
    Maximum number of documents to return (default: 20, max: 100)

    >= 1 · <= 100

    Defaults to 20

  • offset integer nullable
    Number of documents to skip (default: 0)

    >= 0

    Defaults to 0

Responses

200
200

Response Body

object

Paginated list of document summaries
  • documents array of objects required
    List of document summaries
    documents object
    • id string uuid required
      Document identifier
    • type string enum required
      Type of document being uploaded
      governmentIdcommercialRegisterarticlesOfAssociationcertificateOfIncorporationcertificateOfGoodStandingcertificateOfTrustcertificateOfIncumbencycertificateOfIncumbencyOrShareRegisterproofOfPrincipalPlaceOfBusinessactiveTradeLicenseresolutionToOpenBitgoUaeAccountresolutionToOpenBitgoSingaporeAccountproofOfAuthorizedSignatoriesmemorandumOfAssociationmemorandumAndArticlesOfAssociationbylawsOrOperatingAgreementoperatingAgreementw8w9evidenceOfLegalStatusevidenceOfActiveStatusproofOfJfsaLicenseproofOfGamingLicenseorganizationDocumentpartnershipAgreementarticlesOfOrganizationbusinessLicenseOrRegistrationevidenceOfGovernmentOrStateOwnershipsecFilingsAsEvidenceOfPublicTradingStatusfoundingTreatyOrEquivalentproofOfAddresssourceOfWealthsingaporeSupportingDocumentcaseRequiredDocumentscorrespondentAccountCertificationauthorizedSignerForm
    • subType string enum nullable required
      Subtype of document (relevant for governmentId and singaporeSupportingDocument document types)
      cctciddlfoidhicidippkeypltpassmunidmynnbinricofwrppanpidppppcprssstdtribalidumidvidvisawpcomputerizedPayslipsincomeTaxAssessmentemploymentLetterContractbankStatementdptHoldingStatementinvestmentHoldingsStatementtitleDeedspropertyTaxCpfStatementother
    • status string enum required
      Current status of the document
      awaitingUploaduploadedacceptedrejected
    • enterpriseId string nullable required
      Enterprise associated with the document when created, or null for legacy documents
    • forUserId string nullable required
      BitGo public user ID the document was created for, or null when not attributed
    • createdAt string date-time required
      ISO timestamp when the document was created
    • files array of objects required
      Files associated with the document
      files object
      • id string uuid required
        File identifier
      • view string enum nullable required
        View or side of the document file
        frontbackfull
      • status string enum required
        Current status of the file upload. requiresManualReview is a terminal state set after 2 failed AI screening attempts; the file is locked and Trust ops resolves it manually.
        awaitingUploaduploadedacceptedrejectedrequiresManualReview
  • total integer required
    Total number of matched documents

    >= 0

  • limit integer required
    Applied page size

    >= 1

  • offset integer required
    Applied page offset

    >= 0

400
400

Response Body

object

Generic error response
  • code string required
    Error code
  • message string required
    Error message
  • details map of objects
    Additional error details
    details object
    • <key> object nullable
401
401

Response Body

object

Generic error response
  • code string required
    Error code
  • message string required
    Error message
  • details map of objects
    Additional error details
    details object
    • <key> object nullable
500
500

Response Body

object

Generic error response
  • code string required
    Error code
  • message string required
    Error message
  • details map of objects
    Additional error details
    details object
    • <key> object nullable