Connect API Catalog
/
Creditsafe Connect
/
Connect API
/
AML Screening - Individuals
/
Update A Single Individual Hit

Creditsafe Connect (1.10.9)

Metadata

KeyValue
tagsFull Connect API

Introduction

Creditsafe Connect is a REST API that provides access to the Creditsafe Global Company Database. This allows you to:

  • Control your master data
  • Utilize up-to-date Business and Director information, enhancing your onboarding and qualification processes
  • Receive alerts when your customer's and supplier's Credit Report changes

Check the status of Creditsafe Services HERE

Quick Start

To start your Creditsafe Connect API integration you will need to have activated your account and set a password by following the instructions in your Welcome Email. If you have not received a Welcome Email please contact your Creditsafe Account Manager.

By default, you will have been setup on our Sandbox environment.

Using a REST API client construct an /authenticate POST request and enter your username & password (case-sensitive) into the POST body. A successful response will return an authentication token.

Use the authentication token in an Authorization header on all other Creditsafe Connect calls as proof of your authenticity.

Download OpenAPI description
connectAPI.json
connectAPI.yaml
Languages
Servers
Mock server
https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/connect-api-full/connectapi/
Sandbox server
https://connect.sandbox.creditsafe.com/v1/
Production server
https://connect.creditsafe.com/v1/

Authentication

Endpoints for user authentication into the Connect API.

Operations

User Administration

Endpoints for user management.

Operations

Schema Structure

Endpoints to retrieve the structure of the Company and Director Search Criteria's and Reports.
The JSON schema is a blueprint of the data structure that will be returned in the response of the Company and Director Report endpoints. The schema can be used to validate the response data and understand the structure of the data returned. The schema is available for all countries and is a superset of all country's JSON schemas.

Operations

Companies

Endpoints to search for Companies in the Creditsafe Global Company Database. Companies are uniquely identified by the connectId - the identifier used to order a Company Credit Report. The Company Credit Report is a JSON object comprising of key business and financial data points such as Credit Score & Limit, Industry Code, Directors, Balance Sheet and Negative Information. A full list of Company data points can be found in the Data Matrix, in the help resources.

Operations

People/Directors

Endpoints to find People/Directors and order Director Reports. A Director Report will contain a person's registered information and Active & Previous Directorships, where available. This endpoint is not advised to get a list of directors for a specific Company. Instead, order a Company Credit Report using the /companies/{id} endpoint, and use the directors section in the response.

Operations

GB Consumers and AML

Operations

Images

Endpoints to order official Company Image/Filing Documents from

source. Company Filings such as Annual Account Statements, Annual Returns,

Liquidations and Changes of Registered Information can be downloaded as

PDFs, and are typically used as a resource in extended company

auditing/compliance.

Operations

Fresh Investigations

Endpoints to manage Fresh Investigation requests. With the need for accurate data, you can check on any company that is not available within our instant online database by placing a Fresh Investigation (Offline Order). Depending on the market, the information we obtain will vary. Using official sources and registries we are able to quickly answer questions about a company's stability and financial health. Where official information is not available we will conduct a direct interview with the business.

Operations

User Details

Operations

Create and View All Portfolios

Operations

Importing Portfolios

Operations

User Management of Portfolios

Operations

Individual Portfolio Management

Operations

Event Rules and Notifications

Operations

Instance Management

Operations

Decision Trees

Operations

Decision Logs

Operations

Run Decision

Operations

Decision Outcome

Operations

Bank Verification

Operations

Land Registry

Operations

Finance Agreements

Operations

US Search Support

Operations

FR Bank Match

Operations

Create and View All Jobs

Create a Data Cleaning job and view all jobs in the system.

Operations

Individual Job Management

Operations

Administrator Resources

Operations

Audit

Operations

Profile Management

Operations

Profile Updates

Operations

Profile Key Parties

Operations

Batch Uploads

Operations

Profile Business / Individual Details

Operations

AML Screening - Profile Management

Operations

AML Screening - Businesses

Operations

