Company data API tech documentation

Your company data and compliance data integration starts here

Here is a live overview of the technical documentation to set up your integration

Request to be called back Check out the features
Api Documentation
API docs by Redocly

Creditsafe Connect (1.10.4)

Download OpenAPI specification:Download

Last Updated: 09th July 2024

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

Customer Feedback

Use the buttons below to let us know what you think of this documentation. Please leave comments in your feedback for the author to consider for future versions.



Selecting one of the buttons above will open a new tab to the feedback portal.

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.

Environments

Production Environment baseurl: https://connect.creditsafe.com/v1
Sandbox Test Environment baseurl: https://connect.sandbox.creditsafe.com/v1

Resources

Item Description
A Front End Demo Site Opens a friendly UI to test the Connect API
Open API Spec This will allow you to view the documentation in the swagger portal - this will be discontinued
Help Articles Opens the Help Hub with a list of common questions and answers
Data Dictionaries The connect documentation shows the general use case, the data dictionaries include the additional specific data that is returned by individual countries
Data Availability per Country The Data Matrix is a document that outlines all the fields that are available in the company report for an online territory
Creditsafe Online Country Feature Availability This matrix displays what features are available with the online Creditsafe Countries and the partner network
Connect Report Templates The document identifies the templates available for specific parts of the Company Credit Report, avoiding the need to order the full report object in one API call.
Connect API Response Codes Opens up a basic table of response codes, provides a link to a more detailed response code list

Versioning and Changes

Non-Breaking Changes

Non-breaking changes will generally include additive functions or bug fixes. It is crucial for the integration of the code to be done in such a way that it does not depend on the sequence in which items are returned. This ensures that updates can be applied seamlessly without affecting the existing functionality.

Breaking Changes

Breaking changes refer to any modifications to the API's functionality that could disrupt the current contract of the API. Such changes necessitate communication with stakeholders and will lead to a major version number update, indicating the significant nature of these changes.

Authentication

This endpoint generates a Bearer JWT (Authentication Token), which is essential for accessing all other endpoints within the API.

To authenticate your requests, you MUST include this token in the Authorization header as proof of authenticity.

Please note that each token remains valid for 1 hour from the time of issuance and multiple tokens may exist concurrently. It is imperative to obtain and include a valid token in the Authorization header for every subsequent request made to the API.

Authenticate Help - Access Denied..

Authenticate

Supply username and password to generate Authentication Token.

Rate Limiting Authenticate

Rate limiting is implemented on the authenticate endpoint to ensure fair usage and protect the service from excessive requests. Please take note of the following rate limiting rules:

  1. Invalid Request Limit:
    Up to 5 identical invalid requests are permitted within a 2-minute period. Upon reaching this limit:

    • Subsequent identical requests will receive a 429 HTTP Status (Too Many Requests).
    • After a 2-minute waiting period, the endpoint can be called again. However, if the credentials remain invalid, 401 HTTP Status (Unauthorized) responses will be issued.

  2. Overall Request Threshold:
    There is also a threshold for the total number of authentication requests within a given time-frame:

    • More than 10,000 requests to the authenticate endpoint within a 5-minute period will result in a lockout from the endpoint.
    • Note that the evaluation window for this threshold is 5 minutes. Importantly, 429 HTTP Status responses also count towards the 10,000 request limit.
    • In the event that the threshold is exceeded, you must wait a full 5 minutes before the endpoint will accept new requests again.

Request Body schema: application/json
optional
username
string

Credentials assigned upon sign up

password
string

Responses

Request samples

Content type
application/json
{
  • "username": "username@domain.com",
  • "password": "^1gHySRA56aj>tf421o"
}

Response samples

Content type
application/json
{
  • "token": "eyJhbGciOiJSUzI1NiIsImtpZCI6ImRodTNnNkFtTG5QQXVpOEJSMUFEVnp5ZHBnZyIsInR5cCI6IkpXVCIsIng1dCI6ImRodTNnNkFtTG5QQXVpOEJSMUFEVnp5ZHBnZyJ9.eyJuYmYiOjE1OTU0MTYyMDksImV4cCI6MTU5NTQxOTgwOSwiaXNzIjoiaHR0cHM6Ly9teWxvZ2luLnRlc3QuY3JlZGl0c2FmZS5jb20iLCJhdWQiOlsiaHR0cHM6Ly9teWxvZ2luLnRlc3QuY3JlZGl0c2FmZS5jb20vcmVzb3VyY2VzIiwiY29ubmVjdF9hcGkiLCJ1Ym9fYXBpX2dhdGV3YXkiXSwiY2xpZW50X2lkIjoiY29ubmVjdC5hcGkuY2xpZW50Iiwic3ViIjoiMTAxNTIwMjg1IiwiYXV0aF90aW1lIjoxNTk1NDE2MjA5LCJpZHAiOiJsb2NhbCIsInVzZXJuYW1lIjoiQ29ubmVjdHUxIiwiZW1haWwiOiJDb25uZWN0MUBnbWFpbC5jb20iLCJjdXN0b21lcklkIjoiMTAxNzY0NDA1IiwiY291bnRyeSI6IkMwIiwidXNlclJvbGUiOiJDcm1BZG1pblBsdXMiLCJzYl9jb3VudHJ5IjoiVVMiLCJzY29wZSI6WyJjb25uZWN0X2FwaSIsInVib19hcGlfZ2F0ZXdheSJdLCJhbXIiOlsicHdkIl19.p8kPAlKNB9iWEKiQbfbRXBoLQuBG7NuEDN__A8AQ55CL-gcIwkS1717Af1f9W0uifwIQ6HAZQR_x191LVkvuWD94Zw8zLzzr1ioUIhQny_zYuAS3G6EFNaTHh_mvOQ9XVi1FyuIy6YYcYcNLNZurFuITF2w5LuX4YQBjQy3rhEAdRoKcUKbtCClMFaH2dV35jiX2d7BqyhtJ8GeZyJ6yfMfdzznqxlJ4Osf5aasKUy8RYKEpjU2pkCURojoy5_oviGs8X4U9mJWcuajmPF3i5DHkqbhq1Mp0UZrDyoq_0BDStV5xqRgq6aOY8mc45kX7cwY3O2hPeGE7Ak8YtKFbA"
}

User Administration

Endpoints that allow the customer to identify individual user details.

Subscription Details

Returns the available countries in your subscription - Company Report, Director Report, Offline Reports and Monitoring.

Authorizations:
bearerToken

Responses

Response samples

Content type
application/json
{
  • "correlationId": "string",
  • "countryAccess": {
    }
}

List of Active Users

Returns a collection of user details with in the customer

Authorizations:
bearerToken

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalSize": 0
}

Logged In User Details

Returns the details of logged in user.

Authorizations:
bearerToken

Responses

Response samples

Content type
application/json
{
  • "username": "Raj",
  • "emailAddress": "connectm1@mailinator.com",
  • "owningEntity": "CSUS",
  • "defaultLanguage": "EN",
  • "primaryContact": {
    },
  • "ietfLanguage": "en-GB",
  • "countryCode": "en-GB",
  • "isActive": true,
  • "correlationId": "23921650-c073-11ea-860f-06bc8182190e"
}

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.

Company Search Criteria

Returns the set of available Company Search parameters/fields for a provided list of countries.

Authorizations:
bearerToken
query Parameters
countries
required
string

A comma separated list of ISO/Alpha 2 format country codes, or singular country Code. e.g. US,GB will return the common searchable Company fields in the United States and Great Britain.

Responses

Response samples

Content type
application/json
{
  • "correlationId": "string",
  • "countries": [
    ],
  • "languages": [
    ],
  • "criteriaSets": [
    ]
}

Company Search

Endpoint to search for Companies according to the provided Search Criteria. To get the most relevant results, it is recommended to use a unique identifier such as regNo where available. If a unique identifier is not available, use a combination of the companies registered postCode and name for the next best hit rate.

Authorizations:
bearerToken
query Parameters
countries
required
string (Creditsafe.GlobalData.CountryCode)
Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "KH" "CM" "CA" "CV" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MK" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "AN" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SK" "SI" "SB" "SO" "ZA" "GS" "ES" "LK" "SD" "SR" "SJ" "SZ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VA" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW" "XK" "SS" "SX" "CW" "BQ" "WW" "PLC"
Example: countries=GB,FR

comma-separated list of iso-2 country codes.
The code PLC can be used here to search for companies of this type across all countries.

page
integer
Default: 1

Starting page number.

pageSize
integer

Number of items to return per Page.

language
string or null = 2 characters
Default: null

Only used for Countries where more than one Company Name exists for different languages e.g. Japanese Kanji and English.
Country - Languages Available
Japan [JP] - EN & JA

id
string or null
Default: null

connectId - The primary Company identifier that is used to uniquely identify all companies across Creditsafe's Universe and Partner Network. This is returned on all Company Search Results. Use this field to use in other operations such as Ordering Company Credit Report by Id, and Adding Company to Monitoring Portfolio.

safeNo
string or null

Safe Number - Identifier for Companies in Creditsafe's Home Countries.

regNo
string or null

Local Company Identifier - The Company identifier associated with it's Domestic Filing Agency. i.e. French SIREN/SIRET, United Kingdom Companies House CRN.

vatNo
string or null

Company VAT Number

name
string or null

Company Name

tradeName
string or null

Trade Name of the Company, typically used in Countries where Name is not uniquely registered.

acronym
string or null

A (non-unique) identifier to look for Companies by their more commonly known acronym rather than their lesser known full name. Acronym is predominantly available on French Companies.

exact
boolean or null

Provide as true to find Companies matching a Name exactly.
A list of countries this is available at Here.

address
string or null
street
string or null
Default: null

Address part identifier - Street of the Company

houseNo
string or null

Address part identifier - House/Building Number of the Company

city
string or null

Address part identifier - City of the Company

postCode
string or null

Address part identifier - Postcode/Zip Code of the Company. Can be provided partially to extend to a region with a * as a wildcard. I.e. CF* can represent all postcodes starting with CF.

province
string or null

Address part identifier - Province/State of the Company

callRef
string or null
Default: null

This parameter allows users to assign a unique identifier to their API queries. By using a callRef, it facilitates easier tracking and logging within Connect. If you provide a callRef, the Connect team can later retrieve and identify the specific requests associated with that identifier, enabling detailed tracing of interactions.

officeType
string (Creditsafe.GlobalData.OfficeType)
Enum: "registered" "trading" "headOffice" "branch" "subsidiary" "franchise" "franchisor" "singleOffice" "other"
phoneNo
Array of strings or null

Provides Array of phone numbers or Null

status
string (Creditsafe.GlobalData.CompanyStatus)
Enum: "Active" "NonActive" "Pending" "Other"
type
string (Creditsafe.GlobalData.CompanyType)
Enum: "NotSet" "Ltd" "NonLtd" "NonLtdNonReg"

NonLtdNonReg is only available for countries in Norway.

website
string or null
customData
string or null

Not currently used.

Responses

Response samples

Content type
application/json
Example
{
  • "correlationId": "string",
  • "messages": [
    ],
  • "totalSize": 0,
  • "companies": [
    ]
}

Company Credit Report

Orders a Company Credit Report by connectId.

To acquire a PDF version of the report use the optional request in 'Header'.

This request will provide a 'Base64-encoded' script to convert to a PDF, this will appear at the end of the JSON response.

Authorizations:
bearerToken
path Parameters
connectId
required
string
Example: GB-0-03836192

The connectId (optionally Safe Number where available) of the Company required to order their Credit Report. Obtained from /companies search results.

query Parameters
language
string or null^[a-zA-Z]{2}$
Default: "en"

Report Language - The JSON structure of the Report is language invariant, but field content will return as the given language, where available.

template
string or null
Default: "full"

Optional parameter to request a Templated Company Report. A Template adds/reduces sections of the Credit Report depending on your subscription. Do not include this parameter if you have not been given a template to use.
Connect Report Templates

includeIndicators
boolean
Default: false

Optional parameter to include the indicator scores in to a company report -fsi = Financial Strength , pbi = Payment Behaviour Indicator, eti = Estimated Turnover, pei = Payment Expectation Indicator

Addition information on indicator acronyms can be found HERE.

Addition information on understanding indicators can be found HERE.

customData
string or null

Additional Report Parameters e.g. German Report Reason Code value is de_reason_code::1 . Use /reportcustomdata/{country} endpoint to see all values.

callRef
string or null
Default: null

This parameter allows users to assign a unique identifier to their API queries. By using a callRef, it facilitates easier tracking and logging within Connect. If you provide a callRef, the Connect team can later retrieve and identify the specific requests associated with that identifier, enabling detailed tracing of interactions.

header Parameters
Accept
string
Example: application/json+pdf

Applies request for PDF link to Company Report.

Responses

Response samples

Content type
{
  • "correlationId": "string",
  • "failedSections": [
    ],
  • "report": {
    },
  • "companyId": "string",
  • "dateOfOrder": "2019-08-24T14:15:22Z",
  • "language": "string",
  • "userId": 0
}

Confidence Match Search

Supply all company search criteria to find potential company matches ranked by a single score. - See here for more information.

Authorizations:
bearerToken
query Parameters
country
required
string
Example: country=GB

Iso-2 country code

matchThreshold
required
integer
Example: matchThreshold=905

There are 3 main score bands to use for a successful response.
- Use score 898 for a 'good' match on 'name'.
- Use score 899 for a 'good' match on 'name' and 'ok' response on an address component.
- Use scores between 900 - 999 for use on the other searches adjusting for level of 'match' response.

regNo
string or null

Local Company Identifier - The Company identifier associated with it's Domestic Filing Agency. i.e. French SIREN/SIRET, United Kingdom Companies House CRN.

vatNo
string or null

Company VAT Number

name
string or null

Company Name

street
string or null
Default: null

Address part identifier - Street of the Company

houseNo
string or null

Address part identifier - House/Building Number of the Company

city
string or null

Address part identifier - City of the Company

postCode
string or null

Address part identifier - Postcode/Zip Code of the Company.

province
string or null

Address part identifier - Province of the Company

state
string or null

Address part identifier - State of the Company

phoneNo
string or null
reference1
string
Example: reference1=free text 1

Customer supplied free text reference 1 of 3

reference2
string
Example: reference2=free text 2

Customer supplied free text reference 2 of 3

reference3
string
Example: reference3=free text 3

Customer supplied free text reference 3 of 3

callRef
string or null
Default: null

This parameter allows users to assign a unique identifier to their API queries. By using a callRef, it facilitates easier tracking and logging within Connect. If you provide a callRef, the Connect team can later retrieve and identify the specific requests associated with that identifier, enabling detailed tracing of interactions.

Responses

Response samples

Content type
application/json
Example
{
  • "totalMatches": 0,
  • "matchedCompanies": [
    ]
}

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.

Please refer to the following matrix for 'persons report' availability in each country:

Feature Availability Matrix

People/Director Search Criteria

Returns the set of available People Search parameters/fields for a provided list of countries.

Authorizations:
bearerToken
query Parameters
countries
string

A comma separated list of ISO/Alpha 2 format country codes, or singular country Code. e.g. US,GB will return the common searchable People/Director fields in the United States and Great Britain.

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ],
  • "countriesCriteria": [
    ],
  • "customData": [
    ]
}

Director Search

Endpoint to find Directors based on search criteria to order a Creditsafe Director Report.

Authorizations:
bearerToken
query Parameters
countries
required
object
Example: countries=GB,FR

comma-separated list of iso-2 country codes

page
integer
Default: 1

Starting page number.

pageSize
integer

Number of items to return per Page.

peopleId
string

Person/Director Identifier - used to order a Director Report.

firstName
string

Person's First Name.

lastName
string

Person's Last Name

localDirectorNumber
string or null

Local Identifier of the Director, the PNR in GB.

dateOfBirth
string

Person DOB - provide YYYY-MM-DD or YYYY-MM format.

callRef
string or null

This parameter allows users to assign a unique identifier to their API queries. By using a callRef, it facilitates easier tracking and logging within Connect. If you provide a callRef, the Connect team can later retrieve and identify the specific requests associated with that identifier, enabling detailed tracing of interactions.

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ],
  • "correlationId": "string",
  • "directors": [
    ],
  • "totalSize": 0
}

Director Report

Returns a report from the ID supplied to the search.

Authorizations:
bearerToken
path Parameters
peopleId
required
string^[a-zA-Z]{2}([0-9]{1,3})?[-]{1}[a-zA-Z0-9$]+$...

Identifier of the Person/Director required to order their Director Report. Obtained from /people search results.

query Parameters
language
string^[a-zA-Z]{2}$
Default: "en"

Report Language - The JSON structure of the Report is language invariant, but field content will return as the given language, where available.

callRef
string

This parameter allows users to assign a unique identifier to their API queries. By using a callRef, it facilitates easier tracking and logging within Connect. If you provide a callRef, the Connect team can later retrieve and identify the specific requests associated with that identifier, enabling detailed tracing of interactions.

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ],
  • "report": {
    }
}

GB Consumers and AML

The identity service endpoints are used to run GB Consumer and AML searches. You must specify the product type and search parameters you want to obtain a response for in the body of the request.

Submits a GB Consumer or AML Search

Submits a GB Consumer or AML depending on the Product provided. Validates criteria for each individual search before submitting, and may return a list of error strings instead.

Authorizations:
bearerToken
Request Body schema: application/json

Select the relevant tab for the request body for one of the products AML, AMLMultiBureau or Consumer.

NOTE:' If a previous address is used in addition to current the postCode becomes required.

One of
object (Connect.Identity.AmlCommonSearchCriteria)

Person search criteria

object

Contains information relevant for anti-money laundering (AML) identity verification, including contact details, banking information, and documentation status.

products
Array of strings

Enter AML for this product search

Responses

Request samples

Content type
application/json
Example
{
  • "common": {
    },
  • "IdAml": {
    },
  • "products": [
    ],
  • "uniqueId": null
}

Response samples

Content type
application/json
Example
{
  • "correlationId": "a2093b41-b7fe-4973-8eba-78f3627168a7",
  • "uniqueId": "43d27878fa4b4e74b336a6c1b21d690d",
  • "input": {
    },
  • "common": {
    },
  • "consumerResult": {
    },
  • "errors": { }
}

Resolves a picklist against a given UniqueId

Resolves a picklist belonging to the specified UniqueID, which would have been generated during a prior search. Guids (and thus cached searches) expire after fifteen minutes.

