Configuring Creditsafe Company Data API

Updated 5 days ago by Ainsley

How it works
Configuration options
What we'll need
Testing your configuration
Required and optional profile fields

Creditsafe Company Data API is a data provider that you can use to run the Company data check.

How it works

This is the default behaviour for a variant of the Company data check with Creditsafe Company Data API as the data provider.

The check is performed by sending the company's name, country of incorporation, state of incorporation (US and Canada only), and company number to Creditsafe Company Data API and requesting a report.

The check passes when all of the following are true:

The company name is found in the registry.
The company status in the registry is active.
The company has any financial data.
The company number and country of incorporation from the profile match the data in the registry.

When the check passes, the basic company information is imported into the check results. The information is displayed differently for each task. See the description of the Company data check for more information.

The check returns a partial match when the company name is found in the registry but one of the following is true:

Any of the required profile data is missing.
Any of the profile data does not match.
The company does not have any financial data.
The company status is inactive.
The company status is unknown.

See Required and optional profile fields to learn which profile fields are required.

The check fails if the company name cannot be found.

An error is displayed when the company's country of incorporation isn't covered by the Creditsafe Company Data API agreement.

If you have a direct agreement with Creditsafe Company Data API, contact your Creditsafe Company Data API account manager to learn what countries your agreement covers. If you have a reseller agreement, contact us to learn what countries are covered.

If multiple results are discovered for the same company, they're ordered by the best match for the name.

The Company data check only displays results on the Assess Financials task when the company is located in the UK. If the check is run on a company outside the UK, a partial match is always returned with a message saying, "No financial data available". If you would like to use this check on countries outside the UK, select the Pass check with missing financial data configuration option.

Configuration options

You have the following configuration option:

Pass check with missing financial data: When this option is selected, the check passes if the company does not have financial data, as long as the other pass requirements are met.

However, this check is used on the Identify officers and Identify shareholders tasks, which include configuration options to control how the officers and shareholders returned by Creditsafe Company Data API are verified. Learn about task configuration options.

What we'll need

Let us know that you'd like to add a variant of the Company data check with Creditsafe Company Data API and we'll set it up.

If you'd like to use any of the configuration options for the Identify officers or Identify shareholders tasks, please let us know which ones you'd like to use.

If you have a direct agreement with Creditsafe Company Data API, we'll also need your Creditsafe Company Data API username and password. For help getting your username and password, please speak to your Creditsafe Company Data API account manager.

Testing your configuration

Once the check variant is configured, follow these steps in your demo environment to test whether it's working as expected.

Is company information returned from Creditsafe Company Data API? Create any company profile and run the check variant. If the check passes and data for PassFort Ltd is displayed in the check results, the check variant is working as expected.
Is a Partial match returned when the company name is found in Creditsafe Company Data API's sources but the profile data does not match? Create a company profile with "partial" in the name and run the check variant. If the check returns a partial match and an incorrect company number for PassFort Ltd is displayed in the results, the check variant is working as expected.
What happens if the company does not have any financial data? To run this test with the API, create a company profile with "PassFort Limited" as the company name, "09565115" as the company number, and "partial_financial" as the Creditsafe ID. Run the check. If you're not using the Pass check with missing financial data configuration option, the check variant is working as expected if the check returns a partial match. If you are using the Pass check with missing financial data configuration option, the check variant is working as expected if the check passes.
Does the check fail when the company name cannot be found in Creditsafe Company Data API's sources? Create a company profile with "fail" in the name and run the check variant. If the check fails and no results are returned, the check variant is working as expected.

The company name and number autofill feature that's displayed when you create a company profile via the portal displays demo data in the demo environment. Real data will be displayed in the live environment.

Test words are not case sensitive.

Required and optional profile fields

These are the profile details searched in Creditsafe Company Data API's sources:

Name	Description
Country of incorporation (`metadata.country_of_incorporation`) Required	The country in which the company is incorporated.
State of incorporation (`metadata.state_of_incorporation`) Optional (US and Canada only)	The state, province, or territory in which the company is incorporated.
Company name (`metadata.name`) Required If not included, a Partial match is returned	The legal name of the company.
Company number (`metadata.number`) Required	The company’s registration number.