Skip to content
Connect API Catalog/KYC (Know Your Customer)/
/
Profile Business / Indivi...

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

Return Profile Details

Request

Fetches details of a profile by profile Id.

Security
bearerToken
Path
profileIdstringrequired

Id of a profile.

Example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
curl -i -X GET \
  https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/profiles/9a7ae0c8-f473-4ab6-8dbb-03fc061630cc/details \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
profileIdstring(uuid)

Id of the profile

Example: "2770ac31-8d12-4f69-8f93-326e93cd8c34"
legalNamestring or null

Name of the business/individual

Example: "string"
tradingNamestring or null

Trading name of the entity

Example: "string"
aliasesArray of strings or null

Alias names given for the entity

Example: ["string"]
activitystring or null

Activity of the business e.g., NAICS/SIC codes

Example: "string"
descriptionstring or null

Description of the entity

Example: "string"
contactNamestring or null

Contact person name

Example: "string"
emailstring or null

Contact email address

Example: "string"
websitestring or null

Entity website address

Example: "string"
telephonestring or null

Contact telephone number

Example: "string"
turnoverobject
Example: {"currencyCode":"eur","amount":0}
assetsUnderManagementobject
Example: {"currencyCode":"eur","amount":0}
dateOfBirthstring or null(date)

Date of birth of the individual

Example: "2024-02-27"
countryCodestring or null

Two-letter country code ISO-3166-2

Example: "string"
vatNostring or null

Tax Identification Number of the business

Example: "string"
isListedOnExchangeboolea or null

Details of company listed on exchange

Example: true
exchangeNamestring or null

Gets the name of the exchange.

Example: "string"
organizationNumberstring or null

Gets the organisation number.

Example: "string"
internalContactstring or null

Gets the internal contact.

Example: "string"
internalEmailstring or null

Gets the internal email.

Example: "string"
internationalScorestring or null

Gets the international score.

createdAtstring(date-time)

Profile details created time

Example: "2023-08-07T07:12:43.331308Z"
createdByIdinteger(int32)

Id of the user who created profile

Example: 101562008
createdBystring

Name of the user who created profile

Example: "Amol"
modifiedAtstring or null(date-time)

Profile details last updated time

Example: "2023-08-08T07:16:27.734212Z"
modifiedByIdinteger or null(int32)

Id of the user who last modified the profile

Example: 101562008
modifiedBystring or null

Name of the user who last modified the profile

Example: "Amol"
noteCountinteger(int32)

Count of notes associated with profile details

attachmentCountinteger(int32)

Count of attachment associated with profile details

Example: 2
Response
application/json
{
  "profileId": "2770ac31-8d12-4f69-8f93-326e93cd8c34",
  "legalName": "string",
  "tradingName": "string",
  "aliases": [
    "string"
  ],
  "activity": "string",
  "description": "string",
  "contactName": "string",
  "email": "string",
  "website": "string",
  "telephone": "string",
  "turnover": {
    "currencyCode": "eur",
    "amount": 0
  },
  "assetsUnderManagement": {
    "currencyCode": "eur",
    "amount": 0
  },
  "dateOfBirth": "2024-02-27",
  "countryCode": "string",
  "vatNo": "string",
  "isListedOnExchange": true,
  "exchangeName": "string",
  "organizationNumber": "string",
  "internalContact": "string",
  "internalEmail": "string",
  "createdAt": "2023-08-07T07:12:43.331308Z",
  "createdById": 101562008,
  "createdBy": "Amol",
  "modifiedAt": "2023-08-08T07:16:27.734212Z",
  "modifiedById": 101562008,
  "modifiedBy": "Amol",
  "noteCount": 0,
  "attachmentCount": 2,
  "correlationId": "70fd7603-1f75-4de6-8e38-a3c79ac24947"
}

Update Profile Details

Request

Updates the details of profile by the profileId.

Security
bearerToken
Path
profileIdstringrequired