Authorizations:
bearerToken
query Parameters
resolved
Array of strings or null
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "correlationId": "string",
  • "uniqueId": "string",
  • "input": {
    },
  • "common": {
    },
  • "consumer": {
    },
  • "id": {
    },
  • "amlResult": {
    },
  • "bankMatch": {
    },
  • "picklist": [
    ],
  • "message": "string",
  • "errors": {
    }
}

Retrieves a prior identitysearch's input

This will return the input criteria used in a search for a specified id.

Authorizations:
bearerToken
path Parameters
uniqueId
required
string

Responses

Response samples

Content type
application/json
{
  • "correlationId": "string",
  • "uniqueId": "string",
  • "input": {
    },
  • "common": {
    },
  • "consumer": {
    },
  • "id": {
    },
  • "amlResult": {
    },
  • "bankMatch": {
    },
  • "picklist": [
    ],
  • "message": "string",
  • "errors": {
    }
}

Retrieves a prior identitysearch result.

Retrieves a prior search result. This will include the search input and any ID/AML searches, but as we cannot hold Consumer search results these are not included. Resubmission is necessary if an updated Consumer result is needed.

Authorizations:
bearerToken
path Parameters
uniqueId
required
string

Responses

Response samples

Content type
application/json
{
  • "correlationId": "string",
  • "uniqueId": "string",
  • "input": {
    },
  • "common": {
    },
  • "consumer": {
    },
  • "id": {
    },
  • "amlResult": {
    },
  • "bankMatch": {
    },
  • "picklist": [
    ],
  • "message": "string",
  • "errors": {
    }
}

Gets identitysearch Reasons.

Returns an object describing which Reasons for Search are available and which are selected by a given customer. All reasons are always listed, with selected reasons specified as true.

Authorizations:
bearerToken

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "string",
  • "errors": {
    }
}

Gets a list of identitysearch history items

Retrieves a paginated history list for the specified customer/user, filtered based on the include* parameters.

Authorizations:
bearerToken
query Parameters
page
integer or null <int32>

The 1-indexed page number to fetch

pageSize
integer or null <int32>

The page size number to fetch

IncludeCustomer
boolean

If true, returns all results for this customer. Valid for senior users only.

Products
Array of strings or null (Connect.Identity.Product)
Example: Products=AML

The array of products to include

Below is a list of Definitions for the ENUM

  • 0 - Consumer
  • 1 - Id
  • 2 - AML
  • 3 - Bank Match
  • 4 - AML with Bank Match
DateFrom
string or null <date-time>

The earliest date to include

DateTo
string or null <date-time>

The latest date to include

Keyword
string or null

Include this string

Result
string or null

Return only items with this result

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "data": [
    ],
  • "message": "string",
  • "errors": {
    }
}

Sets the reference for an existing history item

Allows you to set a reference for an existing history item. This is useful for storing a reference to the record in your own system.

Authorizations:
bearerToken
path Parameters
uniqueId
required
string

The ID of the record to update

Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
"string"

Revalidate a given identitysearch with additional documents

Revalidate's a given identitysearch with additional documents.

Authorizations:
bearerToken
path Parameters
uniqueId
required
string

The ID of the record to update

Request Body schema: application/json
required
uniqueId
string or null
passport
object (Connect.Identity.Passport)
driversLicense
object (Connect.Identity.DriversLicense)
electricitySupplier
object (Connect.Identity.ElectricitySupplier)
europeanIDCard
object (Connect.Identity.EuropeanIDCard)
niNumber
object (Connect.Identity.NINumber)
bankAccountDetails
object (Connect.Identity.BankAccountDetails)

Responses

Request samples

Content type
application/json
{
  • "uniqueId": "string",
  • "passport": { },
  • "driversLicense": { },
  • "electricitySupplier": { },
  • "europeanIDCard": { },
  • "niNumber": { },
  • "bankAccountDetails": { }
}

Response samples

Content type
application/json
{
  • "correlationId": "string",
  • "uniqueId": "string",
  • "input": {
    },
  • "common": {
    },
  • "consumer": {
    },
  • "id": {
    },
  • "amlResult": {
    },
  • "bankMatch": {
    },
  • "picklist": [
    ],
  • "message": "string",
  • "errors": {
    }
}

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.

Company Image Documents

Returns the available Images for a given Company connectId.

Authorizations:
bearerToken
query Parameters
page
integer
Default: 1

Starting page number.

pageSize
integer

Number of items to return per Page.

id
string

The company's connectId.

Responses

Response samples

Content type
application/json
{
  • "totalSize": 0,
  • "data": [
    ]
}

Image Document Category Types

Lists available Image Document formats, types and languages per country.

Authorizations:
bearerToken
query Parameters
countries
string

Filter Images by country.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Company Image

Endpoint to order an Image Document by Image ID.

Authorizations:
bearerToken
path Parameters
imageId
required
string

Image ID retrieved from images/companies

Responses

Response samples

Content type
application/json
{
  • "correlationID": "string",
  • "failedSections": [
    ],
  • "report": {
    },
  • "pdfReportStream": "string",
  • "companyID": "string",
  • "dateOfOrder": "2019-08-24T14:15:22Z",
  • "language": "string",
  • "userID": 0
}

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.

Create Fresh Investigation

Places an order for a Fresh Investigation (Offline Report). Providing as much detail as possible about the Company, our team will use official sources and registries to quickly answer questions about a company's stability and financial health. Fresh Investigations take 5.5 days on average to complete. By adding consent:true to the request, you are allowing Creditsafe to disclose your company details to the company you have requested the Investigation against, to be used only in the aim of improving our Investigation report.

Authorizations:
bearerToken
Request Body schema: application/json
consent
boolean

Including this allows Creditsafe to disclose your company details to the target company in the aim of improving the quality of our Investigation Report

object

Your contact information

chargeReference
string

Free text field to add your own personal reference to the order

object

Details on the company you are investigating - the target company

Responses

Request samples

Content type
application/json
{
  • "consent": true,
  • "contactInfo": {
    },
  • "chargeReference": "string",
  • "searchCriteria": {
    }
}

Response samples

Content type
application/json
{
  • "correlationId": "string",
  • "message": "string",
  • "orderID": "string",
  • "transactionID": "string"
}

Get Fresh Investigations

Returns a list of your submitted Fresh Investigation Orders.

Authorizations:
bearerToken
query Parameters
page
integer
Default: 1

Starting page number.

pageSize
integer

Number of items to return per Page.

transactionId
string

Fresh Investigation Identifier used internally and with our data partners.

reportCreatedAfter
string
Example: reportCreatedAfter=2020-01-01T11:23:56Z

Returns Fresh Investigations processed after this date

reportCreatedBefore
string
Example: reportCreatedBefore=2020-01-01T11:23:56Z

Returns ordered Fresh Investigations that were processed before this date

createdBefore
string

Returns Fresh Investigations created before this date

createdSince
string

Returns ordered Fresh Investigations created after this date

lookUpOrderBy
string
Enum: "CompanyDetails" "SearchCriteria"

Use to search for your Fresh Investigations by either the returned Company Details in the GET freshInvestigations/{orderId} endpoint or your supplied Search Criteria in the POST /freshInvestigations endpoint

companyDetailsCountry
string

Looks for your returned Fresh Investigations where the returned Company Country is named this. Use with lookUpOrderBy=CompanyDetails

companyDetailsName
string

Looks for your returned Fresh Investigations where the returned Company Name is named this. Use with lookUpOrderBy=CompanyDetails

searchCriteriaCountry
string

Looks for your returned Fresh Investigations where your submitted Search Criteria Company Country is this. Use with lookUpOrderBy=searchCriteria

searchCriteriaName
string

Looks for your Fresh Investigations where your submitted Search Criteria Company Name is this. Use with lookUpOrderBy=searchCriteria

sortBy
string
Enum: "creationDate" "lastStatusChangeDate" "orderID" "status"

Sorts returned Fresh Investigations by this field

sortDir
string
Default: "asc"
Enum: "asc" "desc"

The direction that you wish to sort results by.

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "orders": [
    ]
}

Retrieve FreshInvestigation Order

Returns a specific Fresh Investigation order.

Authorizations:
bearerToken
path Parameters
orderId
required
string
query Parameters
sections
string
Example: sections=companyIdentification,creditScore

Specify a value to return a single section, or multiple-comma separated sections of the completed Fresh Investigation. Leave null to return all sections. Available sections; - companyIdentification - creditScore - contactInformation - directors - otherInformation - groupStructure - extendedGroupStructure - financialStatements - negativeInformation - additionalInformation- directorships - localFinancialStatements - paymentData - companySummary - alternateSummary

comments
string
Default: "last"
Enum: "last" "recent" "none"

Selects number of comments which should be returned with the order details.

Responses

Response samples

Content type
application/json
{
  • "chargeReference": "string",
  • "contactDetails": {
    },
  • "creationDate": "string",
  • "lastStatusChangeDate": "string",
  • "orderID": 0,
  • "reportDate": "string",
  • "searchCriteria": {
    },
  • "sections": [
    ],
  • "status": {
    },
  • "transactionID": 0
}

Delete Fresh Investigations

Deletes specified investigations.

Authorizations:
bearerToken
path Parameters
orderId
required
string

Investigation id.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Update FreshInvestigation Report Content

Update the Fresh Investigation Report data for a specific order, after the order has a status of delivered.

Authorizations:
bearerToken
path Parameters
orderId
required
string

Fresh investigation orderId

Request Body schema: application/json
consent
boolean

Including this allows Creditsafe to disclose your company details to the target company in the aim of improving the quality of our Investigation Report

object (ConnectFreshInvInvestigationContactInfo)

Your contact information

chargeReference
string

Free text field to add your own personal reference to the order

object (ConnectFreshInvInvestigationCompanyData)

Details on the company.

object

PendingInfo property contains the information of respective sections, that someone has requested respective information to be modified.

Responses

Request samples

Content type
application/json
{
  • "consent": true,
  • "contactInfo": {
    },
  • "chargeReference": "string",
  • "searchCriteria": {
    },
  • "pendingInfo": {
    }
}

Response samples

Content type
application/json
{
  • "message": "FreshInvestigation OrderId is being updated"
}

Upload attachments for fresh investigation orderId

Returns the status of attachment upload for the particular order.

Authorizations:
bearerToken
path Parameters
orderId
required
string

Fresh investigation orderId

Request Body schema: multipart/form-data
required
importFile
string <binary>

The file which we want to attach to the fresh investigation order

description
string

Description of the file which we want to attach to the fresh investigation order

Responses

Request samples

Content type
multipart/form-data
{
  "file": "FILE_PATH"
}

Response samples

Content type
application/json
{
  • "correlationId": "string",
  • "message": "string",
  • "details": "string"
}

Get attachments for the given fresh investigation orderId

Returns attachments available for that particular order.

Authorizations:
bearerToken
path Parameters
orderId
required
string

fresh investigation orderId

Responses

Response samples

Content type
application/json
{
  • "correlationId": "string",
  • "Attachments": [
    ]
}

Get attachment for the given fresh investigation attachment Id

Retrieve attachment for the given attachmentId.

Authorizations:
bearerToken
path Parameters
orderId
required
string

fresh investigation orderId

id
required
string

fresh investigation attachment id for the given order

Responses

Response samples

Content type
application/json
{
  • "correlationId": "string",
  • "message": "string",
  • "details": "string"
}

Comments for fresh investigation orderId

Returns the status of comments for the particular order.

Authorizations:
bearerToken
path Parameters
orderId
required
string

fresh investigation orderId

Request Body schema: application/json
required
comments
string

comments for fresh investigation orderId

Responses

Request samples

Content type
application/json
{
  • "comments": "comments by user"
}

Response samples

Content type
application/json
{
  • "correlationId": "string",
  • "message": "string"
}

Retrieve comments of specified FreshInvestigation Report

Returns the Fresh Investigation Report comments for a specific order.

Authorizations:
bearerToken
path Parameters
orderId
required
string

FreshInvestigation Report Id

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "comments": [
    ]
}

Retrieve FreshInvestigation Report Content

Returns the Fresh Investigation Report data for a specific order, after the order has a status of delivered.

Authorizations:
bearerToken
path Parameters
orderId
required
string

Responses

Response samples

Content type
application/json
{
  • "correlationId": "string",
  • "failedSections": [
    ],
  • "report": {
    },
  • "companyId": "string",
  • "dateOfOrder": "2019-08-24T14:15:22Z",
  • "language": "string",
  • "userId": 0
}

Global Monitoring Introduction

Endpoints to Monitor changes to Company Information. Company changes can be retrieved by creating a Portfolio (a collection of companies) and configuring the eventRules (the criteria in which to trigger a change, e.g. company name changes, limit changes) on the portfolio. When a company in your Portfolio changes to satisfy an eventRule, a notificationEvent will be raised to inform you of the nature of the change. See here for Creditsafe's Global Monitoring capabilities.

Global Monitoring Basic Integration Guide

GM User Details

Monitoring User Details

You would use this endpoint to retrieve the user details related to the Global Monitoring product, such as the user's information.

Authorizations:
bearerToken

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GM Create and View All Portfolios

List All Portfolios

This endpoint allows you to manage portfolios. You can use the GET method to retrieve all portfolios associated with the user.

Authorizations:
bearerToken
query Parameters
searchQuery
string

Return portfolios that match the given value

page
integer
Default: 0

Starting page number inGlobal Monitoring is 0. If all items are displayed on one page this can also be left blank.

pageSize
integer

Number of items to return per Page.

Responses

Response samples

Content type
application/json
{
  • "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  • "totalCount": 1,
  • "paging": {
    },
  • "data": {
    }
}

Create Monitoring Portfolio

This endpoint to create a new Portfolio based on the supplied criteria.

A portfolio can contain any number of companies that you wish to monitor changes to. The only required Body parameter is "name" for Connect users.

Authorizations:
bearerToken
Request Body schema: application/json
required
name
required
string

The name of the portfolio

isDefault
boolean

can set the portfolio as default for company monitoring events.

Array of objects

The email address of the user to receive the email notification.

emailSubject
string

The subject of the email notification.

emailLanguage
string

The language of the email notification.

frequency
string

Responses

Request samples

Content type
application/json
{
  • "name": "Test Portfolio",
  • "isDefault": false,
  • "emails": [
    ],
  • "emailSubject": "Creditsafe Monitoring Notification on portfolio {{portfolioName}}",
  • "emailLanguage": "en",
  • "frequency": "string"
}

Response samples

Content type
application/json
{
  • "correlationId": "14cc64a0-c108-11ea-b9af-06bcc69a383e",
  • "portfolioId": 131318,
  • "name": "My New Portfolio",
  • "isDefault": false
}

GM Importing Portfolios

Import A Portfolio File

Endpoint allows you to import a list of companies to add to the selected portfolio along with some personal information for the company. Importing a portfolio will add the companies to the specified portfolio, duplicates in the import file will be ignored.You may also optionally add an email to the body of the request and get an email notification when the import is processed..

Authorizations:
bearerToken
path Parameters
portfolioId
required
number

The unique identifier of the portfolio, obtained from /portfolios.

Request Body schema: multipart/form-data
required
importcsv
string <binary>

The import file ideally needs to be a .csv file.

email
string

Option field. Provide an email and get a notification when the import has been completed with the details about the import.

Responses

Request samples

Content type
multipart/form-data
{
  "importCsv": "FILE_PATH",
  "email": "john.smith@creditsafe.com"
}

Response samples

Content type
application/json
{
  • "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  • "status": "Accepted for processing. Import Id 339523"
}

Sync A Portfolio File

Endpoint allows you to sync a portfolio file with your portfolio. Sync action will delete all companies in your specified portfolio, and then add the companies from the file into the portfolio.

Authorizations:
bearerToken
path Parameters
portfolioId
required
number

The unique identifier of the portfolio, obtained from /portfolios.

Request Body schema: multipart/form-data
required
importcsv
string <binary>

The import file ideally needs to be a .csv file.

email
string

Option field. Provide an email and get a notification when the import has been completed with the details about the import.

Responses

Request samples

Content type
multipart/form-data
{
  "importCsv": "FILE_PATH",
  "email": "john.smith@creditsafe.com"
}

Response samples

Content type
application/json
{
  • "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  • "status": "Accepted for processing. Import Id 339523"
}

GM User Management of Portfolios

Retrieve Portfolio By Id

This endpoint allows you to retrieve the portfolio details from the portfolioId.

Authorizations:
bearerToken
path Parameters
portfolioId
required
number

The unique identifier for the portfolio that you wish to retrieve, obtained from /portfolios.

Responses

Response samples

Content type
application/json
{
  • "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  • "portfolioId": 36,
  • "name": "Customers 2",
  • "isDefault": false,
  • "emailSubject": "Creditsafe Monitoring Notification on portfolio {{portfolioName}}",
  • "emails": [
    ]
}

Delete Portfolio

This endpoint allows you to delete the portfolio using the portfolioId.

Authorizations:
bearerToken
path Parameters
portfolioId
required
number

The unique identifier of the portfolio that you wish to delete, obtained from /portfolios.

Responses

Response samples

Content type
application/json
{
  • "message": "Portfolio removed and service usage will be updated shortly"
}

Update Portfolio Details

This endpoint allows you to update Portfolio details such as Name, email recipients, language and subject line.

Authorizations:
bearerToken
path Parameters
portfolioId
required
number

The unique identifier of the portfolio, obtained from /portfolios.

Request Body schema: application/json
required
name
required
string

The name of the portfolio

isDefault
boolean

Change the setting of the portfolio as default for company monitoring events.

Changing the default portfolio will automatically change the status of the previous default to 'false'.

Array of objects (Connect.Monitoring.UpdatePortfolioRequestEmail)

The email addresses of the user to receive the email notification.

emailSubject
string

The subject of the email notification.

emailLanguage
string

The language of the email notification.

frequency
string

For emails to be activated you must submit a value of '1'

Responses

Request samples

