# Credit and Risk The Credit and Risk API provides access to a comprehensive suite of endpoints designed to deliver critical business insights. This API enables users to authenticate, search for companies and directors, retrieve detailed credit and risk reports, access official company filing documents, and manage fresh investigation requests for companies not available in the instant database. Version: 1.0.0 Metadata: - tags: ["Featured"] ## Servers Sandbox server ``` https://connect.sandbox.creditsafe.com/v1 ``` Production server ``` https://connect.creditsafe.com/v1 ``` ## Security ### bearerToken This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the `Authorization` header of each request. Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description [Credit and Risk](https://doc.creditsafe.com/_spec/connect-apis-catalog/product-catalog/Credit&Risk/creditAndRisk.yaml) ## Authentication Endpoints to authenticate and generate an Authentication Token. ### Authenticate - [POST /authenticate](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/authentication/authenticate.md): Supply username and password to generate Authentication Token. ## 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. ### Return Languages Available For Company Reports For Selected Country - [GET /access/countries/{countryCode}/reportLanguages](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/search-and-report-schemascriteria/useraccessreportlanguages.md): Endpoint which returns available languages for a report. The JSON structure of the report is language invariant, but field content will return in the selected language where available. > Note: The availability of field content in a specific language depends on the data source. If certain properties in the report are not available in the chosen language, they will default to English. As a result, only a certain percentage of the report may appear in the selected language. ### Company Search Criteria - [GET /companies/searchcriteria](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/search-and-report-schemascriteria/companysearchcriteria.md): Returns the set of available Company Search parameters/fields for a provided list of countries. ### People/Director Search Criteria - [GET /people/searchcriteria](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/search-and-report-schemascriteria/people/directorsearchcriteria.md): Returns the set of available People Search parameters/fields for a provided list of countries. ### Report Schema Structure Per Country - [GET /companies/schema/{countryCode}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/search-and-report-schemascriteria/reportschema.md): Returns the Company Report JSON schema of the provided country. Largely redundant as the Company Report 200 response is defined as a superset of all country's JSON schemas and can be used for any country. ## 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. ### Company Search - [GET /companies](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/companies/companysearch.md): 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 where available. If a unique identifier is not available, use a combination of the companies registered and for the next best hit rate. ### Company Credit Report - [GET /companies/{connectId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/companies/companycreditreport.md): Orders a Company Credit Report by connectId. To acquire a PDF version of the report use the optional request in 'Header'. This request will provide a 'Base64-encoded' script to convert to a PDF, this will appear at the end of the JSON response. ### Confidence Match Search - [GET /companies/match](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/companies/confidencematchsearch.md): Supply all company search criteria to find potential company matches ranked by a . - See here for more information. ## 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/{id}` endpoint, and use the `directors` section in the response.

### Director Search - [GET /people](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/peopledirectors/directorssearch.md): Endpoint to find Directors based on search criteria to order a Creditsafe Director Report. ### Director Report - [GET /people/{peopleId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/peopledirectors/directorreport.md): Returns a report from the ID supplied to the search. ## 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.
### Company Image Documents - [GET /images/companies](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/images/companyimagedocuments.md): Returns the available Images for a given Company connectId. ### Image Document Category Types - [GET /images/companies/types](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/images/imagedocumentcategorytypes.md): Lists available Image Document formats, types and languages per country. ### Company Image - [GET /images/{imageId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/images/companyimage.md): Endpoint to order an Image Document by Image ID. ## 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. ### Create Fresh Investigation - [POST /freshinvestigations](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/createfreshinvestigation.md): Places an order for a Fresh Investigation (Offline Report). Providing as much detail as possible about the Company, our team will use official sources and registries to quickly answer questions about a company's stability and financial health. Fresh Investigations take 5.5 days on average to complete. By adding to the request, you are allowing Creditsafe to disclose your company details to the company you have requested the Investigation against, to be used only in the aim of improving our Investigation report. ### Get Fresh Investigations - [GET /freshinvestigations](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/getfreshinvestigations.md): Returns a list of your submitted Fresh Investigation Orders. ### Retrieve FreshInvestigation Order - [GET /freshinvestigations/{orderId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/retrievefreshinvestigationorder.md): Returns a specific Fresh Investigation order. ### Delete Fresh Investigations - [DELETE /freshinvestigations/{orderId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/deletefreshinvestigations.md): Deletes specified investigations. ### Update FreshInvestigation Report Content - [PATCH /freshinvestigations/{orderId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/updatefreshinvestigationreportcontent.md): Update the Fresh Investigation Report data for a specific order, after the order has a status of delivered. ### Upload attachments for fresh investigation orderId - [POST /freshinvestigations/{orderId}/attachments](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/uploadattachmentsforfreshinvestigationorderid.md): Returns the status of attachment upload for the particular order. ### Get attachments for the given fresh investigation orderId - [GET /freshinvestigations/{orderId}/attachments](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/getattachmentsforthegivenfreshinvestigationorderid.md): Returns attachments available for that particular order. ### Get attachment for the given fresh investigation attachment Id - [GET /freshinvestigations/{orderId}/attachments/{id}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/getattachmentforthegivenfreshinvestigationattachmentid.md): Retrieve attachment for the given attachmentId. ### Comments for fresh investigation orderId - [POST /freshinvestigations/{orderId}/comments](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/commentsforfreshinvestigationorderid.md): Returns the status of comments for the particular order. ### Retrieve comments of specified FreshInvestigation Report - [GET /freshinvestigations/{orderId}/comments](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/retrievecommentsofspecifiedfreshinvestigationreport.md): Returns the Fresh Investigation Report comments for a specific order. ### Retrieve FreshInvestigation Report Content - [GET /freshinvestigations/{orderId}/report](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/fresh-investigations/retrievefreshinvestigationreportcontent.md): Returns the Fresh Investigation Report data for a specific order, after the order has a status of delivered.