Skip to main content
POST
Upload Identification Document

Authorizations

X-API-Key
string
header
required

API Key

Headers

IDEMPOTENCY-KEY
string
required

a UUID ensuring a document upload is only processed once

X-SUB-PARTNER-ID
string

Optional sub-partner UUID, if provided, the document is uploaded for the sub-partner's customer

X-API-Version
string

Selects the API version for this request, as an ISO date (YYYY-MM-DD). Omit to use the default version (2025-03-13). Supported versions: 2025-03-13, 2026-07-01, 2026-08-01, 2026-10-01, 2026-10-15.

Path Parameters

id
string<uuid>
required

the ID of the Customer the document belongs to

Body

multipart/form-data
file
file
required

Response

Document stored

Identification Document Upload

A document stored for one customer's identification payload.

expires_at
string<date-time>
required

The id is rejected, and the document deleted, after this time (24 hours after upload).

id
string
required

Send this id instead of the base64 content in any document field of this customer's identification payload, e.g. idoc_0193a1f2-5b7c-7d3e-9f10-2a3b4c5d6e7f.

size_bytes
integer<int64>
required

The file size in bytes