Content type
application/json
{
  • "name": "New portfolio Name",
  • "emails": [
    ],
  • "frequency": "1"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Copy Companies Between Portfolios

This endpoint allows you to copy companies from one portfolio to another. You can specify the source and destination portfolios to perform the copy operation.

Authorizations:
bearerToken
path Parameters
portfolioId
required
number

The unique identifier of the portfolio you want to copy companies from, obtained from /portfolios.

query Parameters
copyAll
boolean
Default: false

When CopyAll query parameter is False, portfolios and companies list needs to be passed. When CopyAll query parameter is True, only portfolios need to be passed and companies List must be empty. All companies are copied from current portfolio are considered here.

Request Body schema: application/json
required
portfolios
required
Array of integers

Comma separated portfolioId(s).

Array of objects (Connect.Monitoring.CopyAndMoveCompaniesBodyCompanies)

Array of companies to copy.

Responses

Request samples

Content type
application/json
{
  • "portfolios": [
    ],
  • "companies": [
    ]
}

Response samples

Content type
application/json
{
  • "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  • "data": {
    }
}

Move Companies Between Portfolios

This endpoint allows you to move companies from one portfolio to single (or) multiple portfolios. Removes the companies from the portfolio provided in the path parameter.

Authorizations:
bearerToken
path Parameters
portfolioId
required
number

The unique identifier of the portfolio you want to move companies from, obtained from /portfolios.

query Parameters
removeAll
boolean
Default: false

When RemoveAll query parameter is False, a portfolios and companies list needs to be passed. When RemoveAll query parameter is True, only portfolios need to be passed and companies List must be empty. All companies are moved and deleted from current portfolio.

Request Body schema: application/json
required
portfolios
required
Array of integers

Comma separated portfolioId(s).

Array of objects (Connect.Monitoring.CopyAndMoveCompaniesBodyCompanies)

Array of companies to copy.

Responses

Request samples

Content type
application/json
{
  • "portfolios": [
    ],
  • "companies": [
    ]
}

Response samples

Content type
application/json
{
  • "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  • "data": {
    }
}

Portfolio User Permissions

Retrieve user permissions within the customer for a portfolio.

Authorizations:
bearerToken
path Parameters
portfolioId
required
number

The unique identifier of the portfolio, obtained from /portfolios.

Responses

Response samples

Content type
application/json
{
  • "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  • "data": {
    }
}

Share Portfolio With Users

Update/Create user permissions within the customer for portfolio.

Authorizations:
bearerToken
path Parameters
portfolioId
required
number

The unique identifier of the portfolio, obtained from /portfolios.

Request Body schema: application/json
required
revokeAll
string

If set to "true", all user permissions will be revoked for the portfolio. By default set to "false".

Array of objects (Connect.Monitoring.SharePortfolioRequestBody)

Responses

Request samples

Content type
application/json
{
  • "revokeAll": "false",
  • "userPermissions": [
    ]
}

Response samples

Content type
application/json
{
  • "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  • "data": {
    }
}

GM Individual Portfolio Management

List Countries of Monitored Companies

This endpoint provides a list of distinct countries associated with the companies monitored within a specific portfolio.

Authorizations:
bearerToken
path Parameters
portfolioId
required
number

The unique identifier of the portfolio, obtained from /portfolios.

Responses

Response samples

Content type
application/json
[
  • "FR",
  • "LU",
  • "DE"
]

List Companies In A Portfolio

This endpoints gets all companies from a specific portfolio based on the portfolio id, optionally filter with query parameters.

Authorizations:
bearerToken
path Parameters
portfolioId
required
number

The unique identifier of the portfolio, obtained from /portfolios.

query Parameters
searchQuery
string

Return companies that match the given value

pageSize
integer

Number of items to return per Page.

page
integer
Default: 0

Starting page number inGlobal Monitoring is 0. If all items are displayed on one page this can also be left blank.

countryCode
string

Return <> that match the given countryCode

Responses

Response samples

Content type
application/json
{
  • "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  • "totalCount": 1,
  • "paging": {
    },
  • "data": [
    ]
}

Add Company To Portfolio

Endpoint to add a company using a company id, into a portfolio provided in as a path parameter. Additional fields can be used to add a personalReference, freeText, and personalLimit. These fields need to be submitted in the requestBody but can be 'nulled' if not required. See the two examples of the submission with and without these fields.

Authorizations:
bearerToken
path Parameters
portfolioId
required
number

The unique identifier of the portfolio, obtained from /portfolios.

Request Body schema: application/json
optional
id
required
string

The company Safe Number or Connect ID

personalReference
required
string or null

A personal reference for the company

freeText
required
string or null

A free field to add any additional text to the company in the portfolio

personalLimit
required
string or null

A personal limit for the company - separate from the credit limit

Responses

Request samples

Content type
application/json
Example
{
  • "id": "GB-0-12345678",
  • "personalReference": "",
  • "freeText": "",
  • "personalLimit": ""
}

Response samples

Content type
application/json
{
  • "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  • "message": "Company Added"
}

Clear Companies From Portfolio

This endpoint allows for companies to be deleted from the specified portfolio.

Authorizations:
bearerToken
path Parameters
portfolioId
required
number

The unique identifier of the portfolio you want to delete companies from, obtained from /portfolios.

query Parameters
clearAll
boolean
Default: false

When ClearAll query parameter is False,Companies List needs to be passed. When ClearAll query parameter is True, Companies List must be empty. All companies will be deleted

Request Body schema: application/json
required
companies
Array of strings

Responses

Request samples

Content type
application/json
{
  • "companies": [
    ]
}

Response samples

Content type
application/json
{
  • "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  • "message": "Companies deleted from portfolio"
}

Get Company Details From A Portfolio

This endpoint allows you to get various company details from a portfolio. Requires a portfolioID and companyID in the PATH of the request.

Authorizations:
bearerToken
path Parameters
portfolioId
required
number

The unique identifier of the portfolio, obtained from /portfolios.

companyId
required
string

A company Safe Number or Connect ID.

Responses

Response samples

Content type
application/json
{
  • "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  • "connectId": "US-X-US22384484",
  • "portfolioId": 589960,
  • "personalReference": "Follow up Jan 2021",
  • "freeText": null,
  • "personalLimit": 10000,
  • "safeNumber": "US22384484",
  • "name": "GOOGLE LLC",
  • "countryCode": "US",
  • "address": "VIA PABLO NERUDA, 4, TREZZANO SUL NAVIGLIO, 20090",
  • "companyStatus": 1,
  • "creditLimit": 10000,
  • "ratingCommon": "A",
  • "ratingLocal": "Not rated - insufficient information to rate",
  • "dateLastEvent": "2018-06-14T00:59:06",
  • "dateAdded": "2020-07-01T00:59:06",
  • "dateModified": "2020-07-01T00:59:06"
}

Delete Company From Portfolio

Endpoint to delete a company from a portfolio.

Authorizations:
bearerToken
path Parameters
portfolioId
required
number

The unique identifier of the portfolio, obtained from /portfolios.

companyId
required
string

A company Safe Number or Connect ID.

Responses

Response samples

Content type
application/json
{
  • "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  • "message": "Company removed"
}

Update Company Details In Portfolio

Updates the company details in a specified portfolio.

Authorizations:
bearerToken
path Parameters
portfolioId
required
number

The unique identifier of the portfolio, obtained from /portfolios.

companyId
required
string

A company Safe Number or Connect ID.

Request Body schema: application/json
personalReference
required
string

Field that can be used to add a personal reference against the company in a portfolio.

freeText
required
string

Field that can be used to add a free text note to when adding/updating a company to a portfolio.

personalLimit
required
string

Field that can be used to add a personal limit number against the company in a portfolio.

Responses

Request samples

Content type
application/json
{
  • "personalReference": "personal reference",
  • "freeText": "Some useful text",
  • "personalLimit": "40"
}

Response samples

Content type
application/json
{
  • "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  • "message": "Company updated successfully"
}

List Portfolio Event Rules

Get all notification eventRules for the given portfolioId. Notification event rules allow you to control which events you wish to monitor for the companies contained within the given portfolio.

Authorizations:
bearerToken
path Parameters
portfolioId
required
number

The unique identifier for the portfolio that you wish to retrieve notification event rules for, obtained from /portfolios.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List Portfolio Event Rules By Country

Endpoint to that lists all the eventRules, their status and parameters based on a portfolio Id, filtered by country. Newly created portfolios are without any notification event rules by default, but you can switch rules on/off per country or on a global basis. There are different rules available for each country due to the different type of change event data that's available. The following GET request lists all the available rules for a portfolio.

Authorizations:
bearerToken
path Parameters
portfolioId
required
number

The unique identifier of the portfolio, obtained from /portfolios.

countryCode
required
string = 2 characters

Country code to show events for.
Please note that there is one exception in that PLC is the only 3-character that can be accepted here.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update EventRules

Endpoint to update an eventRule in a portfolio. Must provide a portfolio unique identifier and a country code in the URL of the PUT request. The Body of the request must contain the ruleCode number of the eventRule you want to update, with an isActive parameter. Some event rules may also contain specific parameters, which can be set with param0, param1 and param2. parameters. Get the above information by calling the List All eventRules endpoint.

Important Note
It is recommended that any changes made to the Event Rules are verified using the List Portfolio Event Rules Endpoint after the PUT call has been made.

Authorizations:
bearerToken
path Parameters
portfolioId
required
number

The unique identifier of the portfolio, obtained from /portfolios.

countryCode
required
string = 2 characters

Country code to show events for

Request Body schema: application/json
required

To ensure optimal processing efficiency when updating live event rules—whether for removal, addition, or status change—it is best practice to update the entire list of rules in a single operation.

Array
ruleCode
required
integer

The unique ID of the EventRule

isActive
required
integer

Flag to show if EventRule is active or not. 0 for false, 1 for true.

string or integer
string or integer
string or integer

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "string"
}

Set Portfolio Default Rules

Update a portfolios event rules to default state. In Connect, default state means all rules are turned off.

Authorizations:
bearerToken
path Parameters
portfolioId
required
number

The unique identifier of the portfolio, obtained from /portfolios.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Portfolio Risk Summary

Get current portfolio risk summary information.

Authorizations:
bearerToken
path Parameters
portfolioId
required
number

The unique identifier of the portfolio, obtained from /portfolios.

Responses

Response samples

Content type
application/json
{
  • "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  • "totalCompanies": 66,
  • "bandACount": 20,
  • "bandApc": 40.625,
  • "bandBCount": 17,
  • "bandBpc": 26.5625,
  • "bandCCount": 14,
  • "bandCpc": 21.8775,
  • "bandDCount": 5,
  • "bandDpc": 7.8125,
  • "bandECount": 2,
  • "bandEpc": 3.125
}

List Portfolio Notifications

Get all notificationEvents based on the portfolio id, optionally filter with query parameters.

Authorizations:
bearerToken
path Parameters
portfolioId
required
number

The unique identifier of the portfolio, obtained from /portfolios.

query Parameters
searchQuery
string

Return notificationEvents that match the given value

sortBy
string
Default: "companyName"
Enum: "companyName" "countryCode" "eventId" "eventDate"

Sort results by this column. Null values of sort column are listed after non-nulls.

sortDir
string
Default: "asc"
Enum: "asc" "desc"

The direction that you wish to sort results by.

pageSize
integer

Number of items to return per Page.

page
integer
Default: 0

Starting page number inGlobal Monitoring is 0. If all items are displayed on one page this can also be left blank.

startDate
string <date-time>

The start date on which results are filtered.

endDate
string <date-time>

The end date on which results are filtered.

filterByCreatedDate
boolean
Default: false
Enum: false true

Set to true to filter the Notification Events of the "createdDate" field when using startDate and endDate parameters. By default this is set to false, with the date parameters filtering using the "eventDate" field.

Responses

Response samples

Content type
application/json
{
  • "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  • "totalCount": 36,
  • "data": [
    ],
  • "paging": {
    }
}

List Company Specific NotificationEvents

List of notification events based on the company id,optionally filtered with query parameters.

Authorizations:
bearerToken
path Parameters
portfolioId
required
string

The unique identifier of the portfolio, obtained from /portfolios.

companyId
required
string

A company Safe Number or Connect ID.

query Parameters
searchQuery
string

Return notificationEvents that match the given value

sortDir
string
Default: "asc"
Enum: "asc" "desc"

The direction that you wish to sort results by.

pageSize
integer
Default: 50

Number of items to return per Page (max 1000)

page
integer
Default: 0

Starting page number inGlobal Monitoring is 0. If all items are displayed on one page this can also be left blank.

isProcessed
boolean
Enum: true false

A flag that can be set to true boolean value to mark it as an event that has been actioned.

sortBy
string
Default: "companyName"
Enum: "companyName" "countryCode" "eventId" "eventDate"

Sort results by this column. Null values of sort column are listed after non-nulls.

Responses

Response samples

Content type
application/json
{
  • "correlationId": "string",
  • "message": "string",
  • "details": "string"
}

GM Event Rules and Notifications

List Company Events

Endpoint to return a collection of events for the given company, optionally filtered on the supplied search criteria. Event information will only be returned if the company exists in at least one of your portfolios.

Authorizations:
bearerToken
path Parameters
id
required
string

The connectId of the company that you wish to retrieve events for.

query Parameters
startDate
string <date-time>

The start date on which results are filtered.

endDate
string <date-time>

The end date on which results are filtered.

page
integer
Default: 0

Starting page number inGlobal Monitoring is 0. If all items are displayed on one page this can also be left blank.

pageSize
integer

Number of items to return per Page.

Responses

Response samples

Content type
application/json
{
  • "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  • "totalCount": 1,
  • "data": [
    ],
  • "paging": {
    }
}

All EventRules

Get all available notification event rules. Notification event rules allow you to control which events you wish to monitor for the companies contained within a given portfolio.

Authorizations:
bearerToken

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Filtered EventRules

Get all available notification event rules for the given countryCode. Notification event rules allow you to control which events you wish to monitor for the companies contained within a given portfolio.

Authorizations:
bearerToken
path Parameters
countryCode
required
string = 2 characters

ISO/Alpha 2 format country code for which notification event rules will be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

All Notification Events

Get all notification events generated for companies monitored in your portfolios, based on the notification rules enabled. The notification events returned will be filtered based upon the supplied search criteria.

Authorizations:
bearerToken
query Parameters
searchQuery
string

Return notificationEvents that match the given value

sortBy
string
Default: "companyName"
Enum: "companyName" "countryCode" "eventId" "eventDate"

Sort results by this column. Null values of sort column are listed after non-nulls.

sortDir
string
Default: "asc"
Enum: "asc" "desc"

The direction that you wish to sort results by.

startDate
string <date-time>

The start date on which results are filtered.

endDate
string <date-time>

The end date on which results are filtered.

page
integer
Default: 0

Starting page number inGlobal Monitoring is 0. If all items are displayed on one page this can also be left blank.

pageSize
integer

Number of items to return per Page.

filterByCreatedDate
boolean
Default: false
Enum: false true

Set to true to filter the Notification Events of the "createdDate" field when using startDate and endDate parameters. By default this is set to false, with the date parameters filtering using the "eventDate" field.

Responses

Response samples

Content type
application/json
{
  • "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  • "totalCount": 36,
  • "data": [
    ],
  • "paging": {
    }
}

Decision Engine Introduction

Endpoints to access pre-configured decision trees to automate credit decisions. Decision Engine can help you save time and money across your company by automating time consuming processes which drain your company's resources. This can free you and your staff to spend more time to work on achieving your business goals.

A full audit trail of previous decisions is maintained for user access and decisions in a pending state can be manually approved or declined.

Instance Management

Return All Available Instances

Returns all instances (Decision Trees) a user has permission to access.

Authorizations:
bearerToken
query Parameters
customerId
integer

The unique identifier of the customer. If used it will return all the Decision Trees associated to that customer.

userId
integer

The unique identifier of the user. If used it will return all the Decision Trees that user has access to.

Responses

Response samples

Content type
application/json
{
  • "correlationId": "string",
  • "instances": [
    ]
}

Instance Configuration

Returns instance user has permission to access.

Authorizations:
bearerToken
path Parameters
guid
required
string

Get results by guid.

Responses

Response samples

Content type
application/json
{ }

Update Instance Configuration

Update the instances information.

You will need to call the GET /decisionEngine/instance/{guid} endpoint to get the current configuration and then update the fields you want to change.

Authorizations:
bearerToken
path Parameters
guid
required
string

get results by guid.

Request Body schema: application/json
templateId
required
string

The template ID of the decision tree to be updated.

guid
required
string

The GUID to be updated.

decisionTreeName
required
string

The name of the decision tree to be updated.

customerId
integer

The customer ID to be updated.

inputParams
object

The input parameters to be updated can be obtained from the GET/instance configuration endpoint.

configurationVariables
object

The Configuration Variables to be updated can be obtained from the GET/instance configuration endpoint.

scalarVariables
object

The Scalar Variables to be updated can be obtained from the GET/instance configuration endpoint.

Responses

Request samples

Content type
application/json
{
  • "templateId": "72a7e73e799a4c3ea2a8b89bd2002829",
  • "guid": "02dce1bbb81b11ed962c01ff1787b18e",
  • "decisionTreeName": "Test US after NL test update5",
  • "customerId": 103361848,
  • "inputParams": { },
  • "configurationVariables": { },
  • "scalarVariables": { },
  • "value": {
    }
}

Response samples

Content type
application/json
{ }

Decision Trees

Decision Trees

Returns all decision trees that the user has permission to access.

Authorizations:
bearerToken
query Parameters
sortDir
string
Default: "asc"
Enum: "asc" "desc"

The direction that you wish to sort results by.

type
string
Enum: "Credit Approval" "Bespoke" "Demo"

Filter the returned decision trees by their associated decision tree type.

sortBy
string
Value: "friendlyName"

Sort results by this column.

decisionOutcome
boolean
Default: false

Fetch decision outcome in guid list endpoint.

Responses

Response samples

Content type
application/json
{
  • "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  • "GUIDList": [
    ]
}

User Data Fields

Returns the user data fields defined for the given decision tree GUID.

Authorizations:
bearerToken
path Parameters
provenirId
required
string

The unique identifier of the decision tree, obtained from /GUID.

Responses

Response samples

Content type
application/json
{
  • "decisionEngineId": "repoObj_0ed6a4aa_16e17d977e9_07ffb16e17d977e9",
  • "fields": [
    ]
}

Decision Logs

Decision History

Returns a log of all previously ran decisions that the user has permission to access, optionally filtered.

Authorizations:
bearerToken
query Parameters
provenirId
string
Example: provenirId=repoObj_0ed6a4aa_16e17d977e9_07ffb16e17d977e9

Filter the returned usage log by the GUID for the associated decision trees, obtained from /GUID.

companyId
string
Example: companyId=US001-X-US60521352

