Download A CSV Report Of Monitored Searches

Request

This endpoint allows downloading monitored searches filtered by various criteria as a CSV file.A maximum of 1000 records can be downloaded at once. If more than 1000 records match the criteria, If no searches are found, a 204 No Content response is returned. A 409 Conflict 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"

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

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

Response

{
  "downloadUrl": "string",
  "fileName": "string",
  "expiresAt": "2019-08-24T14:15:22Z"
}