Download image attachment

Download an image attachment

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

Downloads an existing image attachment.

Path Parameters

Name	Type	Description
id	string	The ID of the document.
side	string	The side of the document to download. Valid values include: 1. front 2. back

Headers

Name	Type	Description
Authorization	string	The API live or test key

200 Document attachment successfully downloaded.

{
    "fileName": "front-test.jpg",
    "contentType": "image/jpg",
    "data": "<BASE64_DATA_CONTENT>"
}

Example request

cURL

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

Node.js

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

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

const image = await complycube.document.download("DOCUMENT_ID","DOCUMENT_SIDE");

Python

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

img = cc_api.documents.download('DOCUMENT_ID','DOCUMENT_SIDE')

PHP

use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR API KEY>');
$up = $ccapi->documents()->download('DOCUMENT_ID', 'DOCUMENT_SIDE');