Depa LogoDocsv1
API Reference

Identification Documents

Identity documents attached to an identification: ID cards, passports, driver's licences, utility bills and source-of-funds evidence.

Documents collected during hosted verification appear here automatically. You can also upload documents yourself, or replace a file while keeping its type and side. Uploads use multipart/form-data.

List documents

GET/identifications/{identification_id}/documents

Returns the documents attached to an identification, including those collected during hosted verification.

Authorization

BearerAuth
AuthorizationBearer <token>

Token from POST /sign_in, sent as Authorization: Bearer <token>.

In: header

Path Parameters

identification_id*string

The UUID of the identification

Formatuuid

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/identifications/25f21bf7-54d2-4b47-9db2-af48558df5eb/documents"

{  "data": [    {      "id": 123,      "doc_type": "id_card",      "doc_side": "front",      "filename": "id_card*frontJohn*Doe*a1b2c3d4",      "content_type": "image/jpeg",      "byte_size": 245890,      "created_at": 1716600000    },    {      "id": 124,      "doc_type": "id_card",      "doc_side": "back",      "filename": "id_card*backJohn*Doe*e5f6g7h8",      "content_type": "image/jpeg",      "byte_size": 230100,      "created_at": 1716600100    }  ]}

Upload a document

POST/identifications/{identification_id}/documents

Attaches a document to an identification. Send it as multipart/form-data with the file, its type (id_card, passport, drivers_license, utility_bill or source_of_funds) and, for two-sided documents, its side.

Authorization

BearerAuth
AuthorizationBearer <token>

Token from POST /sign_in, sent as Authorization: Bearer <token>.

In: header

Path Parameters

identification_id*string

The UUID of the identification

Formatuuid

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/identifications/25f21bf7-54d2-4b47-9db2-af48558df5eb/documents" \  -F file="null" \  -F type="id_card"
{  "data": {    "id": 125,    "doc_type": "id_card",    "doc_side": "front",    "filename": "id_card*frontJohn*Doe*a1b2c3d4",    "content_type": "image/png",    "byte_size": 145200,    "created_at": 1716600200  }}

Replace a document

PUT/identifications/{identification_id}/documents/{id}

Replaces the file of an existing document. Its type and side stay the same.

Authorization

BearerAuth
AuthorizationBearer <token>

Token from POST /sign_in, sent as Authorization: Bearer <token>.

In: header

Path Parameters

identification_id*string

The UUID of the identification

Formatuuid
id*integer

ID of the document, from the list or upload response.

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/identifications/25f21bf7-54d2-4b47-9db2-af48558df5eb/documents/123" \  -F file="null"
{  "data": {    "id": 126,    "doc_type": "id_card",    "doc_side": "front",    "filename": "id_card*frontJohn*Doe*x9y8z7w6",    "content_type": "image/png",    "byte_size": 156300,    "created_at": 1716600300  }}
🍪 We do not track your behaviour or use any cookie on this site.