latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Know Your Business (KYB)

List KYB Documents

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

get/api/document-service/v1/documents

Query parameters

idsstring

Comma-separated list of up to 100 document UUIDs to filter by

type'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'

Type of document being uploaded

Type of document being uploaded

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

Current status of the document

Current status of the document

enterpriseIdstring

Narrows results to documents attributed to the given enterprise; always scoped to the authenticated user

forUserIdstring

BitGo public user ID the document is created for; exactly 32 alphanumeric characters

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

limitinteger

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

offsetinteger nullable

Number of documents to skip (default: 0)

Response

200

totalinteger required

Total number of matched documents

limitinteger required

Applied page size

offsetinteger required

Applied page offset