Getting Started
Authentication
In order to access and use the service, a key is required to be stated in the element open_session key. The credentials are provided by Allabolag in connection to signing the agreement with UC.
Example
In the following example, accessing the service is done by using ”YOUR-KEY”.
<?xmlversion="1.0"encoding="utf-8"?> <biwsXML_request type="find"> <open_session key="YOUR-KEY" /> <query>oms_X:>50000 AND anst_X:>500</query> <response> <sort field="jurnamn desc" /> <records from="1" to="10"> </records> </response> </biwsXML_request> |
There are several different services within BIWS. The various services are specified in the attribute ”type” and places different demands on input parameters in order to execute the request.
Types that requires "orgnr" within the query
| Type | Description | |
|---|---|---|
| abregbevis |
|
|
| koncern | Fetch a corporate group in XML-format. | |
| koncernHtml | Fetch a corporate group in HTML-format. | |
| checkUpdate | Check if there is updated data. | |
| fetchUpdate | Fetch updated data. | |
| handleMonitor | Add/remove monitored companies. | |
| findEvents | Find company events. | |
| fetchEvents | Fetch latest company events. | |
| bolagsordning | Fetch current articles of association from Bolagsverket for an organisation number. | |
| regbevis | Fetch current registration certificate from Bolagsverket for an organisations number. |
In order to specify the organisation number in the query field you need to state ”orgnr:” as a prefix, see example below.
Request
<?xmlversion="1.0"encoding="utf-8"?> <biwsXML_request type="fetch"> <open_session key="API KEY" /> <query>orgnr:5561375113</query> </biwsXML_request> |
Response
<biwsXML_response type="fetch"> <clientdata> <message /> <query>orgnr:5561375113</query> <wpquery /> <wpfilter /> <saldo>9691746,6</saldo> </clientdata> <records total="1"> <record nr="1"> <abv_hgrupp>Foretagstjanster</abv_hgrupp> <abv_kod>82910</abv_kod> <abv_ugrupp>Inkasso- & Kreditupplysningsverksamhet</abv_ugrupp> <aktiekapital>1000000</aktiekapital> <aktier_ant>10000</aktier_ant> <alias /> <anstgrp>200-499</anstgrp> <anstgrp_kod>8</anstgrp_kod> <anst_X>301</anst_X> <ar_senast_pdf>20140627#201312</ar_senast_pdf> <ba_coadress /> <ba_gatuadress>aRSTAaNGSVaGEN 21 B</ba_gatuadress> <ba_kommun>Stockholm</ba_kommun> <ba_lan>Stockholms lan</ba_lan> <ba_postnr>11743</ba_postnr> <ba_postort>Stockholm</ba_postort> <bolform>ab</bolform> <bolord> Bolaget har till foremal for sin verksamhet att bedriva kreditupplysningsverksamhet, att tillhandahalla tjanster och in formation for marknadsforing, att tillhandahalla annan affarsin formation samt att bedriva annan darmed forenlig verksamhet. </bolord> <bors_bolag>0</bors_bolag> <bors_listaid /> <bpfirma /> <brapport /> <bv_boltyp>ab</bv_boltyp> <bv_regdatum>19700715</bv_regdatum> <cfar_antal>2</cfar_antal> <clicks>1</clicks> <datum14>20180307195424</datum14> <dottrar> <dotter> <namn>UC allabolag AB</namn> <orgnr>5567307367</orgnr> </dotter> <dotter> <namn>UC Affarsfakta AB</namn> <orgnr>5566130042</orgnr> </dotter> </dottrar> <firmatecknare> Firman tecknas av styrelsen, Firman tecknas tva i forening av, -Beckman, Per Ingemar, -Bjorknert, Carl Mikael, -Borgcrantz, Karl Anders Allan, -Engstrom, Mats Goran, -Hugosson, Bengt Anders, -Nyblaeus, Nils-Fredrik, eller en av dem i forening med en av, -Dahlqvist, Sven ake, -David, Anna Helena, -Lagergren Bjursten, Oskar, -Lejon Rosvall, Linda Margareta, -ohlander, Anna Sophie Eleonor, Dessutom har verkstallande direktoren ratt att teckna firman, betraffande lopande forvaltningsatgarder </firmatecknare> <ftgnamn>UC AB</ftgnamn> <ftgtyp>ab</ftgtyp> </record> </records> </biwsXML_response> |
The following example requires the year to be specified.
| Type | Description |
|---|---|
| arpdf | Hämta en årsredovisning som base64-kodad PDF i XMLen |
| arpdfstream | Hämta en årsredovisning, resultat som streamad PDF |
Types that require query-syntax
| Type | Description |
|---|---|
| Find | Find and search in the company database. |
| Flow | Search companies, best match. |
| Fetch | Search and fetch data. |
In order to search information the query type "FIND" is used.
Example on a search query to find companies that have an annual result of more than 50 million SEK and have more than 500 employees.
Request
<?xmlversion="1.0"encoding="utf-8"?> <biwsXML_request type="find"> <open_session key="API Nyckel" /> <query>oms_X:>50000 AND anst_X:>500</query> <response> <sort field="jurnamn desc" /> <records from="1" to="10"> </records> </response> </biwsXML_request> |
Response
<biwsXML_response type="find"> <clientdata> <message /> <query>oms_X:>50000 AND anst_X:>500</query> <wpquery /> <wpfilter /> <saldo>9691746</saldo> </clientdata> <records total="1373"> <record nr="1"> <nummer>5566650080</nummer> <orgnr>5566650080</orgnr> <jurnamn>900 meter i Sverige AB</jurnamn> <ba_postort>Stockholm</ba_postort> <abv_ugrupp>Personaluthyrning</abv_ugrupp> <abv_hgrupp>Bemanning & Arbetsformedling</abv_hgrupp> <abv_kod>78200</abv_kod> <aktiekapital>100000</aktiekapital> <aktier_ant>1000</aktier_ant> <anstgrp>0</anstgrp> <anstgrp_kod>13</anstgrp_kod> <anst_X>3259</anst_X> <ar_senast_pdf>20150424#201412</ar_senast_pdf> <ba_gatuadress /> <ba_kommun /> <ba_lan /> <ba_postnr>0</ba_postnr> <bolform>ab</bolform> <bolord> Bolaget skall bedriva konsultverksamhet inom foretagsutveckling, forsaljning och kundvard samt forvalta vardepapper, avensom idka darmed forenlig verksamhet. </bolord> <brapport /> <bv_boltyp>ab</bv_boltyp> <bv_regdatum>20040816</bv_regdatum> <cfar_antal>1</cfar_antal> <oms_X>1878151</oms_X> <statdatakod>31</statdatakod> </record> </records> </biwsXML_response> |
Other types
| Type | Description | Parameter requirements |
|---|---|---|
| group | Grouping of the result in the search query. | groupby |
| checkMonitor | Check if new events are present within the monitoring. | Biws-key |
| account | View account settings, XML | Only type |