Skip to content
Connect API Catalog/Creditsafe Connect/
/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.

Example:page=1
pageSizeinteger, (int32)required

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

Example:pageSize=10
Headers
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?IsScheduled=true&SearchType=individual&SearchTerm=string&Datasets=string&Thresholds=0&PepTiers=pepTier1&page=1&pageSize=10' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-Team-Id: 6b78aed4-9ba6-441b-80b9-df9bea3b7c97'

Responses

OK

Bodyapplication/json
correlationIdstring

A unique ID assigned to this request.

totalSizeinteger, (int32)

Total number of searches available.

itemsArray of objects(KycProtectGetIndividualSearchItems)

The searches on this page.

Response
{
  "items": [
    { … },
    { … }
  ],
  "totalSize": 9,
  "correlationId": "8a9b7005-d2c6-40e7-b8e3-d84b0e4bfec2"
}