Skip to content
Connect API Catalog/
/
/
Alert Metrics

Alert Metrics

Request

Returns a list of KYC and AML alert metrics on profiles.

Security
bearerToken
Query
pageinteger

Starting page number.

Default:1
pageSizeinteger

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

searchTermstring

A search term to search by. The search term will be matched against profile names, and internal ids

sortOrderstring

The order in which the items should be sorted. Available values: asc, desc

sortBystring

The field by which the items should be sorted. Available values: alertLastModifiedDate, addedToMonitoringDate, latestAlertDate

assignedToIdinteger, (int32)

The profile assignee to filter by.

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/profiles/alerts/metrics?page=1&pageSize=0&searchTerm=string&sortOrder=string&sortBy=string&assignedToId=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
totalSizeinteger, (int32)
itemsArray of objects(KYCProtectProfileAlertsMetricsResponse)
Response
{
  "totalSize": 0,
  "items": [
    { … }
  ]
}