Skip to content
Connect API Catalog/KYC (Know Your Customer)/
/
AML Screening - Businesse...

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

Performs An AML Search For A Business And Saves The Results To The Database

Request

A request requires a name, at least one valid dataset, and a threshold. User will be deducted 1 credit for each AML search.

Security
bearerToken
Bodyapplication/jsonrequired
countryCodesArray of strings

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.

namestringrequired

Name of the business to be searched.
Example - Google Inc
Max 200 characters allowed.

datasetsArray of stringsrequired

Specifies which datasets will be searched

PEP - Politically Exposed Persons (All)
PEP-LINKED - Only linked PEPs (PEP by Association)
SAN - Sanctioned (All)
SAN-CURRENT - Only current Sanctions
SAN-FORMER - Only former Sanctions
INS - Insolvency
AM - Adverse Media
POI - Profile of Interest
ENF - Enforcement
SOE - State Owned Enterprises (All)
SOE-CURRENT - Only current SOE
SOE-FORMER - Only former SOE

curl -i -X POST \
  https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/searches/businesses \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "countryCodes": [
      "string"
    ],
    "threshold": 0,
    "sanctionBodies": [
      0
    ],
    "name": "string",
    "datasets": [
      "string"
    ]
  }'

Responses

Success

Bodyapplication/json
idstring(uuid)

Id of the search

namestring

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

countryCodesArray of strings

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. Available values are new, approved, declined, pending, cancelled, referred and closed.

riskRatingstring

Risk associated with the search. Available values are notApplicable, veryLow, low, medium, high AND veryHigh.

assignedToUserIdinteger(int32)

Id of the user assigned to the search

assignedUserstring

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

Note associated with the search

scheduleIdstring(uuid)

Schedule Id linked to 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

correlationIdstring

A unique ID assigned to this request.

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",
  "scheduleId": "b7b4f318-018f-4d71-ac1a-f61e4bfaefbe",
  "totalHitCount": 0,
  "truePositiveHitsCount": 0,
  "falsePositiveHitsCount": 0,
  "undecidedHitsCount": 0,
  "correlationId": "string"
}

Returns Business AML Searches

Request

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

Security
bearerToken
Query
pageinteger

Starting page number.

Default 1
pageSizeinteger

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

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

Responses

Success

Bodyapplication/json
itemsArray of objects
totalSizenumber
Response
application/json
{
  "items": [
    { … }
  ],
  "totalSize": 0
}

Update Business AML Searches

Request

Updates a batch of business AML searches.

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

Responses

Success

Bodyapplication/json
failedArray of objects
successfulArray of objects
Response
application/json
{
  "failed": [
    { … }
  ],
  "successful": [
    { … }
  ]
}

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

Compliance Alerts

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

Production Release Date

11th February 2026

Operations