Skip to main content
POST
Upload a customer document

Authorizations

X-API-Key
string
header
required

Path Parameters

customer_id
string
required

Public customer id returned on create

Example:

"pcus_a1b2c3d4e5f6"

Body

application/json
category
string
required

Document key from requirements (e.g. identity, address).

Required string length: 1 - 64
Example:

"identity"

content_base64
string
required

Base64-encoded file bytes (max ~8 MiB decoded).

Required string length: 1 - 12000000
Example:

"JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFI+PmVuZG9iagoyIDAgb2JqCjw8L1R5cGUvUGFnZXMvQ291bnQgMC9LaWRzW10+PmVuZG9iagp4cmVmCjAgMwowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMTUgMDAwMDAgbiAKMDAwMDAwMDA2OCAwMDAwMCBuIAp0cmFpbGVyCjw8L1NpemUgMy9Sb290IDEgMCBSPj4Kc3RhcnR4cmVmCjEyMQolJUVPRgo="

content_type
string | null

MIME type. Required for upload: image/jpeg, image/png, or application/pdf.

Example:

"image/jpeg"

file_name
string | null

Optional original filename for the partner only; not stored in object keys.

Maximum string length: 128
Example:

"passport.pdf"

Response

Successful Response