INSTANT ACCESS TO AUTHORITATIVE BUSINESS
Image by Jason Hawkes - hayesdavidson.com a service of kompany INSTANT ACCESS TO AUTHORITATIVE BUSINESS INFORMATION. 25 COUNTRIES. 1 API. brex.io API TECHNICAL INTERFACE DOCUMENTATION BREX API – A SERVICE OF KOMPANY BREX Enterprise API – your gateway to verified company information Imagine one neat and powerful API that gives you instant access to 1. 2. 3. 4. Official Commercial Registers Shareholder Information Company Filings Annual & Financial Accounts 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 from 25 European countries, soon the USA (40+ States) and select countries. Make sure to regularly check brex.io for updates. © BREX Business Register Exchange GmbH | Mariahilfer Strasse 93/2/20, A-1060 Vienna, Austria Commercial Court: Vienna, FN405096f | VAT Nr: ATU68362513 | MD: Russell E. PERRY Call us: +43-1-890-9930 | Write us: [email protected] | Visit us: brex.io Page 2 of 11 April 23rd, 2015, version 7 André Baumeier Content BREX Enterprise API – your gateway to verified company information ............................................................................... 2 Change Record of this Documentation ................................................................................................................................. 4 BREX API Technical Interface ................................................................................................................................................ 4 Online Documentation...................................................................................................................................................... 4 Overview ............................................................................................................................................................................... 4 API Authentication ................................................................................................................................................................ 5 User Key ................................................................................................................................................................................ 5 Regenerating an API Key ....................................................................................................................................................... 5 API HOST ............................................................................................................................................................................... 5 Additional Headers ............................................................................................................................................................... 5 Accept Header .................................................................................................................................................................. 5 HTTP Status Codes ................................................................................................................................................................ 5 API Objects ............................................................................................................................................................................ 6 Company ........................................................................................................................................................................... 6 See the current data model for each dataset online ........................................................................................................ 6 Product ............................................................................................................................................................................. 6 Product Order ................................................................................................................................................................... 7 Product Notifier ................................................................................................................................................................ 7 TEST COMPANY SET .............................................................................................................................................................. 8 SKU LIST ................................................................................................................................................................................ 9 COUNTRIES CURRENTLY COVERED ..................................................................................................................................... 10 DESCRIPTION DATA SETS .................................................................................................................................................... 11 © BREX Business Register Exchange GmbH | Mariahilfer Strasse 93/2/20, A-1060 Vienna, Austria Commercial Court: Vienna, FN405096f | VAT Nr: ATU68362513 | MD: Russell E. PERRY Call us: +43-1-890-9930 | Write us: [email protected] | Visit us: brex.io Page 3 of 11 April 23rd, 2015, version 7 André Baumeier CHANGE RECORD OF THIS DOCUMENTATION Version Date Reviewed by 2nd, 1 May 2 September 18th, 2014 3 21st, October 2014 P. Bainbridge-Clayton 2014 6th A. Baumeier P Bainbridge-Clayton 4 November 2014 R. Toifl-Dupin 5 December 1st, 2014 R. Toifl-Dupin 6 7 February April 6th, 23rd, Change References 2015 2015 R. Toifl-Dupin A. Baumeier BREX API TECHNICAL INTERFACE The BREX Enterprise 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 online and in the appendix. 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: https://docs.brex.io/active-docs OVERVIEW The following overview is subject to changes. For a detailed description, please refer to the online documentation. 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: 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 © BREX Business Register Exchange GmbH | Mariahilfer Strasse 93/2/20, A-1060 Vienna, Austria Commercial Court: Vienna, FN405096f | VAT Nr: ATU68362513 | MD: Russell E. PERRY Call us: +43-1-890-9930 | Write us: [email protected] | Visit us: brex.io Page 4 of 11 April 23rd, 2015, version 7 André Baumeier API AUTHENTICATION BREX Enterprise API uses API keys for authentication transferred as a separate header. 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. USER KEY Header: User_key {your API key} REGENERATING AN API KEY Your API key can be regenerated by clicking on the Regenerate button on your dashboard page (login with email address and password will be required). Note: Only one API key may be active on an application 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 application, though your account can manage multiple applications. Regenerating the key will regenerate it for all users. https://dashboard.brex.io/admin/access_details API HOST API HOST: api.brex.io ADDITIONAL HEADERS ACCEPT HEADER 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 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 © BREX Business Register Exchange GmbH | Mariahilfer Strasse 93/2/20, A-1060 Vienna, Austria Commercial Court: Vienna, FN405096f | VAT Nr: ATU68362513 | MD: Russell E. PERRY Call us: +43-1-890-9930 | Write us: [email protected] | Visit us: brex.io Page 5 of 11 April 23rd, 2015, version 7 André Baumeier API OBJECTS 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: COMPANY Search for a company by name: GET /company/search/name/{country code}/{name} Search by registration number: /company/search/number/{country code}/{registration number} GET 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: /company/{company id}?dataset=mini/master/full (defaults to mini) GET SEE THE CURRENT DATA MODEL FOR EACH DATASET ONLINE https://docs.brex.io/active-docs PRODUCT Search for possible Product available for that Company – returns an array of Product objects which includes the BREX SKU /product/search/{company id} GET 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) /product/availability/{sku}/{company id} © BREX Business Register Exchange GmbH | Mariahilfer Strasse 93/2/20, A-1060 Vienna, Austria Commercial Court: Vienna, FN405096f | VAT Nr: ATU68362513 | MD: Russell E. PERRY Call us: +43-1-890-9930 | Write us: [email protected] | Visit us: brex.io GET Page 6 of 11 April 23rd, 2015, version 7 André Baumeier PRODUCT ORDER Place an order for that product – returns a ProductOrder object POST /product/order/{sku}/{company id} Or when there are options available, e.g. a specific year for a document. POST /product/order/{sku}/{option}/{company id} 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. GET /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. GET /product/{product order id} Note the status checking here is done via polling. There is an alternative method by using a ProductNotifier. PRODUCT NOTIFIER This allows BREX to notify you when a product is ready. To use a ProductNotifier, replace step “heck the status of the ProductOrder” with the following: 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 (~) GET /product/notifier/{product order id}/GET/{callback url} 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 this step). The use of a notifier does not preclude the polling method but is more efficient for everybody. © BREX Business Register Exchange GmbH | Mariahilfer Strasse 93/2/20, A-1060 Vienna, Austria Commercial Court: Vienna, FN405096f | VAT Nr: ATU68362513 | MD: Russell E. PERRY Call us: +43-1-890-9930 | Write us: [email protected] | Visit us: brex.io Page 7 of 11 April 23rd, 2015, version 7 André Baumeier TEST COMPANY SET Articles of Association BAYERISCHE MOTOREN WERKE AKTIENGESELLSCHAFT X X X live DE HRB198673 MÜNCHEN FLOOR 13 GMBH X X X live DE HRA50136 BERLIN ARENGO IMMOBILIEN BERLIN E.K. X live/new incorporation DE HRB 2185 FREIBURG FAMILIE FISCHER GMBH X dissolved AT 60562M SIEMENS AKTIENGESELLSCHAFT ÖSTERREICH X X live AT 375714X 360KOMPANY GMBH X X live AT 422604B ARLTROC SCHADENSANIERUNG GMBH X X live/new incorporation AT 170047W YLINE INTERNET BUSINESS SERVICES AG X UK 7556915 GENERAL MOTORS EUROPE LIMITED X X X X live UK 4994880 MASS MEDIA DESIGN LTD X X X X live UK 9191600 CHESLEY PROFESSIONAL SERVICES LIMITED X X UK 6325604 UIMANAGEMENT LTD X X X X dissolved IE 413540 TERRY MCGUINNESS LIMITED X X X X live IE 104547 RYANAIR LIMITED X X X live IE 549999 KILLEEN ENGINEERING FABRICATION LIMITED X IE 13540 IRISH NURSERIES LIMITED CH 03630525834 THE SWATCH GROUP EUROPA AG X live CH 02030208926 NEUE ZÜRCHER ZEITUNG AG X live CH 02030411596 NOONEE AG X live/new incorporation CH 51490091307 CABLECOM SA X dissolved DK/EBR 12519605 DANSKE UNIPOL A/S X FR/EBR 451321335 CARREFOUR HYPERMARCHES GG/EBR 14497 CHANNEL ISLANDS AIRCRAFT SALES LTD IT/EBR BS464745 GIANNI VERSACE SPA JE/EBR RCP17 THE JERSEY RECREATION GROUNDS COMPANY LIMITED LV/EBR 40103708901 SIA "BOOM MEDIA" LU/EBR B155267 Historical Accounts Shareholder List HRB42243 MÜNCHEN Annual Accounts Company Name DE Register Check Country Registration Number Register Report Make sure to regularly check online for updates. Status dissolved live/new incorporation X live/new incorporation dissolved X X registered X registered X registered X X X registered X X X registered X X X X registered QIAGEN US FINANCE HOLDING (LUXEMBOURG) S.À R.L. X X X X registered NO/EBR 997453816 NORSKE SKOG CANADA HOLDING AS X X X registered ES/EBR A08924599 SEAT MOTOR ESPAÑA SA X X X registered SE/EBR 5560266883 IBM SVENSKA AKTIEBOLAG X X © BREX Business Register Exchange GmbH | Mariahilfer Strasse 93/2/20, A-1060 Vienna, Austria Commercial Court: Vienna, FN405096f | VAT Nr: ATU68362513 | MD: Russell E. PERRY Call us: +43-1-890-9930 | Write us: [email protected] | Visit us: brex.io X X X X registered Page 8 of 11 April 23rd, 2015, version 7 André Baumeier SKU LIST Make sure to regularly check online for updates. Product Name SKU Result of a nationwide company search without specific parameters SER01BXAT Result of a company search with specified parameters like commercial court, legal form, legal nature or domicile, or result of a person search SER02BXAT Current business register extract REP01BXAT Current business register extract with historical (deleted) data REP02BXAT Current business register extract with Trade Register data REP03BXAT Current business register extract with historical (deleted) data and with Trade Register data REP04BXAT Abridged extract with company name, domicile, registered office address, legal form) REP05BXAT Abridged extract with maximal 2 persons or alphabetical person list REP06BXAT Result of a search for documents of a company (eg articles of association, specimen of signatures, minutes, etc.) SER03BXAT Documents (PDF format) REP07BXAT Result of a search for annual accounts of a company SER04BXAT Annual accounts (PDF format) REP08BXAT Result of a search for changes in the business register (new entries, dissolutions, changes); price per hit SER05BXAT Result of a search for changes in the business register (filing of annual accounts); price per hit SER06BXAT Annual Subscription SUB12BXAT Register Report Austria REPOFHFAT Register Report Denmark (EBR) REPOFEBDK Register Report Estonia (EBR) REPOFEBEE Register Report Finland (EBR) REPOFEBFI Register Report Germany REPOFHRDE Register Report Greece (EBR) REPOFEBGR Register Report Ireland REPOFCRIE Register Report Italy (EBR) REPOFEBIT Register Report Latvia (EBR) REPOFEBLV Register Report Lithuania (EBR) REPOFEBLT Register Report Luxembourg (EBR) REPOFEBLU Register Report Malta (EBR) REPOFEBMT Register Report Norway (EBR) REPOFEBNO Register Report Serbia (EBR) REPOFEBRS Register Report Slovenia (EBR) REPOFEBSI Register Report Spain (EBR) REPOFEBES Register Report Sweden (EBR) REPOFEBSE Register Report Switzerland REPOFZECH Register Report United Kingdom REPOFCHUK Shareholder List Germany ADDSLHRDE Register Check Belgium (EBR) ADDOFEBBE Register Check Denmark (EBR) ADDOFEBDK Register Check Estonia (EBR) ADDOFEBEE Register Check Finland (EBR) ADDOFEBFI Register Check France (EBR) ADDOFEBFR Register Check Greece (EBR) ADDOFEBGR Register Check Guernsey (EBR) ADDOFEBGG © BREX Business Register Exchange GmbH | Mariahilfer Strasse 93/2/20, A-1060 Vienna, Austria Commercial Court: Vienna, FN405096f | VAT Nr: ATU68362513 | MD: Russell E. PERRY Call us: +43-1-890-9930 | Write us: [email protected] | Visit us: brex.io Page 9 of 11 April 23rd, 2015, version 7 André Baumeier Register Check Ireland (EBR) ADDOFEBIE Register Check Italy (EBR) ADDOFEBIT Register Check Jersey (EBR) ADDOFEBJE Register Check Latvia (EBR) ADDOFEBLV Register Check Lithuania (EBR) ADDOFEBLT Register Check Luxembourg (EBR) ADDOFEBLU Register Check Macedonia (EBR) ADDOFEBMK Register Check Malta (EBR) ADDOFEBMT Register Check Netherlands (EBR) ADDOFEBNL Register Check Norway (EBR) ADDOFEBNO Register Check Serbia (EBR) ADDOFEBRS Register Check Slovenia (EBR) ADDOFEBSI Register Check Spain (EBR) ADDOFEBES Register Check Sweden (EBR) ADDOFEBSE Articles of Association Austria ADDASEBAT Articles of Association Estonia (EBR) ADDASEBEE Articles of Association Finland (EBR) ADDASEBFI Articles of Association Germany ADDASEBDE Articles of Association Ireland ADDASEBIE Articles of Association Italy (EBR) ADDASEBIT Articles of Association Jersey (EBR) ADDASEBJE Articles of Association Latvia (EBR) ADDASEBLV Articles of Association Luxembourg (EBR) ADDASEBLU Articles of Association Sweden (EBR) ADDASEBSE Articles of Association United Kingdom ADDASEBUK Annual Accounts Austria ADDAAEBAT Annual Accounts Denmark (EBR) ADDAAEBDK Annual Accounts Estonia (EBR) ADDAAEBEE Annual Accounts Finland (EBR) ADDAAEBFI Annual Accounts Ireland ADDAAEBIE Annual Accounts Italy (EBR) ADDAAEBIT Annual Accounts Jersey (EBR) ADDAAEBJE Annual Accounts Latvia (EBR) ADDAAEBLV Annual Accounts Luxembourg (EBR) ADDAAEBLU Annual Accounts Norway (EBR) ADDAAEBNO Annual Accounts Slovenia (EBR) ADDAAEBSI Annual Accounts Spain (EBR) ADDAAEBES Annual Accounts Sweden (EBR) ADDAAEBSE Annual Accounts United Kingdom ADDAAEBUK COUNTRIES CURRENTLY COVERED Germany, Austria, Switzerland, United Kingdom, Ireland, Belgium, Denmark, Estonia, Finland, France Greece, Guernsey, Italy, Jersey, Latvia, Lithuania, Luxembourg, Macedonia, Malta, Netherlands, Norway, Slovenia, Spain, Sweden Bulgaria*, Croatia*, Czech Republic*, Hungary*, Moldova*, Montenegro*, Poland*, Romania*, Serbia*, Slovakia* * Scheduled for 2015 © BREX Business Register Exchange GmbH | Mariahilfer Strasse 93/2/20, A-1060 Vienna, Austria Commercial Court: Vienna, FN405096f | VAT Nr: ATU68362513 | MD: Russell E. PERRY Call us: +43-1-890-9930 | Write us: [email protected] | Visit us: brex.io Page 10 of 11 April 23rd, 2015, version 7 André Baumeier DESCRIPTION DATA SETS Call Result Data Set – All Countries Master Data Set – All Countries Full Data Set - Germany Full Data Set - Austria Full Data Set - Switzerland Full Data Set - United Kingdom Full Data Set - Ireland Full Data Set - Belgium (EBR) Full Data Set - Denmark (EBR) Full Data Set - Estonia (EBR) Full Data Set - Finland (EBR) Full Data Set - France (EBR) Full Data Set - Greece (EBR) Full Data Set - Guernsey (EBR) Full Data Set - Italy (EBR) Full Data Set - Jersey (EBR) Full Data Set - Latvia (EBR) Full Data Set - Lithuania (EBR) Full Data Set - Luxembourg (EBR) Full Data Set - Macedonia (EBR) Full Data Set - Malta (EBR) Full Data Set - Netherlands (EBR) Full Data Set - Norway (EBR) Full Data Set - Slovenia (EBR) Full Data Set - Spain (EBR) Full Data Set - Sweden (EBR) Make sure to regularly check online for updates. kompany ID Company Name Company Registration Number Company Status Registered Address 1) 1) 1) 1) 1) 1) 1) 1) 1) 1) 1) 1) 1) 1) 1) 1) 1) * * * * Registration Court Incorporated (date) * * * * Age of Company * * * * Type of Business / Legal Form Activity Description * * * * SIC/NACE * * * * Share Capital * * * * * * * * VAT Number Shareholders Managing Directors Company Directors Company Secretaries Number of Charges / Mortgages Filing of Accounts (date) Filing of Annual Return (date) Previous Company Names * * * * Trade Names * * * * * * * * * * * * Brand Names Previous Address Domicile Address Website * * * * Email * * * * Phone * * * * Fax * * * * * Scheduled for 2015 1) City © BREX Business Register Exchange GmbH | Mariahilfer Strasse 93/2/20, A-1060 Vienna, Austria Commercial Court: Vienna, FN405096f | VAT Nr: ATU68362513 | MD: Russell E. PERRY Call us: +43-1-890-9930 | Write us: [email protected] | Visit us: brex.io Page 11 of 11 April 23rd, 2015, version 7 André Baumeier
© Copyright 2024