Endpoints to authenticate and generate an Authentication Token.
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.
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.
curl -i -X GET \
'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/people?callRef=string&countries=GB%2CFR&dateOfBirth=string&firstName=string&lastName=string&localDirectorNumber=string&page=1&pageSize=0&peopleId=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "messages": [ { … } ], "correlationId": "string", "directors": [ { … } ], "totalSize": 0 }
Report Language - The JSON structure of the Report is language invariant, but field content will return as the given language, where available.
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.
curl -i -X GET \
'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/people/{peopleId}?callRef=string&language=en' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "messages": [ { … } ], "report": { "directorId": "string", "directorSummary": { … }, "directorDetails": { … }, "otherAddresses": [ … ], "directorships": { … } } }
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.
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.