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

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

Return All Async AML Jobs

Request

Gets a list of async aml jobs for user.

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.

statusesArray of strings

The async job statuses. It can be the collection of created, processing, completed

targetTypestring

The async job's target type. It can be either Profile or KeyParty

Enum"profile""keyParty"
curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/asyncAmlJobs?page=1&pageSize=0&statuses=string&targetType=profile' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

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

Return Async AML Jobs By Id

Request

Returns a list of async aml jobs for user.

Security
bearerToken
Path
jobIdstring(uuid)required

id of the async aml job

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.

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/asyncAmlJobs/{jobId}?page=1&pageSize=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstring(uuid)
statusstring
Enum"created""processing""completed"
createdAtstring(date-time)
createdByIdinteger(int32)
createdBystring
startedAtstring or null(date-time)
finishedAtstring or null(date-time)
criteriaCountinteger(int32)
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "created",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdById": 0,
  "createdBy": "string",
  "startedAt": "2019-08-24T14:15:22Z",
  "finishedAt": "2019-08-24T14:15:22Z",
  "criteriaCount": 0
}

Return Async Job Criteria By Id

Request

Gets a list of job criteria by async job id for user.

Security
bearerToken
Path
jobIdstring(uuid)required

id of the async aml job

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.

statusesArray of strings

The async job criteria statuses. It can be the collection of submitted, processing, completed, failed.

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/asyncAmlJobs/{jobId}/criteria?page=1&pageSize=0&statuses=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
itemsobject(KycProtectAsyncJobCriteriaResponse)
totalSizeinteger(int64)
Response
application/json
{
  "items": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
    "status": "submitted",
    "errorMessage": "string",
    "targetType": "profile",
    "targetId": "cbca1126-180e-4334-9df8-cf82289d378b",
    "type": "individual",
    "startedAt": "2019-08-24T14:15:22Z",
    "finishedAt": "2019-08-24T14:15:22Z",
    "countryCodes": [ … ],
    "threshold": 0,
    "name": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "dateOfBirth": "2019-08-24",
    "gender": "male",
    "pepTiers": [ … ],
    "datasets": [ … ],
    "sanctionBodies": [ … ],
    "isDobRequired": true
  },
  "totalSize": 0
}

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