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.
Endpoint to search for Companies according to the provided Search Criteria. To get the most relevant results, it is recommended to use a unique identifier such as regNo where available. If a unique identifier is not available, use a combination of the companies registered postCode and name for the next best hit rate.
comma-separated list of iso-2 country codes.
The code PLC can be used here to search for companies of this type across all countries.
Only used for Countries where more than one Company Name exists for different languages e.g. Japanese Kanji and English.
Country - Languages Available
Japan [JP] - EN & JA
connectId - The primary Company identifier that is used to uniquely identify all companies across Creditsafe's Universe and Partner Network. This is returned on all Company Search Results. Use this field to use in other operations such as Ordering Company Credit Report by Id, and Adding Company to Monitoring Portfolio.
Local Company Identifier - The Company identifier associated with it's Domestic Filing Agency. i.e. French SIREN/SIRET, United Kingdom Companies House CRN.
Trade Name of the Company, typically used in Countries where Name is not uniquely registered.
A (non-unique) identifier to look for Companies by their more commonly known acronym rather than their lesser known full name. Acronym is predominantly available on French Companies.
Provide as true to find Companies matching a Name exactly.
A list of countries this is available at Here.
Address part identifier - Postcode/Zip Code of the Company. Can be provided partially to extend to a region with a * as a wildcard. I.e. CF* can represent all postcodes starting with CF.
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.
High-level status. Values include "Active", "NonActive", "Pending" and "Other". Note - “Pending” indicates that the entity has entered into a legal process such as insolvency or liquidation, and “Other” indicates an unknown status.
NonLtdNonReg is only available for countries in Norway.
curl -i -X GET \
'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/connect-api-full/connectapi/companies?acronym=string&address=string&city=string&countries=GB%2CFR&customData=string&exact=true&houseNo=string&name=string&officeType=registered&page=1&pageSize=0&phoneNo=string&postCode=string&province=string®No=string&safeNo=string&status=Active&tradeName=string&type=NotSet&vatNo=string&website=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "correlationId": "string", "messages": [ { … } ], "totalSize": 0, "companies": [ { … } ] }
Report Language - The JSON structure of the Report is language invariant, but field content will return as the given language, where available.
Optional parameter to request a Templated Company Report. A Template adds/reduces sections of the Credit Report depending on your subscription. Do not include this parameter if you have not been given a template to use.
Connect Report Templates
Optional parameter to include the indicator scores in to a company report -fsi = Financial Strength , pbi = Payment Behaviour Indicator, eti = Estimated Turnover, pei = Payment Expectation Indicator
Addition information on indicator acronyms can be found HERE.
Addition information on understanding indicators can be found HERE.
Additional Report Parameters e.g. German Report Reason Code value is de_reason_code::1 . Use /reportcustomdata/{country} endpoint to see all values.
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/connect-api-full/connectapi/companies/GB-0-03836192?customData=string&includeIndicators=false&language=en&template=full' \
-H 'Accept: application/json+pdf' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "correlationId": "string", "failedSections": [ "CompanySummary" ], "report": { "companyId": "string", "language": "OM", "companySummary": { … }, "companyIdentification": { … }, "creditScore": { … }, "contactInformation": { … }, "indicators": [ … ], "shareCapitalStructure": { … }, "directors": { … }, "directorships": { … }, "otherInformation": { … }, "groupStructure": { … }, "extendedGroupStructure": [ … ], "financialStatements": [ … ], "localFinancialStatements": [ … ], "negativeInformation": {}, "additionalInformation": {}, "directorsExtra": {}, "extendedGroupStructureExtra": {}, "paymentData": {}, "paymentDataExtra": {}, "alternateSummary": {}, "negativeInformationExtra": {}, "exceptions": [ … ] }, "companyId": "string", "dateOfOrder": "2019-08-24T14:15:22Z", "language": "string", "userId": 0 }
Supply all company search criteria to find potential company matches ranked by a single score. - See here for more information.
There are 3 main score bands to use for a successful response.
- Use score 898 for a 'good' match on 'name'.
- Use score 899 for a 'good' match on 'name' and 'ok' response on an address component.
- Use scores between 900 - 999 for use on the other searches adjusting for level of 'match' response.
Local Company Identifier - The Company identifier associated with it's Domestic Filing Agency. i.e. French SIREN/SIRET, United Kingdom Companies House CRN.
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/connect-api-full/connectapi/companies/match?city=string&country=GB&houseNo=string&matchThreshold=905&name=string&phoneNo=string&postCode=string&province=string&reference1=free%20text%201&reference2=free%20text%202&reference3=free%20text%203®No=string&state=string&vatNo=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "totalMatches": 0, "matchedCompanies": [ { … } ] }
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.