Skip to content
Connect API Catalog/
/
/
Returns Individual AML Se...

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

Performs An AML Search For An Individual And Saves The Results To The Database

Request

A request requires a name, or first name and last name, at least one valid dataset and a threshold.

Length of name or combination of first name, middle name and last name must not exceed 200 characters. If user is providing first name, middle name and last name combination, the max characters limit includes the formatted name in this format {lastName} {firstName} {middleName}.

User will be deducted 1 credit for each search.

Security
bearerToken
Bodyapplication/json
countryCodesArray of strings or null

List of Two-letter country code ISO-3166-2.

thresholdinteger(int32)required

Hits with scores below the chosen value will not be shown.
Must be one of 75, 80, 85, 90, 95, or 100

sanctionBodiesArray of integers or null

Specifies which SanctionBodies will be searched. When null is supplied, the Settings preferences will be applied. When null is supplied and Settings preferences not set, all sanction bodies will be applied. When no sanction bodies supplied, all sanction bodies will be applied.

namestring or null

Required if FirstName and LastName are not provided

firstNamestring or null

If firstName is provided then lastName must also be provided

middleNamestring or null

middleName is optional, valid along with firstName and lastName only

lastNamestring or null

If LastName is provided then FirstName must also be provided

dateOfBirthstring or null(date)

Date YYYY-MM-DD or YYYY format. Must be after 1900 and not in the future.

genderstring or null

Define the gender of the individual you are searching for. Available values are male and female.

Enum"male""female"
pepTiersArray of strings or null

When searching the PEP dataset, define what tiers of the PEP profiles should be included in the results.
PEP Tier 1 - senior roles
PEP Tier 2 - middle-ranking
PEP Tier 3 - junior officials

If the PEP Dataset is NOT included on the list of searched datasets, then this value is ignored.

The PEP Tier filter does not apply to PEP-LINKED Profiles.

Enum"pepTier1""pepTier2""pepTier3"
datasetsArray of strings or nullrequired

Specifies which datasets will be searched
PEP - Politically Exposed Persons (All)
PEP-CURRENT - Only current PEPs
PEP-FORMER - Only former PEPs
PEP-LINKED - Only linked PEPs (PEP by Association)
SAN - Sanctioned (All)
SAN-CURRENT - Only current Sanctions
SAN-FORMER - Only former Sanctions
INS - Insolvency
AM - Averse Media
POI - Profile of Interest
ENF - Enforcement DD - Disqualified Director

curl -i -X POST \
  https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/searches/individuals \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "countryCodes": [
      "string"
    ],
    "threshold": 0,
    "sanctionBodies": [
      0
    ],
    "name": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "dateOfBirth": "2019-08-24",
    "gender": "male",
    "pepTiers": [
      "pepTier1"
    ],
    "datasets": [
      "string"
    ]
  }'

Responses

Created

Bodyapplication/json
idstring(uuid)

Id of the search

namestring or null

Name provided for the search. Length must not exceed 200 characters

countryCodesArray of strings or null

Countries provided to the search

thresholdinteger(int32)

Hits with scores below this value will not be shown.

typestring

Indicates whether search type is individual or business

datasetsArray of strings

Provided datasets for the search

statusstring

Status of the search

riskRatingstring

Risk associated with the search

assignedToUserIdinteger or null(int32)

Id of the user assigned to the search

assignedUserstring or null

Name of the user assigned to the search

createdByIdinteger(int32)

Id of the user who created the search

createdBystring

Name of the user who created the search

createdAtstring(date-time)

Search created date time

modifiedByIdinteger(int32)

Id of the user who modified the search

modifiedBystring

Name of the user who modified the search

modifiedAtstring(date-time)

Search modified date time

notestring or null

Note associated with the search

totalHitCountinteger(int32)

Total number of hits in the search

truePositiveHitsCountinteger(int32)

The number of true-positive hits in the search

falsePositiveHitsCountinteger(int32)

The number of false-positive hits in the search

undecidedHitsCountinteger(int32)

The number of undecided hits in the search

firstNamestring or null

First name provided in the search. The combination of first name, middle name, and last name must not exceed 200 characters

middleNamestring or null

Middle name provided in the search. The combination of first name, middle name, and last name must not exceed 200 characters

lastNamestring or null

Last name provided in the search. The combination of first name, middle name, and last name must not exceed 200 characters

genderstring or null

Gender provided in the search

dateOfBirthstring or null(date)

DOB provided in the search

pepTiersArray of strings or null

Pep Tiers provided in the search

scheduleIdstring or null

Schedule Id linked to the search

isDobRequiredboolean or null

Indicates whether date of birth is required for the individual search.

Default true
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "countryCodes": [
    "string"
  ],
  "threshold": 0,
  "type": "string",
  "datasets": [
    "string"
  ],
  "status": "string",
  "riskRating": "string",
  "assignedToUserId": 0,
  "assignedUser": "string",
  "createdById": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "modifiedById": 0,
  "modifiedBy": "string",
  "modifiedAt": "2019-08-24T14:15:22Z",
  "note": "string",
  "totalHitCount": 0,
  "truePositiveHitsCount": 0,
  "falsePositiveHitsCount": 0,
  "undecidedHitsCount": 0,
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "gender": "string",
  "dateOfBirth": "2019-08-24",
  "pepTiers": [
    "string"
  ],
  "scheduleId": "string",
  "isDobRequired": true
}

Returns Individual AML Searches

Request

Returns a list of individual AML searches ordered by modified date.

Security
bearerToken
Query
pageinteger

Starting page number.

Default 1
pageSizeinteger

Number of items to return per Page.

isScheduledboolean
curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/searches/individuals?page=1&pageSize=0&isScheduled=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
totalSizeinteger(int32)
itemsArray of objects(KycProtectGetIndividualSearchItems)
Response
application/json
{
  "totalSize": 0,
  "items": [
    { … }
  ]
}

Update Individual AML Searches

Request

Updates a batch of individual AML searches.

Security
bearerToken
Bodyapplication/json
itemsArray of objects
curl -i -X PUT \
  https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/searches/individuals \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "items": [
      {
        "assignedToUserId": {},
        "status": {},
        "riskRating": {},
        "note": {},
        "searchId": "9b1a67f9-9477-48e5-8a6c-11b70245e1d9"
      }
    ]
  }'

Responses

Success

Bodyapplication/json
failedArray of objects
successfulArray of objects
correlationIdstring

A unique ID assigned to this request.

Response
application/json
{
  "failed": [
    { … }
  ],
  "successful": [
    { … }
  ],
  "correlationId": "string"
}

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