Please wait while we set up your BREX account.

 
 
Solution

Power your compliance processes

The BREX API enables you to fully automate the retrieval of company data from commercial registers worldwide for your KYC, AML and enhanced due diligence (EDD) processes. Or to prefill your internal CRM or ERP system with company vitals to ensure up to date and correct information in your supplier or customer databases.

It provides instant access to:

  • Official Commercial Registers
  • Shareholder Information
  • Company Filings
  • Annual & Financial Accounts
Flow diagram

With only one lightweight RESTful API to worry about, integration is easy and cost-efficient.

Examples of use cases include:


Shake

Client or supplier onboarding: automated retrieval of company vitals and commercial register extracts enable a rapid business verification based on the official source data. E.g. pre-fill register number, company name, address, status, managing director, etc based on the data filed with the commercial register.

Monitor

Regulatory required compliance checks: automated regular checks of the complete customer base including access to lodged financials to comply with regulatory stress tests and to remediate business partner data stored in the internal systems.

Group

Payment merchant verification: payment providers need to verify merchants before providing access to their platforms to them. Automation of this process can significantly cut the time required for merchant verification and onboarding and ensure that no losses are occurred as a result of missed transactions.

Cog

Customized solutions: for specific customer requirements or inhouse applications, we also offer customized solutions to improve efficiency or add value to workflows or processes. For more information contact support@brex.io

Globe

Worldwide Coverage

We cover over 80+ countries and jurisdictions today. Furthermore, we offer a concierge service through which we provide additional commercial register information on companies for a total of 115 jurisdictions quickly and efficiently.

coverage map
Claudia

If you have any questions, please do let us know - we can clarify any points and are always happy to work with you to find a proposal to meet your requirements. Contact with us at support@brex.io

Claudia Prkna (Solutions Specialist)

Choose your BREX API Plan

1. Choose your plan

If you feel ready to get started you can register for a FREE sandbox account straight away. Alternatively, choose from one of the plans below.

For individual solutions please connect with us at support@brex.io.

€ 100 per month

Traffic volume

Maximum Calls

1,000 per day

Maximum Calls per Minute

60

Call Results per Country

Unlimited

structured data sets

Product Availability

Included
€0.25 per set
€0.50 per set
€0.20 each

Format

JSON, XML

Interface

RESTful

Authoritative extracts

* Government Fee + Service Charge

€2 per extract

Format

PDF, TIFF

Credit Reports

Please contact us

Services

PEP Lists

No

Sanctions Lists

No

Professional Document Translation

No

Push Notifications

No

Push Notifications Full Content

No

Reporting

Included

minimum term

None, Maximum 3 months
€ 500 per month

Traffic volume

Maximum Calls

2,500 per day

Maximum Calls per Minute

60

Call Results per Country

Unlimited

structured data sets

Product Availability

Included
2,000 sets included
500 sets included
€0.10 each

Format

JSON, XML

Interface

RESTful

Authoritative extracts

* Government Fee + Service Charge

€2 per extract

Format

PDF, TIFF

Credit Reports

Please contact us

Services

PEP Lists

No

Sanction Lists

No

Professional Document Translation

No

Push Notifications

Yes

Push Notifications Full Content

No

Reporting

Included

minimum term

None, cancel at anytime
€ 1700 per month

Traffic volume

Maximum Calls

12,000 per day

Maximum Calls per Minute

300

Call Results per Country

Unlimited

structured data sets

Product Availability

Included
10,000 sets included
2,000 sets included
€0.10 each

Format

JSON, XML

Interface

RESTful

Authoritative extracts

* Government Fee + Service Charge

€ 1 per extract

Format

PDF, TIFF

Credit Reports

Please contact us

Services

PEP Lists

Please contact us

Sanction Lists

Please contact us

Professional Document Translation

Please contact us

Push Notifications

Yes

Push Notifications Full Content

No

Reporting

Included

minimum term

None, cancel at anytime
from € 35,000
12 month rolling contract

Traffic volume

Maximum Calls

up to 10,000,000 per month

Maximum Calls per Minute

Please contact us

Call Results per Country

Unlimited

structured data sets

Product Availability

Included
Please contact us
Please contact us
Please contact us

Format

JSON, XML

Interface

RESTful

Authoritative extracts

* Government Fee + Service Charge

€ 1 per extract

Format

PDF, TIFF

Credit Reports

Please contact us

Services

PEP Lists

Yes

Sanction Lists

Yes

Professional Document Translation

Yes

Push Notifications

Yes

Push Notifications Full Content

