Upload image attachment

Upload an image attachment

POST https://api.complycube.com/v1/documents/:id/upload/:documentSide

Associates an image attachment to an existing document. The images must be either in JPG, PNG, or PDF format. Each side of the document must be between 34 KB and 4 MB.

Path Parameters

Name	Type	Description

Headers

Name	Type	Description

Request Body

Name	Type	Description

200 Document attachment successfully uploaded.

{
    "id": "5eb169302d868c0008828591",
    "fileName": "front-test.jpg",
    "documentSide": "front",
    "downloadLink": "/documents/5eb158880c19580007310f22/images/5eb169302d868c0008828591/download",
    "contentType": "image/jpg",
    "size": 72716,
    "createdAt": "2020-01-04T17:24:29.146Z",
    "updatedAt": "2020-01-04T17:24:29.146Z"
}

400 An example of a Bad Request response, when a tiny attachment, smaller than 34 KB, is provided.

{
    "type": "invalid_request",
    "message": "Image file size should be between 34KB and 4MB",
    "param": "data"
}

Example request

cURL

curl -X POST https://api.complycube.com/v1/documents/{:documentId}/upload/{:documentSide} \
     -H 'Authorization: <YOUR_API_KEY>' \
     -H 'Content-Type: application/json' \
     -d '{
          	"fileName": "front-test.jpg",
          	"data": "<BASE64_DATA_CONTENT>"
        }' 

Node.js

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

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

await complycube.document.upload("DOCUMENT_ID", {
      fileName: "front-test.jpg",
      data: "<BASE64_DATA_CONTENT>"
}, "DOCUMENT_SIDE");

Python

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

doc_front = {
    'fileName': 'passport_front.jpg',
    'data': '<BASE_64_ENCODED>'
}

img = cc_api.documents.upload('DOCUMENT_ID','DOCUMENT_SIDE',**doc_front)

PHP

use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR API KEY>');
$up = $ccapi->documents()->upload('DOCUMENT_ID', 
                                  'front', 
                                  ['fileName' => 'passport_front.jpg',
                                   'data' => '<BASE64_CONTENT>']);