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

KYC (Know Your Customer) (1.0.0)

KYC (Know Your Customer) enables you to make better-informed risk management decisions by utilizing our comprehensive business information. This service is designed for both Know Your Business operations and AML (Anti-Money Laundering) screening features.

The application ensures that you can conduct due diligence on customers and suppliers alike, identify key parties, verify individual identity details globally, and screen against international sanctions, regulatory enforcements, PEP (Politically Exposed Persons) lists, and potential adverse media.

Download OpenAPI description
kycProtect.json
kycProtect.yaml
Languages
Servers
Sandbox server

https://connect.sandbox.creditsafe.com/v1/

Production server

https://connect.creditsafe.com/v1/

Authentication

Endpoints to authenticate and generate an authentication token for secure access to the API.

Operations

Administrator Resources

Endpoints for managing administrative tasks, such as user roles, currency codes, country codes and profile document types.

Operations

Audit

Endpoints to retrieve audit logs and track activity related to profiles, searches, and monitoring actions.

Operations

Profile Management

Endpoints to create, retrieve, and manage profiles.

Operations

Profile Updates

Endpoints to update existing profiles with new information, such as addresses, notes, or attachments.

Operations

Profile Key Parties

Endpoints to manage key parties associated with a profile, such as directors, shareholders, or UBOs.

Operations

Profile Business / Individual Details

Endpoints to retrieve detailed information about businesses or individuals associated with a profile.

Operations

AML Screening - Profile Management

Endpoints to manage AML screening profiles, including creating, updating, and retrieving screening results.

Operations

AML Screening - Businesses

Endpoints to perform AML screening for businesses, including risk assessments and compliance checks.

Operations

AML Screening - Individuals

Endpoints to perform AML screening for individuals, including identity verification and risk assessments.

Operations

AML Bulk Screening

Endpoints to perform bulk AML screenings for multiple businesses or individuals in a single request.

Operations

AML Monitoring Management

Endpoints to set up and manage ongoing AML monitoring for profiles, including receiving alerts for changes or risks.

Operations

Async AML

Endpoints to return asynchronous AML jobs, such as bulk screenings or monitoring tasks.

Operations

Batch Uploads

Endpoints to upload and process batch files for profiles or searches, including retrying failed uploads and downloading error reports.

Operations

Global Monitoring

Endpoints to monitor changes to company information globally, including event rules and notifications.

Operations

Reporting

Endpoints to generate and retrieve reports, including compliance reports and risk assessments.

Operations

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
totalSizeinteger(int32)
itemsArray of objects(KycProtectGetIndividualSearchItems)
Response
application/json
{
  "totalSize": 0,
  "items": [
    { … }
  ]
}

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
application/json
{
  "downloadUrl": "string",
  "fileName": "string",
  "expiresAt": "2019-08-24T14:15:22Z"
}

Compliance Alerts

Endpoints to manage and retrieve compliance alerts related to companies via a connectId.

Production Release Date

11th February 2026

Operations