Skip to content
Connect API Catalog
/
Creditsafe Connect
/
API Documentation
/
AML Screening - Businesses
/
Update A Single Business Hit

Creditsafe Connect (1.10.9)

Introduction

This is the full Connect API and contains all available endpoints. For additional information, integration processes, and supplementary documentation, please use the targeted product

The Creditsafe Connect API 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

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
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

Search And Report Schemas/Criteria

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

Endpoints for managing decision engine instances, including retrieval, and updating.

Operations

Decision Trees

Endpoints for accessing and managing pre-configured decision trees used for automated credit decisions.

Operations

Decision Logs

Endpoints for retrieving and managing logs of past decisions.

Operations

Run Decision

Endpoints for executing decision trees to automate credit decisions.

Operations

Decision Outcome

Endpoints for retrieving the outcomes of executed decisions, including detailed results.

Operations

Audit (Legacy)

Operations

IDV (Legacy)

Operations

GB Bank Match

Operations

GB Bank Verification

Operations

GB Land Registry

Operations

GB Finance Agreements

Operations

FR Bank Match

This endpoint provides tools for matching bank information in France.

Operations

DE NonLtd Companies

This endpoint provides the tools for searching non-limited companies in Germany and acquiring company reports.

Operations

NL KVK Extract

This endpoint provides tools for extracting information from the Dutch Chamber of Commerce (KVK).

Operations

US Search Support

Operations

Verify

Verify is an exclusive add-on to Creditsafe's company credit reports, designed to assist businesses in making smarter, quicker, and more informed credit decisions. For new or small companies that lack a detailed financial footprint, Verify offers unparalleled insights by screening company directors and the individuals behind businesses for their personal financial stability and identity.

Using Verify, you can confidently assess a company's leadership, using trusted public datasets that highlight potential financial concerns, such as CCJs or Insolvencies and confirm that they reside at an address on the Electoral roll.

Operations

Create and View All Jobs

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

Operations

Individual Job Management

Manage individual Data Cleaning jobs. Including updating required mappings and enrichment processes.

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

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.

Security
bearerToken
Path
searchIdstringrequired

Id of the search

hitIdstringrequired

Id of the hit

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/searches/businesses/{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 or null

The name associated to the search hit

matchstring or null

The match string associated to the search hit

notestring or null

The note added to the search hit

countriesArray of strings or null

The countries associated to the search hit

datasetsArray of strings

The datasets associated to the search hit

profileImagesArray of strings or null

The profile images associated to the search hit

screeningNotesArray of strings or null

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 Avaialable values are undecided, trueMatch, falsePositive, discarded

identifiersArray of objects(WebApiModelsSearchesSearchResultHitsHitIdentifierResponse)

The identifiers associated to the search hit

addressesArray of objects(WebApiModelsSearchesSearchResultHitsHitAddressResponse)

The addresses associated to the search hit

contactsArray of objects(WebApiModelsSearchesSearchResultHitsHitContactResponse)

The contact details associated to the search hit

businessLinksArray of objects(WebApiModelsSearchesSearchResultHitsHitBusinessLinkResponse)

The business links associated to the search hit

individualLinksArray of objects(WebApiModelsSearchesSearchResultHitsHitIndividualLinkResponse)

The individual links associated to the search hit

sourcesArray of objects(WebApiModelsSearchesSearchResultHitsHitSourceResponse)

The sources associated to the search hit

activitiesArray of strings or null

The activities associated to the search hit

aliasesArray of objects(WebApiModelsSearchesSearchResultHitsHitBusinessAliasResponse)

The aliases associated to the search hit

amlResultsobject(WebApiModelsSearchesSearchResultHitsBusinessHitAmlResultsResponse)
descriptionstring or null

The description associated to the search hit

businessTypesArray of strings or null

The business types associated to the search hit

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": "string",
  "identifiers": [
    { … }
  ],
  "addresses": [
    { … }
  ],
  "contacts": [
    { … }
  ],
  "businessLinks": [
    { … }
  ],
  "individualLinks": [
    { … }
  ],
  "sources": [
    { … }
  ],
  "activities": [
    "string"
  ],
  "aliases": [
    { … }
  ],
  "amlResults": {
    "AM": [ … ],
    "ENF": [ … ],
    "INS": [ … ],
    "POI": [ … ],
    "SAN": { … },
    "SOE": { … }
  },
  "description": "string",
  "businessTypes": [
    "string"
  ]
}

Update A Single Business Hit

Request

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

Security
bearerToken
Path
searchIdstringrequired

Id of the search

hitIdstringrequired
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://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/searches/businesses/{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, 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.

supersededHitobject(KYCBaseBusinessSearchResultHitSummaryResponse)
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",
  "supersededHit": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "hitScore": 0,
    "name": {},
    "match": {},
    "countries": [ … ],
    "datasets": [ … ],
    "decision": "string",
    "note": {},
    "modifiedById": 0,
    "modifiedBy": {},
    "modifiedAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z"
  }
}

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.

Security
bearerToken
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://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/searches/businesses/{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 Screening - Individuals

Operations

AML Bulk Screening

Operations

AML Monitoring Management

Operations

Async AML

Operations

Global Monitoring

Operations

Reporting

Operations

Consumers

Update this description.

Operations