Id of a profile.

Example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
Bodyapplication/json
legalNamestring or nullrequired

Name of the Business or Individual
Maximum length is 150 characters

Example: "Creditsafe Ltd"
tradingNamestring or null

Valid for profile type - SoleTrader
Maximum length is 150 characters

Example: null
aliasesArray of strings or null

Name of any Aliases
Maximum length of each alias is 150 characters

Example: null
activitystring or null

Activity of the Business e.g. NAIC S/SIC Codes
Valid for profile types - Trust, Company, Partnership, OtherEntity and PLC
Maximum length of activity is 150 characters

Example: "62409"
descriptionstring or null

Description of the business/individual entity
Valid for the profile types Trust, Company, Partnership, OtherEntity and PLC

Example: "Example Free Text"
contactNamestring or null

Contact person at the organisation.

Example: null
emailstring or null

Contact email address of the entity

Example: "example@creditsafe.com"
websitestring or null

Website address of the entity
Valid for the profile types Trust, Company, Partnership, OtherEntity and PLC

Example: "www.creditsafe.com"
telephonestring or null

Telephone number of the entity.
Valid for the profile types Trust, Company, Partnership, OtherEntity and PLC

Example: null
turnoverobject
assetsUnderManagementobject
organizationNumberstring or null

Property valid for profile type - Trust, Company, Partnership, OtherEntity and PLC

Example: "12345678"
internalContactstring or null

Internal contact name to contact regarding this profile,
Property valid for profile type - Trust, Company, Partnership, OtherEntity and PLC.

Example: null
internalEmailstring or null

Internal email address to contact regarding this profile.
Property valid for profile type - Trust, Company, Partnership, OtherEntity and PLC

Example: null
dateOfBirthstring or null(date)

Date YYYY-MM-DD or YYYY format. Must be after 1900 and not in the future
Valid for the profile types Individual and SoleTrader

Example: "2024-03-25"
countryCodestring or null

Two-letter country code ISO-3166-2.
Valid for the profile types Individual and SoleTrader

Example: "GB"
vatNostring or null

Tax Identification Number of the business
Valid for the profile types Company, Partnership, OtherEntity and PLC

Example: "GB12345678"
isListedOnExchangeboolean or null

Property valid for profile type PLC

Example: null
exchangeNamestring or null

Property valid for profile type PLC

Example: null
curl -i -X PUT \
  https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/profiles/9a7ae0c8-f473-4ab6-8dbb-03fc061630cc/details \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "legalName": "Creditsafe Ltd",
    "tradingName": null,
    "aliases": null,
    "activity": "62409",
    "description": "Example Free Text",
    "contactName": null,
    "email": "example@creditsafe.com",
    "website": "www.creditsafe.com",
    "telephone": null,
    "turnover": {
      "currencyCode": "eur",
      "amount": 0
    },
    "assetsUnderManagement": {
      "currencyCode": "eur",
      "amount": 0
    },
    "organizationNumber": "12345678",
    "internalContact": null,
    "internalEmail": null,
    "dateOfBirth": "2024-03-25",
    "countryCode": "GB",
    "vatNo": "GB12345678",
    "isListedOnExchange": null,
    "exchangeName": null
  }'

Responses

Bodyapplication/json
profileIdstring(uuid)

Id of the profile

legalNamestring

Name of the business/individual

tradingNamestring

Trading name of the entity

aliasesArray of strings

Alias names given for the entity

activitystring

Activity of the business e.g., NAICS/SIC codes

descriptionstring

Description of the entity

contactNamestring

Contact person name

emailstring

Contact email address

websitestring

Entity website address

telephonestring

Contact telephone number

turnoverobject
assetsUnderManagementobject
dateOfBirthstring(date)

Date of birth of the individual

countryCodestring

Two-letter country code ISO-3166-2

vatNostring

Tax Identification Number of the business

isListedOnExchangeboolean

