Skip to content
Connect API Catalog/KYC (Know Your Customer)/
/Profile Updates

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

Update Profile By Profile Id

Request

Updates a single profile by profile Id.

Security
bearerToken
Path
profileIdstringrequired

Id of a profile.

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

The name of the profile to be updated.

riskRatingstring or nullrequired

Risk rating of the profile.

Enum"notApplicable""veryLow""low""medium""high""veryHigh"
Example: "notApplicable"
statusstring or nullrequired

Status of the profile.

Enum"new""approved""declined""pending""cancelled""referred""closed""approvedReviewDue"
Example: "new"
internalIdstring or null

Internal ID of the profile, this MUST be unique across your profiles.

assignedToIdobject or null(int32)

Creditsafe Id of the user to assign the profile to.
Passing null will unassign the profile.

kycReviewOnobject or null(date)

The date to which the profile should be reviewed.
Format YYYY-MM-DD
Validates when the date changes and is either current or in the future.

Example: "2021-04-20"
kycCommentsstring or null

Free text field for users to highlight key information to other users.
Maximum characters allowed is 250

curl -i -X PUT \
  https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/profiles/9a7ae0c8-f473-4ab6-8dbb-03fc061630cc \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "riskRating": "notApplicable",
    "status": "new",
    "internalId": "string",
    "assignedToId": {},
    "kycReviewOn": "2021-04-20",
    "kycComments": "string"
  }'

Responses

Bodyapplication/json
idstring(uuid)

Id of the Profile

namestring

Name of the Profile

riskRatingstring

The risk rating being assigned to the profile

Enum"notApplicable""veryLow""low""medium""high""veryHigh"
statusstring

Status of the profile (new, approved, declined, pending, cancelled, referred, closed, approvedReviewDue)

typestring

Type of the profile (trust, individual, soleTrader, company, plc, partnership, otherEntity)

internalIdstring

Internal Id of the profile.

assignedToIdinteger

Id of the user assigned to the profile

assignedTostring

Name of the user assigned to the profile

safeNumberstring

safe number of the business linked to the profile

companyIdstring

company id of the business linked to the profile

formationDatestring(date)

Formation date of the business linked to the profile

createdAtstring(date-time)

Profile created time

createdByIdinteger(int32)

Id of the user who created the profile

createdBystring

Name of the user who created the profile

modifiedAtstring(date-time)

Profile last updated time

modifiedByIdinteger(int32)

Id of the user who last modified the profile

modifiedBystring

Name of the user who last modified the profile

kycApprovedAtstring(date-time)

Date when the profile got approved

kycReviewOnstring(date)

Date when profile is to be reviewed

kycStatusUpdatedOnstring(date-time)

Date when the profile status was last updated

kycCommentsstring

Profile comments

noteCountinteger(int32)

Count of notes associated with profile

attachmentCountinteger(int32)

Count of attachments associated with profile

keyPartyCountinteger(int32)

Count of key parties associated with profile

uboCountinteger(int32)

Count of UBOs associated with profile

openAlertCountinteger(int32)

Count of Open Alerts

modeOfCreationstring

Mode of profile creation (manual, import)

importStatusstring

Status of profile creation (submitted, preprocessed, validated, queued, inProgress, processed, completed, partiallyCompleted, failed)

isLockedboolean

Value indicating whether the profile is locked

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "riskRating": "notApplicable",
  "status": "string",
  "type": "string",
  "internalId": "string",
  "assignedToId": 0,
  "assignedTo": "string",
  "safeNumber": "string",
  "companyId": "string",
  "formationDate": "2019-08-24",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdById": 0,
  "createdBy": "string",
  "modifiedAt": "2019-08-24T14:15:22Z",
  "modifiedById": 0,
  "modifiedBy": "string",
  "kycApprovedAt": "2019-08-24T14:15:22Z",
  "kycReviewOn": "2019-08-24",
  "kycStatusUpdatedOn": "2019-08-24T14:15:22Z",
  "kycComments": "string",
  "noteCount": 0,
  "attachmentCount": 0,
  "keyPartyCount": 0,
  "uboCount": 0,
  "openAlertCount": 0,
  "modeOfCreation": "string",
  "importStatus": "string",
  "isLocked": true
}

Create Profile Note

Request

Adds a note to a profile then Returns the details of the added note.

Security
bearerToken
Path
profileIdstringrequired

Id of a profile.

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

The body of the note to be added. Limited to 1000 characters

Example: "The body of the note to be added. Limited to 1000 characters"
curl -i -X POST \
  https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/profiles/9a7ae0c8-f473-4ab6-8dbb-03fc061630cc/notes \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "body": "The body of the note to be added. Limited to 1000 characters"
  }'

Responses

Bodyapplication/json
idstring(uuid)

Id of the note

Example: "c3966c5f-576e-4770-902b-eaab894b83d7"
bodystring or null

Body of the note

Example: "testing"
isArchivedboolean

Value indicating whether the note is archived

createdAtstring(date-time)

Note created time

Example: "2023-08-08T07:32:06.4989594Z"
createdByIdinteger(int32)

Id of the user who created note

Example: 101562008
createdBystring

Name of the user who created note

Example: "Amol"
modifiedAtstring(date-time)

Note last updated time

Example: "2023-08-08T07:32:06.4989594Z"
modifiedByIdinteger(int32)

Id of the user who last modified the note

Example: 101562008
modifiedBystring or null

Name of the user who last modified the note

Example: "Amol"
Response
application/json
{
  "id": "c3966c5f-576e-4770-902b-eaab894b83d7",
  "body": "testing",
  "isArchived": false,
  "createdAt": "2023-08-08T07:32:06.4989594Z",
  "createdById": 101562008,
  "createdBy": "Amol",
  "modifiedAt": "2023-08-08T07:32:06.4989594Z",
  "modifiedById": 101562008,
  "modifiedBy": "Amol",
  "correlationId": "f447fa87-d538-4ccb-9bac-43084d840a12"
}

Return Profile Notes

Request

Returns a list of profile notes for the given profile id.

Security
bearerToken
Path
profileIdstringrequired

Id of a profile.

Example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
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.

searchTermstring

Filters the note list by notes with body containing the provided string

isArchivedboolean

Get archived notes based on this flag. Allowed values are true, false or null

Default false
curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/profiles/9a7ae0c8-f473-4ab6-8dbb-03fc061630cc/notes?page=1&pageSize=0&searchTerm=string&isArchived=false' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
itemsArray of objects
totalSizenumber

The total number of notes returned for the given profileId.

correlationIdstring

A unique ID assigned to this request.

Response
application/json
{
  "items": [
    { … }
  ],
  "totalSize": 0,
  "correlationId": "string"
}

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