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

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

Create KYC Protect Alert

Request

Compliance Alerts

Security
bearerToken
Bodyapplication/json
safeNumberstring

The Creditsafe Safe Number uniquely identifying the company or entity for the alert.

namestring

The name of the company or entity for which the alert is being created.

countryCodestring

The ISO country code associated with the company or entity.

entitiesobject

A collection of related entities to include in the alert, such as individuals or organizations.

curl -i -X POST \
  https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/alerts \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "safeNumber": "string",
    "name": "string",
    "countryCode": "string",
    "entities": {
      "additionalProp1": [
        {
          "id": "string",
          "type": "string",
          "name": "string",
          "firstName": "string",
          "middleName": "string",
          "lastName": "string",
          "countryCode": "string",
          "gender": "string",
          "dateOfBirth": {
            "year": 0,
            "month": 0,
            "day": 0
          },
          "isDobRequired": true
        }
      ]
    }
  }'

Responses

Success

Bodyapplication/json
safeNumberstring

The Creditsafe Safe Number uniquely identifying the company or entity for the alert response.

namestring

The name of the company or entity for which the alert response is generated.

countryCodestring

The ISO country code associated with the company or entity.

entitiesobject

A collection of related entities included in the alert response, such as individuals or organizations.

hasAlertsboolean

Indicates if any alerts are present for the overall response.

entitiesWithAlertsnumber

The number of entities in the response that have alerts.

lastUpdatedstring

The date and time when the alert response was last updated.

hasErrorboolean

Indicates if any errors occurred in the overall response.

errorDescriptionstring

Description of any error encountered in the overall response.

dataAuditIdstring

The unique identifier for the data audit associated with this alert response.

resultIdstring

The unique identifier for the result associated with the overall response.

Response
application/json
{
  "safeNumber": "string",
  "name": "string",
  "countryCode": "string",
  "entities": {
    "additionalProp1": [ … ]
  },
  "hasAlerts": true,
  "entitiesWithAlerts": 0,
  "lastUpdated": "string",
  "hasError": true,
  "errorDescription": "string",
  "dataAuditId": "string",
  "resultId": "string"
}

Add Search To AML Monitoring

Request

Adds the specified searches to AML monitoring, i.e. schedules them for screening. If thresholds and datasets are amended from the original search, new results will generated. Any existing hits will be overridden and any previous match decisions will be reset.

Important A pre-requisite for monitoring work is that any searches MUST be linked to a profile before Monitoring can be Active.

Security
bearerToken
Bodyapplication/json
itemsArray of objects(PostKYCProtectSchedulesRequest)
curl -i -X POST \
  https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/schedules \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "items": [
      {
        "threshold": 0,
        "datasets": [
          "string"
        ],
        "sanctionBodies": [
          0
        ],
        "isEmailRequired": true,
        "emailRecipients": [
          "string"
        ],
        "searchId": "9b1a67f9-9477-48e5-8a6c-11b70245e1d9",
        "isDobRequired": false
      }
    ]
  }'

Responses

Success

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

Return All Ordered Schedules

Request

Returns all schedules ordered by modified date.

Security
bearerToken
Query
pageinteger

Starting page number.

Default 1
pageSizeinteger

Number of items to return per Page.

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

Responses

Success

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

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