All categories ​ > ​ ​Configuration ​ > ​ ​Checks and data providers ​ > ​   Configuring BREX the kompany API

Configuring BREX the kompany API

Updated 3 months ago by Ainsley

BREX the kompany API is a data provider you can use to run these checks:

  • Company data check
  • Company filings retrieval
  • Company registry check

Company data check

How it works

BREX the kompany API does not return shareholder information and cannot be used for the Identify shareholders task. If you're using a check variant with BREX configured as the data provider, a message is always displayed on the Identify shareholders task saying, "No shareholders found in check result".

This is the default behaviour for a variant of the Company data check with BREX the kompany 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 BREX the kompany 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 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 imported information is displayed differently for the Identify officers task and the Verify company details 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:

  1. Any of the required profile data is missing.
  2. Any of the profile data does not match.
  3. The company status is inactive.
  4. The company status is unknown.
See Required and optional profile fields to learn which profile fields are required.

If the company name cannot be found, the check fails.

An error is returned if any of the following is true:

  • BREX the kompany API discovers more than one company that matches the profile details.
  • The company's country of incorporation isn't covered by the agreement with BREX the kompany API.
Contact your BREX account manager to learn which countries your agreement covers.

Configuration options

There are no additional configuration options for the Company data check variant with BREX the kompany API.

However, this check is used on the Identify officers task, which includes configuration options to control how the officers returned by BREX the kompany API are verified. Learn about task configuration options.

What we'll need

Let us know that you’d like to run this check with BREX the kompany API and we’ll set it up. If you’d like to use any of the configuration options for the Identify officers task, please let us know which ones you’d like to use.

We’ll also need your API key for BREX. For help getting your API key, please speak to your BREX 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.

  1. Is company information returned from BREX the kompany API? Create a company profile for a company called "GENERAL MOTORS EUROPE LIMITED" and run the check variant. If the check passes and data for General Motors Europe Ltd is displayed in the check results, the check variant is working as expected.
  2. Is a Partial match returned when the company name is found in the BREX the kompany API's sources but the profile data does not match? Create any company profile and run the check variant. If the check returns a partial match on the Verify company details task and data for General Motors Europe Ltd is displayed in the results, the check variant is working as expected.
To run the first test, "GENERAL MOTORS EUROPE LIMITED" must be in capital letters.

Required and optional profile fields

These are the profile details searched in the BREX the kompany 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

The state, province, or territory of the address.

The format follows the state code of the ISO-3166-2 standard.

Note that a UK county should not go here.

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.

Company filings retrieval

How it works

This is the default behaviour for a variant of the Company filings retrieval check with BREX the kompany API as the data provider.

The check is performed by searching the company’s country of incorporation and registration number in the registry for the jurisdiction in which the company is incorporated.

The check passes when any documents are found in the registry.

When the check passes:

  • The names of the documents are displayed in the check results.
  • If the following information is available, it’s also displayed in the check results: filing date, filing type, description, and source.
  • All free documents are imported so you can see them.
  • All paid documents have the cost displayed and the option to purchase them. Once a document is purchased, it's imported so you can see it.

If the company’s country of incorporation isn’t covered by BREX the kompany API, an error is displayed.

Configuration options

There are no additional configuration options for the Company filings retrieval check variant with BREX the kompany API.

What we’ll need

Let us know that you’d like to add a Company filings retrieval check variant with BREX the kompany API and we’ll set it up.

We’ll also need your API key. For help getting your API key, please speak to your BREX 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.

  • Are company filings returned from BREX the kompany API? Create any company profile and run the check variant. If the check passes and live data is returned in the check results, the check variant is working as expected.
In the live environment, an error is displayed when the check variant is run on a profile with a country of address that isn't covered by BREX the kompany API. This error is not displayed in the demo environment.

Required and optional profile fields

These are the profile details searched in BREX the kompany API’s sources:

Name

Description

Country of incorporation (metadata.country_of_incorporation)

Required

The country in which the company is incorporated.

Company number (metadata.number)

Required

The company’s registration number.

To purchase a document, the check variant also uses the following key:

Name

Description

source_id

Required

The ID of the document to purchase.

Company registry check

How it works

This is the default behaviour for a variant of the Company registry check with BREX the kompany API as the data provider.

The check is performed by searching the company’s country of incorporation and registration number in the registry for the jurisdiction in which the company is incorporated.

The check passes when all of the following are true:

  1. The company name is found in the registry.
  2. The company status in the registry is active.
  3. The company number and country of incorporation from the company’s profile match the data found in the registry.

When the check passes, the basic company information (e.g. name, company number, incorporation date) as well as a list of all the company officers found in the registry is imported into the check results.

If the company name is found, but any of the other data is missing or does not match, the check returns a Partial match.

If the company name cannot be found, the check fails.

If the company’s country of incorporation isn’t covered by BREX the kompany API, an error is displayed.

Configuration options

There are no additional configuration options for the Company registry check variant with BREX the kompany API.

However, this check can be used on the Identify officers task, which includes configuration options to control how the officers returned by BREX the kompany API are verified. Learn more about task configuration options.

What we’ll need

Let us know that you’d like to add a Company registry check variant with BREX the kompany API and we’ll set it up. If you’d like to use any of the configuration options for the Identify officers task, please let us know which ones you’d like to use.

We’ll also need your API key for BREX. For help getting your API key, please speak to your BREX account manager.

Using your configuration

We're currently building the tests for this variant.

Required and optional profile fields

These are the profile details searched in BREX the kompany API’s sources:

Name

Description

Country of incorporation (metadata.country_of_incorporation)

Required

The country in which the company is incorporated.

Company number (metadata.number)

Required

The company’s registration number.

How did we do?

Powered by HelpDocs (opens in a new tab)