Filter the returned usage log by the Connect ID for the associated companies for each decision.

companyName
string
Example: companyName=CREDITSAFE

Filter the returned usage log by the Company Name for the associated companies for each decision.

status
number
Example: status=1

Filter the returned usage log by the status for each decision.

fromDate
string <date-time>

Filter the returned usage log by the date the the decision was run.

toDate
string <date-time>

Filter the returned usage log by the date the the decision was run.

page
integer
Default: 1

Starting page number.

pageSize
integer

Number of items to return per Page.

Responses

Response samples

Content type
application/json
{
  • "totalCount": 3108,
  • "usageLog": [
    ]
}

Get Decision Log

Returns a specified decision log for a previously ran decision.

Authorizations:
bearerToken
path Parameters
decisionLogId
required
string

The unique identifier of the decision log to retrieve, obtained from /usageLog.

Responses

Response samples

Content type
application/json
{
  • "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  • "decisionLogId": 64492,
  • "provenirId": "repoObj_0ed6a4aa_16e17d977e9_07ffb16e17d977e9",
  • "friendlyName": "Check & Decide Demo",
  • "userId": 101445010,
  • "companyId": "US001-X-US60521352",
  • "companyName": "CREDITSAFE USA INC.",
  • "response": {
    },
  • "decisionDate": "2019-08-24T14:15:22Z",
  • "originationId": "SFC-1976",
  • "status": 3,
  • "notes": "string",
  • "modifiedDate": "2019-08-24T14:15:22Z"
}

Update Decision Log

Updates the status and/or notes for a specified decision.

Authorizations:
bearerToken
path Parameters
decisionLogId
required
string

The unique identifier of the decision log to retrieve, obtained from /usageLog.

Request Body schema: application/json
statusCode
number

The status that the decision will be updated to. Typically, 1 is reserved for positive outcomes, 2 for pending status and 3 for negative outcomes.

notes
string

Free text field to allow for the saving of notes on the associated decision object.

Responses

Request samples

Content type
application/json
{
  • "statusCode": 1,
  • "notes": "Manually approved by Senior Credit Controller."
}

Response samples

Content type
application/json
{
  • "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  • "decisionLogId": 64492,
  • "provenirId": "repoObj_0ed6a4aa_16e17d977e9_07ffb16e17d977e9",
  • "friendlyName": "Check & Decide Demo",
  • "userId": 101445010,
  • "companyId": "US001-X-US60521352",
  • "companyName": "CREDITSAFE USA INC.",
  • "response": {
    },
  • "decisionDate": "2019-08-24T14:15:22Z",
  • "originationId": "SFC-1976",
  • "status": 3,
  • "notes": "string",
  • "modifiedDate": "2019-08-24T14:15:22Z"
}

Run Decision

Run Decision Tree

Runs the provided decision tree for the given company, optionally using the data provided in the body of the call.

Authorizations:
bearerToken
path Parameters
provenirId
required
string

The unique identifier of the decision tree to run, obtained from /GUID.

query Parameters
companyId
required
string
Example: companyId=GB-0-03836192

The Connect ID for the company that you wish to run the decision tree on. Obtained from /companies search results. A Connect ID is the primary Company identifier that is used to uniquely identify all companies across Creditsafe's Universe and Partner Network.

originationId
string
Example: originationId=SFC-1976

An optional field that will allow text passed through to be stored against the decision. Typically used for internal identifiers (e.g. SalesForce IDs).

Request Body schema: application/json
object

The POST body should contain the User Data Fields for the decision tree you want to run obtained via the /{guid}/userDataFields endpoint.

Responses

Request samples

Content type
application/json
{
  • "productType": "Product A",
  • "isCustomer": "Yes",
  • "salesValue": 197600
}

Response samples

Content type
application/json
{
  • "Decision": "Reject",
  • "DecisionText": "The Sales Value requested is greater than Creditsafe's recommended credit limit.",
  • "Audits": [
    ],
  • "originationId": "SFC-1976",
  • "statusCode": 3
}

Decision Outcome

Return Decision Outcome

Returns decision outcomes which is set for decision tree.

Authorizations:
bearerToken
path Parameters
guid
required
string

get results by guid.

Responses

Response samples

Content type
application/json
{
  • "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  • "includeInManualReview": true,
  • "decisionOutcomes": {
    }
}

Update Decision Outcome

This allows the user to manually update the decision outcome

Authorizations:
bearerToken
path Parameters
guid
required
string

updates decision outcomes by guid.

Request Body schema: application/json
includeInManualReview
boolean

This key is used to enable or restrict the manual review process for pending status.

Array of objects

Responses

Request samples

Content type
application/json
{
  • "includeInManualReview": true,
  • "decisionOutcomes": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Decision outcome updated successfully."
}

Protect Introduction

The focus on screening clients and third parties is increasing. International regulators are demanding that firms improve their ongoing sanctions screening process. World Compliance data through Connect allows customers to mitigate risk around Anti-Bribery and Corruption under local and international regulations such as the UK Bribery Act, by enabling users to screen their third party agents, suppliers or employees against watch lists. With World Compliance through Creditsafe Connect, compliance is easy, efficient and cost-effective, even as the regulatory mountain grows.

How to use Protect API Document

Protect Profile

Profiles can be used as an additional category to group related investigations together. For instance - You may want to investigate all Branches, Directors and Shareholders of one business, and keep them in the same Profile.

Create Protect Profile

Creates an empty profile for collating investigations.

Authorizations:
bearerToken
Request Body schema: application/json
required
name
required
string

Assign a unique name to the profile for ease of identification.

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "userId": 0,
  • "customerId": 0,
  • "name": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

List All Protect Profiles

Returns all profiles for the logged in user or filtered with a matching profile name.

Authorizations:
bearerToken
query Parameters
name
string or null
page
integer
Default: 1

Starting page number.

pageSize
integer

Number of items to return per Page.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve Protect Profile By ID

Retrieves a profile by Id in the Path.

Authorizations:
bearerToken
path Parameters
profileId
required
string <guid>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "userId": 0,
  • "customerId": 0,
  • "name": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

Edit Protect Profile

Endpoint to change the name of a profile.

Authorizations:
bearerToken
path Parameters
profileId
required
string <guid>
Request Body schema: application/json
required
name
required
string

Assign a unique name to the profile for ease of identification.

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "userId": 0,
  • "customerId": 0,
  • "name": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

List Investigations In A Profile.

Endpoint to retrieve all Investigations associated with a specific Profile.

Authorizations:
bearerToken
path Parameters
profileId
required
string <guid>
query Parameters
object (Connect.Protect.CreateInvestigationQueryDto)
page
integer
Default: 1

Starting page number.

pageSize
integer

Number of items to return per Page.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Investigation To Profile

Adds an Investigation to a Profile.

Authorizations:
bearerToken
path Parameters
profileId
required
string <guid>
investigationId
required
string <guid>

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "extensions": {
    }
}

Protect Investigations

An Investigation is the terminology used within Protect for a search.

Investigations are created against Businesses or Individuals, but you also need to decide which additional parameters you have available to base your Investigation on. This is typically a Name and an Address.

Searches are exclusively populated by Businesses and Individuals that meet a strict criteria e.g. They possess PEPs, SEOs, Sanctions.

Create Protect Investigation

Creates an Investigation according to the provided Investigation criteria. Each result is potential match which is attributed a relevancy/match score between 1-100 and a high level reason for it's inclusion in the World Compliance Database by looking at the Reason Listed and Comments to firstly ascertain whether the entry is a match for you search criteria and then utilize the data available for your own onboarding needs.

Authorizations:
bearerToken
Request Body schema: application/json
required
type
required
string
Enum: "business" "individual"

Individual relates to individuals
Business relates to businesses and organisations e.g political parties and terrorist groups.

name
string or null

The full or partial business or individual name

screeningThreshold
integer or null <int32>

Default Threshold is 85. Can only enter the following options: 85, 90, 95, 100

countryCode
string or null
firstName
string or null

Individual Only - To be used instead of ''name'' field should the user want to split out the name into first, middle, last.

middleName
string or null

Individual Only - To be used instead of ''name'' field should the user want to split out the name into first, middle, last.

lastName
string or null

Individual Only - To be used instead of ''name'' field should the user want to split out the name into first, middle, last.

dateOfBirth
string or null
gender
string or null
Enum: "male" "female"

Responses

Request samples

Content type
application/json
{
  • "type": "business",
  • "name": "string",
  • "screeningThreshold": 0,
  • "countryCode": "string",
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "dateOfBirth": "string",
  • "gender": "male"
}

Response samples

Content type
application/json
{
  • "correlationId": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": 0,
  • "searchCriteria": {
    },
  • "scheduleId": "string",
  • "profileId": "string",
  • "profileName": "string",
  • "alertsCount": 0,
  • "currentAlert": {
    },
  • "results": [
    ]
}

List All Protect Investigations

Endpoint to return all investigations. Filter response by using query parameters. Use the alertsCount parameter to only return Investigations with alerts greater than the supplied value.

Authorizations:
bearerToken
query Parameters
scheduled
boolean
alertsCount
integer or null <int32>
type
string
Enum: "business" "individual"
q
string

Keyword search: It searches in the 'name' fields of the investigation.

order
string
Enum: "asc" "desc"
orderBy
string
Enum: "alertCount" "city" "country" "createdAt" "dateOfBirth" "name" "profile" "province" "searchAt" "street"
page
integer
Default: 1

Starting page number.

pageSize
integer

Number of items to return per Page.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return Protect Investigation By Id

Endpoint to return a specific Investigation by ID. Can also be used to retrieve the associated Schedule Id that has been linked to the Investigation.

Authorizations:
bearerToken
path Parameters
investigationId
required
string <guid>

Responses

Response samples

Content type
application/json
{
  • "correlationId": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": 0,
  • "searchCriteria": {
    },
  • "scheduleId": "string",
  • "profileId": "string",
  • "profileName": "string",
  • "alertsCount": 0,
  • "currentAlert": {
    },
  • "results": [
    ]
}

Delete Investigation

Deletes an Investigation by {Id} number. This will remove the entire Investigation and all results within it.

Authorizations:
bearerToken
path Parameters
investigationId
required
string <guid>

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "extensions": {
    },
  • "property1": { },
  • "property2": { }
}

Add Investigations Records

Requires the 'Investigation Id' in path, followed by 'Record Id' in the request body to add a record to the previously created Investigation.

By adding InvestigationRecords you are confirming that the result is a match to your search criteria.

To return to the original Investigation search to allocate other records, use "GET Investigation results by ID.".

Authorizations:
bearerToken
path Parameters
investigationId
required
string <guid>
Request Body schema:
required
recordIds
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
{
  • "recordIds": [
    ]
}

Response samples

Content type
[
  • {
    }
]

Return Investigation Records

Requires the 'Investigation Id' in path.

Authorizations:
bearerToken
path Parameters
investigationId
required
string <guid>

Investigation Id

query Parameters
page
integer
Default: 1

Starting page number.

pageSize
integer

Number of items to return per Page.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Investigation Records

Sends an update to the investigation specified by the ID and changes will be reflected within that investigation.

Authorizations:
bearerToken
path Parameters
investigationId
required
string <guid>
Request Body schema:
required
Array of objects (InvestigationRecordDto)

Responses

Request samples

Content type
{
  • "records": [
    ]
}

Response samples

Content type
[
  • {
    }
]

Delete Investigation Records

Deletes a record from an Investigation ID.

Authorizations:
bearerToken
path Parameters
investigationId
required
string <guid>
Request Body schema:
required
recordIds
required
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
{
  • "recordIds": [
    ]
}

Response samples

Content type
[
  • {
    }
]

Get Investigation Results By Id

Returns original Investigation search results to assign any other results to the records.

Authorizations:
bearerToken
path Parameters
investigationId
required
string <guid>
query Parameters
page
integer <int32>
limit
integer <int32>

Responses

Response samples

Content type
{
  • "items": [
    ]
}

Assign Risk to Investigation

Allows user to update the risk with an Investigation.

Authorizations:
bearerToken
path Parameters
id
required
string <guid>
Request Body schema:
required
assignedRisk
required
string (InvestigationRisk)
Enum: "noRisk" "high" "medium" "low"

Responses

Request samples

Content type
{
  • "assignedRisk": "noRisk"
}

Response samples

Content type
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "userId": 0,
  • "customerId": 0,
  • "query": {
    },
  • "scheduleId": "string",
  • "scheduledOn": "2019-08-24T14:15:22Z",
  • "profileId": "string",
  • "profileName": "string",
  • "alertCreatedAt": "2019-08-24T14:15:22Z",
  • "alertsCount": 0,
  • "noteCount": 0,
  • "assignedRisk": "noRisk",
  • "investigationName": "string",
  • "currentAlert": {
    },
  • "status": "string"
}

Returns Investigation Report

This endpoint will Return a report by providing a file path.

Authorizations:
bearerToken
path Parameters
investigationId
required
string <guid>
Request Body schema:
required
recordIds
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
{
  • "recordIds": [
    ]
}

Response samples

Content type
No sample

Create Investigation Note

Creates a note to a specific investigation ID.

Authorizations:
bearerToken
path Parameters
id
required
string <guid>
Request Body schema:
required
subject
required
string
text
string

Responses

Request samples

Content type
{
  • "subject": "string",
  • "text": "string"
}

Response samples

Content type
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "subject": "string",
  • "text": "string",
  • "userId": 0,
  • "investigationId": "string"
}

Get Investigation Notes

Returns the notes created against a specific investigation ID.

Authorizations:
bearerToken
path Parameters
id
required
string <guid>
query Parameters
page
integer <int32>
limit
integer <int32>

Responses

Response samples

Content type
[
  • {
    }
]

Create Protect Investigation PDF

Creates a PDF that shows the full report for the selected entities. This report will include search criteria used, user, time/date stamp and full World Compliance Report. It is recommended to call this endpoint before adding InvestigationRecords to an Investigation, as only non-processed alerts populate the PDF.

Authorizations:
bearerToken
path Parameters
investigationId
required
string <guid>
Request Body schema: application/json
required
recordIds
Array of integers <int32> [ items <int32 > ]

Responses

Request samples

Content type
application/json
{
  • "recordIds": [
    ]
}

Response samples

Content type
application/json
{
  • "filePath": "string"
}

Protect Audit

Provides a log of all actions taken against endpoints to evidence any necessary that checks were carried out correctly.

Retrieve Protect Audit Log

Returns logged interactions with Protect endpoints for audit purposes. Actions logged include creating an Investigation, Investigation Record and Schedule.

Authorizations:
bearerToken
query Parameters
page
integer
Default: 1

Starting page number.

pageSize
integer

Number of items to return per Page.

type
string or null
Enum: "alert.accepted" "alert.rejected" "alert.received" "investigation.accepted" "investigation.created" "investigation.rejected" "investigation.removed" "investigation.file_downloaded" "investigation.risk_assigned" "investigation.record_removed" "investigation.note_removed" "investigation.assigned_to" "investigation.status" "idv.file_downloaded" "idv.gdc_search" "note.created" "profile.created" "profile.added" "profile.updated" "schedule.created" "schedule.recharged" "schedule.disabled" "schedule.deleted" "schedule.removed" "schedule.updated" "report.monitoring.requested" "report.monitoring.submitted" "report.monitoring.completed" "report.monitoring.failed"
newerThan
string or null <date-time>
olderThan
string or null <date-time>
profileId
string or null <guid>
order
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Export Audit Log File

Produces a collection a csv of Audit records.

Authorizations:
bearerToken
Request Body schema: application/json
required
fileType
required
string
Value: "csv"
auditType
string
Enum: "alert.accepted" "alert.rejected" "alert.received" "profile.added" "profile.created" "investigation.accepted" "investigation.created" "investigation.file_downloaded" "schedule.created" "schedule.removed"
userId
integer <int32>
keywordSearch
string
createdAtOrAfter
string <date-time>
createdAtOrBefore
string <date-time>
object (Connect.Protect.AuditExportPayloadDto)

Responses

Request samples

Content type
application/json
{
  • "fileType": "csv",
  • "auditType": "alert.accepted",
  • "userId": 0,
  • "keywordSearch": "string",
  • "createdAtOrAfter": "2019-08-24T14:15:22Z",
  • "createdAtOrBefore": "2019-08-24T14:15:22Z",
  • "payload": {
    }
}

Response samples

Content type
application/json
{}

Protect Schedules

A Schedule has a 1:1 relationship with an Investigation. Investigations that are scheduled will automatically check for new re-screen your initial search criteria on a nightly basis allowing you to review any new alerts each day.

Create Protect Schedule

Creates a Schedule to check against new sanctions that effect your chosen Investigation.
The frequency of the schedule is set to 'daily' as a default.

To receive notifications of alerts you need to follow this POST call with PUT/Update Schedules to set the 'isEmailRequired' to true.

Authorizations:
bearerToken
Request Body schema: application/json
required
screeningThreshold
required
integer <int32>

The match score you will be alerted above. Can only enter the following options: 85, 90, 95, 100

investigationId
required
string <guid>

Responses

Request samples

Content type
application/json
{
  • "investigationId": "string",
  • "screeningThreshold": 0
}

Response samples

Content type
application/json
{
  • "correlationId": "string",
  • "id": "string",
  • "customerId": 0,
  • "userId": 0,
  • "investigationId": "string",
  • "investigation": {
    },
  • "frequency": "Daily",
  • "screeningThreshold": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isEmailRequired": true,
  • "isDisabled": true
}

Updates Schedule

Endpoint will update the details around the schedule.

Authorizations:
bearerToken
path Parameters
id
required
string <guid>

Enter the schedule id.

Request Body schema:
required
frequency
required
string

Need to enter Daily.

isEmailRequired
required
boolean

Select true if you wish to recieve notifications when an alert is detected.

investigationId
required
string <guid>
screeningThreshold
required
integer <int32>

Can only enter the following options: 85, 90, 95, 100

Responses

Request samples

Content type
{
  • "investigationId": "string",
  • "frequency": "string",
  • "screeningThreshold": 0,
  • "isEmailRequired": true
}

Response samples

Content type
No sample

Retrieve Schedule By Id

Endpoint to retrieve a specific Schedule by Id. A Schedule Id can be retrieved from the associated Investigation.

Authorizations:
bearerToken
path Parameters
id
required
string

Enter the schedule id.

Responses

Response samples

