Generate a check report
URL
GET https://api.complycube.com/v1/reports?checkId=:id
Generates a check PDF report.
Headers
Name
Type
Description
Authorization*
string
The API live or test key.
Query parameters
Name
Type
Description
checkId*
string
The ID of the check.
Example request
curl -X POST https://api.complycube.com/v1/reports?checkId={:checkId} \
-H 'Authorization: <YOUR_API_KEY>' const { ComplyCube } = require("@complycube/api");
const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });
const report = await complycube.report.generate({ checkId: "CHECK_ID" });from complycube import ComplyCubeClient
cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')
check = cc_api.reports.generate_check_report('CHECK_ID')use ComplyCube\ComplyCubeClient;
$ccapi = new ComplyCubeClient('<YOUR_API_KEY>');
$report = $ccapi->reports()->generate(['checkId' => 'CHECK_ID']);using ComplyCube.Net;
using ComplyCube.Net.Resources.Reports;
var reportApi = new ReportApi(new ComplyCubeClient("<YOUR_API_KEY>"));
var reportRequest = new ReportRequest { checkId = aCheck.id }
var report = await reportApi.GenerateReport(reportRequest);Example responses
{
"contentType": "images/jpg",
"data": "<BASE64_DATA_CONTENT>"
}{
"type": "resource_not_found",
"message": "Invalid check id '5eaecff4a675310007440c08'"
}Last updated
Was this helpful?