Know Your Business (KYB)

Get KYB Document

Get details about a specific KYB document including file information. Users can only access documents they created.

get/api/document-service/v1/documents/{documentId}

Request

  • Base URL
    https://developers.bitgo.com
  • URL
    https://developers.bitgo.com/api/document-service/v1/documents/{documentId}
  • Auth
    none declared

Path parameters

documentIdstring uuid required

Unique identifier for the document

Response

200

documentIdstring required

Unique identifier for the document

documentType'governmentId' | 'commercialRegister' | 'articlesOfAssociation' | 'certificateOfIncorporation' | 'certificateOfGoodStanding' | 'certificateOfTrust' | 'certificateOfIncumbency' | 'certificateOfIncumbencyOrShareRegister' | 'proofOfPrincipalPlaceOfBusiness' | 'activeTradeLicense' | 'resolutionToOpenBitgoUaeAccount' | 'resolutionToOpenBitgoSingaporeAccount' | 'proofOfAuthorizedSignatories' | 'memorandumOfAssociation' | 'memorandumAndArticlesOfAssociation' | 'bylawsOrOperatingAgreement' | 'operatingAgreement' | 'w8' | 'w9' | 'evidenceOfLegalStatus' | 'evidenceOfActiveStatus' | 'proofOfJfsaLicense' | 'proofOfGamingLicense' | 'organizationDocument' | 'partnershipAgreement' | 'articlesOfOrganization' | 'businessLicenseOrRegistration' | 'evidenceOfGovernmentOrStateOwnership' | 'secFilingsAsEvidenceOfPublicTradingStatus' | 'foundingTreatyOrEquivalent' | 'proofOfAddress' | 'sourceOfWealth' | 'singaporeSupportingDocument' | 'caseRequiredDocuments' | 'correspondentAccountCertification' | 'authorizedSignerForm' required

Type of document being uploaded

documentTypeLabelstring required

Human-readable label for the document type

subType'cct' | 'cid' | 'dl' | 'foid' | 'hic' | 'id' | 'ipp' | 'keyp' | 'ltpass' | 'munid' | 'myn' | 'nbi' | 'nric' | 'ofw' | 'rp' | 'pan' | 'pid' | 'pp' | 'ppc' | 'pr' | 'sss' | 'td' | 'tribalid' | 'umid' | 'vid' | 'visa' | 'wp' | 'computerizedPayslips' | 'incomeTaxAssessment' | 'employmentLetterContract' | 'bankStatement' | 'dptHoldingStatement' | 'investmentHoldingsStatement' | 'titleDeeds' | 'propertyTaxCpfStatement' | 'other'

Subtype of document (relevant for governmentId and singaporeSupportingDocument document types)

status'awaitingUpload' | 'uploaded' | 'accepted' | 'rejected' required

Current status of the document

enterpriseIdstring nullable required

Enterprise associated with the document when created, or null for legacy documents

forUserIdstring nullable required

BitGo public user ID the document was created for, or null when not attributed

metadataobject

Optional metadata for the document

createdAtstring date-time required

When the document was created

updatedAtstring date-time required

When the document was last updated

Changes

No operation changes recorded.