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.
Fetches the available criteria for a specified report type.
This endpoint is a prerequisite for creating a report and provides the valid fields that can populate the criteria property in the POST /reports request.
Use this to retrieve a list of valid fields for the report type before proceeding with report creation.
curl -i -X GET \
'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/connect-api-full/connectapi/compliance/kyc-protect/reports/criteria/{type}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "fromDate": { "isRequired": true, "type": "string", "format": "yyyy-mm-dd", "description": "Cannot be a future date", "acceptableValues": null }, "toDate": { "isRequired": true, "type": "string", "format": "yyyy-mm-dd", "description": "Should fall after fromDate, results will be fetched excluding the provided to date", "acceptableValues": null }, "hitDecisions": { "isRequired": false, "type": "array[string]", "format": null, "description": "Decisions made on hits. Multiple values are acceptable", "acceptableValues": [ … ] }, "hasHits": { "isRequired": false, "type": "boolean", "format": null, "description": "Indicates if there are any hits.", "acceptableValues": [ … ] } }
Uses the user-provided information to create a compliance report.
The criteria property in the request body must be populated using the fields returned by the GET /criteria/{type} endpoint.
Ensure you first retrieve the criteria for the desired report type using the GET /criteria/{type} endpoint before making this request.
Request body containing the report type, file name, and criteria details for creating a compliance report.
The criteria field must adhere to the schema provided by the GET /criteria/{type} endpoint.
curl -i -X POST \
https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/connect-api-full/connectapi/compliance/kyc-protect/reports \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"type": "string",
"fileName": "string",
"criteria": {
"additionalProperties": {}
}
}'Success
Current processing status of the report. Indicates the lifecycle stage, such as:
- submitted: The report request has been submitted.
- queued: The report is waiting to be processed.
- inProgress: The report is currently being generated.
- completed: The report has been successfully created.
- failed: The report generation encountered an error.
Type of the report, determining the data and format of the results. Supported values:
- amlAlert: Report for Anti-Money Laundering alerts.
- audit: Report for audit-related compliance checks.
The unique identifier of the user who initiated the creation of the report.
The timestamp of the last modification made to the report, if applicable.
The criteria used to generate the report, reflecting the filters and parameters applied during its creation.
The structure of the criteria object depends on the report type (amlAlert or audit). Some properties may be nested in arrays or objects.
The expiration timestamp for the report, after which it may no longer be accessible.
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "fileName": "string", "status": "submitted", "type": "amlAlert", "createdAt": "2019-08-24T14:15:22Z", "createdById": 0, "createdByUser": "string", "modifiedAt": "2019-08-24T14:15:22Z", "criteria": { "fromDate": "2019-08-24", "toDate": "2019-08-24", "property1": {}, "property2": {} }, "expiresAt": "2019-08-24T14:15:22Z", "correlationId": "string" }
Fetches the details of a single compliance report identified by its unique reportId.
This endpoint allows users to retrieve the full metadata and status of a specific report, including its creation details, criteria, and expiration timeline.
Use this endpoint to inspect or verify the information of an existing report, or to confirm its current status (e.g., inProgress, completed, failed).
Ensure that the reportId provided corresponds to an existing report in the system.
curl -i -X GET \
'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/connect-api-full/connectapi/compliance/kyc-protect/reports/{reportId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Success
Current processing status of the report. Indicates the lifecycle stage, such as:
- submitted: The report request has been submitted.
- queued: The report is waiting to be processed.
- inProgress: The report is currently being generated.
- completed: The report has been successfully created.
- failed: The report generation encountered an error.
Type of the report, determining the data and format of the results. Supported values:
- amlAlert: Report for Anti-Money Laundering alerts.
- audit: Report for audit-related compliance checks.
The unique identifier of the user who initiated the creation of the report.
The timestamp of the last modification made to the report, if applicable.
The criteria used to generate the report, reflecting the filters and parameters applied during its creation.
The structure of the criteria object depends on the report type (amlAlert or audit). Some properties may be nested in arrays or objects.
The expiration timestamp for the report, after which it may no longer be accessible.
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "fileName": "string", "status": "submitted", "type": "amlAlert", "createdAt": "2019-08-24T14:15:22Z", "createdById": 0, "createdByUser": "string", "modifiedAt": "2019-08-24T14:15:22Z", "criteria": { "fromDate": "2019-08-24", "toDate": "2019-08-24", "property1": {}, "property2": {} }, "expiresAt": "2019-08-24T14:15:22Z", "correlationId": "string" }