Create AML / Audit Report

Uses the user-provided information to create a compliance report.

The criteria property in the request body must be populated using the fields returned by the GET /criteria/{type} endpoint.

Ensure you first retrieve the criteria for the desired report type using the GET /criteria/{type} endpoint before making this request.

SecuritybearerToken
Request
Request Body schema: application/json

Request body containing the report type, file name, and criteria details for creating a compliance report.
The criteria field must adhere to the schema provided by the GET /criteria/{type} endpoint.

type
string or null

Type of the report (e.g., amlAlert or audit).

fileName
string or null

File name for the report to be created. This must be unique.

object

The criteria used to create the report. These fields should match those provided by the GET /criteria/{type} endpoint.

Responses
202

Success

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

502

Server Error

post/compliance/kyc-protect/reports
Request samples
application/json
{
  • "type": "string",
  • "fileName": "string",
  • "criteria": {
    }
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "fileName": "string",
  • "status": "submitted",
  • "type": "amlAlert",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdById": 0,
  • "createdByUser": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "criteria": {
    },
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "correlationId": "string"
}
➔ Next to Returns Report By Type