Content type
application/json
{
  • "correlationId": "string",
  • "id": "string",
  • "customerId": 0,
  • "userId": 0,
  • "investigationId": "string",
  • "investigation": {
    },
  • "frequency": "Daily",
  • "screeningThreshold": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isEmailRequired": true,
  • "isDisabled": true
}

Deletes Schedule from Investigation

Deletes a Schedule from an Investigation meaning entity will no longer be monitored on a nightly basis but record will still remain in the audit trail.

Authorizations:
bearerToken
path Parameters
id
required
string

Enter the schedule id.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "extensions": {
    }
}

Protect IDV

Person identity verification by validating against other known sources.

IDV Search

Creates a search request for a GDC IDV search.

Authorizations:
bearerToken
Request Body schema:
required
address
required
string
country
required
string
dateOfBirth
required
string <date-time>
id
required
string <guid>
name
required
string
city
string
state
string
postalCode
string
acceptCulture
string

Responses

Request samples

Content type
{
  • "name": "string",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "postalCode": "string",
  • "acceptCulture": "string",
  • "id": "string"
}

Response samples

Content type
{
  • "matchRate": "fullMatch",
  • "fullName": "string",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "address": "string",
  • "country": "string",
  • "sources": [
    ],
  • "id": "string",
  • "idvSearchId": "string"
}

Returns IDV Report

Returns an IDV Report with the potential results and the sources they were matched against.

Authorizations:
bearerToken
query Parameters
idvSearchId
string <guid>

Responses

Response samples

Content type
"string"

Protect Batch Uploads

Allows for a file to be uploaded to create multiple searches.

Once the status is 'Complete' you can view all the files by calling - GET List all Protect Investigations.

Refer to the 'Selected Template' endpoint for help guide and file header templates.

Batch Upload File

Endpoint to upload a file that generates multiple searches and investigations.

Note - file needs to be structured as per the template.

Authorizations:
bearerToken
Request Body schema: multipart/form-data
File
required
string or null <binary>

Uploads a file to the server in csv format. Ensure the file follows the same format as the template.

investigationType
string
Enum: "business" "individual"

Responses

Response samples

Content type
{
  • "id": "string",
  • "userId": 0,
  • "customerId": 0,
  • "type": "business",
  • "fileName": "string",
  • "storageFileName": "string",
  • "errorFilename": "string",
  • "rowCount": 0,
  • "status": "inProgress",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

Returns Batch Uploads

Returns all the Batch Uploads created by a user.

Authorizations:
bearerToken
query Parameters
page
integer <int32>
limit
integer <int32>

Responses

Response samples

Content type
[
  • {
    }
]

Returns Batch Uploads by ID

Will return the batch upload details of a specific file id.

Authorizations:
bearerToken
path Parameters
batchUploadId
required
string <guid>

Responses

Response samples

Content type
{
  • "id": "string",
  • "userId": 0,
  • "customerId": 0,
  • "type": "business",
  • "fileName": "string",
  • "storageFileName": "string",
  • "errorFilename": "string",
  • "rowCount": 0,
  • "status": "inProgress",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

LS Introduction

A toolbox of country-specific functionality. See the description under each endpoint for more information on a particular solution.

Bank Match

Bank Match

The Bank Verification tool allows customers to instantly verify that small and medium sized companies you are working with are providing correct bank details, to reduce fraud and avoid delays in your on boarding process. The bank data for these companies is provided to Creditsafe by various financial providers, including major banks. When you provide us with a company number and their bank details, we are able to perform instant checks to verify that those bank details are associated with that company and return -
Match – We have bank information on the company, and the data provided by the customer matches the company records
No Match – We have bank information on the company, but the data provided does not match any of the company records
Data Unavailable - We do not have bank information on the company.

Authorizations:
bearerToken
query Parameters
checkType
required
any
Enum: "Both" "Validate" "Verify"

Validation uses an algorithm to determine if a SCAN or IBAN exists, but does not let you know if that SCAN or IBAN actually belongs to the company who has provided it. Verification takes this a step further and checks the Creditsafe database for a match on the SCAN/IBAN, and tells you if the bank details actually belong to the company, so you can be assured that you are sending your money to the correct entity.

companyId
required
string
Example: companyId=GB-0-X9999999

The connectId or safeNumber of the company to check against.

sortCode
string
Example: sortCode=089997

Sort Code to check - Must be passed in with Account Number to form a SCAN Result

accountNumber
string
Example: accountNumber=66374958

Account Number to check - Must be passed in with Sort Code to form a SCAN Result

iban
string
Example: iban=GB55TEST08999966374957

IBAN to check

vatNumber
string

VAT Number to check

Responses

Response samples

Content type
application/json
{
  • "totalSize": 1,
  • "bankMatchResults": [
    ]
}

Bank Verification

The Bank Verification API allows you to make a query to validate known details of an individual's or business's bank account against the banks' or building societies' databases.

Single Request

This endpoint will perform a search with the supplied data against a bank or building society.

NOTE:- This endpoint will charge when a successful request is made to a bank or building society. This endpoint will charge when a result is returned. This includes charging if the no match is found.

All property fields need to be submitted with the request, if information for a specific property is not needed, it is required to pass an empty string.

Authorizations:
bearerToken
Request Body schema: application/json
customerName
required
string

This field is for the name on the account you are matching against with the bankAccount, sortCode and secondaryReference fields

bankAccount
required
string

Must be numeric and a length of 8 characters

sortCode
required
string

Must be numeric and a length of 6 characters

accountType
required
string

field must be either Business or Personal, it can not be blank or any other value

secondaryReference
string

Should not be used unless you have been advised to use this by a bank or building society
This field will affect the results data

customerReference
string

Field is for text input and does not affect the search result
This field can be used for filtering your past results at a later date

Responses

Request samples

Content type
application/json
{
  • "customerName": "string",
  • "bankAccount": "string",
  • "sortCode": "string",
  • "accountType": "string",
  • "secondaryReference": "string",
  • "customerReference": "string"
}

Response samples

Content type
application/json
{
  • "supplierRequestData": {
    },
  • "customerReference": "string",
  • "supplierResponse": {
    },
  • "requestDatetime": "string",
  • "requestId": "string"
}

Validate Bank Verification Request

This endpoint will return whether the sort code and bank account number match the sort code and bank account number that was provided for the given single request.

Note:- A valid request requires all fields to exist in the request.

Authorizations:
bearerToken
path Parameters
id
required
string

request id to fetch details

Request Body schema: application/json
bankAccount
required
string

The bank account number you would like to check matches the bank account number you queried with the the supplier when making the request with request-id

sortCode
required
string

The sort code you would like to check matches the sort code you queried with the the supplier when making the request with request-id

Responses

Request samples

Content type
application/json
{
  • "bankAccount": "string",
  • "sortCode": "string"
}

Response samples

Content type
application/json
{
  • "isValid": true
}

Returns Request History By ID

This endpoint will return details of a past request by id.

Authorizations:
bearerToken
path Parameters
id
required
string

request id to fetch details

Responses

Response samples

Content type
application/json
{
  • "supplierRequestData": {
    },
  • "customerReference": "string",
  • "supplierResponse": {
    },
  • "requestDatetime": "string",
  • "requestId": "string"
}

Update CustomerReference by HistoryId

This endpoint will update the stored customerReference field of a past request with the provided ID.

Authorizations:
bearerToken
path Parameters
id
required
string

The id of the history record

Request Body schema: application/json
customerReference
required
string

The replacement text to overwrite the previous customerReference in the selected history Id.

Responses

Request samples

Content type
application/json
{
  • "customerReference": "string"
}

Response samples

Content type
application/json
{
  • "correlationId": "string",
  • "message": "string",
  • "details": "string"
}

Requests Search History

Bank Verification History list Request

Note:- All property fields need to be submitted with the request, if information for a specific property is not needed, it is required to pass an empty string.

Authorizations:
bearerToken
query Parameters
searchByCustomer
required
boolean

A value of false will only search records for your account. If your account manager has configured your account to be able to view other users records within your company, a value of true will search all records made by all accounts within your company.

customerName
string

Name of the customer returned by the supplier.

matchResult
string

Whether a match or not a match returned by the supplier. Values are 'Full', 'Close' and 'No Match'.

dateFrom
string

Start date for filtering the results list by.

dateTo
string

End date for filtering the results list by.

accountType
string

Type of account queried with the the supplier. Values are 'Business' and 'Personal'.

customerReference
string

Your Customer reference.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Land Registry

GB Land Registry

Allows users to return Land Registry details of a company.

Authorizations:
bearerToken
path Parameters
companyId
required
string

A company Safe Number or Connect ID.

query Parameters
language
string^[a-zA-Z]{2}$
Default: "en"

language the report is requested in.

page
integer
Default: 1

Starting page number.

pageSize
integer

Number of items to return per Page.

Responses

Response samples

Content type
application/json
{
  • "totalSize": 64293,
  • "data": [
    ]
}

Finance Agreements

Finance Agreements

This tool provides a detailed view of data supplied via the CCDS scheme(Commercial Credit Data Sharing ). It's tailored for users needing immediate access to current and accurate financial agreement information, enhancing decision-making with up-to-date data insights.

1. Full CCDS Access - Gain in-depth insights with access to up to 48 months of historical data on current accounts, loans, and credit card facilities. This tool is perfect for comprehensive long-term financial analysis, offering a thorough understanding of credit history and trends.

2. Financial Footprint - Get a summarized view of non performance related credit activity data. This tool simplifies the complex data into an easily understandable summary, ideal for quick assessments and initial screenings.

3. Finance Performance Indicator - A predictive tool that evaluates the likelihood of a company defaulting on payments within the next 90 days. This tool is crucial for risk assessment and mitigation, offering foresight and preparation for potential financial challenges.

Authorizations:
bearerToken
path Parameters
companyId
required
string
Example: GB-0-X9999999

The connectId or safeNumber of the company

Responses

Response samples

Content type
application/json
Example
{
  • "correlationId": "string",
  • "safeNumber": "UK08368892",
  • "creditSafe": {
    },
  • "overallAggregations": {
    },
  • "history": [
    ],
  • "footprintData": {
    },
  • "indicatorData": {
    }
}

US Search Support

US Fresh Investigation Request

Places an order for a Fresh Investigation (Offline Report). Providing as much detail as possible about the Company, our team will use official sources and registries to quickly answer questions about a company's stability and financial health. Fresh Investigations take 5.5 days on average to complete. By adding consent:true to the request, you are allowing Creditsafe to disclose your company details to the company you have requested the Investigation against, to be used only in the aim of improving our Investigation report.

Authorizations:
bearerToken
query Parameters
operationType
string
Value: "searchSupport"
Example: operationType=searchSupport

type of check

Request Body schema:
attachment
string

Base64 encoded string of any relevant document or file that supports the investigation request.

object

Contains all necessary details about the investigation, focusing on both the customer submitting the request and the target subject.

Responses

Request samples

Content type
No sample

Response samples

Content type
application/json
{
  • "freshInvestigationRequestResult": {
    }
}

FR Bank Match

Bank Match

This endpoint can be used to check the reliability of a company/bank details combination, and ensure that the IBAN is not linked to a risk of fraud.

NOTE - There are a set of 'required' parameters for this endpoint, however please note the exceptions in the countryCode description.

Authorizations:
bearerToken
query Parameters
registrationId
required
string

registrationId of company

countryCode
required
string

Country codes in iso-2 format

The following counties do NOT support the iban parameter -
AU, CA,CN, HK, IN,JP,KR,MX, MY, SG, US, ZA

Please see the following link for required parameters on these countries:
Unsupported Country parameter requirements

iban
required
string

Bank Account details in IBAN format

bban
string

Bank Account Number for countries where IBAN format doesn't support

bic
string

Business/Bank Identifier Code to identify the bank/branch holding the account along with BBAN

routingCode
string

Routing Code to identify the bank/branch holding the account along with BBAN

Responses

Response samples

Content type
application/json
{
  • "@domain": "string",
  • "createdBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": "string",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "score": 0,
  • "classification": "string",
  • "status": "string",
  • "entity": {
    },
  • "issuerCompany": {
    },
  • "input": {
    },
  • "withDeferredResult": true,
  • "byAPI": true,
  • "byFTP": true,
  • "workflow": "string",
  • "reasons": [
    ],
  • "reasonLabels": {
    }
}

Bank Match Status

This endpoint is used to check the status of a verification whose status is ‘pending’.

Authorizations:
bearerToken
query Parameters
audition_id
required
string

identifier to check status

Responses

Response samples

Content type
application/json
{
  • "@domain": "string",
  • "createdBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": "string",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "score": 0,
  • "classification": "string",
  • "status": "string",
  • "entity": {
    },
  • "issuerCompany": {
    },
  • "input": {
    },
  • "withDeferredResult": true,
  • "byAPI": true,
  • "byFTP": true,
  • "workflow": "string",
  • "reasons": [
    ],
  • "reasonLabels": {
    }
}

NL KVK

Return NL Extract

NL extract from KVK Number

Authorizations:
bearerToken
path Parameters
kvkNumber
required
string

kvkNumber to fetch details

Responses

Response samples

Content type
application/json
{
  • "correlationId": "string",
  • "message": "string",
  • "details": "string"
}

DC Introduction

A suite of endpoints to allow you to upload, map, match and then append Creditsafe company data to your own master data. Maintaining the quality of company data is of greatest importance to ensure efficiency and maximisation of opportunity.

DC Create and View All Jobs

Create Job Request

Enter a name for the 'Job Request' to be associated to the file going to be processed.

Authorizations:
bearerToken
Request Body schema: application:json
required
name
required
string

The name associated to the Data Cleaning job created by the user in the 'POST - Create Job Request'

Responses

Request samples

Content type
application:json
{
  • "name": "Create a Data Cleaning Job 03-10-20xx"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAT": "2019-08-24T14:15:22Z",
  • "managingUserId": 0,
  • "managingCustomerId": 0,
  • "owningCustomerId": 0,
  • "owningUserId": 0,
  • "status": "created",
  • "countryCode": "string",
  • "portfolioId": "string",
  • "source": "dataCleaning",
  • "jobSummary": {
    },
  • "jobEnrichmentSettings": {
    },
  • "archived": true
}

Returns all Data Cleaning Jobs

This endpoint can be used to retrieve all created data cleaning job requests as defined by the query parameters.

Authorizations:
bearerToken
query Parameters
countries
string

Comma separated list of ISO/Alpha-2 country codes to filter the results by.

status
string

Returns the individual jobs by status. Possible values are: pending, processing, completed, failed.

jobName
string

Returns the individual jobs by name.

fromDate
integer <date-time>

Returns the individual jobs created after the specified date.

customerId
integer

Returns the individual jobs by customer id.

toDate
integer <date-time>

Returns the individual jobs created before the specified date.

userId
integer

Returns the individual jobs by user id.

pageSize
integer

Returns the number of individual jobs per page.

companyName
string

Returns the individual jobs by company name.

page
integer

Returns the page number of the individual jobs.

archived
boolean

Returns the individual jobs by archived status.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

DC Individual Job Management

Returns Job by {id} number

Returns Job by {id} number which is generated from 'Creating Job Request' stage. This endpoint is used to check the status of the job.

Authorizations:
bearerToken
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAT": "2019-08-24T14:15:22Z",
  • "managingUserId": 0,
  • "managingCustomerId": 0,
  • "owningCustomerId": 0,
  • "owningUserId": 0,
  • "status": "created",
  • "countryCode": "string",
  • "portfolioId": "string",
  • "source": "dataCleaning",
  • "jobSummary": {
    },
  • "jobEnrichmentSettings": {
    },
  • "archived": true
}

Upload a Job File with an {id}

Upload a Job File for processing, you need to link to the {id} number generated from the 'Job Request'.

Authorizations:
bearerToken
path Parameters
id
required
string

The {id} number generated from the 'Job Request'.

Request Body schema: multipart/form-data
hasHeader
required
boolean

Indicates if the file has a header row

jobFile
required
string <binary>

The file to be uploaded

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "sourceFilename": "string",
  • "hasHeader": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "managingUserId": 0,
  • "managingCustomerId": 0,
  • "status": "string",
  • "active": true
}

Update Mappings Request

Update the mapping of the uploaded file to match that of the header within it. You can add or remove the required number of mapping points in the Request Body.

Authorizations:
bearerToken
path Parameters
id
required
string
Request Body schema: application/json
required
required
Array of objects (JobMappingDto)

Responses

Request samples

