# Return Report By Type

Retrieves a list of compliance reports previously created, including their current status. Each report includes details such as the report type, creation date, status, and the criteria used to generate it.  The  field reflects the filters and parameters applied during report creation, which depend on the report type  (e.g.,  or ). Use this endpoint to monitor the status of your reports, view historical reports, and manage expiration timelines.  For generating new reports, refer to the  endpoint.


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

## Query parameters:

  - `page` (integer, required)
    Starting page number.

  - `pageSize` (integer, required)
    Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

  - `reportType` (string, required)
    Acceptable value is either 'AmlAlert', 'Audit', 'Profile', 'AmlScreen', 'MonitorSearch'.
    Enum: "amlAlert", "audit", "profile", "amlScreen", "monitorSearch"

  - `searchTerm` (string)
    Filters the monitor reports by search_term.

## Response 200 fields (application/json):

  - `items` (array)

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

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

  - `items.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"

  - `items.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"

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

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

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

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

  - `items.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.

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

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

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

  - `totalSize` (integer)
    The total number of reports available.

  - `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