Ctrl+K

Create a new document

post/api/document-service/v1/documents

Creates a new document and returns presigned URLs for file uploads

Request Body

Body
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
subType string
Subtype of document (used for government ID documents)
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
metadata dictionary<string, any>
Optional metadata for the document (max 100KB)

201 Response

documentId string required
Unique identifier for the created document
documentType string required
Type of the document
documentTypeLabel string required
Human-readable label for the document type
subType string
Subtype of the document
status string required
Current status of the document
Allowed values: awaitingUpload uploaded
files array[object] required
Detailed file information for document creation response
fileId string required
Unique identifier for the file
fileView string required
View or side of the document file
label string required
Human-readable label for the file
required boolean required
Whether this file is required for the document
uploadUrl string <uri>required
Presigned URL for file upload
expiresAt string <date-time>required
When the upload URL expires

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