Generate a client report

Generate a client report

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

Generates a client PDF report.

Query Parameters

Name	Type	Description
clientId	string	The ID of the client.

Headers

Name	Type	Description
Authorization	string	The API live or test key

200 Client report successfully generated.

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

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

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

Example request

cURL

curl -X POST https://api.complycube.com/v1/reports?clientId={:clientId} \
     -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({ clientId: "CLIENT_ID" });

Python

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

check = cc_api.reports.generate_client_report('CLIENT_ID')

PHP

use ComplyCube\ComplyCubeClient;

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