AML Screening - Individuals

Operations

Return Full AML Search Hit Information By SearchId And HitId

Request

This endpoint will return the full hit information by search Id and hitId.
Once this information is requested the information returned is stored to the database as a snap shot of that point in time.

Path
searchIdstring(uuid)required

Id of the search

hitIdstring(uuid)required

Id of the hit

curl -i -X GET \
  'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/connect-api-full/connectapi/compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstring(uuid)

The Id of the search hit

hitScoreinteger(int32)

The hit score associated to the search hit.

namestring

The name associated to the search hit.

matchstring

The match string associated to the search hit.

notestring

The note added to the search hit.

countriesArray of strings

The countries associated to the search hit.

datasetsArray of strings

The datasets associated to the search hit.

profileImagesArray of strings

The profile images associated to the search hit.

screeningNotesArray of strings

The screening notes associated to the search hit.

modifiedAtstring(date-time)

The search hit modified date and time.

modifiedByIdinteger(int32)

The search hit modified by user id.

modifiedBystring

The search hit modified by user name.

createdAtstring(date-time)

The search hit created date and time.

decisionstring

The decision made on the search hit.

Enum"undecided""trueMatch""falsePositive"
identifiersArray of objects(SearchResultHitsIdentifierResponse)

The identifiers associated to the search hit.

addressesArray of objects(SearchResultHitsAddressResponse)

The addresses associated to the search hit.

contactsArray of objects(SearchResultHitsContactResponse)

The contact details associated to the search hit.

businessLinksArray of objects(SearchResultHitsBusinessLinkResponse)

The business links associated to the search hit.

individualLinksArray of objects(SearchResultHitsIndividualLinkResponse)

The individual links associated to the search hit.

sourcesArray of objects(SearchResultHitsSourceResponse)

The sources associated to the search hit.

firstNamestring

The first name of the individual search hit.

middleNamestring

The middle name of the individual search hit.

lastNamestring

The last name of the individual search hit.

genderstring or null

The gender associated with the search hit.

Enum"male""female"
datesOfBirthArray of strings(date)

The dates of birth associated to the search hit.

isDeceasedboolean

The deceased status of the individual associated to the search hit

datesOfDeathArray of strings(date)

The dates of death associated to the search hit.

pepTierstring

The pep tier associated to the search hit.

Enum"tier1""tier2""tier3"
aliasesArray of objects(SearchResultHitsIndividualAliasResponse)

The aliases associated to the search hit.

amlResultsobject
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "hitScore": 0,
  "name": "string",
  "match": "string",
  "note": "string",
  "countries": [
    "string"
  ],
  "datasets": [
    "string"
  ],
  "profileImages": [
    "string"
  ],
  "screeningNotes": [
    "string"
  ],
  "modifiedAt": "2019-08-24T14:15:22Z",
  "modifiedById": 0,
  "modifiedBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "decision": "undecided",
  "identifiers": [
    { … }
  ],
  "addresses": [
    { … }
  ],
  "contacts": [
    { … }
  ],
  "businessLinks": [
    { … }
  ],
  "individualLinks": [
    { … }
  ],
  "sources": [
    { … }
  ],
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "gender": "male",
  "datesOfBirth": [
    "2019-08-24"
  ],
  "isDeceased": true,
  "datesOfDeath": [
    "2019-08-24"
  ],
  "pepTier": "tier1",
  "aliases": [
    { … }
  ],
  "amlResults": {
    "AM": [ … ],
    "ENF": [ … ],
    "INS": [ … ],
    "POI": [ … ],
    "SAN": { … },
    "DD": [ … ],
    "PEP": { … }
  }
}

Update A Single Individual Hit

Request

This endpoint will update a single individual AML search hit by searchId and hitId.

Path
searchIdstring(uuid)required

Id of the search

hitIdstring(uuid)required

Id of the hit

Bodyapplication/json
decisionstring

The Decision of the Hit to be updated. The Decision can only be made once.
Allowed values are undecided,trueMatch and falsePositive

notestring

