Skip to content
Connect API Catalog/KYC (Know Your Customer)/
/Reporting

Retrieve Report Criteria

Request

Fetches the available criteria for a specified report type.
This endpoint is a prerequisite for creating a report and provides the valid fields that can populate the criteria property in the POST /reports request.

Use this to retrieve a list of valid fields for the report type before proceeding with report creation.

Security
bearerToken
Path
typestringrequired

The type of report for which criteria are requested. Supported values:

- amlAlert: Criteria for Anti-Money Laundering alerts.
- audit: Criteria for audit-related reports.
- profile: Criteria for profile-based reports.
- amlScreen: Criteria for AML screening reports.
- monitorSearch: Criteria for monitoring search reports.

Enum:"amlAlert""audit""profile""amlScreen""monitorSearch"
curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/reports/criteria/{type}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
additionalPropertiesobject

Additional fields applicable to the specific report type. These may vary depending on whether the report type is amlAlert or audit. Nested arrays and objects are supported for complex criteria.

correlationIdstring

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

Response
{
  "fromDate": {
    "isRequired": true,
    "type": "string",
    "format": "yyyy-mm-dd",
    "description": "Cannot be a future date",
    "acceptableValues": null
  },
  "toDate": {
    "isRequired": true,
    "type": "string",
    "format": "yyyy-mm-dd",
    "description": "Should fall after fromDate, results will be fetched excluding the provided to date",
    "acceptableValues": null
  },
  "hitDecisions": {
    "isRequired": false,
    "type": "array[string]",
    "format": null,
    "description": "Decisions made on hits. Multiple values are acceptable",
    "acceptableValues": [ … ]
  },
  "hasHits": {
    "isRequired": false,
    "type": "boolean",
    "format": null,
    "description": "Indicates if there are any hits.",
    "acceptableValues": [ … ]
  }
}