List KYB Documents (internal)

get/api/document-service/internal/v1/documents

Get a list of documents with file information and userId. At least one of userId or documentIds must be provided. Optionally filter by status. When documentIds is provided, returns only documents with those IDs. When both userId and documentIds are provided, returns documents that match both criteria. This endpoint bypasses user ownership restrictions and is available only to internal services.

Query Parameters

  • userIdstring
    Filter by user ID
  • statusstring
    Current status of the document
    Enum: awaitingUpload uploaded
  • documentIdsarray[string]<uuid>
    Filter by specific document IDs

200 Response

documents array[object] required
Response containing internal document information
documentId string required
Unique identifier for the document
documentType string required
Type of document being uploaded
Allowed values: governmentId commercialRegister articlesOfAssociation certificateOfIncorporation 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
documentTypeLabel string required
Human-readable label for the document type
subType string
Subtype of document (relevant for `governmentId` document type)
Allowed values: 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
status string required
Current status of the document
Allowed values: awaitingUpload uploaded
metadata dictionary<string, any>
Optional metadata for the document
files array[object] required
File information for internal document retrieval
userId string required
ID of the user who created the document
createdAt string <date-time>required
When the document was created
updatedAt string <date-time>required
When the document was last updated

400 Response

code string required
Error code
message string required
Error message
details dictionary<string, any>
Additional error details

401 Response

code string required
Error code
message string required
Error message
details dictionary<string, any>
Additional error details

500 Response

code string required
Error code
message string required
Error message
details dictionary<string, any>
Additional error details