Content type
application/json
{
  • "mappings": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Submit Job Request

Submission of the file after mappings have been carried out. To have a successful submission a blank response body (See example) is required to be posted.

Authorizations:
bearerToken
path Parameters
id
required
string
Request Body schema: application/json
required
object (ConnectDataCleaningSubmitJobRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "messageId": "string"
}

Update Enrichments Request

Detail which package of enrichment settings are to be applied to the uploaded file.

Select one of the three creditTypes to acquire the JSON Enrichment tag schema possible for that product.

Removal of Enrichment tags is possible from each creditType. Addition of Enrichment tags to a creditType is not possible beyond the maximum schema for each.

Authorizations:
bearerToken
path Parameters
id
required
string
Request Body schema: application/json
required
One of
Array of objects

Responses

Request samples

Content type
application/json
Example
{
  • "enrichments": [
    ]
}

Response samples

Content type
application/json
{
  • "enrichments": [
    ]
}

Start Enrichment Request

Commencing the Job enrichment to the uploaded file after mapping the enrichment requirements. To have a successful submission a blank response body (See example) is required to be posted.

POST 'enrich' will not commence unless the Job Status is jobMatchingComplete.

Use the GET/dataCleaning/jobs/{id} to check Status of job.

Authorizations:
bearerToken
path Parameters
id
required
string
Request Body schema: application/json
required
object (ConnectDataCleaningEnrichRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • { }
]

Returns Enriched Job File

Returns the enriched file after enrichment is complete. Identify the file type to be returned via the query parameter.

Authorizations:
bearerToken
path Parameters
id
required
string
query Parameters
fileType
string
Example: fileType=csv

Responses

Response samples

Content type
application/json
{
  • "correlationId": "string",
  • "filePath": "string"
}

Archive Job by id

Archives the job, this can be done at any stage. To have a successful submission a blank response body (See example) is required to be posted.

Authorizations:
bearerToken
path Parameters
id
required
string
Request Body schema: application/json
required
object (ConnectDataCleaningArchiveJobRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "createdAt": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "managingUserId": 0,
  • "managingCustomerId": 0,
  • "owningCustomerId": 0,
  • "owningUserId": 0,
  • "status": "string",
  • "countryCode": "string",
  • "source": "string",
  • "jobEnrichmentSettings": {
    },
  • "archived": true
}

KYC Introduction

KYC (Know Your Customer) Protect 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.

KYC Administrator Resources

Return Profile Types

Returns all the profile Types

Authorizations:
bearerToken

Responses

Response samples

Content type
application/json
[
  • "trust"
]

Returns Accepted Currency Codes

Returns the list of accepted currency codes.

Authorizations:
bearerToken

Responses

Response samples

Content type
application/json
[
  • "eur"
]

Return Accepted Country Codes

Returns the list of accepted country-codes.

Authorizations:
bearerToken

Responses

Response samples

Content type
application/json
[
  • "GB"
]

Return Profile Document Types

Returns a list of document types valid for the provided profile type.

Authorizations:
bearerToken
query Parameters
type
required
string
Enum: "trust" "individual" "soleTrader" "company" "plc" "partnership" "otherEntity"

The type of the profile the user wants to return.

Responses

Response samples

Content type
application/json
[
  • "string"
]

KYC Audit

Return Audit Trail

Returns a list of audits which can be filtered by various categories.

Authorizations:
bearerToken
query Parameters
profileIds
Array of strings

Select the profileId's for the filter.

categories
Array of strings
Items Enum: "profile" "amlSearch"

Available categories for the filter.

subcategories
Array of strings
Items Enum: "profileDetails" "keyParty" "amlMonitoring"

Available subcategories for the filter.

actions
Array of strings
Items Enum: "created" "updated" "deleted" "searchRemoved" "searchLinked" "attachmentCreated" "attachmentUpdated" "attachmentDeleted" "noteCreated" "noteUpdated" "noteDeleted" "noteArchived" "noteUnarchived" "addressCreated" "addressUpdated" "addressDeleted" "kycStatusUpdated" "addedToAmlMonitoring" "updatedInAmlMonitoring" "removedFromAmlMonitoring"

Available actions for the filter.

userIds
Array of integers

User Ids for the filter.

startDate
string <date>

Start date for the filter.

endDate
string <date>

End date for the filter.

page
integer
Default: 1

Starting page number.

pageSize
integer <int32>
Default: 10

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalSize": 0,
  • "correlationId": "string"
}

KYC Profile Management

Create Profile

Uses the name and type provided by the user to create a profile.

Authorizations:
bearerToken
Request Body schema: application/json
name
required
string

The name of the profile being created.
This MUST be unique across your profiles.

type
required
string
Enum: "trust" "individual" "soleTrader" "company" "plc" "partnership" "otherEntity"

The profile type to be created. This will effect searches later for validations.
i.e. Not being able to apply certain datasets (Example - State Owned Enterprises) to an Individual profile. Ensure the correct type is applied for intended search.

internalId
string

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

assignedToId
integer

Creditsafe Id of the user to assign the profile to.

kycReviewOn
string

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.

status
string
Enum: "new" "approved" "declined" "pending" "cancelled" "referred" "closed" "approvedReviewDue"

Status of the profile.

riskRating
string
Enum: "notApplicable" "veryLow" "low" "medium" "high" "veryHigh"

Risk rating of the profile.

kycComments
string

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

object

Please note the required property in this object.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "trust",
  • "internalId": "string",
  • "assignedToId": 0,
  • "kycReviewOn": "string",
  • "status": "new",
  • "riskRating": "notApplicable",
  • "kycComments": "string",
  • "details": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "riskRating": "string",
  • "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,
  • "details": {
    }
}

Return Created Profiles

Returns a list of profiles ordered by modified date.

Authorizations:
bearerToken
query Parameters
page
integer
Default: 1

Starting page number.

pageSize
integer <int32>
Default: 10

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

searchTerm
string

A search term to filter by. The search term will be matched against names, and internal ids containing the search term.

assignees
integer <int32>

The ids of assigned users to filter by.

kycReviewAfter
string <date>

Filters results based on profiles with a kyc review date after this date.

kycReviewBefore
string <date>

Filters results based on profiles with a kyc review date after this date.

riskRatings
Array of strings

The risk ratings to filter by. Available values: notApplicable, veryLow, low, medium, high, veryHigh

sortOrder
string

The order in which the items should be sorted. Available values: asc, desc

sortBy
string

The field by which the items should be sorted. Available values: modifiedAt, name

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalSize": 0,
  • "correlationId": "string"
}

Delete All Profiles

Deletes list of profiles.
This will delete all its dependencies/child items associated to that profileId.

Authorizations:
bearerToken
Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "fd91185f-c10e-4a42-b0b4-cc367371ebdb"
]

Response samples

Content type
application/json
true

Return Profile By Profile Id

Returns a single profile by id.

Authorizations:
bearerToken
path Parameters
profileId
required
string
Example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc

Id of a profile.

Responses

Response samples

Content type
application/json
{
  • "id": "fd91185f-c10e-4a42-b0b4-cc367371ebdb",
  • "name": "tej",
  • "riskRating": "notApplicable",
  • "status": "new",
  • "type": "trust",
  • "internalId": null,
  • "customerId": 103077765,
  • "assignedToId": 101562008,
  • "assignedTo": "Amol",
  • "safeNumber": null,
  • "formationDate": null,
  • "createdAt": "2023-07-25T09:32:40.428637Z",
  • "createdById": 101562008,
  • "createdBy": "Amol",
  • "modifiedAt": "2023-07-25T14:50:50.170613Z",
  • "modifiedById": 101562008,
  • "modifiedBy": "Amol",
  • "kycApprovedAt": null,
  • "kycReviewOn": null,
  • "kycStatusUpdatedOn": "2023-07-25T09:32:40.428637Z",
  • "kycComments": null,
  • "noteCount": 0,
  • "attachmentCount": 0,
  • "keyPartyCount": 0,
  • "uboCount": 0,
  • "openAlertCount": 0
}

Delete Profile By Profile Id

Deletes a single profile by id.

Authorizations:
bearerToken
path Parameters
profileId
required
string
Example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc

Id of a profile.

Responses

Response samples

Content type
application/json
{
  • "correlationId": "string",
  • "message": "string",
  • "details": "string"
}

Assign Profile To User

Assign a profile to a user

Authorizations:
bearerToken
query Parameters
profileId
required
string

Id of the profile being assigned to a user

userId
string

User Id to assign the Profile to

Responses

Response samples

Content type
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
}

Assigns A List Of Profiles To User

Assigns list of profiles to a user.

Authorizations:
bearerToken
Request Body schema: application/json
profileIds
required
Array of strings <uuid> [ items <uuid > ]

List of profiles to assign a user

userId
integer <int32>

Id of the User to assign the Profiles. Passing null will unassign the profile

Responses

Request samples

Content type
application/json
{
  • "userId": 0,
  • "profileIds": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

KYC Profile Updates

Update Profile By Profile Id

Updates a single profile by profile Id.

Authorizations:
bearerToken
path Parameters
profileId
required
string
Example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc

Id of a profile.

Request Body schema: application/json
name
required
string

The name of the profile to be updated.

riskRating
required
string
Enum: "notApplicable" "veryLow" "low" "medium" "high" "veryHigh"

Risk rating of the profile.

status
required
string
Enum: "new" "approved" "declined" "pending" "cancelled" "referred" "closed" "approvedReviewDue"

Status of the profile.

internalId
string

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

assignedToId
object <int32>

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

kycReviewOn
object <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.

kycComments
string

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

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "riskRating": "notApplicable",
  • "status": "new",
  • "internalId": "string",
  • "assignedToId": { },
  • "kycReviewOn": "2021-04-20",
  • "kycComments": "string"
}

Response samples

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

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

Authorizations:
bearerToken
path Parameters
profileId
required
string
Example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc

Id of a profile.

Request Body schema: application/json
body
string or null

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

Responses

Request samples

Content type
application/json
{
  • "body": "The body of the note to be added. Limited to 1000 characters"
}

Response samples

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

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

Authorizations:
bearerToken
path Parameters
profileId
required
string
Example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc

Id of a profile.

query Parameters
page
integer
Default: 1

Starting page number.

pageSize
integer <int32>
Default: 10

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

searchTerm
string

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

isArchived
boolean or null

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

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalSize": 0,
  • "correlationId": "string"
}

Return Profile Notes By Note Id

Returns a profile note based on profile id and note id.

Authorizations:
bearerToken
path Parameters
profileId
required
string
Example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc

Id of a profile.

noteId
required
string
Example: 047ae398-7639-40af-911e-cc214cf3045c

Id of a note.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "body": "string",
  • "isArchived": true,
  • "createdAt": "string",
  • "createdById": 0,
  • "createdBy": "string",
  • "modifiedAt": "string",
  • "modifiedById": 0,
  • "modifiedBy": "string",
  • "linkedTo": "string",
  • "correlationId": "string"
}

Update Profile Note By Note Id

Updates a profile note based on profile id and note id.

Authorizations:
bearerToken
path Parameters
profileId
required
string
Example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc

Id of a profile.

noteId
required
string
Example: 047ae398-7639-40af-911e-cc214cf3045c

Id of a note.

Request Body schema: application/json
body
string or null

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

isArchived
boolean

Responses

Request samples

Content type
application/json
{
  • "body": "testing",
  • "isArchived": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "body": "string",
  • "isArchived": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdById": 0,
  • "createdBy": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedById": 0,
  • "modifiedBy": "string"
}

Deletes Profile Note By Note Id

Deletes a profile note based on profile id and note id.

Authorizations:
bearerToken
path Parameters
profileId
required
string
Example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc

Id of a profile.

noteId
required
string
Example: 047ae398-7639-40af-911e-cc214cf3045c

Id of a note.

Responses

Response samples

Content type
application/json
{
  • "correlationId": "string",
  • "message": "string",
  • "details": "string"
}

Add An Attachment To The Given Profile

Adds an attachment to a profile. Returns the details of the added attachment.

Authorizations:
bearerToken
path Parameters
profileId
required
string <uuid>

id of the profile

Request Body schema: multipart/form-data
File
string <binary>

The attachment to be added. Size Limited to 50MB.

DocumentType
string

The document type of the attachment

Description
string

The description of the attachment. Limited to 250 characters.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "fileName": "string",
  • "fileSizeInBytes": 0,
  • "documentType": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdById": 0,
  • "createdBy": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedById": 0,
  • "modifiedBy": "string"
}

Return List Of Attachments On The Given Profile

Gets a list of attachments on the given profile ordered by modified date.

Authorizations:
bearerToken
path Parameters
profileId
required
string <uuid>

id of the profile

query Parameters
page
integer <int32>

The page number to fetch. Should be a positive integer.

pageSize
integer <int32>
Default: 10

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

Responses

Response samples

Content type
application/json
{
  • "totalSize": 0,
  • "items": [
    ]
}

Return A Profile Attachment By Profile And Attachment Id

Returns an attachment by the provided attachment Id and profile Id.

Authorizations:
bearerToken
path Parameters
profileId
required
string <uuid>
Example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc

Id of a profile.

attachmentId
required
string <uuid>
Example: 24faad02-7e20-4912-bdd9-51e4797380c5

Id of an attachment.

Responses

Response samples

Content type
application/json
{
  • "id": "24faad02-7e20-4912-bdd9-51e4797380c5",
  • "fileName": "NL-X-170661060000.pdf",
  • "fileSizeInBytes": 424860,
  • "documentType": "financials",
  • "description": "test1",
  • "createdAt": "2023-08-07T07:30:03.186352Z",
  • "createdById": 101562008,
  • "createdBy": "Amol",
  • "modifiedAt": "2023-08-07T07:30:25.630464Z",
  • "modifiedById": 101562008,
  • "modifiedBy": "Amol",
  • "correlationId": "23b5a4a7-148f-4b82-8631-eab69bbe0a67"
}

Update Profile Attachment By Profile And Attachment Id

Updates A Profile Attachment By Profile And Attachment Id

Authorizations:
bearerToken
path Parameters
profileId
required
string <uuid>
Example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc

Id of a profile.

attachmentId
required
string <uuid>
Example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc

Id of a attachmentId.

Request Body schema: multipart/form-data
documentType
string

The document type of the attachment

description
string

The description of the attachment. Limited to 250 characters.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "fileName": "string",
  • "fileSizeInBytes": 0,
  • "documentType": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdById": 0,
  • "createdBy": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedById": 0,
  • "modifiedBy": "string"
}

Delete Attachment By Profile And Attachment Id

Deletes A Profile Attachment By Profile And Attachment Id

Authorizations:
bearerToken
path Parameters
profileId
required
string <uuid>
Example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc

Id of a profile.

attachmentId
required
string <uuid>
Example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc

Id of a attachmentId.

Responses

Response samples

Content type
application/json
{
  • "correlationId": "string",
  • "message": "string",
  • "details": "string"
}

Download Profile Attachment By Profile And Attachment Id

Gets profile attachment's download link.

Authorizations:
bearerToken
path Parameters
profileId
required
string <uuid>
Example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc

Id of a profile.

attachmentId
required
string <uuid>
Example: 24faad02-7e20-4912-bdd9-51e4797380c5

Id of a note.

Responses

Response samples

Content type
application/json
{}

KYC Profile Key Parties

Creates A Key Party Folder Linked To The Profile Id

Uses the details provided by the user to create key parties. Returns the created key parties information.

Authorizations:
bearerToken
path Parameters
profileId
required
string <uuid>

id of the profile

Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "failed": [
    ],
  • "successful": [
    ]
}

Return All Key Party Records Linked To A Profile

This endpoint will return all created Key Party folders linked to the profile id.

Authorizations:
bearerToken
path Parameters
profileId
required
string <uuid>

Id of the profile

query Parameters
entityType
string

Entity type of the key party. Available values are individual, business.

keyPartyTypes
string

Type of the key party. Available values are director, shareholder and ubo.

page
integer
Default: 1

Starting page number.

pageSize
integer <int32>
Default: 10

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalSize": 0
}

Update A Batch Of Key Parties

Updates a batch of key parties

Authorizations:
bearerToken
path Parameters
profileId
required
string <uuid>

id of the profile

Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "failed": [
    ],
  • "successful": [
    ]
}

Delete a batch of key parties

Delete a selection of key parties from a specific profile.

Authorizations:
bearerToken
path Parameters
profileId
required
string <uuid>

Id of the profile

Request Body schema: application/json
keyPartyIds
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "keyPartyIds": [
    ]
}

Response samples

Content type
application/json
{
  • "failed": [
    ],
  • "successful": [
    ]
}

Return All Key Party Searches

Get profile key party searches for the user.

Authorizations:
bearerToken
path Parameters
profileId
required
string <uuid>

id of the profile

query Parameters
page
integer
Default: 1

Starting page number.

pageSize
integer <int32>
Default: 10

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

type
string

type of searches. Available values: individual, business

keyPartyTypes
string

keyparty types. Available values: director, shareHolder, ubo

isScheduled
boolean

schedule check.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "countryCodes": [
    ],
  • "threshold": 0,
  • "type": "string",
  • "datasets": [
    ],
  • "status": "string",
  • "riskRating": "string",
  • "assignedToUserId": 0,
  • "assignedUser": "string",
  • "createdById": 0,
  • "createdBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedById": 0,
  • "modifiedBy": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "note": "string",
  • "scheduleId": "b7b4f318-018f-4d71-ac1a-f61e4bfaefbe",
  • "totalHitCount": 0,
  • "truePositiveHitsCount": 0,
  • "falsePositiveHitsCount": 0,
  • "undecidedHitsCount": 0,
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "gender": "string",
  • "dateOfBirth": "2019-08-24",
  • "pepTiers": [
    ],
  • "keyPartyId": "fdc696df-3708-44b9-964f-6f4cff7001e9",
  • "keyPartyType": "string"
}

Deletes A Batch Of Key Party Searches

Delete a batch of key parties searches

Authorizations:
bearerToken
path Parameters
profileId
required
string <uuid>

id of the profile

Request Body schema: application/json
Array of objects

Array of objects containing key party and search IDs.

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "failed": [
    ],
  • "successful": [
    ],
  • "error": {
    }
}

Request Multiple Searches Linked To A Key Party Asynchronously

Request multiple searches to be performed and linked to a key party asynchronously

Authorizations:
bearerToken
path Parameters
profileId
required
string <uuid>

id of the profile

Request Body schema: application/json
Array of objects or null (AddKeyPartySearchContract)

The Request Items collection

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "correlationId": "string",
  • "message": "string",
  • "details": "string"
}

Links Searches To Key Parties

Add searches link to key parties for the current logged in user.

Authorizations:
bearerToken
path Parameters
profileId
required
string <uuid>

id of the profile

Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "failed": [
    ],
  • "successful": [
    ]
}

Updates The Key Party By Profile Id and Key Party Id

Updates a key party on a profile by Id. Returns the updated key party data.

Authorizations:
bearerToken
path Parameters
profileId
required
string <uuid>

id of the profile

keyPartyId
required
string <uuid>

id of the keyParty

Request Body schema: application/json

Modified key party

name
string or null

Name of the key party Maximum length is 200 characters

firstName
string or null

First name of the key party
Valid for only entity type Individual
Maximum length is 200 characters combining First name, Middle name and Last name

middleName
string or null

Middle name of the key party
Valid for only entity type Individual
Maximum length is 200 characters combining First name, Middle name and Last name

lastName
string or null

Last name of the key party
Valid for only entity type Individual
Maximum length is 200 characters combining First name, Middle name and Last name

gender
string or null

Gender of the key party Valid for entity type Individual (male, female)

dateOfBirth
string or null <date>

Date of birth of the key party Date YYYY-MM-DD or YYYY format. Must be after 1900 and not in the future
Valid for the entity type Individual

organisationNumber
string or null


Key party organisation number
Valid for entity type Business

activityCode
string or null

Activity code of the key party
Valid for entity type Business

percentageOfShares
number or null <double>

Share percentage of the key party
Valid for key party type ShareHolder

role
string or null

Role of the key party
Valid for key party type Director

countryCode
string or null

Country code of the key party

