Analytics

Handle compliance report generation. It includes endpoints for initiating compliance report jobs and monitoring their status.

Build Compliance Reports

Start a job to build selected reports. Depending on the report you request, you need to run a Screening or Whitelist job first. With the build toggle you can control which report is generated or not. Every report may have specific additional configuration options which are explained in detail below.

SecurityapiKey
Request
Request Body schema: application/json
required

cmd

object (ComplianceReportsConfiguration)

Configures if and how Compliance Reports are generated.

screeningJobId
string (ScreeningJobId)
Deprecated

Job ID of the screening job. This is deprecated, please use the nested Screening Job ID within the report.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
Responses
200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post/compliancereports
Request samples
application/json
{
  • "reportsConfiguration": {
    }
}
Response samples
application/json
{
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "name": "Process vendor data.",
  • "description": "I started this job to improve quality of our data.",
  • "status": "RUNNING",
  • "statusMessage": "The job failed because storage is empty.",
  • "createdAt": "2024-12-21T01:35:24Z",
  • "user": "742429-234242-4343-232323",
  • "progress": "77",
  • "attachments": [
    ],
  • "sanctionWatchlistMatching": {
    },
  • "whitelist": {
    }
}

Poll Compliance Reports

After you have started a Compliance Reports job, you will receive a job id in the response. ´´´ { "id" : "" } ´´´ Use this ID to poll for the status of the job using this endpoint. Once the status is FINISHED, you can download the report files which you will find in attachments in the response.

SecurityapiKey
Request
path Parameters
id
required
string

ID of the Compliance Reports.

Example: 35f23c03-1c22-45fe-9484-3ffe769325de
Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/compliancereports/{id}
Request samples 
Response samples 
application/json
{
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "name": "Process vendor data.",
  • "description": "I started this job to improve quality of our data.",
  • "status": "RUNNING",
  • "statusMessage": "The job failed because storage is empty.",
  • "createdAt": "2024-12-21T01:35:24Z",
  • "user": "742429-234242-4343-232323",
  • "progress": "77",
  • "attachments": [
    ],
  • "sanctionWatchlistMatching": {
    },
  • "whitelist": {
    }
}