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

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

Compliance Alerts

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

Production Release Date

11th February 2026

Operations

Return Compliance Alerts

Request

Returns compliance alerts for a company by automatically fetching the company report using the provided connectId or Safe Number, extracting required data (directors, UBOs, etc.), and processing it through the compliance alerts API. This eliminates the need for manual report retrieval and data transformation.

Security
bearerToken
Path
connectIdstringrequired

The connectId (optionally Safe Number where available) of the Company required to order their Credit Report.

Example: GB-0-03836192
curl -i -X GET \
  https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/complianceAlerts/GB-0-03836192 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
safeNumberstring

Safe number of the company or entity.

namestring

Name of the company or entity.

countryCodestring

Two-letter ISO country code.

entitiesobject

Entities associated with the alert, grouped by property.

Note Any properties with no available data are excluded from the response.

hasAlertsboolean

Indicates if there are any alerts for the response.

entitiesWithAlertsnumber

Number of entities with alerts.

lastUpdatedstring(date-time)

Timestamp of the last update.

Response
application/json
{
  "safeNumber": "string",
  "name": "string",
  "countryCode": "string",
  "entities": {
    "currentDirectors": [ … ],
    "ubos": [ … ]
  },
  "hasAlerts": true,
  "entitiesWithAlerts": 0,
  "lastUpdated": "2019-08-24T14:15:22Z"
}