Create AML / Audit Report

Request

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.

Security

bearerToken

Bodyapplication/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.

typestring or null

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

fileNamestring or null

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

criteriaobject

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

curl -i -X POST \
  https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/reports \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "string",
    "fileName": "string",
    "criteria": {
      "additionalProperties": {}
    }
  }'

Responses

Success

Bodyapplication/json

idstring, (uuid)

Unique identifier for the report, generated when the report is created.

fileNamestring

The name of the report file, as specified during creation or generated automatically.

statusstring

Current processing status of the report. Indicates the lifecycle stage, such as:
- submitted: The report request has been submitted.
- queued: The report is waiting to be processed.
- inProgress: The report is currently being generated.
- completed: The report has been successfully created.
- failed: The report generation encountered an error.

Enum:"submitted""queued""inProgress""completed""failed"

typestring

Type of the report, determining the data and format of the results. Supported values:
- amlAlert: Report for Anti-Money Laundering alerts.
- audit: Report for audit-related compliance checks.

Enum:"amlAlert""audit"

createdAtstring, (date-time)

The timestamp when the report was initially created.

createdByIdinteger, (int32)

The unique identifier of the user who initiated the creation of the report.

createdByUserstring

The username or identifier of the user who created the report.

modifiedAtstring, (date-time)

The timestamp of the last modification made to the report, if applicable.

criteriaobject

The criteria used to generate the report, reflecting the filters and parameters applied during its creation.

The structure of the criteria object depends on the report type (amlAlert or audit). Some properties may be nested in arrays or objects.

expiresAtstring or null, (date-time)

The expiration timestamp for the report, after which it may no longer be accessible.

correlationIdstring

Unique identifier for tracking the request, useful for debugging and tracing.

Response

{
  "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": {
    "fromDate": "2019-08-24",
    "toDate": "2019-08-24",
    "property1": {},
    "property2": {}
  },
  "expiresAt": "2019-08-24T14:15:22Z",
  "correlationId": "string"
}