Skip to main content
POST
Upload document

Authorizations

API-KEY
string
header
required

Your partner API key. The key must carry the customers permission.

Headers

Api-Version
string
default:2026-09.1
required

The API version this request targets. Required on every /api/v0/* call. Format YYYY-MM.<release>; 2026-09.1 is the latest. The version that served the request is echoed back on the response. Missing, malformed or unsupported values are rejected with 400.

Pattern: ^\d{4}-\d{2}\.\d+$

Path Parameters

userId
string
required

The customer reference id returned by create — a cus_-prefixed string, not a UUID.

Body

multipart/form-data
document
file
required

JPEG, PNG or PDF. Maximum 5 MB; the whole request is capped at 10 MB.

idDocType
string
required

For an individual: PASSPORT, ID_CARD, DRIVERS, RESIDENCE_PERMIT, SELFIE or UTILITY_BILL (a utility bill or bank statement, as proof of address). DRIVERS_LICENSE is still accepted as an alias and is stored and returned as DRIVERS. Omitted entirely → 400 ERRCORE_1001 (idDocType is required); sent but blank → ERRCUS_1405; any other value → ERRCUS_1406. For a business use COMPANY_DOC.

country
string
required

ISO 3166-1 alpha-3. Omitted entirely → 400 ERRCORE_1001 (country is required); sent but blank → ERRCUS_1012; invalid → ERRCUS_1013.

idDocSubType
string

Which company document: INCORPORATION_CERT, INCORPORATION_ARTICLES or SHAREHOLDER_REGISTRY. Not needed for individual photo IDs.

side
string

FRONT or BACK, meaningful only for two-sided documents (ID_CARD, DRIVERS). Not validated — any value is passed through.

Response

Accepted. missing lists the document steps still outstanding, and is omitted once they are all in. For a business company upload, missing is not returned.

accepted
boolean

Whether the upload was accepted.

status
string

The customer's verification status after the upload.

missing
string[]

Document steps still outstanding — IDENTITY, SELFIE, PROOF_OF_RESIDENCE. Omitted once every step is uploaded.