Connect API Catalog
/
Credit and Risk
/
API Documentation
/
Schema Structure
/
People/Director Search Criteria

Credit and Risk (1.0.0)

Download OpenAPI description
creditAndRisk.json
creditAndRisk.yaml
Languages
Servers
Mock server
https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/
Sandbox server
https://connect.sandbox.creditsafe.com/v1/
Production server
https://connect.creditsafe.com/v1/

Authentication

Endpoints to authenticate and generate an Authentication Token.

Operations

Schema Structure

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.

Operations

Company Search Criteria

Request

Returns the set of available Company Search parameters/fields for a provided list of countries.

Query
countriesstringrequired

A comma separated list of ISO/Alpha 2 format country codes, or singular country Code. e.g. US,GB will return the common searchable Company fields in the United States and Great Britain.

curl -i -X GET \
  'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/companies/searchcriteria?countries=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful

Bodyapplication/json
correlationIdstring

A unique ID assigned to this request.

countriesArray of strings(CreditsafeGlobalDataCountryCode)
Items Enum"AF""AX""AL""DZ""AS""AD""AO""AI""AQ""AG"
languagesArray of strings

Available languages to perform a company search in the country queried

criteriaSetsArray of objects(CreditsafeGlobalDataSearchCriteriaSchema)
Response
application/json
{
  "correlationId": "string",
  "countries": [
    "AF"
  ],
  "languages": [
    "string"
  ],
  "criteriaSets": [
    { … }
  ]
}

People/Director Search Criteria

Request

Returns the set of available People Search parameters/fields for a provided list of countries.

Query
countriesstring

A comma separated list of ISO/Alpha 2 format country codes, or singular country Code. e.g. US,GB will return the common searchable People/Director fields in the United States and Great Britain.

curl -i -X GET \
  'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/people/searchcriteria?countries=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
messagesArray of objects(CreditsafeGlobalDataMessage)

Provides information about the request and the response.

countriesCriteriaArray of objects(CreditsafeGlobalDataSearchCriteriaSchemaCountryDirector)

The list of available parameters for the search in the given country.

customDataArray of objects(CreditsafeGlobalDataCustomDataEntrySchema)
Response
application/json
{
  "messages": [
    { … }
  ],
  "countriesCriteria": [
    { … }
  ],
  "customData": [
    { … }
  ]
}

Report Schema Structure Per Country

Request

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.

Path
countryCodestringrequired

ISO2 / Alpha 2 Country Code

Query
sectionstring

Use CompanyReportResponse for the Company Credit Report JSON schema.
Use DirectorReportResponse for the Director Report JSON schema.

Enum"CompanyReportResponse""DirectorReportResponse"
templatestring

For Templated Company Report JSON Schemas

curl -i -X GET \
  'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/companies/schema/{countryCode}?section=CompanyReportResponse&template=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
object
Response
application/json
{}

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.

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/{id} endpoint, and use the directors section in the 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