Yes

Reporting

Yes

minimum term

12 Months
€ 100 per month
Maximum 3 months
€ 500 per month
3 month rolling contract
€ 1700 per month
3 month rolling contract
from € 35,000
12 month rolling contract

Traffic volume

Maximum Calls

1,000 per day
2,500 per day
12,000 per day
up to 10,000,000 per month

Maximum Calls per Minute

60
60
300
Please contact us

Call Results per Country

Unlimited
Unlimited
Unlimited
Unlimited

structured data sets

Included
Included
Included
Included

Product Availability

Included
Included
Included
Included
€0.25 per set
2,000 sets included
10,000 sets included
Please contact us
€0.50 per set
500 sets included
2,000 sets included
Please contact us
€0.20 each
€0.10 each
€0.10 each
Please contact us

Format

JSON, XML
JSON, XML
JSON, XML
JSON, XML

Interface

RESTful
RESTful
RESTful
RESTful

Authoritative extracts

* Government Fee + Service Charge

€2 per extract
€2 per extract
€1 per extract
€1 per extract

Format

PDF, TIFF
PDF, TIFF
PDF, TIFF
PDF, TIFF

Credit Reports

Please contact us
Please contact us
Please contact us
Please contact us

Services

PEP Lists

No
No
Please contact us
Yes

Sanction Lists

No
No
Please contact us
Yes

Professional Document Translation

No
No
Please contact us
Yes

Push Notifications

No
Yes
Yes
Yes

Push Notifications Full Content

No
No
No
Yes

Reporting

Yes
Yes
Yes
Yes

minimum term

None, cancel at anytime
None, cancel at anytime
None, cancel at anytime
12 Months

Need a sandbox? Once your registration is complete we’ll provide you with instant access to test data. This is what you get:

  • 100 calls per hour – fair use 1 call per second
  • 100 Full Data sets / Test Data only
  • 100 Reports / Test Data only

Try it out for free with our sandbox

  • * For further details refer to the Product Catalogue & Country Coverage in the documention section
  • 1) Call Result: the Mini Data Set is a structured data set that contains: kompanyID, Registered Company Name, Registration Number. This Data Set is returned as default value if you have not chosen any other Data Set.
  • 2) Master Data Set is a structured data set that contains: the Mini Data Set, Company Status, Registered Address. Please note that in some countries, the registered address may only contain the city, not the full postal address. For details, refer to the BREX API Technical Documentation.
  • 3) Full Data Set is a structured data set which always contains the Master Data Set, and additionally may contain Managing Directors, Date of Incorporation, Legal Form, SIC/NACE, VAT number, and many more. For details, refer to the BREX API Technical Documentation.
  • 4) German Handelsregister announcements, structured content.

All prices in Euro and excl. 20% VAT.

Over limit consumption each called Master Data Set and Full Data set is charged per set at the prices as in Pay-As-You-Go.

4. Payment Details

Secure payment gateway

Cards
up

Contact Us

We'd love to hear from you. Fill out the form below with some info about your project.

BREX Business Register Exchange GmbH
Mariahilfer Strasse 93/2/20
A-1060 Vienna, Austria
T: +43-1-890-9930
Russell E. Perry
Managing Director
russell.perry at brex.io
Peter Bainbridge-Clayton
CTO
peter.bc at brex.io

Documentation

API Overview

Test Area


Download the BREX API Technical Documentation.

BREX API OVERVIEW

The BREX API is a lightweight RESTful webservice which can be used to search for corporate and related information, and to order and retrieve documents. Requests are sent through an HTTPS channel, the reply will be in JSON for data or PDF for report delivery – further formats may be added in future. The content and format of a response varies with the request and chosen subscription model, examples are given in the appendix.

The API is separated into logical functional groups which follow the general format of:

version/object/method/parameter1/.../parameter

It is important to note that parameter1 to parameterX may possibly include reserved URI characters, and must therefore be URL encoded to the current standard (RFC3986). Any components of the URL preceding the parameter sections will not require encoding, but will also be defined in such a way that encoding them would have no effect.

The valid 'object' values at the time of writing are:

  • company used to search for and access company data
  • product used to list, order and retrieve products

Valid 'method' values are:

  • (none) used to access an object directly by specifying a returned BREX id – e.g. a Company record or an ordered product
  • search used to return a list of objects that match the parameters following
  • availability used to check the actual availability of a product for a given company
  • buy used to order a product
  • status get the current status of an ordered product

ONLINE DOCUMENTATION

