Sign in

v1

latestOpenAPI 3.0.12026-07-2699111970.1 KB
User Documents

Upload a User Document

Upload a document for a user.

API scope required: users.create

post/2025-06-09/documents

Headers

X-API-KEYstring required

API key required for authentication

Request body

documentType'id-passport' | 'id-idcard-back' | 'id-idcard-front' | 'id-residency-permit' | 'proof-of-address' | 'proof-of-income' | 'selfie-front' | 'selfie-left' | 'selfie-right' required

Type of document

datastring required

Base64 encoded document data

expiresAtstring

Document expiration date in YYYY-MM-DD format

Example request

{
  "reference": {
    "userLocator": "email:user@example.com"
  },
  "documentType": "id-passport",
  "data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
  "expiresAt": "2030-12-31"
}

Response

Document replaced successfully

idstring required

Unique identifier for the document

documentType'id-passport' | 'id-idcard-back' | 'id-idcard-front' | 'id-residency-permit' | 'proof-of-address' | 'proof-of-income' | 'selfie-front' | 'selfie-left' | 'selfie-right' required

Type of document

createdAtstring required

ISO 8601 timestamp when the document was created

expiresAtstring

Document expiration date in YYYY-MM-DD format

Example response

{
  "id": "doc_abc123xyz",
  "documentType": "id-passport",
  "createdAt": "2024-12-05T10:30:00.000Z",
  "expiresAt": "2030-12-31"
}