Skip to main content
POST
CLI

Authorizations

Authorization
string
header
required

API Key in Bearer format (e.g., Bearer sk_test_...)

Headers

X-API-Key
string

API key

Body

application/json
documentType
string
required

Type of document

Example:

"INVOICE"

fileName
string
required

Original file name

Example:

"invoice-2026-001.pdf"

contentType
string
required

MIME type of the file

Example:

"application/pdf"

customerId
string
required

Customer ID the document belongs to

Example:

"cus_abc123"

documentSubtype
string

Specific document subtype

Example:

"GOVERNMENT_ID_FRONT"

transferId
string

Transfer ID if document is associated with a transfer

Example:

"txn_xyz789"

fileHash
string

SHA-256 hash of file content for deduplication. If provided and a duplicate exists, returns the existing document instead of creating a new upload request.

Example:

"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"

remarks
string

Free-form remarks or notes about the document

Maximum string length: 1000
Example:

"Utility bill for the registered office"

Response

Upload request created successfully

documentId
string
required

Document ID

Example:

"doc_abc123"

uploadUrl
string
required

Signed URL for uploading the document

Example:

"https://storage.googleapis.com/..."

expiresAt
string<date-time>
required

When the upload URL expires

Example:

"2026-01-01T12:00:00Z"

existingDocumentId
string

If a duplicate was found, returns existing document ID instead

Example:

"doc_existing123"