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

Searches

Endpoint to review performed searches for businesses or individuals, including retrieving search results and downloading reports.

Operations

Return Compliance Kyc Protect Searches Results

Request

Returns a list of all performed searches, including details such as ID, name, type, risk rating, datasets, creation and assignment information, and PEP tier. Supports filters such as search type, keyword, dataset, threshold, PEP tier, and scheduled status.

Security
bearerToken
Query
IsScheduledboolean

Filter searches by scheduled status. Defaults to false if not specified.

SearchTypestring

Filter searches by type (e.g., Individual, Business)

Enum:"individual""business"
SearchTermstring

Filter searches by search term

DatasetsArray of strings

Filter searches by specific datasets

ThresholdsArray of integers, (int32)

Filter searches by specific thresholds

PepTiersArray of strings

Filter searches by PEP tiers

Items Enum:"pepTier1""pepTier2""pepTier3""byAssociation"
pageinteger, (int32)required

The page number to fetch. Should be a positive integer.

pageSizeinteger, (int32)required

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

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/searches?IsScheduled=true&SearchType=individual&SearchTerm=string&Datasets=string&Thresholds=0&PepTiers=pepTier1&page=0&pageSize=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
correlationIdstring

A unique ID assigned to this request.

totalSizeinteger, (int32)
itemsArray of objects(KycProtectGetIndividualSearchItems)
Response
{
  "correlationId": "string",
  "totalSize": 0,
  "items": [
    { … }
  ]
}