object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "gender": "string",
  • "dateOfBirth": "2019-08-24",
  • "organisationNumber": "string",
  • "activityCode": "string",
  • "percentageOfShares": 0.1,
  • "role": "string",
  • "countryCode": "string",
  • "address": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "entityType": "string",
  • "keyPartyType": "string",
  • "gender": "string",
  • "dateOfBirth": "2019-08-24",
  • "organisationNumber": "string",
  • "activityCode": "string",
  • "percentageOfShares": 0.1,
  • "role": "string",
  • "countryCode": "string",
  • "address": {
    },
  • "searchId": "9b1a67f9-9477-48e5-8a6c-11b70245e1d9",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdById": 0,
  • "createdBy": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedById": 0,
  • "modifiedBy": "string"
}

Deletes a Key PArty By Key Party Id

Delete a key party by Id.

Authorizations:
bearerToken
path Parameters
profileId
required
string <uuid>

id of the profile

keyPartyId
required
string <uuid>

id of the keyParty

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0
}

KYC Batch Uploads

Return Template For Batch Upload

This endpoint the HTTP Request is planned to be altered in the next release


Returns the template to complete a batch upload.
Authorizations:
bearerToken

Responses

Response samples

Content type
application/json
{
  • "downloadUrl": "string",
  • "fileName": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "correlationId": "string"
}

Request Batch Upload

Submits the batch file process request. Returns the details of the accepted request.

Authorizations:
bearerToken
Request Body schema: multipart/form-data
File
required
string <binary>

The batch file to be processed. Size Limited to 10MB

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "filename": "string",
  • "status": "submitted",
  • "rowCount": 0,
  • "successCount": 0,
  • "uploadedAt": "2019-08-24T14:15:22Z",
  • "uploadedById": 0,
  • "uploadedBy": "string",
  • "completedAt": "2019-08-24T14:15:22Z"
}

Return A List Of Requested Uploads

Returns a list of uploads that have been requested.

Authorizations:
bearerToken
query Parameters
page
integer
Default: 1

Starting page number.

pageSize
integer <int32>
Default: 10

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

statuses
Array of strings

The statuses list to filter by. It can be the collection of submitted, validating, rejected, validated, insufficientCredits, queued, inProgress, processed, completed, partiallyCompleted, failed.

uploadedById
integer <int32>

The id of the uploaded user to filter by.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalSize": 0
}

Return Batch Upload File Details

Returns a batch Upload response as specified by the provided id.

Authorizations:
bearerToken
path Parameters
uploadId
required
integer <int32>

id of the upload.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "filename": "string",
  • "status": "submitted",
  • "rowCount": 0,
  • "successCount": 0,
  • "uploadedAt": "2019-08-24T14:15:22Z",
  • "uploadedById": 0,
  • "uploadedBy": "string",
  • "completedAt": "2019-08-24T14:15:22Z"
}

Download Batch Upload Error File

Returns a link to download the error file if it has does fail during the upload this is acquired using the upload Id..

Authorizations:
bearerToken
path Parameters
uploadId
required
string <uuid>

id of the upload

Responses

Response samples

Content type
application/json
{
  • "downloadUrl": "string",
  • "fileName": "string",
  • "expiresAt": "2019-08-24T14:15:22Z"
}

Retry Previous Upload

Re-uploads the file if it was previously failed due to 'insufficientCredits' status.

Authorizations:
bearerToken
path Parameters
uploadId
required
string <uuid>

id of the upload

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "filename": "string",
  • "status": "string",
  • "rowCount": 0,
  • "successCount": 0,
  • "uploadedAt": "2019-08-24T14:15:22Z",
  • "uploadedById": 0,
  • "uploadedBy": "string",
  • "completedAt": "2019-08-24T14:15:22Z"
}

KYC Profile Business / Individual Details

Return Profile Details

Fetches details of a profile by profile Id.

Authorizations:
bearerToken
path Parameters
profileId
required
string
Example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc

Id of a profile.

Responses

Response samples

Content type
application/json
{
  • "profileId": "2770ac31-8d12-4f69-8f93-326e93cd8c34",
  • "legalName": "string",
  • "tradingName": "string",
  • "aliases": [
    ],
  • "activity": "string",
  • "description": "string",
  • "contactName": "string",
  • "email": "string",
  • "website": "string",
  • "telephone": "string",
  • "turnover": {
    },
  • "assetsUnderManagement": {
    },
  • "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

Updates the details of profile by the profileId.

Authorizations:
bearerToken
path Parameters
profileId
required
string
Example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc

Id of a profile.

Request Body schema: application/json
legalName
required
string

Name of the Business or Individual
Maximum length is 150 characters

tradingName
string

Valid for profile type - SoleTrader
Maximum length is 150 characters

aliases
Array of strings

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

activity
string

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

description
string

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

contactName
string

Contact person at the organisation.

email
string

Contact email address of the entity

website
string

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

telephone
string

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

object
object
organizationNumber
string

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

internalContact
string

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

internalEmail
string

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

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

countryCode
string

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

vatNo
string

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

isListedOnExchange
boolean

Property valid for profile type PLC

exchangeName
string

Property valid for profile type PLC

Responses

Request samples

Content type
application/json
{
  • "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": {
    },
  • "assetsUnderManagement": {
    },
  • "organizationNumber": "12345678",
  • "internalContact": null,
  • "internalEmail": null,
  • "dateOfBirth": "2024-03-25",
  • "countryCode": "GB",
  • "vatNo": "GB12345678",
  • "isListedOnExchange": null,
  • "exchangeName": null
}

Response samples

Content type
application/json
{
  • "profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
  • "legalName": "string",
  • "tradingName": "string",
  • "aliases": [
    ],
  • "activity": "string",
  • "description": "string",
  • "contactName": "string",
  • "email": "string",
  • "website": "string",
  • "telephone": "string",
  • "turnover": {
    },
  • "assetsUnderManagement": {
    },
  • "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

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

Authorizations:
bearerToken
path Parameters
profileId
required
string <uuid>

id of the profile

Request Body schema: application/json
type
required
string or null
Enum: "registered" "trading" "other"

The type of the address.

description
required
string or null

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

buildingDetails
string or null

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

street
string or null

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

city
string or null

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

region
string or null

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

postalCode
string or null

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

countryCode
string or null

Two-letter ISO-3166-2 country code

Responses

Request samples

Content type
application/json
{
  • "type": "registered",
  • "buildingDetails": "string",
  • "street": "string",
  • "city": "string",
  • "region": "string",
  • "postalCode": "string",
  • "countryCode": "string",
  • "description": "string"
}

Response samples

Content type
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"
}

Return Lists Of Addresses

Returns list of addresses for the current logged in user based on profileId.

Authorizations:
bearerToken
path Parameters
profileId
required
string <uuid>

id of the profile

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return Profile Address Details By Profile And Address Id

Returns the address by profile Id and address Id.

Authorizations:
bearerToken
path Parameters
profileId
required
string <uuid>
Example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc

Id of a profile.

addressId
required
string <uuid>
Example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc

Id of a user address.

Responses

Response samples

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

Update Profile Address Details By Profile Id And Address Id

Update Profile Address Details By Profile Id And Address Id

Authorizations:
bearerToken
path Parameters
profileId
required
string <uuid>
Example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc

Id of a profile.

addressId
required
string <uuid>
Example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc

Id of a user address.

Request Body schema: application/json
buildingDetails
string

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

street
string

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

city
string

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

region
string

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

postalCode
string

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

countryCode
string

The country code of the address being created.

type
string
Enum: "registered" "trading" "other"

The type of the address.

description
string

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

Responses

Request samples

Content type
application/json
{
  • "buildingDetails": "string",
  • "street": "string",
  • "city": "string",
  • "region": "string",
  • "postalCode": "string",
  • "countryCode": "string",
  • "type": "registered",
  • "description": "string"
}

Response samples

Content type
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"
}

Delete Profile Address Details By Profile Id And Address Id

Deletes the address by profile Id and address id.

Authorizations:
bearerToken
path Parameters
profileId
required
string <uuid>
Example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc

Id of a profile.

addressId
required
string <uuid>
Example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc

Id of a addressId.

Responses

Response samples

Content type
application/json
{
  • "correlationId": "string",
  • "message": "string",
  • "details": "string"
}

KYC AML Screening - Profile Management

Return List Of AML Searches On The Given Profile

Returns a list of searches both business and individual associated to the profile for the profile Id.

Authorizations:
bearerToken
path Parameters
profileId
required
string <uuid>

id of the profile

query Parameters
page
integer
Default: 1

Starting page number.

pageSize
integer <int32>
Default: 10

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

isScheduled
boolean

Responses

Response samples

Content type
application/json
{
  • "totalSize": 0,
  • "items": [
    ]
}

Adds AML Searches To The Given Profile

Adds a list of searches to a profile.

Authorizations:
bearerToken
path Parameters
profileId
required
string <uuid>

id of the profile

Request Body schema: application/json
searchIds
Array of strings <uuid> [ items <uuid > ]

List of searches to link to a profile

Responses

Request samples

Content type
application/json
{
  • "searchIds": [
    ]
}

Response samples

Content type
application/json
{
  • "successful": [
    ],
  • "failed": [
    ]
}

Deletes AML searches linked to a profile

Deletes AML searches from a profile by profile Id and Search Id.

Authorizations:
bearerToken
path Parameters
profileId
required
string
Example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc

Id of a profile.

Request Body schema: application/json
required
searchIds
Array of strings

List of searches to de-link from a profile

Responses

Request samples

Content type
application/json
{
  • "searchIds": [
    ]
}

Response samples

Content type
application/json
{
  • "failed": [
    ],
  • "successful": [
    ]
}

Return All Schedules By ProfileId And Modified Date

Returns all schedules based on profileId ordered by modified date.

Authorizations:
bearerToken
path Parameters
profileId
required
string <uuid>

id of the profile

query Parameters
page
integer
Default: 1

Starting page number.

pageSize
integer <int32>
Default: 10

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "searchId": "9b1a67f9-9477-48e5-8a6c-11b70245e1d9",
  • "isEmailRequired": true,
  • "emailRecipients": [
    ],
  • "createdById": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "modifiedById": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": "string",
  • "type": "string",
  • "name": "string",
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "gender": "string",
  • "dateOfBirth": "2019-08-24",
  • "countries": [
    ],
  • "threshold": 0,
  • "datasets": [
    ],
  • "pepTiers": [
    ],
  • "correlationId": "string"
}

Return Schedule By ProfileId And ScheduleId

Returns a schedule by profileId and scheduleId.

Authorizations:
bearerToken
path Parameters
profileId
required
string <uuid>

id of the profile

scheduleId
required
string

id of the schedule

Responses

Response samples

Content type
application/json
{
  • "totalSize": 0,
  • "items": [
    ]
}

Return All Hits Linked To The Profile

Returns hits of all searches linked to the profile and key parties.

Authorizations:
bearerToken
path Parameters
profileId
required
string <uuid>

id of the profile

query Parameters
page
integer
Default: 1

Starting page number.

pageSize
integer <int32>
Default: 10

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

hitDecisions
Array of strings

The hit decisions to filter by. It can be the collection of undecided, truematch, falsepositive, discarded

Responses

Response samples

Content type
application/json
{
  • "totalSize": 0,
  • "items": [
    ]
}

Return All Hits Of Searches Linked To A Profile

Return hits of the searches linked to a profile.

Authorizations:
bearerToken
path Parameters
profileId
required
string

Id of the profile

query Parameters
hitDecisions
Array of strings

The hit decisions. It can be the collection of undecided, truematch, falsepositive, discarded

page
integer
Default: 1

Starting page number.

pageSize
integer <int32>
Default: 10

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalSize": 0
}

KYC AML Screening - Businesses

Performs An AML Search For A Business And Saves The Results To The Database

A request requires a name, at least one valid dataset, and a threshold. User will be deducted 1 credit for each AML search.

Authorizations:
bearerToken
Request Body schema: application/json
required
threshold
required
integer <int32>

Hits with scores below the chosen value will not be shown.
Must be one of 75, 80, 85, 90, 95, or 100

name
required
string

Name of the business to be searched.
Example - Google Inc
Max 200 characters allowed.

countryCodes
Array of strings

List of Two-letter country code ISO-3166-2.

datasets
Array of strings

Specifies which datasets will be searched

PEP - Politically Exposed Persons (All)
PEP-LINKED - Only linked PEPs (PEP by Association)
SAN - Sanctioned (All)
SAN-CURRENT - Only current Sanctions
SAN-FORMER - Only former Sanctions
INS - Insolvency
AM - Adverse Media
POI - Profile of Interest
ENF - Enforcement
SOE - State Owned Enterprises (All)
SOE-CURRENT - Only current SOE
SOE-FORMER - Only former SOE

Responses

Request samples

Content type
application/json
{
  • "countryCodes": [
    ],
  • "threshold": 0,
  • "name": "string",
  • "datasets": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "countryCodes": [
    ],
  • "threshold": 0,
  • "type": "string",
  • "datasets": [
    ],
  • "status": "string",
  • "riskRating": "string",
  • "assignedToUserId": 0,
  • "assignedUser": "string",
  • "createdById": 0,
  • "createdBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedById": 0,
  • "modifiedBy": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "note": "string",
  • "scheduleId": "b7b4f318-018f-4d71-ac1a-f61e4bfaefbe",
  • "totalHitCount": 0,
  • "truePositiveHitsCount": 0,
  • "falsePositiveHitsCount": 0,
  • "undecidedHitsCount": 0,
  • "correlationId": "string"
}

Returns Business AML Searches

Returns a list of business AML searches ordered by modified date.

Authorizations:
bearerToken
query Parameters
page
integer
Default: 1

Starting page number.

pageSize
integer <int32>
Default: 10

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

isScheduled
boolean

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalSize": 0
}

Update Business AML Searches

Updates a batch of business AML searches.

Authorizations:
bearerToken
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "failed": [
    ],
  • "successful": [
    ]
}

Return Business AML Search By Search Id

Returns a single AML search based on Search id.

Authorizations:
bearerToken
path Parameters
searchId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "countryCodes": [
    ],
  • "threshold": 0,
  • "type": "string",
  • "datasets": [
    ],
  • "status": "string",
  • "riskRating": "notApplicable",
  • "assignedToUserId": 0,
  • "assignedUser": "string",
  • "createdById": 0,
  • "createdBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedById": 0,
  • "modifiedBy": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "note": "string",
  • "scheduleId": "b7b4f318-018f-4d71-ac1a-f61e4bfaefbe",
  • "totalHitCount": 0,
  • "truePositiveHitsCount": 0,
  • "falsePositiveHitsCount": 0,
  • "undecidedHitsCount": 0
}

Update A Business AML Search By Search Id

Updates a business AML search.

Authorizations:
bearerToken
path Parameters
searchId
required
string
Request Body schema: application/json
assignedToUserId
integer <int32>

Id of the User to assign to the Search

status
string

Status of the Search. Available values are new, approved, declined, pending, cancelled, referred and closed.

riskRating
string

Risk rating of the Search. Available values are notApplicable, veryLow, low, medium, high AND veryHigh.

note
string

Note associated with the search

Responses

Request samples

Content type
application/json
{
  • "assignedToUserId": 0,
  • "status": "string",
  • "riskRating": "string",
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "countryCodes": [
    ],
  • "threshold": 0,
  • "type": "string",
  • "datasets": [
    ],
  • "status": "string",
  • "riskRating": "notApplicable",
  • "assignedToUserId": 0,
  • "assignedUser": "string",
  • "createdById": 0,
  • "createdBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedById": 0,
  • "modifiedBy": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "note": "string",
  • "scheduleId": "b7b4f318-018f-4d71-ac1a-f61e4bfaefbe",
  • "totalHitCount": 0,
  • "truePositiveHitsCount": 0,
  • "falsePositiveHitsCount": 0,
  • "undecidedHitsCount": 0
}

Return Business AML Search Hits

Returns the business AML search hits from the AML search results.

Authorizations:
bearerToken
path Parameters
searchId
required
string
query Parameters
page
integer
Default: 1

Starting page number.

pageSize
integer <int32>
Default: 10

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

hitDecisions
string

The hit decisions.
Available Values - [undecided, truematch, falsepositive, discarded]

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalSize": 0
}

Update Batch Of Business AML Search Hits

Updates a batch of business AML search hits.

Authorizations:
bearerToken
path Parameters
searchId
required
string
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "failed": [
    ],
  • "successful": [
    ]
}

Return Full AML Search Hit Information By SearchId And HitId

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.

Authorizations:
bearerToken
path Parameters
searchId
required
string

Id of the search

hitId
required
string

Id of the hit

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "hitScore": 0,
  • "name": "string",
  • "match": "string",
  • "note": "string",
  • "countries": [
    ],
  • "datasets": [
    ],
  • "profileImages": [
    ],
  • "screeningNotes": [
    ],
  • "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": [
    ],
  • "aliases": [
    ],
  • "amlResults": {
    },
  • "description": "string",
  • "businessTypes": [
    ]
}

Update A Single Business Hit

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

Authorizations:
bearerToken
path Parameters
searchId
required
string
hitId
required
string
Request Body schema: application/json
decision
string

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

note
string

Note associated with the Hit

Responses

Request samples

Content type
application/json
{
  • "decision": "string",
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "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",
  • "supersededHit": {
    }
}

KYC AML Screening - Individuals

Performs An AML Search For An Individual And Saves The Results To The Database

A request requires a name, or first name and last name, at least one valid dataset and a threshold.

Length of name or combination of first name, middle name and last name must not exceed 200 characters. If user is providing first name, middle name and last name combination, the max characters limit includes the formatted name in this format {lastName} {firstName} {middleName}.

User will be deducted 1 credit for each search.

Authorizations:
bearerToken
Request Body schema: application/json
threshold
required
integer <int32>

Hits with scores below the chosen value will not be shown.
Must be one of 75, 80, 85, 90, 95, or 100

datasets
required
Array of strings or null

Specifies which datasets will be searched
PEP - Politically Exposed Persons (All)
PEP-CURRENT - Only current PEPs
PEP-FORMER - Only former PEPs
PEP-LINKED - Only linked PEPs (PEP by Association)
SAN - Sanctioned (All)
SAN-CURRENT - Only current Sanctions
SAN-FORMER - Only former Sanctions
INS - Insolvency
AM - Averse Media
POI - Profile of Interest
ENF - Enforcement DD - Disqualified Director

countryCodes
Array of strings or null

List of Two-letter country code ISO-3166-2.

name
string or null

Required if FirstName and LastName are not provided

firstName
string or null

