Download A CSV Report Of Monitored Searches

Request

Downloads the monitored searches that match the filter criteria as a CSV file. A maximum of 1,000 records can be downloaded at once. If more than 1,000 records match the criteria, a 409 Conflict response is returned. If no searches match, a 204 No Content response is returned.

Security

bearerToken

Query

searchTypestring

Gets or sets the search type (e.g., "business", "individual").

Enum:"individual""business"

searchTermstring

Gets or sets the search term.

isScheduledboolean

Gets or sets a value indicating whether the search is scheduled. Default is true for monitored searches.

datasetsArray of strings

Gets or sets the datasets to filter by.

thresholdsArray of integers, (int32)

Gets or sets the thresholds for the search results (e.g., 75, 80, 85, 90, 95, 100).

pepTiersArray of strings

Gets or sets the PEP tiers to filter by.

Items Enum:"pepTier1""pepTier2""pepTier3""byAssociation"

X-Team-Idstring, (uuid)

Optional. The team to work in, using a team id from List Teams. If left out, the default team is used. Records created in a team can only be seen by sending that team's id. A team id that doesn't exist, or a team being deleted, is rejected with 404 Team Not Found.

Example:6b78aed4-9ba6-441b-80b9-df9bea3b7c97

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/searches/monitored/download?searchType=individual&searchTerm=string&isScheduled=true&datasets=string&thresholds=0&pepTiers=pepTier1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-Team-Id: 6b78aed4-9ba6-441b-80b9-df9bea3b7c97'

Responses

OK

Bodyapplication/json

downloadUrlstring

Url of the file to download

fileNamestring

Name of the file

expiresAtstring, (date-time)

Date and time when the url will expire

correlationIdstring

A unique ID assigned to this request.

Response

{
  "downloadUrl": "https://kyc-protect-api-stage.s3.eu-west-1.amazonaws.com/sync-downloads/monitor-search/customers/100000002/monitor-search-dd418af1-d566-43fc-8f73-205fd24e4763-2026-11-03_14_41_00-report.csv",
  "fileName": "monitor-search-dd418af1-d566-43fc-8f73-205fd24e4763-2026-11-03_14_41_00-report.csv",
  "expiresAt": "2026-11-03T15:41:00.849Z",
  "correlationId": "3da2a015-d849-4907-b258-1a19018e4f6b"
}