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.
Filter the returned usage log by the GUID for the associated decision trees, obtained from /GUID.
Filter the returned usage log by the Connect ID for the associated companies for each decision.
Filter the returned usage log by the Company Name for the associated companies for each decision.
curl -i -X GET \
'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decisionEngine/usageLog?companyId=US001-X-US60521352&companyName=CREDITSAFE&fromDate=2019-08-24T14%3A15%3A22Z&page=1&pageSize=0&provenirId=repoObj_0ed6a4aa_16e17d977e9_07ffb16e17d977e9&status=1&toDate=2019-08-24T14%3A15%3A22Z' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "totalCount": 3108, "usageLog": [ { … } ] }
curl -i -X GET \
'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decisionEngine/usageLog/{decisionLogId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The unique identifier of the decision tree.
The unique identifier for the user's account, used across the Creditsafe product suite.
The connectId of the company that the decision was ran on. A connectId is the primary Company identifier that is used to uniquely identify all companies across Creditsafe's Universe and Partner Network.
The name of the company that the decision was ran on.
Displays the optional text passed through to be stored against the decision in the original call to /{provenirId}. Typically used for internal identifiers (e.g. SalesForce IDs).
The status of the decision. typically, 1 is reserved for positive outcomes, 2 for pending status and 3 for negative outcomes.
{ "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": { "Decision": "Reject", "DecisionText": "The Sales Value requested is greater than Creditsafe's recommended credit limit.", "Audits": [ … ], "statusCode": 3 }, "decisionDate": "2019-08-24T14:15:22Z", "originationId": "SFC-1976", "status": 3, "notes": "string", "modifiedDate": "2019-08-24T14:15:22Z" }
curl -i -X PATCH \
'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decisionEngine/usageLog/{decisionLogId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json'The unique identifier of the decision tree.
The unique identifier for the user's account, used across the Creditsafe product suite.
The connectId of the company that the decision was ran on. A connectId is the primary Company identifier that is used to uniquely identify all companies across Creditsafe's Universe and Partner Network.
The name of the company that the decision was ran on.
Displays the optional text passed through to be stored against the decision in the original call to /{provenirId}. Typically used for internal identifiers (e.g. SalesForce IDs).
The status of the decision. typically, 1 is reserved for positive outcomes, 2 for pending status and 3 for negative outcomes.
{ "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": { "Decision": "Reject", "DecisionText": "The Sales Value requested is greater than Creditsafe's recommended credit limit.", "Audits": [ … ], "statusCode": 3 }, "decisionDate": "2019-08-24T14:15:22Z", "originationId": "SFC-1976", "status": 3, "notes": "string", "modifiedDate": "2019-08-24T14:15:22Z" }