Note associated with the Hit

curl -i -X PUT \
  'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/connect-api-full/connectapi/compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "decision": "string",
    "note": "string"
  }'

Responses

Success

Bodyapplication/json
idstring(uuid)

The Id of the search hit.

hitScoreinteger(int32)

The hit score associated to the search hit.

namestring

The name associated to the search hit.

matchstring

The match string associated to the search hit.

countriesArray of strings

The countries associated to the search hit.

datasetsArray of strings

The datasets associated to the search hit.

decisionstring

The decision made on the search hit. Available values are undecided, trueMatch, falsePositive and discarded.

notestring

The note added to the search hit.

modifiedByIdinteger(int32)

The search hit last modified by user id.

modifiedBystring

The search hit last modified by user name.

modifiedAtstring(date-time)

The search hit last modified date and time.

createdAtstring(date-time)

The search hit created date and time.

firstNamestring

The first name of the search hit.

middleNamestring

The middle name of the search hit.

lastNamestring

The last name of the search hit.

genderstring

The gender associated to the search hit. (male, female)

datesOfBirthArray of strings(date)

The dates of birth associated to the search hit.

pepTierstring

The pep tier associated to the search hit. (pepTier1, pepTier2, pepTier3)

profileImagesArray of strings

The profile images associated to the search hit.

supersededHitobject
correlationIdstring

A unique ID assigned to this request.

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "hitScore": 0,
  "name": "string",
  "match": "string",
  "countries": [
    "string"
  ],
  "datasets": [
    "string"
  ],
  "decision": "string",
  "note": "string",
  "modifiedById": 0,
  "modifiedBy": "string",
  "modifiedAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "gender": "string",
  "datesOfBirth": [
    "2019-08-24"
  ],
  "pepTier": "string",
  "profileImages": [
    "string"
  ],
  "supersededHit": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "hitScore": 0,
    "name": "string",
    "match": "string",
    "countries": [ … ],
    "datasets": [ … ],
    "decision": "string",
    "note": "string",
    "modifiedById": 0,
    "modifiedBy": "string",
    "modifiedAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "gender": "string",
    "datesOfBirth": [ … ],
    "pepTier": "string",
    "profileImages": [ … ]
  },
  "correlationId": "string"
}

Download AML Details for a Hit

Request

Retrieves the download URL and metadata for the AML details PDF associated with a specific hit within a business search.

Use this endpoint to obtain the PDF file containing detailed AML information for a flagged result (hitId) from a previously performed search (searchId). The response includes the download URL, file name, expiration timestamp, and identifiers for the search and hit.

Path
searchIdstring(uuid)required

The unique identifier of the search that generated the hit. This ID links the request to the specific search performed in the KYC Protect system.

hitIdstring(uuid)required

The unique identifier of the hit associated with the search. This ID is used to retrieve the specific details of a flagged result from the search.

curl -i -X GET \
  'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/connect-api-full/connectapi/compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}/download' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
downloadUrlstring

The direct URL to download the PDF file containing AML details for the specified hit.
This URL is valid only until the expiration time specified in the expiresAt field.

fileNamestring

The name of the downloaded PDF file, generated automatically based on the search and hit details.

expiresAtstring(date-time)

The expiration date and time for the download URL. After this time, the link will no longer be valid.

searchIdstring(uuid)

The unique identifier of the search that generated the hit, provided as a reference for the requested file.

hitIdstring(uuid)

The unique identifier of the hit associated with the search. This ID corresponds to the flagged result being downloaded.

Response
application/json
{
  "downloadUrl": "string",
  "fileName": "string",
  "expiresAt": "2019-08-24T14:15:22Z",
  "searchId": "9b1a67f9-9477-48e5-8a6c-11b70245e1d9",
  "hitId": "a8444036-cfe2-422f-9778-a43eef4cff86"
}

AML Bulk Screening

Operations

AML Monitoring Management

Operations

Async AML

Operations

Global Monitoring

Operations

Reporting

Operations

Consumers

Update this description.

Operations