Return Report By Type

Request

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 criteria field reflects the filters and parameters applied during report creation, which depend on the report type (e.g., amlAlert or audit).

Use this endpoint to monitor the status of your reports, view historical reports, and manage expiration timelines. For generating new reports, refer to the POST /compliance/kyc-protect/reports endpoint.

Security

bearerToken

Query

pageintegerrequired

Starting page number.

pageSizeinteger, (int32)required

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

reportTypestringrequired

Acceptable value is either 'AmlAlert', 'Audit', 'Profile', 'AmlScreen', 'MonitorSearch'.

Enum:"amlAlert""audit""profile""amlScreen""monitorSearch"

searchTermstring

Filters the monitor reports by search_term.

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/reports?page=0&pageSize=0&reportType=amlAlert&searchTerm=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json

itemsArray of any

totalSizeinteger

The total number of reports available.

correlationIdstring

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

Response

{
  "items": [],
  "totalSize": 0,
  "correlationId": "string"
}