Details of company listed on exchange

exchangeNamestring

Gets the name of the exchange.

organizationNumberstring

Gets the organisation number.

internalContactstring

Gets the internal contact.

internalEmailstring

Gets the internal email.

internationalScorestring

Gets the international score.

createdAtstring(date-time)

Profile details created time

createdByIdinteger(int32)

Id of the user who created profile

createdBystring

Name of the user who created profile

modifiedAtstring(date-time)

Profile details last updated time

modifiedByIdinteger(int32)

Id of the user who last modified the profile

modifiedBystring

Name of the user who last modified the profile

noteCountinteger(int32)

Count of notes associated with profile details

attachmentCountinteger(int32)

Count of attachment associated with profile details

Response
application/json
{
  "profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
  "legalName": "string",
  "tradingName": "string",
  "aliases": [
    "string"
  ],
  "activity": "string",
  "description": "string",
  "contactName": "string",
  "email": "string",
  "website": "string",
  "telephone": "string",
  "turnover": {
    "currencyCode": "string",
    "amount": 0.1
  },
  "assetsUnderManagement": {
    "currencyCode": "string",
    "amount": 0.1
  },
  "dateOfBirth": "2019-08-24",
  "countryCode": "string",
  "vatNo": "string",
  "isListedOnExchange": true,
  "exchangeName": "string",
  "organizationNumber": "string",
  "internalContact": "string",
  "internalEmail": "string",
  "internationalScore": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdById": 0,
  "createdBy": "string",
  "modifiedAt": "2019-08-24T14:15:22Z",
  "modifiedById": 0,
  "modifiedBy": "string",
  "noteCount": 0,
  "attachmentCount": 0
}

Creates An Address For Profile

Request

Creates an address for the given profileId. Returns the created address information.

Security
bearerToken
Path
profileIdstring(uuid)required

id of the profile

Bodyapplication/json
typestring or nullrequired

The type of the address.

Enum"registered""trading""other"
buildingDetailsstring or null

The building details of the address being created. Must have a maximum length of 250 characters.

streetstring or null

The street of the address being created. Must have a maximum length of 250 characters.

citystring or null

The city of the address being created. Must have a maximum length of 250 characters.

regionstring or null

The region of the address being created. Must have a maximum length of 250 characters.

postalCodestring or null

The postal code of the address being created. Must have a maximum length of 50 characters.

countryCodestring or null

Two-letter ISO-3166-2 country code

descriptionstring or nullrequired

The description of the address being created. Must have a maximum length of 250 characters

curl -i -X POST \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/profiles/{profileId}/details/addresses' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "registered",
    "buildingDetails": "string",
    "street": "string",
    "city": "string",
    "region": "string",
    "postalCode": "string",
    "countryCode": "string",
    "description": "string"
  }'

Responses

Created

Bodyapplication/json
idstring(uuid)

Id of the address

buildingDetailsstring or null

Building details of the address

streetstring or null

Street of the address

citystring or null

City of the address

regionstring or null

Region of the address

postalCodestring or null

Postalcode of the address

countryCodestring or null

Two-letter country code ISO-3166-2

typestring

Type of the address (registered, trading, other)

descriptionstring or null

Description of the address

createdAtstring(date-time)

Address created date time

createdByIdinteger(int32)

Id of the user who created the Address

createdBystring

Name of the user who created the Address

modifiedAtstring or null(date-time)

Address last updated date time

modifiedByIdinteger or null(int32)

Id of the user who last modified the Address

modifiedBystring or null

Name of the user who last modified the Address

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "buildingDetails": "string",
  "street": "string",
  "city": "string",
  "region": "string",
  "postalCode": "string",
  "countryCode": "string",
  "type": "string",
  "description": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdById": 0,
  "createdBy": "string",
  "modifiedAt": "2019-08-24T14:15:22Z",
  "modifiedById": 0,
  "modifiedBy": "string"
}

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