Endpoints for user authentication into the Connect API.
Creditsafe Connect (1.10.9)
This is the full Connect API and contains all available endpoints. For additional information, integration processes, and supplementary documentation, please use the targeted product
The Creditsafe Connect API is a REST API that provides access to the Creditsafe Global Company Database (opens in new tab). This allows you to:
- Control your master data
- Utilize up-to-date Business and Director information, enhancing your onboarding and qualification processes
- Receive alerts when your customer's and supplier's Credit Report changes
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.
Download OpenAPI description
Languages
Servers
Sandbox server
https://connect.sandbox.creditsafe.com/v1/
Production server
https://connect.creditsafe.com/v1/
- Sandbox server
https://connect.sandbox.creditsafe.com/v1/compliance/countryRisk/{countryCode}
- Production server
https://connect.creditsafe.com/v1/compliance/countryRisk/{countryCode}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://connect.sandbox.creditsafe.com/v1/compliance/countryRisk/{countryCode}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Country risk response for the requested country.
Correlation ID for request tracing.
Example: "f563b6bc-549f-4d4a-95bc-c658b407bd2f"
Country identity and regional metadata.
Example: {"countryCodeIso3":"MAF","countryCodeIso2":"MF","countryName":"Saint Martin (French part)","region":"Americas"}
Country risk indicators returned by the service. Nullable indicator fields are included in the schema model, but may be omitted from runtime responses when no value is available.
Example: {"oecdMember":false,"worldBankClassification":"High income","countryRiskIndicatorAml":{"countryRank":154,"countryUniverse":249,"dataQualityCategorical":"Poor","dataQualityNumeric":2,"euHighRiskFlag":false,"fatfHighRisk":false,"fatfIncreasedMonitoring":false,"riskClassificationCategorical":"High","riskClassificationNumeric":4,"score":42.86},"countryRiskIndicatorEsg":{"dataQualityCategorical":"Very Poor","countryUniverse":186,"dataQualityNumeric":1,"riskClassificationCategorical":null,"score":null,"countryRank":null,"riskClassificationNumeric":null},"countryRiskIndicatorSovereign":{"dataQualityCategorical":"Very Poor","dataQualityNumeric":1,"countryUniverse":184,"riskClassificationCategorical":null,"score":null,"countryRank":null,"riskClassificationNumeric":null},"countryRiskIndicatorSupplyChainRisk":{"dataQualityCategorical":"Very Poor","riskClassificationCategorical":"Very Low","score":12.63,"countryRank":18,"countryUniverse":233,"dataQualityNumeric":1,"riskClassificationNumeric":1}}
The World Bank classification of the country.
Example: "High income"
Contains AML (Anti-Money Laundering) risk metrics for the country. Includes the AML risk score (0–100), categorical risk classification, global ranking, and data‑quality indicators. Values reflect inherent AML exposure and the strength of regulatory and enforcement frameworks.
Scores and rankings are provided only where sufficient underlying AML data is available.
Example: {"countryRank":154,"countryUniverse":249,"dataQualityCategorical":"Poor","dataQualityNumeric":2,"euHighRiskFlag":false,"fatfHighRisk":false,"fatfIncreasedMonitoring":false,"riskClassificationCategorical":"High","riskClassificationNumeric":4,"score":42.86}
Contains ESG (Environmental, Social, and Governance) risk metrics for the country. Includes ESG score, categorical risk classification, global ranking, and data‑quality indicators.
Scores and rankings are provided only where sufficient underlying ESG data is available.
Example: {"dataQualityCategorical":"Very Poor","countryUniverse":186,"dataQualityNumeric":1,"riskClassificationCategorical":null,"score":null,"countryRank":null,"riskClassificationNumeric":null}
Contains sovereign‑risk metrics assessing a country’s economic and financial stability and its ability to meet debt obligations. Includes sovereign risk score, categorical classification, global ranking, and data‑quality measures.
Scores and rankings are provided only where sufficient underlying sovereign data is available.
Example: {"dataQualityCategorical":"Very Poor","dataQualityNumeric":1,"countryUniverse":184,"riskClassificationCategorical":null,"score":null,"countryRank":null,"riskClassificationNumeric":null}
Contains supply‑chain‑related country‑risk metrics, including the overall supply chain risk score, categorical classification, global ranking, and data‑quality indicators. The score reflects exposure to vulnerabilities such as governance, environmental conditions, and labour‑related risks.
Scores and rankings are provided only where sufficient underlying supply chain data is available.
Example: {"dataQualityCategorical":"Very Poor","riskClassificationCategorical":"Very Low","score":12.63,"countryRank":18,"countryUniverse":233,"dataQualityNumeric":1,"riskClassificationNumeric":1}
Response
application/json
{ "correlationId": "f563b6bc-549f-4d4a-95bc-c658b407bd2f", "country": { "countryCodeIso3": "MAF", "countryCodeIso2": "MF", "countryName": "Saint Martin (French part)", "region": "Americas" }, "risk": { "oecdMember": false, "worldBankClassification": "High income", "countryRiskIndicatorAml": { … }, "countryRiskIndicatorEsg": { … }, "countryRiskIndicatorSovereign": { … }, "countryRiskIndicatorSupplyChainRisk": { … } } }
Search And Report Schemas/Criteria
Endpoints to retrieve the structure of the Company and Director Search Criteria, Report Schemas, and available Report Languages for a specific country.
These endpoints provide the necessary information to validate responses, understand search parameters, and determine localization options for reports.
Operations
Companies
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.
Order a Company Credit Report
Operations
People/Directors
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 Report Endpoint, and use the directors section in the report response.
Operations
Images
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.
Operations
Fresh Investigations
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.
Operations
Verify
Verify is an exclusive add-on to Creditsafe's company credit reports, designed to assist businesses in making smarter, quicker, and more informed credit decisions. For new or small companies that lack a detailed financial footprint, Verify offers unparalleled insights by screening company directors and the individuals behind businesses for their personal financial stability and identity.
Using Verify, you can confidently assess a company's leadership, using trusted public datasets that highlight potential financial concerns, such as CCJs or Insolvencies and confirm that they reside at an address on the Electoral roll.
Operations