BREX Enterprise API uses a 'live' online documentation method – this allows readers to see the format of the request URLs, any parameters, the actual URLs called and the structure of the responses. It is also synchronized with the API code, so it is always correct, and even allows the API to be driven via the website, which makes testing a much simpler operation that conventional techniques. The information supplied by this live documentation can assist greatly in writing one's own interface to the BREX API. This documentation is available to anyone with an API key and can be accessed at: http://docs.brex.io/active-docs

API AUTHENTICATION (HTTP BASIC)

BREX Enterprise API uses a simple key authentication mechanism over HTTPS - this is safe because your API key is securely encrypted by the SSL channel. The easiest way to test the API is to use the online live documentation – this is a web page which allows you to test the various API methods and handles all the communications for you, whilst showing you the appropriate URLs. Brex will provide client code in php and java in due course.

When you are ready to write code to access the API, you simply pass your API key as an HTTP header called user_key. This key is used by the API to determine who you are, your access rights and your costs - keep this key secret and safe!

REGENERATING AN API KEY

Your API key can be regenerated by clicking on the Regenerate button on your dashboard page.

Note: Only one API key may be active on an account per plan at a time. If you choose to regenerate your API key, your services will not work until you’ve updated all references to your API key. There is only one API key per plan. Regenerating the key will regenerate it for all users.

API HOST

api.brex.io

ADDITIONAL HEADERS

Brex Enterprise API currently returns results only JSON. If the accept header is specified it should be application/json, but will be ignored. Including this header, however, will future proof your client code.

Accept: application/json

CONTENT-TYPE-HEADER

Brex Enterprise API currently returns results only JSON. If the content-type header is specified it should be application/json, but will be ignored. Including this header, however, will future proof your client code.

Content-Type: application/json; charset=utf-8
  Accept: application/json

If your JSON or XML request is invalid, the API will respond with a status code 400 Bad Request. This commonly occurs when ampersands are not correctly encoded in the text of your request. Please inspect the body of the response for more details regarding the error. However, please note that at the time of writing there are no API methods that correspond to a 'create' or 'update' request -therefore this is for future reference only.

HTTP STATUS CODES

Every request includes an HTTP status code with the result. The status code should examined before the response. The online documentation provides up to date status code information, however in general the response codes can be interpreted as:

  • 200–299 as success,
  • 400–499 as client request errors,
  • 500–599 as server errors

API OBJECT MODEL

The API method calls are documented in the online system, but the general object structure and sequence is as described below:

At the time of writing there are 4 basic objects – Company, Product, ProductOrder and ProductOrderNotifier.

A typical use case would be:

  • search for a Company by name or registration number – returns an array of Company objects that match API method: /company/search/name/{country code}/{name} or /company/search/name/{country code}/{registration number}
  • select the appropriate Company from the returned array and get more details – returns a populated Company object. The level of information in the object is determined by the request, but there may be pricing differences and availability differences depending on your API plan API method: /company/{company id}?dataset=mini/master/full (defaults to mini)
  • search for possible Product available for that Company – returns an array of Product objects which includes the BREX SKU API method: /product/search/{company id}
  • check the actual availability for the selected Product – returns an updated Product object with availability status and whether there are options available (e.g. accounts year) API method: /product/availability/{sku}/{company id}
  • place an order for that product – returns a ProductOrder object API method: /product/order/{sku}/{company id} or /product/order/{sku}/{option}/{company id} (where there are options available)
  • check the status of the ProductOrder object to see when it is ready. Loop here every 60 seconds until ready or the product is marked as failed for some reason API method: /product/status/{product order id}
  • retrieve the ordered product – will return a byte stream containing the product in an appropriate format as per the response content-type header API method: /product/{product order id}

Note the status checking here is done via polling. There is an alternative method by using a ProductNotifier. This allows BREX to notify the customer when a product is ready. To use a ProductNotifier, replace step (6) with the following:

  • 6 Create a ProductOrderNotifier passing in a URL which will be called using HTTP GET. Note – the callback URL MUST have any forward slashes (/) converted to tilde characters (~) API method: /product/notifier/{product order id}/GET/{callback url}
  • 6a Wait for the callback from BREX to the URL you supplied. The URL will be called with added parameters of orderId={product order id} and notifierId={the id of the product order notifier as created in step 6)

The use of a notifier does not preclude the polling method but is more efficient for everybody.

TEST AREA

Enter your API key here to test our API service.

If you don't have an API key yet don't enter anything, make sure to search for the available testdata provided in BREX API Technical Documentation on page 8.

Enter your API key here.