# Create AML / Audit Report

Uses the user-provided information to create a compliance report.  The  property in the request body must be populated using the fields returned by  the  endpoint. Ensure you first retrieve the criteria for the desired report type using the   endpoint before making this request.


Endpoint: POST /compliance/kyc-protect/reports
Version: 1.10.9
Security: bearerToken

## Request fields (application/json):

  - `type` (string,null)
    Type of the report (e.g.,  or ).

  - `fileName` (string,null)
    File name for the report to be created. This must be unique.

  - `criteria` (object)
    The criteria used to create the report. These fields should match those provided by the  endpoint.

  - `criteria.additionalProperties` (object)
    Additional fields specific to the report type ( or ) that customize the report's scope  and contents. These properties are dynamically generated and may include nested objects or arrays  for complex criteria. For example: - For , this may include parameters like  and . - For , this may include date ranges or detailed filtering options. Refer to the response from the  endpoint for a complete list of possible fields.

## Response 202 fields (application/json):

  - `id` (string)
    Unique identifier for the report, generated when the report is created.

  - `fileName` (string)
    The name of the report file, as specified during creation or generated automatically.

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

  - `type` (string)
    Type of the report, determining the data and format of the results. Supported values: - : Report for Anti-Money Laundering alerts. - : Report for audit-related compliance checks.
    Enum: "amlAlert", "audit"

  - `createdAt` (string)
    The timestamp when the report was initially created.

  - `createdById` (integer)
    The unique identifier of the user who initiated the creation of the report.

  - `createdByUser` (string)
    The username or identifier of the user who created the report.

  - `modifiedAt` (string)
    The timestamp of the last modification made to the report, if applicable.

  - `criteria` (object)
    The criteria used to generate the report, reflecting the filters and parameters applied during its creation. The structure of the  object depends on the report  ( or ). Some properties may be nested in arrays or objects.

  - `criteria.fromDate` (string)
    The starting date for the report's criteria, defining the range of data included.

  - `criteria.toDate` (string)
    The ending date for the report's criteria. Results exclude this date.

  - `expiresAt` (string,null)
    The expiration timestamp for the report, after which it may no longer be accessible.

  - `correlationId` (string)
    Unique identifier for tracking the request, useful for debugging and tracing.

## Response 400 fields (application/json):

  - `correlationId` (string)
    A unique ID assigned to this request.

  - `message` (string)

  - `details` (string)
    Provides further information on why the request was rejected

## Response 401 fields (application/json):

  - `error` (string)

## Response 403 fields (application/json):

  - `message` (string)
    Example: "Access forbidden"

## Response 409 fields (application/json):

  - `correlationId` (string)
    The unique identifier. (A UUID specified by RFC4122).

  - `message` (string)

  - `details` (string)
    Provides further information on why the request was rejected

## Response 502 fields (application/json):

  - `correlationId` (string)
    A unique ID assigned to this request.

  - `message` (string)

  - `details` (string)
    Provides further information on why the request was rejected