List documents
List documents
GET
https://api.complycube.com/v1/documents?clientId=:id
This endpoint allows you to list all existing documents for a given client. The documents are returned sorted by creation date, with the most recent documents appearing first.
Query Parameters
Name
Type
Description
clientId
string
The ID of the client.
<pagination>
string
The number of items to return and the number of pages to offset.
<filtering>
string
Filter the results.
Headers
Name
Type
Description
Authorization
string
The live or sandbox API key.
{
"page": 1,
"pageSize": 100,
"totalItems": 1,
"pages": 1,
"items": [
{
"id": "5eb158880c19580007310f22",
"clientId": "5eb1276d96be4a0008713af5",
"type": "passport",
"classification": "proof_of_identity",
"issuingCountry": "GB",
"createdAt": "2020-01-04T17:24:29.146Z",
"updatedAt": "2020-01-04T17:13:10.712Z"
}
]
}
Example request
curl -X GET https://api.complycube.com/v1/documents?clientId={:clientId} \
-H 'Authorization: <YOUR_API_KEY>'
Last updated
Was this helpful?