Configuring BREX the kompany API

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

  • Company filings retrieval
  • Company registry check

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.

If you have a direct agreement with BREX the kompany API, 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.

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

Field name

Description

Notes

Portal: Country of incorporation

API:metadata.country_of_incorporation

The country in which the company is incorporated.

Required

Portal: Company number

API:metadata.number

The company’s registration number.

Required

To purchase a document, the check variant uses the following field:

API field name

Description

Note

source_id

The ID of the document to purchase.

Required

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.

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

Field name

Description

Notes

Portal: Country of incorporation

API:metadata.country_of_incorporation

The country in which the company is incorporated.

Required

Portal: Company number

API:metadata.number

The company’s registration number.

Required


How did we do?