Generate a check report

Generate a check report

GET https://api.complycube.com/v1/reports?checkId=:id

Generates a check PDF report.

Query Parameters

Name	Type	Description
checkId	string	The ID of the check.

Headers

Name	Type	Description
Authorization	string	The API live or test key

200 Check report successfully generated.

{
    "contentType": "images/jpg",
    "data": "<BASE64_DATA_CONTENT>"
}

404 An example of a Not Found response, when an invalid checkId is provided.

{
    "type": "resource_not_found",
    "message": "Invalid check id '5eaecff4a675310007440c08'"
}

Example request

cURL

curl -X POST https://api.complycube.com/v1/reports?checkId={:checkId} \
     -H 'Authorization: <YOUR_API_KEY>' 

Node.js

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

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

const report = await complycube.report.generate({ checkId: "CHECK_ID" });

Python

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

check = cc_api.reports.generate_check_report('CHECK_ID')

PHP

use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR API KEY>');
$report = $ccapi->reports()->generate(['checkId' => 'CHECK_ID']);