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.
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.
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 of the profile.
Risk rating of the profile.
Free text field for users to highlight key information to other users.
Maximum characters allowed is 250
curl -i -X POST \
https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/connect-api-full/connectapi/compliance/kyc-protect/profiles \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"type": "trust",
"internalId": "string",
"assignedToId": 0,
"kycReviewOn": "string",
"status": "new",
"riskRating": "notApplicable",
"kycComments": "string",
"details": {
"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": {
"currencyCode": "eur",
"amount": 0
},
"assetsUnderManagement": {
"currencyCode": "eur",
"amount": 0
},
"organizationNumber": "12345678",
"internalContact": null,
"internalEmail": null,
"dateOfBirth": "2024-03-25",
"countryCode": "GB",
"vatNo": "GB12345678",
"isListedOnExchange": null,
"exchangeName": null
}
}'Created
Status of the profile (new, approved, declined, pending, cancelled, referred, closed, approvedReviewDue)
Type of the profile (trust, individual, soleTrader, company, plc, partnership, otherEntity)
Status of profile creation (submitted, preprocessed, validated, queued, inProgress, processed, completed, partiallyCompleted, failed)
{ "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": { "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 } }
curl -i -X GET \
https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/connect-api-full/connectapi/compliance/kyc-protect/profiles/9a7ae0c8-f473-4ab6-8dbb-03fc061630cc \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The risk rating being assigned to the profile
The current status of the profile
The type of the profile
The time the profile was last updated
Date when the profile status was last updated
{ "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 }
curl -i -X DELETE \
https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/connect-api-full/connectapi/compliance/kyc-protect/profiles/9a7ae0c8-f473-4ab6-8dbb-03fc061630cc \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'