If firstName is provided then lastName must also be provided

middleName
string or null

middleName is optional, valid along with firstName and lastName only

lastName
string or null

If LastName is provided then FirstName must also be provided

dateOfBirth
string or null <date>

Date YYYY-MM-DD or YYYY format. Must be after 1900 and not in the future.

gender
string or null
Enum: "male" "female"

Define the gender of the individual you are searching for. Available values are male and female.

pepTiers
Array of strings or null
Enum: "pepTier1" "pepTier2" "pepTier3"

When searching the PEP dataset, define what tiers of the PEP profiles should be included in the results.
PEP Tier 1 indicates senior roles
PEP Tier 2 - middle-ranking
PEP Tier 3 - junior officials

If the PEP Dataset is NOT included on the list of searched datasets, then this value is ignored.

The PEP Tier filter does not apply to PEP-LINKED Profiles.

Responses

Request samples

Content type
application/json
{
  • "countryCodes": [
    ],
  • "threshold": 0,
  • "name": "string",
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "dateOfBirth": "2019-08-24",
  • "gender": "male",
  • "pepTiers": [
    ],
  • "datasets": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "countryCodes": [
    ],
  • "threshold": 0,
  • "type": "string",
  • "datasets": [
    ],
  • "status": "string",
  • "riskRating": "string",
  • "assignedToUserId": 0,
  • "assignedUser": "string",
  • "createdById": 0,
  • "createdBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedById": 0,
  • "modifiedBy": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "note": "string",
  • "totalHitCount": 0,
  • "truePositiveHitsCount": 0,
  • "falsePositiveHitsCount": 0,
  • "undecidedHitsCount": 0,
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "gender": "string",
  • "dateOfBirth": "2019-08-24",
  • "pepTiers": [
    ],
  • "scheduleId": "string"
}

Returns Individual AML Searches

Returns a list of individual AML searches ordered by modified date.

Authorizations:
bearerToken
query Parameters
page
integer
Default: 1

Starting page number.

pageSize
integer

Number of items to return per Page.

isScheduled
boolean

Responses

Response samples

Content type
application/json
{
  • "totalSize": 0,
  • "items": [
    ]
}

Update Individual AML Searches

Updates a batch of individual AML searches.

Authorizations:
bearerToken
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "failed": [
    ],
  • "successful": [
    ],
  • "correlationId": "string"
}

Return Individual AML Search By Search Id

Returns a single AML Search based on searchId.

Authorizations:
bearerToken
path Parameters
searchId
required
string <uuid>

search id to fetch

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "countryCodes": [
    ],
  • "threshold": 0,
  • "type": "string",
  • "datasets": [
    ],
  • "status": "string",
  • "riskRating": "notApplicable",
  • "assignedToUserId": 0,
  • "assignedUser": "string",
  • "createdById": 0,
  • "createdBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedById": 0,
  • "modifiedBy": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "note": "string",
  • "totalHitCount": 0,
  • "truePositiveHitsCount": 0,
  • "falsePositiveHitsCount": 0,
  • "undecidedHitsCount": 0,
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "gender": "string",
  • "dateOfBirth": "2019-08-24",
  • "pepTiers": [
    ],
  • "scheduleId": "string"
}

Updates An Individual AML Search By SearchID

Updates an Individual AML Search by Search Id.

Authorizations:
bearerToken
path Parameters
searchId
required
string <uuid>

search id to update

Request Body schema: application/json
riskRating
required
string

Risk rating of the Search and allowed values notApplicable,veryLow,low,medium,high and veryHigh

status
required
string

Status of the Search. Available values are new, approved, declined, pending, cancelled, referred and closed.

assignedToUserId
integer <int32>

Id of the User to assign to the Search

note
string

Note associated with the search

Responses

Request samples

Content type
application/json
{
  • "assignedToUserId": 0,
  • "status": "string",
  • "riskRating": "string",
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "countryCodes": [
    ],
  • "threshold": 0,
  • "type": "string",
  • "datasets": [
    ],
  • "status": "string",
  • "riskRating": "notApplicable",
  • "assignedToUserId": 0,
  • "assignedUser": "string",
  • "createdById": 0,
  • "createdBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedById": 0,
  • "modifiedBy": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "note": "string",
  • "totalHitCount": 0,
  • "truePositiveHitsCount": 0,
  • "falsePositiveHitsCount": 0,
  • "undecidedHitsCount": 0,
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "gender": "string",
  • "dateOfBirth": "2019-08-24",
  • "pepTiers": [
    ],
  • "scheduleId": "string",
  • "correlationId": "string"
}

Returns Individual AML Search Hits

Returns the individual AML search hits from the AML search results.

Authorizations:
bearerToken
path Parameters
searchId
required
string <uuid>

The search identifier.

query Parameters
hitDecisions
string

The hit decisions. It can be the collection of undecided, trueMatch, falsePositive, discarded

page
integer
Default: 1

Starting page number.

pageSize
integer <int32>
Default: 10

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalSize": 0
}

Updates A Batch Of individual AML search Hits

Update a batch of Individual AML Search Hits.

Authorizations:
bearerToken
path Parameters
searchId
required
string <uuid>

Id of the search

Request Body schema: application/json
Array of objects (IndividualSearchUpdateHitRequest)

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "failed": [
    ],
  • "successful": [
    ],
  • "correlationId": "string"
}

Return Full AML Search Hit Information By SearchId And HitId

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.

Authorizations:
bearerToken
path Parameters
searchId
required
string <uuid>

Id of the search

hitId
required
string <uuid>

Id of the hit

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "hitScore": 0,
  • "name": "string",
  • "match": "string",
  • "note": "string",
  • "countries": [
    ],
  • "datasets": [
    ],
  • "profileImages": [
    ],
  • "screeningNotes": [
    ],
  • "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": [
    ],
  • "isDeceased": true,
  • "datesOfDeath": [
    ],
  • "pepTier": "tier1",
  • "aliases": [
    ],
  • "amlResults": {
    }
}

Update A Single Individual Hit

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

Authorizations:
bearerToken
path Parameters
searchId
required
string <uuid>

Id of the search

hitId
required
string <uuid>

Id of the hit

Request Body schema: application/json
decision
string

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

note
string

Note associated with the Hit

Responses

Request samples

Content type
application/json
{
  • "decision": "string",
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "supersededHit": {
    },
  • "correlationId": "string"
}

KYC AML Bulk Screening

Perform Bulk AML Screening

Request multiple searches to be performed and linked to a profile asynchronously

Authorizations:
bearerToken
path Parameters
profileId
required
string <uuid>

id of the profile

Request Body schema: application/json
Array of objects or null (AddSearchContract)

The Request Items collection

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "correlationId": "string",
  • "message": "string",
  • "details": "string"
}

KYC AML Monitoring Management

Add Search To AML Monitoring

Adds the specified searches to AML monitoring, i.e. schedules them for screening. If thresholds and datasets are amended from the original search, new results will generated. Any existing hits will be overridden and any previous match decisions will be reset.

Authorizations:
bearerToken
Request Body schema: application/json
Array of objects (PostKYCProtectSchedulesRequest)

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "failed": [
    ],
  • "successful": [
    ]
}

Return All Ordered Schedules

Returns all schedules ordered by modified date.

Authorizations:
bearerToken
query Parameters
page
integer
Default: 1

Starting page number.

pageSize
integer <int32>
Default: 10

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalSize": 0
}

Delete Searches From AML Monitoring

Removes the specified searches from AML monitoring.

Authorizations:
bearerToken
Request Body schema: application/json
items
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "failed": [
    ],
  • "successful": [
    ]
}

Update Schedules

Updates schedules in AML monitoring.

Authorizations:
bearerToken
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "failed": [
    ],
  • "successful": [
    ],
  • "correlationId": "string"
}

Returns A Schedule

Returns a schedule in AML monitoring.

Authorizations:
bearerToken
path Parameters
scheduleId
required
string <uuid>

id of the profile

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "searchId": "9b1a67f9-9477-48e5-8a6c-11b70245e1d9",
  • "isEmailRequired": true,
  • "emailRecipients": [
    ],
  • "createdById": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "modifiedById": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": "string",
  • "type": "string",
  • "name": "string",
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "gender": "string",
  • "dateOfBirth": "2019-08-24",
  • "countries": [
    ],
  • "threshold": 0,
  • "datasets": [
    ],
  • "pepTiers": [
    ]
}

Delete A Search From AML Monitoring

Removes a search from AML monitoring.

Authorizations:
bearerToken
path Parameters
scheduleId
required
string <uuid>

id of the profile

Responses

Response samples

Content type
application/json
{
  • "correlationId": "string",
  • "message": "string",
  • "details": "string"
}

Update A Schedule In Monitoring

Updates a schedule in AML monitoring.

When there is a change in threshold or datasets, the system will deduct one credit for screening.

Authorizations:
bearerToken
path Parameters
scheduleId
required
string <uuid>

id of the profile

Request Body schema: application/json
threshold
integer <int32>

The threshold to use when running the schedule. Must be one of 75, 80, 85, 90, 95, 100. Changing threshold will cause even decided results to come back again and a new decision will need to be made.

datasets
Array of strings

The datasets to use when running the schedule. Changing datasets will cause even decided results to come back again and a new decision will need to be made.

Note: Please refer to the corresponding endpoint that the schedule is set against for the correct dataset options

isEmailRequired
boolean

Set to true to send an email when the schedule is run. If there are no email recipients set then this will be ignored.

emailRecipients
Array of strings

The list of email recipients to send the email to when the schedule is run. Email will not be sent if IsEmailRequired is false.

Responses

Request samples

Content type
application/json
{
  • "threshold": 0,
  • "datasets": [
    ],
  • "isEmailRequired": true,
  • "emailRecipients": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "searchId": "9b1a67f9-9477-48e5-8a6c-11b70245e1d9",
  • "isEmailRequired": true,
  • "emailRecipients": [
    ],
  • "createdById": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "modifiedById": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": "string",
  • "type": "string",
  • "name": "string",
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "gender": "string",
  • "dateOfBirth": "2019-08-24",
  • "countries": [
    ],
  • "threshold": 0,
  • "datasets": [
    ],
  • "pepTiers": [
    ],
  • "correlationId": "string"
}

Return All Hits For A Schedule By Created Date

Get all hits for an AML monitoring schedule ordered by hit created date.

Authorizations:
bearerToken
query Parameters
page
integer
Default: 1

Starting page number.

pageSize
integer <int32>
Default: 10

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

hitDecisions
Array of strings

The hit decisions to filter by. It can be the collection of undecided, truematch, falsepositive, discarded

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "hitScore": 0,
  • "name": "string",
  • "match": "string",
  • "countries": [
    ],
  • "datasets": [
    ],
  • "decision": "undecided",
  • "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": "male",
  • "datesOfBirth": [
    ],
  • "pepTier": "pepTier1",
  • "profileImages": [
    ],
  • "supersededHit": {
    },
  • "searchId": "9b1a67f9-9477-48e5-8a6c-11b70245e1d9",
  • "profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
  • "scheduleId": "b7b4f318-018f-4d71-ac1a-f61e4bfaefbe",
  • "keyPartyId": "fdc696df-3708-44b9-964f-6f4cff7001e9",
  • "searchType": "individual"
}

KYC Async AML

Return All Async AML Jobs

Gets a list of async aml jobs for user.

Authorizations:
bearerToken
query Parameters
page
integer
Default: 1

Starting page number.

pageSize
integer <int32>
Default: 10

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

statuses
Array of strings

The async job statuses. It can be the collection of created, processing, completed

targetType
string
Enum: "profile" "keyParty"

The async job's target type. It can be either Profile or KeyParty

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalSize": 0
}

Return Async AML Jobs By Id

Returns a list of async aml jobs for user.

Authorizations:
bearerToken
path Parameters
jobId
required
string <uuid>

id of the async aml job

query Parameters
page
integer
Default: 1

Starting page number.

pageSize
integer <int32>
Default: 10

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "created",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdById": 0,
  • "createdBy": "string",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "criteriaCount": 0
}

Return Async Job Criteria By Id

Gets a list of job criteria by async job id for user.

Authorizations:
bearerToken
path Parameters
jobId
required
string <uuid>

id of the async aml job

query Parameters
page
integer
Default: 1

Starting page number.

pageSize
integer <int32>
Default: 10

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

statuses
Array of strings

The async job criteria statuses. It can be the collection of submitted, processing, completed, failed.

Responses

Response samples

Content type
application/json
{
  • "items": {
    },
  • "totalSize": 0
}

KYC Global Monitoring

Returns Available Country Codes

Gets the list of acceptable country codes for kyc monitoring.

Authorizations:
bearerToken

Responses

Response samples

Content type
application/json
[
  • "string"
]

Add Profiles To Monitoring

Adds a list of profile/s to monitoring.

Authorizations:
bearerToken
Request Body schema: application/json
items
Array of strings or null <uuid> [ items <uuid > ]

Provide the list of profile Id's in the array.

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "failed": [
    ],
  • "successful": [
    ]
}

Delete Profiles From Monitoring

Removes list of profiles from kyc monitoring

Authorizations:
bearerToken
Request Body schema: application/json
items
Array of strings or null <uuid> [ items <uuid > ]

The Request Items collection

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "failed": [
    ],
  • "successful": [
    ]
}

Return List Of Alerts By Profile

Gets a list of kyc alerts by profile.

Authorizations:
bearerToken
path Parameters
profileId
required
string <uuid>

id of the profile

query Parameters
page
integer
Default: 1

Starting page number.

pageSize
integer <int32>
Default: 10

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

statuses
Array of strings

Statuses of kyc alert to filter. Allowed values are Open, ClosedProcessed and ClosedUnprocessed

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalSize": 0
}

Return Alert By Alert Id And ProfileId

Gets a kyc alert associated with a given profile.

Authorizations:
bearerToken
path Parameters
profileId
required
string <uuid>

id of the profile

alertId
required
string <uuid>

id of the kyc alert

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
  • "safeNumber": "string",
  • "companyId": "string",
  • "previousValue": "string",
  • "newValue": "string",
  • "ruleName": "string",
  • "eventAt": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "note": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdById": 0,
  • "createdBy": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedById": 0,
  • "modifiedBy": "string"
}

Update Status of Alert By Profile Id And Alert Id

Updates a kyc alert associated with a given profile

Authorizations:
bearerToken
path Parameters
profileId
required
string <uuid>

id of the profile

alertId
required
string <uuid>

id of the kyc alert

Request Body schema: application/json
note
string or null

Note of kyc alert

status
string or null

Status of kyc alert. Allowed values are open, closedProcessed, closedUnprocessed

Responses

Request samples

Content type
application/json
{
  • "note": "string",
  • "status": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
  • "safeNumber": "string",
  • "companyId": "string",
  • "previousValue": "string",
  • "newValue": "string",
  • "ruleName": "string",
  • "eventAt": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "note": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdById": 0,
  • "createdBy": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedById": 0,
  • "modifiedBy": "string"
}

Consumers

Endpoints to order Consumer Reports. In order to order a Consumer Report, sufficient information to uniquely identify the Consumer (search criteria) must be provided to filter potential results down to one record. When one record has been found, the returned object will be the Consumer Report. Currently only piloting with German Consumers.

Consumer Report

Consumer Search and Report endpoint. When sufficient information has been provided to filter potential Consumer results down to one record then the Consumer Report will be returned.

Authorizations:
bearerToken
query Parameters
countries
required
string (Creditsafe.GlobalData.CountryCode)
Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "KH" "CM" "CA" "CV" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MK" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "AN" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SK" "SI" "SB" "SO" "ZA" "GS" "ES" "LK" "SD" "SR" "SJ" "SZ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VA" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW" "XK" "SS" "SX" "CW" "BQ" "WW" "PLC"
Example: countries=DE

ISO-2 country code

firstName
required
string

Consumer's First Name

lastName
required
string

Consumer's Last Name

street
required
string

Address part identifier - Street of the Consumer

houseNo
required
string

Address part identifier - House/Building Number of the Consumer

city
required
string

Address part identifier - City of the Consumer

postCode
required
string

Address part identifier - Postcode/Zip Code of the Consumer

language
string or null = 2 characters
Default: "EN"
dateOfBirth
string or null <date-time>
customData
string or null
Example: customData=de_reason_code::ER
callRef
string or null
Default: null

This parameter allows users to assign a unique identifier to their API queries. By using a callRef, it facilitates easier tracking and logging within Connect. If you provide a callRef, the Connect team can later retrieve and identify the specific requests associated with that identifier, enabling detailed tracing of interactions.

Responses

Response samples

Content type
application/json
{
  • "totalSize": 0,
  • "consumers": [
    ]
}

Consumer Search Criteria

Returns country specific fields that can be used to search for a Consumer.

Authorizations:
bearerToken
query Parameters
countries
required
string

Comma-separated list of ISO-2 country codes

callRef
string

This parameter allows users to assign a unique identifier to their API queries. By using a callRef, it facilitates easier tracking and logging within Connect. If you provide a callRef, the Connect team can later retrieve and identify the specific requests associated with that identifier, enabling detailed tracing of interactions.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Misc

Supporting endpoints for metadata/discovery. Not frequently used directly in integrations.

Report Schema

Returns the Company Report JSON schema of the provided country. Largely redundant as the Company Report 200 response is defined as a superset of all country's JSON schemas and can be used for any country.

Authorizations:
bearerToken
path Parameters
countryCode
required
string

ISO2 / Alpha 2 Country Code

query Parameters
section
string
Enum: "CompanyReportResponse" "DirectorReportResponse"

Use CompanyReportResponse for the Company Credit Report JSON schema, DirectorReportResponse for the Director Report JSON schema.

template
string

For Templated Company Report JSON Schemas

Responses

Response samples

Content type
application/json
{ }

Custom Report Parameters

Returns the allowed values of the customData parameter, used in the GET Company Report and Director Report endpoints. I.e. Supplying DE as a country code will return a list of reasons for requesting a DE Credit Report (a legal requirement to supply with each Credit Report request in Germany). This will provide a list of allowedValues to enter into the mandatory Parameter customData = de_reason_code::allowedValue.

Authorizations:
bearerToken
path Parameters
country
required
string

An ISO/Alpha-2 country code to display any special mandatory parameters when ordering a Credit Report in that territory.

Responses

Response samples

Content type
application/json
{
  • "customData": [
    ],
  • "country": "DE"
}