Endpoints for user authentication into the Connect API.
Metadata
| Key | Value |
|---|---|
| tags | Full Connect API |
| Key | Value |
|---|---|
| tags | Full Connect API |
Creditsafe Connect is a REST API that provides access to the Creditsafe Global Company Database. This allows you to:
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.
Endpoints to retrieve the structure of the Company and Director Search Criteria's and Reports.
The JSON schema is a blueprint of the data structure that will be returned in the response of the Company and Director Report endpoints. The schema can be used to validate the response data and understand the structure of the data returned. The schema is available for all countries and is a superset of all country's JSON schemas.
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.
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.
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.
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.
Hits with scores below the chosen value will not be shown.
Must be one of 75, 80, 85, 90, 95, or 100
Date YYYY-MM-DD or YYYY format. Must be after 1900 and not in the future.
Define the gender of the individual you are searching for. Available values are male and female.
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.
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
curl -i -X POST \
https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/connect-api-full/connectapi/compliance/kyc-protect/searches/individuals \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"countryCodes": [
"string"
],
"threshold": 0,
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dateOfBirth": "2019-08-24",
"gender": "male",
"pepTiers": [
"pepTier1"
],
"datasets": [
"string"
]
}'Created
First name provided in the search. The combination of first name, middle name, and last name must not exceed 200 characters
Middle name provided in the search. The combination of first name, middle name, and last name must not exceed 200 characters
Last name provided in the search. The combination of first name, middle name, and last name must not exceed 200 characters
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "countryCodes": [ "string" ], "threshold": 0, "type": "string", "datasets": [ "string" ], "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": [ "string" ], "scheduleId": "string" }
curl -i -X GET \
'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/connect-api-full/connectapi/compliance/kyc-protect/searches/individuals?isScheduled=true&page=1&pageSize=0' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "totalSize": 0, "items": [ { … } ] }
curl -i -X PUT \
https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/connect-api-full/connectapi/compliance/kyc-protect/searches/individuals \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"items": [
{
"assignedToUserId": {},
"status": {},
"riskRating": {},
"note": {},
"searchId": "9b1a67f9-9477-48e5-8a6c-11b70245e1d9"
}
]
}'{ "failed": [ { … } ], "successful": [ { … } ], "correlationId": "string" }