Home
API Reference

Initiate an identity document upload

post
https://api.dev.cfx.to/v1/identity//documents

Reserve a presigned PUT URL for uploading an identity document. After the client uploads the bytes, call the complete endpoint.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique Identity ID provided upon identity registration

Body Params

Reserve a presigned upload slot for an identity document. side is required for two-sided document types (PASSPORT, DRIVER_LICENSE, NATIONAL_ID, ID_CARD, VOTER_ID_CARD, RESIDENT_CARD) and rejected for all others.

Reserve a presigned upload slot for an identity document. side is required for two-sided document types (PASSPORT, DRIVER_LICENSE, NATIONAL_ID, ID_CARD, VOTER_ID_CARD, RESIDENT_CARD) and rejected for all others.

string
required

Original filename of the document

string
required

MIME type — must match the Content-Type header used when uploading to the presigned URL

integer
required
≥ 1

Size in bytes — must match the Content-Length used when uploading to the presigned URL

string

Optional free-form description of the document. Required when type is OTHER.

string
enum
required
string
enum
Allowed:
Headers
string
Responses

Updated 3 days ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 days ago