Get a document

This will retrieve the document object. To download attachments, you should use the download attachment image endpoint.

Performing a get document request on a document with attachments will return details on the document and all its attachments.

Get a document

GET https://api.complycube.com/v1/documents/:id

Retrieves an existing document.

Path Parameters

Name	Type	Description
id	string	The ID of the document.

Headers

Name	Type	Description
Authorization	string	The live or sandbox API key.

200 Document, with an attachment, successfully retrieved.

{
    "id": "5eb158880c19580007310f22",
    "clientId": "5eb1276d96be4a0008713af5",
    "type": "driving_license",
    "classification": "proof_of_identity",
    "issuingCountry": "GB",
    "images": [
        {
            "id": "5eb3c8ff2b5c980007e62024",
            "fileName": "front-test.jpg",
            "documentSide": "front",
            "downloadLink": "/documents/5eb158880c19580007310f22/images/5eb169302d868c0008828591/download",
            "contentType": "image/jpg",
            "size": 72716,
            "createdAt": "2020-01-04T18:20:21.122Z",
            "updatedAt": "2020-01-04T18:20:21.122Z"
        }
    ],
    "createdAt": "2020-01-04T17:24:29.146Z",
    "updatedAt": "2020-01-04T17:24:29.146Z"
}

404 Could not find a document matching provided id.

{
    "type": "resource_not_found",
    "message": "Invalid document id '5eb158880c19580007310f21'"
}

Example request

cURL

curl -X GET https://api.complycube.com/v1/documents/{:documentId} \
     -H 'Authorization: <YOUR_API_KEY>' 

Node.js

const { ComplyCube } = require("@complycube/api");

const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });

const document = await complycube.document.get("DOCUMENT_ID");

Python

from complycube import ComplyCubeClient
cc_api = ComplyCubeClient(api_key='<YOUR API KEY>')

a_doc = cc_api.documents.get('DOCUMENT_ID')

PHP

use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR API KEY>');
$doc = $ccapi->documents()->get('DOCUMENT_ID');