The next generation of company information – trusted and authoritative data for your KYC, AML, AVS, CRM or ERP applications. With only one API to worry about, integration is easy and cost-effective.
The BREX Enterprise API is your central gateway to verified business data in over 80 countries & jurisdictions.
Available countries: Austria, Belgium, Canada (beta), Denmark, Estonia, Finland, France, Germany, Gibraltar, Greece (soon), Guernsey, Ireland, Italy, Jersey, Latvia, Lithuania, Luxembourg, Malta, Macedonia, Netherlands, New Zealand(new), Norway, Russia, Romania, Serbia, Slovenia, Spain, Sweden, Switzerland, Ukraine, United Kingdom and USA (Search).
Access our service through our web-tool on www.kompany.com
The web-tool is accessible from any device at any time and is a very efficient means to conduct quick manual checks of a limited set of companies.
We'd love to hear from you. Fill out the form below with some info about your project.
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:
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:
Valid 'method' values are:
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
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!
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.
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.
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.
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:
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:
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:
The use of a notifier does not preclude the polling method but is more efficient for everybody.
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.