NAV Navbar

Introduction

Our Web API provides client applications with fast and reliable access to data about companies and private persons.

Through the Roaring API your applications can retrieve and manage Roaring content. The base address of the API is https://api.roaring.io. There are several endpoints at that address, each with its own unique path. The endpoints are restricted and require you to have an account for you to acquire credentials. Visit roaring.io/developers for more information.

Get Started

Get Started: It's free!

Create an account and start testing using our sandbox for free today!

Follow these simple steps to get started!

Go to app.roaring.io

  1. Click on Create Account.
  2. Enter the required information in the signup flow (wait with payment information if you want to test it for free).
  3. Click Developer in the top navigation.
  4. Use the keys under Access keys.
  5. Click the API you want to you use under APIs and follow instructions.

Use production data by choosing a payment option

To be able to run the API in the production mode you need to connect the API account to a credit card or invoice.

  1. Click Admin
  2. Select Account information
  3. Submit Credit Card or Invoice Company details under Payment details.
  4. Click save

Special requirements to search population registry in production mode

Production mode for the population registers also requires that you apply for a SPAR and or Skattetaten permit. Contact us and we will help you with the application process

The application process usually takes 2-3 weeks from start to finish.

Requests

The Roaring API is based on REST principles: data resources are accessed via standard HTTPS requests in UTF-8 format to an API endpoint. Where possible, the API strives to use appropriate HTTP verbs for each action:

Verb Description
GET Used for retrieving resources.
POST Used for creating resources.
PUT Used for changing/replacing resources or collections.
DELETE Used for deleting resources.

Responses

All data is received as a JSON object. The API Object Model visible in the presentation of each API on the developer site provides a description of all the retrievable objects.

Time and Date

Timestamps are returned in ISO 8601 format as Coordinated Universal Time (UTC) with zero offset: YYYY-MM-DDTHH:MM:SSZ and dates are in the same manner returned in format YYYY-MM-DD.

Response Status Codes

The API uses the following response status codes, as defined in the RFC 2616 and RFC 6585:

Status Code Description
200 OK - The request has succeeded. The client can read the result of the request in the body and the headers of the response.
201 Created - The request has been fulfilled and resulted in a new resource being created.
202 Accepted - The request has been accepted for processing, but the processing has not been completed.
204 No Content - The request has succeeded but returns no message body.
400 Bad Request - The request could not be understood by the server due to malformed syntax. The message body will contain more information; see Error Details
401 Unauthorized - The request requires user authentication or, if the request included authorization credentials, authorization has been refused for those credentials.
403 Forbidden - The server understood the request, but is refusing to fulfill it.
404 Not Found - The requested resource could not be found. This error can be due to a temporary or permanent condition.
500 Internal Server Error. You should never receive this error because our clever coders catch them all ... but if you are unlucky enough to get one, please report it to us.
502 Bad Gateway - The server was acting as a gateway or proxy and received an invalid response from the upstream server.
503 Service Unavailable - The server is currently unable to handle the request due to a temporary condition which will be alleviated after some delay. You can choose to resend the request again.

Error Details

Authentication Error Object

The following command returns an example of an error received when a token fails:

curl -H "Authorization: Basic Oik...vL" -d grant_type=client_credentials "https://api.roaring.io/token"

the JSON structure looks like this

  {
    "error": "invalid_client", 
    "error_description": "Invalid client secret" 
  }

The API uses two different formats to describe an error. One is for authentication errors connected to the token service and the other is the normal error received when calling the API.

Whenever the application makes requests to the API which are related to authentication or authorization, e.g. retrieving an access token, the error response follows RFC 6749 on The OAuth 2.0 Authorization Framework.

Key Value Description
error
string
A high level description of the error as specified in RFC 6749 Section 5.2
error_description
string
A more detailed description of the error as specified in RFC 6749 Section 4.1.2.1

Regular Error Object

The following command returns an example of an error received when fetching person data using a non existing person identifier:

$ `curl -i "https://api.roaring.io/person/1.0/person?personalNumber=1234"
  HTTP/1.1 400 Bad Request 
  {
    "error":"InvalidPersonalNumber", 
    "message":"The given personal number is not valid" 
  }

Apart from the response code, unsuccessful responses return information about the error as an error JSON object containing the following information:

Key Value Description
error
string
Short description of the error
message string
string
More detailed description of the error

Code Lists

General codes

Swedish codes

Below is a list of available Legal Group codes for a company. The information is displayed as a code with a descriptive text.

Code Status (Svenska) Status (English)
AB Privat aktiebolag Limited liability company
AB Publikt aktiebolag Limited liability company
AB Privat skadeförsäkring Private general insurance limited company
AB Skadeförsäkringbolag Insurance company
AB Livförsäkringsbolag Life insurance company
AB Publikt bankaktiebolag Public banking limited liability company
AB Privat bankaktiebolag Private banking limited liability company
AB Publikt livförsäkringsbolag Public life insurance limited company
AB Privat livförsäkringsbolag Private life insurance limited company
AB Publikt skadeförsäkringsbolag Public general insurance limited company
AB Aktiebolag Limited liability company
AB Bankaktiebolag Joint-stock banking company
OVR Bostadsförening Housing association
AB Utländsk Banks Fillial Branches of foreign bank
OVR Bostadsrättsförening Tenant-owner association
EF Enskild firma Sole trader
OVR Enkelt bolag Joined owned shipping firm
OVR Europeisk ekonomisk intressegruppering European Economic Interest Grouping
OVR Europeiska Grupperingar for Territoriellt Samarbete (EGTS) European groupings for territorial cooperation
OVR Ekonomisk förening Economic association
AB Försäkringsaktiebolag Insurance company
OVR Filial till utländskt bolag Branch to foreign company
OVR Försäkringsförening Insurance Association
HB/KB Handelsbolag Trading partnership
OVR Ideell förening Non-profit association
EF Enskild firma Sole trader
OVR Enkelt bolag Joined owned shipping firm
OVR Partrederi Joined owned shipping firm
OVR Värdepapperfond Security fund
HB/KB Handelsbolag/Kommanditbolag Trading/Limited partnership
AB Försäkringsbolag Insurance company
AB Europabolag European company
OVR Ekonomisk förening Economic association
OVR Bostadsrättsförening Tenant-owner association
OVR Kooperativ Hyresrättsförening Cooperative rented appartment association
OVR Europakooperativ European cooperative
OVR Samfällighet Community association
OVR Registrerat trossamfund Religious community
OVR Familjestiftelse Family foundation
OVR Stiftelse/Fond Foundation
OVR Statlig enhet Governmental unit
OVR Kommun Muncipality
OVR Kommunförbund Muncipality federation
OVR Landsting County council
OVR Allmän försäkringskassa Social Insurance
OVR Enhet inom Svenska kyrkan Unit in the Swedish Church
OVR Offentlig korporation och anstalt Public corporation and institution
OVR Hypoteksförening Mortgage association
OVR Regional statlig myndighet Regional government department
OVR Oskiftat dödsbo Estate in co-ownership
AB Ömsesidigt försäkringsbolag Mutual insurance company
AB Sparbank Savings bank
OVR Understödsförening Relief Society
OVR Erkänd arbetslöshetskassa Unemployment benefit
OVR Utländsk juridisk person Foreign juridical person
OVR Övrig svensk juridisk person Other Swedish juridical person
OVR Okänd juridisk form Unknown juridical form
HB/KB Kommanditbolag Limited partnership
OVR Kooperativ Hyresgästförening Cooperative rented appartment association
AB Medlemsbank Membership bank
AB Ömsesidigt försäkringsbolag Mutual insurance company
AB Ömsesidigt tjänstepensionsbolag Mutual service pension limited liability company
OVR Stiftelse Foundation
AB Sambruksförening Association for cooperative use
AB Tjänstepensionsaktiebolag Occupational pension limited liability company
AB Tjänstepensionsförening Occupational pension Association

Swedish Company Status Codes

Below is a list of available status codes for a company. The information is displayed as a code with a descriptive text. Also, the date of the last status change is supplied.

Code Status (Svenska) Status (English)
100 Aktivt Active
101 Lagerbolag Storage company
102 Drivs i Kommission Commission
103 Konkurshistorik Bankruptcy history
104 Vilande enligt senaste årsredovisning Dormant
109 Ingen statusinformation finns Missing status information
111 Ackordsförhandling inledd Composition declared
112 Ackordsförhandling upphörd Composition cessation
113 Ackordsförhandling upphävd av domstol Composition reverse
118 Konkursansökan Applied bankruptcy
132 Likvidation beslutad Liquidation declared
133 Likvidation fortsätter Liquidation continues
134 Likvidation upphörd Liquidation cessation
135 Likvidation upphävd av domstol Liquidation reverse
140 Fusion inledd Merger declared
141 Fusion avslutad Merger concluded
142 Fusion förfallen/upphävd Merger cessation
145 Fusion tillåten Merger grant
149 Fusion pågår Merger ongoing
180 Rekonstruktion inledd Reconstruction declared
181 Rekonstruktion upphörd Reconstruction cessation
182 Rekonstruktion upphävd av domstol Reconstruction reverse
190 Konkursbeslut Bankruptcy declared
191 Konkurs nedlagd Bankruptcy withdrawn
192 Konkursbeslut med bevakning Bankruptcy declared
194 Konkurs upphävd av rätt Bankruptcy reverse
195 Konkursansökan återkallad Applied bankruptcy withdrawn
200 Inaktivt Inactive
203 Vilande Dormant
231 Likvidation avslutad Liquidation concluded
241 Fusion avslutad Merger concluded
291 Konkurs avslutad Bankruptcy concluded
292 Konkurs avslutad med överskott Bankruptcy concluded
300 Avregistrerat Delisted
336 Bolaget avfört enl 13:18 aktiebolagslagen Company stricken off according to the Companies Act 13:18
337 Bolaget avfört Company stricken off
350 Avfört enligt 17 kap 2 st handelsregisterlagen Stricken off according to the Partnership and Non-registered Partnership Act 17:2
351 Avfört enligt 11 kap 18 § lag om ek. föreningar Stricken off according to the Economic Association (co-operative) Act 11:18
352 Avregistrerat Delisted
353 Avregistrerat p g a ny innehavare Delisted due to new owner
354 Avfört p g a fusion med utländskt företag Delisted due to fusion with foreign company
360 Avfört p g a utländskt företags likvidation/konkurs Delisted due to liquidation/bankruptcy of foreign company
361 Avfört, verksamheten har upphört Delisted due to discontinuation of business operation
362 Avfört, filialen saknar verkställande direktör Delisted, the branch office has no managing director
363 Avfört, enligt domstolsbeslut Delisted, according to court order
364 Avfört, årsredovisning saknas Delisted, annual report lacking
370 Bolaget avfört på eget begäran Delisted at own request
371 Bolaget avfört av Bolagsverket Delisted by request from Bolagsverket (Companies House)
373 Avfört Stricken off
374 Avfört, omregistrerat till bankaktiebolag Stricken off, re-registered as a joint-stock bank
377 Avregistrat pga ombildning Delisted due to conversion

Norwegian codes

Below is a list of available Legal Group codes for a company. The information is displayed as a code with a descriptive text.

Code Status (Norsk) Status (English)
AS Aksjeselskap Limited company
FLI Forening/Lag/Innretning Association/club/organisation
ENK Enkeltpersonsforetak Sole proprietorship
ESEK Eierseksjonssameie Condominium flat owner
DA Delt Ansvar General partnership with shared liability
SAM Tingsrettslig Sameie Joint ownership according to the law of property
SA Samvirkeforetak Cooperative
NUF Norsk Avd. Av Utenl. Foretak Norwegian division of foreign business
ORGL Organisasjonsledd Organisation section
ANS Ansvarlig Selskap General partnership
ANNA Annen Juridisk Person Other body corporate
STI Stiftelse Foundation
KIRK Kirkelig Fellesråd Council of Churches
BRL Borettslag Housing cooperative
ASA Allmennaksjeselskap Public limited company
KS Kommandittselskap Limited partnerships
KF Kommunalt Foretak Municipal business enterprise
IKS Interkommunalt Selskap Inter-municipal company
PK Pensjonskasse Pension Fund
SÆR Annet Foretak Iflg. Særsk. Lov Other business enterprise in accordance with special legislation
OPMV Særskilt Oppdelt Enhet Specially sectioned unit
SPA Sparebank Savings bank
KOMM Kommune Municipality
PRE Partrederi Jointly owned shipping company
FYLK Fylkeskommune County
BA Selskap Med Begrenset Ansvar Company with limited liability
GFS Gjensidig Forsikringselskap Mutual Insurance Company
BBL Boligbyggelag House building cooperative
STAT Staten State
BO Andre Bo Other estates
SF Statsforetak Public corporation
SE Europeisk Selskap  European Company
FKF Fylkeskommunalt Foretak County municipal business enterprise
ADOS Administrativ Enhet Offentlig Sektor ADOS
BEDR Underavdeling Unit
UTLA Utenlandsk Enhet Foreign entity
KBO Konkursbo Bankrupt estate
AAFY  Ikkenæringsdrivende Virksomhet Non-commercial entity
VPFO Verdipapirfond Unit trusts
KTRF Kontorfellesskap  Joint office
TVAM Tvangsregistrert For Mva Compulsory registration in the Value Added Tax Registration List
IKJP Andre Ikke-Juridiske Personer Other non-body corporate
PERS Andre Enkeltpers I Tilkn. Reg. Individuals who are registered in affiliated register

Norwegian Company Status Codes

Below is a list of available status codes for a company. The information is displayed as a code with a descriptive text. Also, the date of the last status change is supplied.

Code Description
S Deleted
O Dissolved
T Under forced liquidation
U Under liquidation
K Bankrupt
C Under public composition
Z No activity
A Active

API Authorization Guide

This guide shows you how to get a user’s authorization to access private data through the API.

Permission

Requests to the Roaring API require authorization; that is, the user must have granted permission for an application to access the requested data. To prove that the user has granted permission, the request header sent by the application must include a valid access token.

As the first step towards authorization, you will need to go to the developer page and fetch your unique Consumer Key and Consumer Secret to use in the authorization header. These are located under Development -> Access keys.

1. Your application requests access tokens

Using your unique Consumer Key and Consumer Secret you call the token service to retrieve an access token. The call is made towards the /token endpoint:

POST https://api.roaring.io/token

The body of this POST request must contain the following parameters:

REQUEST BODY PARAMETER VALUE
grant_type Required. Shall be set to "client_credentials"

The header of this POST request must contain the following parameter:

HEADER PARAMETER VALUE
Authorization Required. Base 64 encoded string that contains the consumer key and consumer secret. The field must have the format: Authorization: Basic

2. The tokens are returned to the application

On success, the response from the Roaring Accounts service has the status code 200 OK in the response header, and the following JSON data in the response body:

KEY VALUE DESCRIPTION
access_token
string
An access token to be used in subsequent calls to the Roaring API.
token_type
string
How the access_token may be used, always "Bearer".
scope
string
A space-separated list of scopes which have been granted for this access_token
expires_in
int
The time period (in seconds) for which the access token is valid.

An example request and response to the token endpoint will look something like this:

$ curl -H "Authorization: Basic XXX...zzz" -d grant_type=client_credentials https://api.roaring.io/token 
{
  "access_token": "asdfg...xzy", 
  "token_type": "Bearer", 
  "scope": "am_application_scope default", 
  "expires_in": 3600
}

3. Use the access token to access the Roaring API

The access token allows you to make requests to the Roaring API.

An example of how access token allows you to make requests to the Roaring API.

$ curl -H "Authorization: Bearer XXXX...zzzzz" "https://api.roaring.io/person/1.0/person?personalNumber=193604139208"
{
  "posts": [
    {
      "nationalRegistryChangeDate": "2011-03-15T00:00",
      "personalNumber": "193604139208",
      "hasHistory": true,
      "secrecyChangeDate": "2010-02-02T00:00",
      "secrecyMarked": false,
      "details": [
        {
          "dateFrom": "2011-03-15T00:00",
          "dateTo": "9999-12-31T00:00",
          "firstName": "Carina",
          "surName": "Efternamn1301",
          "gender": "F",
          "birthDate": "1936-04-13T00:00",
          "deRegistrationDate": "2011-02-02",
          "deRegistrationReason": "A"
        }
      ],
      "address": {
        "nationalRegistrationAddress": [
          {
            "dateFrom": "2015-12-18T00:00",
            "dateTo": "9999-12-31T00:00",
            "registrationDate": "2002-09-01T00:00",
            "careOf": "CO-NAMN",
            "deliveryAddress2": "Gatan177 2",
            "postalNumber": "17890",
            "city": "EKERÖ",
            "districtCode": "215002",
            "communeCode": "25",
            "countyCode": "01"
          }
        ]
      }
    }
  ]
}

Authentication

All requests towards the API's require authentication. This is achieved by using the Consumer key and Consumer secret received from the developer site and calling the token service:

Use the following example to generate an access token using the client_credentials grant type.

curl request

curl -k -d "grant_type=client_credentials" \
                    -H "Authorization: Basic Base64(consumer-key:consumer-secret)" \
                     https://api.roaring.io/token

csharp request

var client = new RestClient("https://api.roaring.io/token");
var request = new RestRequest(Method.POST);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("content-type", "application/x-www-form-urlencoded");
request.AddHeader("authorization", "Basic Base64(consumer-key:consumer-secret)");
request.AddParameter("application/x-www-form-urlencoded", "grant_type=client_credentials", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);                        

java request

OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/x-www-form-urlencoded");
RequestBody body = RequestBody.create(mediaType, "grant_type=client_credentials");
Request request = new Request.Builder()
  .url("https://api.roaring.io/token")
  .post(body)
  .addHeader("authorization", "Basic Base64(consumer-key:consumer-secret)")
  .addHeader("content-type", "application/x-www-form-urlencoded")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

php request

<?php

$request = new HttpRequest();
$request->setUrl('https://api.roaring.io/token');
$request->setMethod(HTTP_METH_POST);

$request->setHeaders(array(
  'Cache-Control' => 'no-cache',
  'Content-Type' => 'application/x-www-form-urlencoded',
  'authorization' => 'Basic Base64(consumer-key:consumer-secret)'
));

$request->setContentType('application/x-www-form-urlencoded');
$request->setPostFields(array(
  'scope' => 'PRODUCTION',
  'grant_type' => 'client_credentials'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}                           

Where Base64(consumer-key:consumer-secret) is a placeholder for the actual base64 encoded version of the string "consumer-key" + "consumer-secret". This will return an OAuth token with a validity time according to the settings you have made, a response example:

Example response

{
   "access_token": "d4c7d9a8-eb5f-34fb-b7b6-2acaad1cdd86",
   "scope": "am_application_scope default",
   "token_type": "Bearer",
   "expires_in": 3600
}

The access_token received must then be used when calling the API by sending it in the request (Authorization) header:

Authorization : Bearer e6a59442-h1s5-31da-8032-0b0ba88a1y04

On the developer site there are also several code snippet examples for token creation in common programming languages.

Security at Roaring

Security is very important for us at Roaring. If you have any questions after reading this, or encounter any issues, please let us know.

Payments and credit card management

All payment and creditcard handling is done using our payment provider Stripe which has been audited by a PCI-certified auditor and is certified to PCI Service Provider Level 1 Visa. For more information about security at Stripe.

HTTPS for secure connections Roaring forces HTTPS for all services using TLS (SSL), including the developer portal and all the apis.

We regularly audit the details of our implementation: the certificates we serve, the certificate authorities we use, and the ciphers we support.

API Authentication and Authorization

We are using the Oauth2 framework for authentication and authorization in our API's. for more information about how this flow works, please take a look at our authentication flow documentation.

Questions?

We're always happy to help with code or any other questions you might have! Look through our documentation or contact support.

Webhooks

Use webhooks to be notified about changes that happen to objects connected to a certain service. Roaring can send webhook events that notify your application any time a change of information happens on an object conneted to a dataset that you are interested in.

Common use-cases:

Datasets available for monitoring

We are constantly adding more event types to the webhook monitoring service to be able to offer monitoring of as many of our available datasets as possible.

In order to see the full list of datasets that can be monitored using our webhook service please log in to our web portal app.roaring.io and navigate to the webhooks page in the developer section.

Setting up Webhooks

You can register webhook URLs for Roaring to notify any time an event happens in the datasets of your interest. When the event occurs Roaring creates an Event object.

This Event object contains all the relevant information about what just happened, including the type of event, the data associated with that event and data on what has changed. Roaring then sends an Event "continue" request, via an HTTP POST request, to any endpoint URLs that you have defined in your account’s Webhooks settings. In order to then recieve the complete Event payload you need to respond the notification with a HTTP status code of 200 (OK), after which Roaring will HTTP POST the full Event object. You can have Roaring send events concerning a specific dataset to multiple webhook's.

To set up an endpoint, you need to define a route on your server for receiving events, configure webhook settings so Roaring knows where to POST events to, verify your endpoint is valid, and acknowledge your endpoint is receiving events successfully.

Step 1 - Create a webhook endpoint

Webhook data is sent as JSON in the POST request body. The full event details are included and can be used directly, after parsing the JSON into an Event object.

Creating a webhook endpoint on your server is no different from creating any page on your website accepting a HTTP POST payload request.

Step 2 - Configure webhook settings

With your endpoint created, you need to tell Roaring about where to send events to. Webhook endpoints are configured in the Webhooks tab on the Developer page at app.roaring.io.

Add webhook endpoints

In the Webhooks tab, click the green plus button to reveal a form to add a new endpoint for receiving events. You can enter any URL as the destination for events. However, this should be a dedicated resouce context on your server that is set up to receive webhook events. You can choose to be notified of all event types, or only specific ones. You can start off with setting the endpoint to sandbox mode which is a totally free testing environment for webhooks where you can test them by sending single event messages on your own for testing purposes.

Update webhook endpoints

If you need to update or delete a webhook endpoint, you can do so in the webhooks developer tab. You also have the option of disabling a webhook endpoint temporarily. Roaring does not retry any notifications that are generated while the endpoint is disabled.

Step 3 - Send webhook test event

Next, test that your endpoint is working properly. To do this, have your webhook set to sandbox mode, navigate to the log view and press the button "send test event". The test event will then be sent to your webhook url and you will be able to see the results from the communication attempts in the log.

Step 4 - Respond to webhook events

Roaring webhook events send notifications for all updates to objects connected to the event types that you choose to monitor. Then you check the recieved notifications identifier against your database and decide weather you want the payload event information connected to the notification sent to your webhook url or not. If you have no interest in the notification payload you respond with a HTTP status code of 417 (Expectation Failed) and no more information on the object will be sent. If you want the notification payload you respond with a HTTP status code of 200 (OK) and Roaring will make another POST request to your webhook url with a payload containing the data that initiated the notification.

To acknowledge receipt of the payload event, your endpoint must return a 200 HTTP status code. Acknowledge events prior to any logic that needs to take place to prevent timeouts.

All response codes outside this range, including 3xx codes, indicate to Roaring that you did not receive the event. This does mean that a URL redirection or a "Not Modified" response is treated as a failure. Roaring ignores any other information returned in the request headers or request body.

Step 5 - Go live!

Once you’ve verified your endpoint is receiving, acknowledging, and handling events correctly, switch the webhook from sandbox mode to production on the Developer pages and go through the configuration again to configure an endpoint for your live integration. If you’re using the same endpoint for both test and live modes, the signing secret is unique to each mode. Make sure to add the new signing secret to your endpoint code if you’re checking webhook signatures.

Events

Events are our way of letting you know when something interesting happens in the datasets we provide. When something interesting occurs or changes, we create a new Event object. This Event object is sent as a notification through our webhook service.

Continue Request

{
  "changeType": "ADD",
  "countryCodes": [
    "se"
  ],
  "keyMap": {
    "personId": 55000,
    "personalNumber": "193103249078"
  },
  "requestType": "continue",
  "timestamp": 1568203715,
  "type": "pep",
  "version": "1.0"
}

Payload Request

{
  "changeType": "ADD",
  "countryCodes": [
    "se"
  ],
  "keyMap": {
    "personalNumber": "193103249078"
  },
  "object": {
    "birthDate": "1931-03-24",
    "gender": "Male",
    "imageLink": "https://image.freepik.com/free-icon/protected-person-of-secret-service_318-64589.jpg",
    "names": [
      {
        "firstName": "Jan",
        "lastName": "Bananberg",
        "nameType": "Primary name",
        "nameTypeId": "3"
      },
      {
        "firstName": "Jan Erik",
        "lastName": "Bananberg",
        "nameType": "National registry name",
        "nameTypeId": "4"
      }
    ],
    "pep": true,
    "pepCountries": [
      "Sweden"
    ],
    "personId": 55000,
    "rca": false,
    "relations": [
      {
        "relationPersonId": 55001,
        "relationType": "Partner",
        "relationTypeId": 6
      },
      {
        "relationPersonId": 55002,
        "relationType": "Daughter-in-law",
        "relationTypeId": 9
      },
      {
        "relationPersonId": 55003,
        "relationType": "Son",
        "relationTypeId": 7
      }
    ],
    "roles": [
      {
        "active": false,
        "baseRoleCategoryId": 9,
        "baseRoleCategoryName": "Members of parliament",
        "countryOfJurisdiction": "SWE",
        "detailedRoleCategoryId": 54,
        "detailedRoleCategoryName": "Member of national parliament",
        "fromDateDay": 3,
        "fromDateMonth": 10,
        "fromDateYear": 1992,
        "roleDescription": "Riksdagsledamot"
      },
      {
        "active": false,
        "baseRoleCategoryId": 9,
        "baseRoleCategoryName": "Members of parliament",
        "countryOfJurisdiction": "SWE",
        "detailedRoleCategoryId": 54,
        "detailedRoleCategoryName": "Member of national parliament",
        "fromDateDay": 2,
        "fromDateMonth": 10,
        "fromDateYear": 2006,
        "roleDescription": "Riksdagsledamot"
      }
    ],
    "ssns": [
      {
        "currentSsn": "193103249078",
        "ssnType": "SwePersonalNumber",
        "ssnTypeId": 1
      }
    ]
  },
  "requestType": "payload",
  "timestamp": 1568203715,
  "type": "pep",
  "version": "1.0"
}

Handling webhook events correctly is crucial to making sure your integration’s business logic works as expected.

The event object

An event object is sent two times, once where the actual object initiating the notification is omitted and only the object identifier is sent. We call this a "continue" request and you as a customer use this object identifier to decide if you want Roaring to send you the full payload or not. If you decide you want the payload and answer the request with HTTP status code 200 Roaring will attempt to send over the full payload to the registered webhook url in what we call the "payload" request.

Attribute Description
timestamp
long
Unix timestamp for when the event was created
changeType
string
Type of event change, ADD, UPDATE or DELETE
countryCodes
array
ISO 3166-1 alpha-2 country codes for country(ies) that the object belong to
keyMap
object
Identifier that uniqly identifies the object
object
object
The actual object that caused the event to be created. The object will follow the model of the types api model of the version associated with the used version of the webhook event model
previousAttributes
object
Previous version of the changed attribute. Only appears for update changeType
newAttributes
object
New version of the changed attribute. Only appears for update changeType
requestType
string
The webhook request event type, continue or payload
type
string
The notification data type
version
string
The notification event version

Change Type

The "changeType" field can have one of three different values explaining if the change is indicating an ADD of a new object the UPDATE of an existing object or for some datasets the DELETE of a previously existing object.

Value Description
ADD New object has been added to the monitored dataset
UPDATE There has been an update to an object in the monitored dataset
DELETE An entity in the monitored dataset has ben removed from it (this changeType is not applicable for all datasets)

Acknowledge payload events immediately

If your webhook script performs complex logic, or makes network calls when handling the payload, it’s possible that the script would time out before Roaring sees its complete execution. Ideally, your webhook payload message handler code (acknowledging receipt of an event by returning a 200 status code) is separate of any other logic you do for that payload event.

Handle duplicate events

Webhook endpoints might occasionally receive the same event more than once. We advise you to guard against duplicated event receipts by making your event processing idempotent. One way of doing this is logging the events you’ve processed, and then not processing already-logged events.

Error handling

If an error occurs when Roaring is trying to send notifications to a webhook url the webhook service will retry the sending of that notification every hour for x hours before dropping the notification which then will be lost.

In order to support your development process and make the setup of the webhook's as painless as possible the Roaring webhook Developer page holds the possibility to view logs connected to your webhooks. This makes it easy to locate the retry attempts connected to notifications and troubleshoot your endpoint.

Preventing replay attacks

A replay attack is when an attacker intercepts a valid payload and its signature, then re-transmits them. To mitigate such attacks, Roaring includes a timestamp in the Roaring-Signature header. Because this timestamp is part of the signed payload, it is also verified by the signature, so an attacker cannot change the timestamp without invalidating the signature. If the signature is valid but the timestamp is too old, you can have your application reject the payload.

We recommend that you use Network Time Protocol (NTP) to ensure that your server's clock is accurate and synchronizes with the time on Roaring's servers.

Roaring generates the timestamp and signature each time we send an event to your endpoint. If Roaring retries an event (e.g., your endpoint previously replied with an error), then we generate a new signature and timestamp for the new delivery attempt.

Verifying signatures

The Roaring-Signature header contains a timestamp and one or more signatures. The timestamp is prefixed by t=, and each signature is prefixed by a scheme. Schemes start with v, followed by an integer. Currently, the only valid signature scheme is v1.

Roaring-Signature: t=1568900674, v1=5257a869e7ecebeda32affa62cdca3fa51cad7e77a0e56ff536d0ce8e108d8bd Note that newlines have been added in the example signature header for clarity, but a real Roaring-Signature header will be all one line. Roaring generates signatures using a hash-based message authentication code (HMAC) with SHA-256. To prevent downgrade attacks, you should ignore all schemes that are not v1.

Step 1 - Extract the timestamp and signatures from the header

Split the header, using the , character as the separator, to get a list of elements. Then split each element, using the = character as the separator, to get a prefix and value pair.

The value for the prefix t corresponds to the timestamp, and v1 corresponds to the signature(s). You can discard all other elements.

Step 2 - Prepare the signed_payload string

You achieve this by concatenating:

The timestamp (as a string) The character . The actual JSON payload (i.e., the request’s body)

Step 3: Determine the expected signature

Compute an HMAC with the SHA256 hash function. Use the endpoint’s signing secret as the key, and use the signed_payload string as the message.

Step 4 - Compare signatures

Compare the signature(s) in the header to the expected signature. If a signature matches, compute the difference between the current timestamp and the received timestamp, then decide if the difference is within your tolerance.

To protect against timing attacks, use a constant-time string comparison to compare the expected signature to each of the received signatures.

Person

Sweden

Population Register

v1.0 Fetch personal information about an individual using the personal identification number. Includes information about a person's current name and address information, relationships, gender and information about a person being deceased.

There are three endpoints "person" includes current information, "personhistory" includes historical information and "personfull" that includes both current and historical information

Common use-cases:

Endpoint

Get current person information

https://api.roaring.io/person/1.0/person

Get historical person information (3 years)

https://api.roaring.io/person/1.0/personhistory

Get current and historical person information

https://api.roaring.io/person/1.0/personfull

Detailed data description

Detailed description of all the retrievable data in the API Object Model. The API Object model is also visible in the presentation of each API on the developer site

If a valid

Model Explanation
Person
nationalRegistryChangeDate
string, optional
Date for latest change in national registry
actualPersonalNumber
boolean, optional
Indication on if this is an active personal number
personalNumber
string, optional
The personal number identifying a person in Sweden
hasHistory
boolean, optional
Information on if there are any historical information available for this person. If "true" you can get the historical data with the API; GET /personhistory.
secrecyChangeDate
string, optional
Date for change of secrecy marking
secrecyMarked
boolean, optional
The consumer's information is protected and will not be returned. Any previously stored information should be removed in compliance with local laws.
details
Array[Details], optional
Person details like names and birthdate, includes dates for when the detailed information is valid
address
(Address, optional)
relation
Array[Relation], optional)
Information about persons that have a relation to this person
taxationYear
string, optional
Taxation year (YYYY)
aggregatedIncome
string, optional
Summed up income for the year expressed in taxationYear
realEstate
Array[RealEstate], optional)
List of real estate owned by the person
Details
dateFrom
string, optional
Date from which these details are valid
dateTo
string, optional
Date to which these details are valid
notificationName
string, optional
Middle name, first name and surname together in that order
firstName
string, optional
All first names of this person.
givenName
(integer, optional)
A code that show which of the first names that is used as calling name.
middleName
string, optional
All middle names of this person
surName
string, optional
Surname is the person's family name (last name).
gender
string, optional
The gender this person identifies as. Either F (female) or M (male)
birthDate
string, optional
Date of birth in accordance with ISO 8601 date, i.e. YYYY-MM-DDThh:mm
birthCongregation
string, optional
two digit code for the congregation the person was born in
birthCountyCode
string, optional
two digit code for the county the person was born in
deRegistrationDate
string, optional
Date for deregistration from the national registry
deRegistrationReason
string, optional
Reason for deregestering from the national registry, represented as a code
personalNumberChangedFrom
string, optional
Old personal number after a switch
personalNumberChangedTo
string, optional
The new personal number after a switch
swedishCitizen
boolean, optional
A code showing whether the person is a Swedish citizen or not.
secrecyMarked
boolean, optional
A code showing if the persons's information is protected or not. If the persons' information is protected it will not be returned.
Address
foreignAddress
Array[ForeignAddress], optional
List of foreign addresses recorded for the person
nationalRegistrationAddress
Array[NationalRegistrationAddress], optional
List of national registration addresses recorded for the person
specialPostAddress
Array[SpecialPostAddress], optional)
List of special postal addresses recorded for the person
Relation
birthDate
string, optional
Birth date for the related person. Can be incomplete or missing
dateFrom
string, optional
Date from which this relation is/was active
dateTo
string, optional
Date to which this relation is/was active
deRegistrationDate
string, optional
Date for deregistration from the national registry for the related person
deRegistrationReason
string, optional
Code describing reason for deregistration
firstName
string, optional
First name for a related person that is missing a personal number
middleName
string, optional
Middle name for a related person that is missing a personal number
personalNumber
string, optional
Personal number for the related person. Can be missing for a non registered related person
relationType
string, optional
Code for relation type V = guardian. M = husband, wife or partner
surName
string, optional
Surname for a related person that is missing a personal number
RealEstate
changeDate
string, optional
Date for change of real estate information
communeCode
string, optional
Commune where the real estate resides
countyCode
string, optional
County where the real estate resides
realEstateCode
string, optional
Code describing type of real estate
shareDenominator
string, optional
Share of ownership, Denominator
shareNominator
string, optional
Share of ownership, Nominator
taxationValue
string, optional
The real estates calculated taxation value
taxationYear
string, optional
Latest year the real estate was taxed (YYYY)
ForeignAddress
dateFrom
string, optional
Date from which the address is/was in use
dateTo
string, optional
Date to which the address is/was in use
careOf
string, optional
The "care of"-line (c/o) if any. E.g. c/o 'Adam Eriksson'
city
string, optional
The postal city name. E.g. 'Sundbyberg'
country
string, optional
Country e.g. 'Norway'
deliveryAddress1
string, optional
First line for physical address information such as street name and number
deliveryAddress2
string, optional
Second line for physical address information such as street name and number, e.g. Sturegatan 5
deliveryAddress3
string, optional
Third extra line for foreign address information
NationalRegistrationAddress
dateFrom
string, optional
Date from which the address is/was in use
dateTo
string, optional
Date to which the address is/was in use
registrationDate
string, optional
Registry registration date
careOf
string, optional
The "care of"-line (c/o) if any. E.g. c/o 'Adam Eriksson'
deliveryAddress1
string, optional
First line for address information, e.g. 'Sturegatan 5'
deliveryAddress2
string, optional
Second line for address information, e.g. 'LGH 3214'
postalNumber
string, optional
The postal code number (zip code). E.g. '16974'
city
string, optional
The postal city name. E.g. 'Sundbyberg'
districtCode
string, optional
Code for the district
congregationCode
string, optional
Code for congregation
communeCode
string, optional
Code for commune
countyCode
string, optional
Code for county
SpecialPostAddress
dateFrom
string, optional
Date from which the address is/was in use
dateTo
string, optional
Date to which the address is/was in use
careOf
string, optional
The "care of"-line (c/o) if any. E.g. c/o 'Adam Eriksson'
city
string, optional
The postal city name. E.g. 'Sundbyberg'
deliveryAddress1
string, optional
First line for special postal address information
deliveryAddress2
string, optional
Second line for special postal address information
postalNumber
string, optional
The postal code number (zip code). E.g. '16974'

Apply for Production Data

Get started

Authorization Types

Information about persons in SPAR
The national registry contains the following information about persons.

The national registry can also contain information that a person has demanded a block against receiving direct mail with SPAR as the address source.

Authorization types
What information can you access?

In our data source SPAR, there are several different authorization types regarding the information that you are allowed to receive.

Roaring can help you with the authorization application process towards Skatteverket.

Basic Permission
Basic authorization most organizations have a right to includes the nameof the person, address, national registry commun, personal identity number (personal number or co-ordination number), date of birth and gender.

Citizenship
Organizations entitled to have access to citizenship is CSN, Bolagsverket, Polisen, SÄPO and Tullverket.

Relations
Relations to husband / wife / partner or guardians. Authorization is given to authorities, banks, insurance companies, mutual fund companies and others.

Origin of Birth
The authorization contains information about the birth place of origin. Authorization is given to Polismyndigheten, Säkerhetspolisen and Tullverket.

Income and Real Estate
The authorization contains information about taxed income, income from capital and data about real estate regarding single-family units such as place and taxation value. Authorization is given to Polismyndigheten, Säkerhetspolisen and Tullverket.

Deregistration codes

Code Deregistration reason
A Deceased
G Old number
O Other deregistration reason

Personal Numbers for Test

Example: Notification name | 193701308888

Request

curl -X GET --header 'Accept: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
'https://api.roaring.io/person/1.0/person?\
personalNumber=193701308888'

Response

{
  "posts": [
    {
      "nationalRegistryChangeDate": "2010-02-02T00:00",
      "personalNumber": "193701308888",
      "hasHistory": true,
      "secrecyChangeDate": "2010-02-02T00:00",
      "secrecyMarked": false,
      "details": [
        {
          "dateFrom": "2010-02-02T00:00",
          "dateTo": "9999-12-31T00:00",
          "notificationName": "Efternamn3542, Christina Birgitta",
          "firstName": "Christina Birgitta Ulrika",
          "givenName": 20,
          "middleName": "Thomeaus",
          "surName": "Efternamn3542",
          "gender": "F",
          "birthDate": "1937-01-30T00:00"
        }
      ],
      "address": {
        "nationalRegistrationAddress": [
          {
            "dateFrom": "2015-12-18T00:00",
            "dateTo": "9999-12-31T00:00",
            "registrationDate": "2003-01-01T00:00",
            "deliveryAddress2": "Gatan142 8",
            "postalNumber": "11146",
            "city": "STOCKHOLM",
            "districtCode": "215025",
            "communeCode": "80",
            "countyCode": "01"
          }
        ]
      }
    }
  ]
}

This dev person data service fetches test person data information from a database containing ca 6500 fictive persons with various different information types available.

Here are some personal numbers available in the test data to get your testing going.

Type Endpoint  Social security number
Notification name Person 193701308888
National Registration Address Person 192907304766
Special Post Address Person 196805029268
Foreign Address Person 194812161596
History Person 197904182396
Personal Number Changed From Person 199111029196
Personal Number Changed To Person 199111022399
Reason for deregestering from the national registry, represented as a code G Person 199111022399
Reason for deregestering from the national registry, represented as a code A Person 193604139208
Reason for deregestering from the national registry, represented as a code O Person 198512122394
Person is secrecy marked Person 193103249078
Incorrect personal number Person 19360413920
Child with relational data Person  200902102383
No hit in National Registry but correct syntax Person 197305150000
National Registration Address History 192907304766
Special Post Address History 196805029268
Foreign Address History 194812161596
History History 197904182396
Personal Number Changed From History 199111029196
Personal Number Changed To History 199111022399
Reason for deregestering from the national registry, represented as a code G History 199111022399
Reason for deregestering from the national registry, represented as a code A History 193604139208
Reason for deregestering from the national registry, represented as a code O History 198512122394
Person is secrecy marked History 193103249078
Incorrect personal number History 19360413920
Physical person ID as a coordination number History 199211629192
Notification name Full 193701308888
National Registration Address Full 192907304766
Special Post Address Full 196805029268
Foreign Address Full 194812161596
History Full 197904182396
Personal Number Changed From Full 199111029196
Personal Number Changed To Full 199111022399
Reason for deregestering from the national registry, represented as a code G Full 199111022399
Reason for deregestering from the national registry, represented as a code A Full 193604139208

Board Directorships

v2.0 Displays all companies a person has board assignments in.

Common use-cases:

Endpoint

https://api.roaring.io/se/company/engagement/2.0/

Detailed data description

Detailed description of all the retrievable data in the API Object Model. The API Object model is also visible in the presentation of each API on the developer site

Model Explanation
personalNumber
string, optional
Personal identity number and co-ordination number.
hitCount
integer, optional
Number of hits
engagements
Array[Engagement], optional
Array of engagements for the requested company
roles
Array[Role], optional
Roles held in the company
town
string, optional
Postal address town
Engagement
companyId
string, optional
Company identifier (company registration number / organization number)
changeDate
string, optional
Date for when the record was last changed
companyName
string, optional
Company name
statusCode
integer, optional
Company status code
statusText
string, optional
Company status text
Role
roleCode
integer, optional
Code for type of role
roleName
string, optional
Name of the office

Role codes

Code Role
0 Innehavare
1 Arbetstagarrepresentant
2 Extern firmatecknare
3 Extern verkställande direktör
4 Extern vice verkställande direktör
5 Ledamot
6 Likvidator
7 Likvidatorssuppleant
8 Revisor
9 Revisorssuppleant
10 Suppleant
12 Verkställande direktör
13 Vice verkställande direktör
14 Bolagsman
15 Kommanditdelägare
16 Komplementär
18 Ordförande
20 Prokurist
21 Huvudansvarig revisor
22 Lekmannarevisor
23 Lekmannarevisorssuppleant
24 Ställföreträdande VD
25 Verkställande ledamot
26 Vice ordförande
27 Särskild delgivningsmottagare
28 Aktuarie
29 Utlandsbosatt inom EES
30 Utlandsbosatt utanför EES
31 Försäkringsrepresentant

Personal Numbers for Test

Example: 193701308888

Request

curl -X GET --header 'Accept: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
'https://api.roaring.io/se/company/engagement/2.0/193701308888'

Response

{
  "hitCount": 2,
  "personalNumber": "193701308888",
  "firstName": "Christina Birgitta Ulrika",
  "givenName": "Birgitta",
  "middleName": "Thomeaus",
  "surName": "Efternamn3542",
  "engagements": [
    {
      "companyId": "5560572850",
      "companyName": "ACM 2001 AB",
      "statusCode": 141,
      "statusText": "Aktivt",
      "roles": [
        {
          "roleCode": 18,
          "roleName": "Ordförande"
        }
      ],
      "town": "STOCKHOLM"
    },
    {
      "companyId": "5567164818",
      "companyName": "Swedec AB",
      "statusCode": 100,
      "statusText": "Aktivt",
      "roles": [
        {
          "roleCode": 10,
          "roleName": "Suppleant"
        }
      ],
      "town": "TROLLHÄTTAN"
    }
  ]
}

This dev company data service fetches test company data information from a database containing a set of fictive persons with various different information types available.

Here are some personal indentity numbers available in the test data to get your testing going.

Note that this is test data. Thus, information will change over time and can disappear. These are only examples of the responses you can receive in production.

Type Personal identity number
AB, KB, HB, BRF and Ek. För. 192907304766
AB 196805029268
Multiple AB and HB 197904182396
AB and BRF 194812161596
Multiple AB 193701308888
EF 198201232389
EF 198406232382

Beneficial Owner - Person

v1.0

See which companies a person is a Beneficial Owner for. A beneficial owner is someone who ultimately owns or controls a company, association or other type of legal entity. A beneficial owner can also be someone who benefits from someone else acting on their behalf.

Common use-cases:

Endpoint

Get Beneficial Owner

https://api.roaring.io/se/beneficialowner/1.0/person/{personalNumber}

Detailed data description

Detailed description of all the retrievable data in the API Object Model. The API Object model is also visible in the presentation of each API on the developer site. If a beneficial owner does not have a swedish personal number a 6-digit birth date is still available.

Model Explanation
CompanyResponse
legalEntity
Association, optional
otherAssociation
Association, optional
associationCollected
boolean, optional
falseInformation
boolean, optional
representatives
Array[PersonDetails], optional
beneficialOwners
Array[BeneficialOwner], optional
status
Status, optional
registrationDate
string, optional
Association
companyId
string, optional
Company Id
companyName
string, optional
Name of company
type
Status, optional
PersonDetails
personalNumber
string, optional
Personal number
coordinationNumber
string, optional
Coordination number
birthDate
string, optional
Date of birth
firstNames
Array[string], optional
Array of first names
givenName
string, optional
Given name
middleName
string, optional
Middle name
surName
string, optional
Surname
gdNumber
string, optional
GD number
countryResidence
Status, optional
citizenship
Status, optional
BeneficialOwner
person
PersonDetails, optional
extentOfControl
Status, optional
controlTypes
Array[ControlType], optional
association
Association, optional
Status
code
string, optional
Status code
description
string, optional
Description of status code
ControlType
code
string, optional
Control code
description
string, optional
Description of control code
association
Association, optional

Codes

Citizenship, Country of residence

In addition to the country codes and countries that may occur, the following can also be displayed:

Code Explanation
VETEJ Can not be determined
STATSLOS Stateless (applies only to country of residence)
Code Explanation
AB Aktiebolag
AKASSA Erkänd Arbetslöshetskassa
ANNANJUR Annan typ av juridisk person
BAB Bankaktiebolag
BF Bostadsförening
BRF Bostadsrättsförening
EEIG Europeisk ekonomisk intressegruppering
EK Ekonomisk förening
FAB Försäkringsaktiebolag
FAMSTIFT Familjestiftelse
FOF Försäkringsförening
GB Gruvbolag HB Handelsbolag
IF Ideell förening KB Kommanditbolag
KHF Kooperativ hyresrättsförening
MB Medlemsbank
OFB Ömsesidigt försäkringsbolag
OFFKORP Offentlig korporation
OVRJUR Övriga svenska juridiska personer bildade enligt särskild lagstiftning OVRSTIFT
RTSF Registrerade Trossamfund
SAMF Samfällighetsförening
SB Sparbank
SCE Europakooperativ
SE Europabolag SF Sambruksförening
UNDERFORF Understödsföreningar, försäkringsföreningar
UTLJUR Utländsk juridisk person
Code Explanation
TRUST Trust eller liknande juridisk konstruktion

Status Beneficial Owner

Code Explanation Swedish  Explanation English
FINNS Det finns en eller flera verkliga huvudmän There are one or more beneficial owners
FINNS_EJ Det finns ingen verklig huvudman There is no beneficial owner
EJFASTSTALLD Företaget eller föreningen kan inte komma fram till om det finns någon verklig huvudman eller har inte tillräckligt med uppgifter för att identifiera vem det är The company or association can not judge if there is any benificial owners or do not have enough information to identify who it is.

Extent Of Control

Code Explanation Swedish  Explanation English
INTERVALL1 Mer än 0 % men inte mer än 25 % More than 0% but not more than 25%
INTERVALL2 Mer än 25 % men inte mer än 50 % More than 25% but not more than 50%
INTERVALL3 Mer än 50 % men inte mer än 75 % More than 50% but not more than 75%
INTERVALL4 Mer än 75 % men mindre än 100 % More than 75% but less than 100%
INTERVALL5 100 % 100%

ControlType | Art

Code Explanation
ART10 Personen har kontroll genom aktier, andelar, medlemskap, avtal eller bestämmelse i exempelvis bolagsordning eller stadgar.
ART14 Personen är styrelseledamot eller motsvarande befattningshavare.
ART17 Personen företräder förvaltaren av stiftelsen.
ART20 Personen har rätt att utse eller avsätta mer än hälften av styrelseledamöterna eller motsvarande befattningshavare.
ART25 Personen kan, enligt stiftelseförordnandet, få en väsentlig del av de medel som stiftelsen delar ut. ART30 Personen har kontroll tillsammans med närstående. ART40 Personen har kontroll genom andra företag eller föreningar.
ART70 Personen är instiftare av trusten.
ART71 Personen är förvaltare av trusten eller företrädare för förvaltaren om den är en juridisk person.
ART72 Personen är beskyddare av trusten. ART73 Personen är förmånstagare till trusten.
ART74 Personen utövar kontroll på annat sätt.

Numbers for Test

Example: Beneficial Owner | 193701308888

Request

curl -X GET --header 'Accept: application/json' \
--header 'Authorization: {ACCESS TOKEN}' \ 
'https://api.roaring.io/se/beneficialowner/1.0/person/193701308888'

Response

{
  "beneficialOwners": [
    {
      "person": {
        "firstNames": [
          "Christina", "Birgitta", "Ulrika"
        ],
        "givenName": "Birgitta",
        "surName": "Efternamn3542"
      },
      "association": {
        "companyId": "5564866803",
        "companyName": "Aronfors Bygg och Teknik Aktiebolag"
      }
    },
    {
      "person": {
        "firstNames": [
          "Christina", "Birgitta", "Ulrika"
        ],
        "givenName": "Birgitta",
        "surName": "Efternamn3542"
      },
      "association": {
        "companyId": "5565002465",
        "companyName": "Wilfast Högsbo Aktiebolag"
      }
    },
    {
      "person": {
        "firstName": [
          "Christina", "Birgitta", "Ulrika"
        ],
        "givenName": "Birgitta",
        "surName": "Efternamn3542"
      },
      "association": {
        "companyId": "5567164818",
        "companyName": "Swedec AB"
      }
    }
  ]
}

This dev company data service fetches test company data information from a database containing a set of fictive persons with various different information types available.

Here are some personal indentity numbers available in the test data to get your testing going.

Note that this is test data. Thus, information will change over time and can disappear. These are only examples of the responses you can receive in production.

Type of test case Number
Beneficial Owner 193701308888

Signatory Right

v1.0

Check if a person has Signatory Right in a company. Signatory Right automatically answers if a person is entitled to sign a company by himself. The API is used to automate customer registration and make sure that you enter into binding agreements with the correct company signatory. Simplifies the ability to enter B2B services through the Internet and mobile. The response will show if a person can sign a company himself, in association with others or not at all.

Common use-cases:

Endpoint

https://api.roaring.io/se/company/right-to-sign/1.0

Detailed data description

Detailed description of all the retrievable data in the API Object Model. The API Object model is also visible in the presentation of each API on the developer site

Model Explanation
companyId
string, optional
Company identifier
changeDate
string, optional
Date for latest change on signing rights for company
personalNumber
string, optional
Personal number controled for signing rights
individualSigningRight
boolean, optional
True if person has individual signing rights
signingRightDescription
string, optional
Describes if the person can sign alone or together with others

Organization Numbers for Test

Example: companyId: 5565002465 | personalNumber 19290730476

Request

curl -X GET --header 'Accept: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
'https://api.roaring.io/se/company/right-to-sign/1.0\
/single?companyId=5565002465&personalNumber=192907304766'

Response

{
   "companyId": "5565002465",
   "changeDate": "2018-01-10",
   "personalNumber": "192907304766",
   "individualSigningRight": false,
   "signingRightDescription": "Person has the right to sign in conjunction with others"
}

Example: companyId: 5560572850 | personalNumber 193701308888

Request

curl -X GET --header 'Accept: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
'https://api.roaring.io/se/company/right-to-sign/1.0\
/single?companyId= 5560572850&personalNumber= 193701308888'

Response

{
   "companyId": "5560572850",
   "changeDate": "2018-01-10",
   "personalNumber": "193701308888",
   "individualSigningRight": true,
   "signingRightDescription": "Person has individual signing rights"
}

This dev company data service fetches test company data information from a database containing a set of fictive comapnies and persons with various different information types available.

Note that this is test data. Thus, information will change over time and can disappear. These are only examples of the responses you can receive in production.

Legalform Swedish  Company ID Personal identity number
Aktiebolag  5565002465 19290730476
Aktiebolag  5560572850 193701308888
Enskild firma 2907304766 2907304766
Enskild firma 7904182396 7904182396

Norway

Population Register

v1.0 Fetch personal information about an individual using name and birthdate. Includes information about a person's current name and address information, relationships, gender and information about a person being deceased.

Common use-cases:

Endpoint

Get current person information

https://api.roaring.io/no/person/1.0/person

Get historical person information

https://api.roaring.io/no/person/1.0/personhistory

Get current and historical person information

https://api.roaring.io/no/person/1.0/personfull

Detailed data description

Detailed description of all the retrievable data in the API Object Model. The API Object model is also visible in the presentation of each API on the developer site

Model Explanation
PersonLookupResponse
posts
Array[Person], optional
Person
importantNote
string, optional
socialSecurityNumber
string, optional
nameChangeCauseCode
string, optional
hasHistory
boolean, optional
memberOfChurch
boolean, optional
showCredentials
boolean, optional
actualPersonalNumber
boolean, optional
Indication on if this is an active personal number
personalNumber
string, optional
The personal number identifying a person in Norway
details
Array[Details], optional
Person details like names and birthdate, includes dates for when the detailed information is valid
address
Address, optional
relations
Relations, optional
newPersonalNumber
PersonalNumberRegistration,
optional
previousPersonalNumber
PersonalNumberRegistration,
optional
status
PersonStatus, optional
citizenship
Array[Citizenship], optional
Details
firstName
string, optional
All first names of this person
middleName
string, optional
All middle names of this person
surName
string, optional
Surname is the person's family name (last name)
surNameNotMarried
string, optional
fullName
string, optional
schoolDistrict
string, optional
constituency
string, optional
basicCircuit
string, optional
gender
string, optional
The gender this person identifies as. Either F (female) or M (male)
birthDate
string, optional
Date of birth in accordance with ISO 8601 date, i.e. YYYY-MM-DDThh:mm
birthTown
string, optional
birthCommuneOrCountry
string, optional
birthCommuneCodeOr
CountryCode

string, optional
registrationDate
string, optional
Registry registration date
same
Same, optional
incapacitated
Incapacitated, optional
residencePermit
ResidencePermit, optional
retention
Retention, optional
Address
moveAddressCauseCode
string, optional
foreignAddress
Array[ForeignAddress], optional
List of foreign addresses recorded for the person
nationalRegistrationAddress
Array[NationalRegistrationAddress],
optional
List of national registration addresses recorded for the person
previousAddresses
Array[PreviousAddress], optional
List of previous registration addresses recorded for the person
homelandAddresses
Array[HomelandAddress], optional
List of homeland registration addresses recorded for the person
specialAddresses
Array[SpecialAddress], optional
List of special registration addresses recorded for the person
Relations
family
Family, optional
maritalStatus
MaritalStatus, optional
mother
PersonIdentity, optional
father
PersonIdentity, optional
children
Array[PersonIdentity], optional
parentalResponsibility
ParentalResponsibility, optional
PersonalNumberRegistration
personalNumber
string, optional
registrationDate
string, optional
Registry registration date
PersonStatus
code
integer, optional
formatted
string, optional
registrationDate
string, optional
Registry registration date
Citizenship
code
string, optional
country
string, optional
registrationDate
string, optional
Registry registration date
Same
enrolled
boolean, optional
registrationDate
string, optional
Registry registration date
Incapacitated
code
string, optional
registrationDate
string, optional
Registry registration date
ResidencePermit
status
string, optional
formatted
string, optional
additionalText
string, optional
duf
string, optional
registrationDate
string, optional
Registry registration date
Retention
status
object, optional
registrationDate
string, optional
Registry registration date
ForeignAddress
careOf
string, optional
The "care of"-line (c/o) if any. E.g. c/o 'Tomas Topstad'
country
string, optional
Country e.g. 'Norway'
countryCode
string, optional
Country code e.g. '000'
moveToForeignDate
string, optional
Date when moved to foreign address
**type string, optional
registrationDate
string, optional
Registry registration date
deliveryAddress1
string, optional
First line for physical address
deliveryAddress2
string, optional
Second line for physical address
deliveryAddress3
string, optional
Third extra line for foreign address information
NationalRegistrationAddress
registrationDate
string, optional
Registry registration date
moveToDate
string, optional
Registry move date
careOf
string, optional
The "care of"-line (c/o) if any. E.g. c/o 'Tomas Topstad'
districtCode
string, optional
congregationCode
string, optional
communeCode
string, optional
communeName
string, optional
residentialNumber
string, optional
requisitionName
string, optional
requisitionNumber
string, optional
countyCode
string, optional
floorNumber
string, optional
addressType
AddressType, optional
PreviousAddress
country
string, optional
countryCode
string, optional
moveFromRegistrationDate
string, optional
moveFromForeignCountry
RegistrationDate

string, optional
moveFromForeign
CountryDate

string, optional
registrationDate
string, optional
Registry registration date
moveFromDate
string, optional
moveFromCommuneCode
string, optional
moveFromCommuneName
string, optional
moveFromForeignCountry
string, optional
moveFromForeignCountryCode
string, optional
HomelandAddress
country
string, optional
countryCode
string, optional
deliveryAddress1
string, optional
deliveryAddress2
string, optional
deliveryAddress3
string, optional
registrationDate
string, optional
Registry registration date
SpecialAddress
code
integer, optional
formatted
string, optional
registrationDate
string, optional
Registry registration date
Family
number
string, optional
personCode
string, optional
personCodeFormatted
string, optional
registrationDate
string, optional
Registry registration date
MaritalStatus
code
integer, optional
formatted
string, optional
causeCode
string, optional
registrationDate
string, optional
Registry registration date
PersonIdentity
countryCode
string, optional
country
string, optional
name
string, optional
gender
string, optional
personalNumber
string, optional
birthDate
string, optional
ParentalResponsibility
countryCode
string, optional
formatted
string, optional
registrationDate
string, optional
Registry registration date
AddressType
code
integer, optional
0 = Official, 1 = Property
formatted
string, optional
code formatted
property
PropertyRegister, optional
official
OfficialRegister, optional
PropertyRegister
holdingNumber
string, optional
subHoldingNumber
string, optional
leaseNumber
string, optional
OfficialRegister
houseNumber
string, optional
streetNumber
string, optional
addressLetter
string, optional 

Apply for Production Data

Get started To get started and get access to production data from Det Sentrale Folkeregister (DSF) you need to create an account with us and fill in a few documents. Contact us and we will help you with the application process.

Personal Numbers for Test

Example: Resident | 20119800324 |Kavli | Stian

{
  "posts": [
    {
      "actualPersonalNumber": true,
      "personalNumber": "20119800324",
      "status": {
        "code": 1,
        "formatted": "Resident"
      },
      "hasHistory": false,
      "secrecyMarked": false,
      "details": [
        {
          "birthDate": "1998-11-20",
          "firstName": "STIAN",
          "surName": "KAVLI",
          "middleName": "FOS",
          "fullName": "KAVLI STIAN FOS",
          "gender": "M"
        }
      ],
      "address": {
        "nationalRegistrationAddress": [
          {
            "registrationDate": "2000-02-25",
            "deliveryAddress1": "ETTERSTAD",
            "postalNumber": "0603",
            "city": "OSLO",
            "communeCode": "0018",
            "communeName": "REFKOM1",
            "addressType": {
              "code": 1,
              "formatted": "Property",
              "property": {
                "holdingNumber": "00018",
                "subHoldingNumber": "0018"
              }
            },
            "moveToDate": "2000-02-25"
          }
        ],
        "specialAddresses": [
          {
            "code": 0,
            "formatted": "Ordinary resident"
          }
        ]
      },
      "citizenship": [
        {
          "code": "000",
          "country": "NORSK"
        }
      ]
    }
  ],
  "source": "Det Sentrale Folkeregister (DSF)"
}

Example: No hit in DSF

{
  "message": "NoRecordsFound",
  "error": "There were no records matching the search parameters"
}

This dev person data service fetches test person data information from a database containing 10 fictive persons with various different information types available.

Here are some fictional persons available in the test data to get your testing going.

Type date of birth last name first name
Death  31120000767 Johansen Bror
Resident  20119800324 Kavli Stian
Resident  22100250539 Otterli Roy
Resident 19066600109 Os Ove 
Resident 19066600370 Muren Magne
Expat  17056800344 Fallet Henrik
Resident 20067900562 Gjestvang Eirik
Disappeared 13084000374 Rud Svein
Disappeared 01017700568 Nilsen Kristian
Canceled Access 07087000405 Hageland  Inger

Board Directorships

v2.0 Displays all companies a person has board assignments in

Common use-cases:

Endpoint

https://api.roaring.io/no/company/engagements/1.0/

Detailed data description

Detailed description of all the retrievable data in the API Object Model. The API Object model is also visible in the presentation of each API on the developer site

Response data

Property Explanation
personalNumber
string
Person identifier
status
Object[Status]
Object describing status for the data delivery
changeDate
string
Date for latest engagements related change
firstName
string
First name
surName
string
Sur name
fullName
string
Full name
hitCount
integer
No of engagements
engagements
Array[Engagement]
Board members

Status

Property Explanation
code Status code
text Status text

Engagement

Property Explanation
companyId
string
Company identifier
companyName
string
Company name
statusCode
string
Status code
statusText
string
Status text
roles
Array[Role]
Roles
changeDate
string
Date for latest engagement related change

Role

Property Explanation
roleCode
string
Role code
roleName
string
Role name
fromDate
string
Role access date

Example

Request

curl -X GET --header 'Accept: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
'https://api.roaring.io/no/company/engagements/1.0/01025700259'

Response

{
  "personalNumber": "01025700259",
  "status": {
    "code": 0,
    "text": "Engagements found"
  },
  "changeDate": "1970-01-01",
  "firstName": "Frida",
  "surName": "Dyre",
  "fullName": "Dyre, Frida",
  "hitCount": 2,
  "engagements": [
    {
      "companyId": "971697555",
      "companyName": "Juniors AS",
      "statusCode": "A",
      "statusText": "Active",
      "commune": "Kongsberg",
      "roles": [
        {
          "roleCode": "KONT",
          "roleName": "Contact person / representative",
          "fromDate": "2019-09-10"
        },
        {
          "roleCode": "MEDL",
          "roleName": "Board member(s)",
          "fromDate": "2018-09-30"
        }
      ],
      "changeDate": "2019-11-01"
    },
    {
      "companyId": "810392312",
      "companyName": "Metallco AS",
      "statusCode": "A",
      "statusText": "Active",
      "commune": "Oslo",
      "roles": [
        {
          "roleCode": "DAGL",
          "roleName": "General Manager/CEO",
          "fromDate": "2017-08-28"
        },
        {
          "roleCode": "LEDE",
          "roleName": "Chairman of the board",
          "fromDate": "2018-01-02"
        }
      ],
      "changeDate": "2019-10-20"
    }
  ]
}

Role codes

Code Description Description (No) Type
INNH Owner Eier DIRECTOR
DAGL General manager/CEO Daglig leder/administrerende direktør DIRECTOR
FFØR General manager Daglig leder DIRECTOR
REPR Norwegian representative of foreign entity Norsk representant for utenlandsk enhet  OTHER
LEDE Chairman of the board Styreleder DIRECTOR
NEST Deputy chairman  Nestleder DIRECTOR
MEDL  Board member(s)  Styremedlem DIRECTOR
VARA  Deputy board member/substitute Varamedlem DIRECTOR
KONT Contact person / representative Kontaktperson/representant OTHER
KOMP General partner Komplementar/medinnehaver OTHER
DTSO Partner with joint and several liability Deltaker med solidarisk ansvar (fullt ansvarlig) OTHER
DTPR  Partner with joint/pro rata liability Deltaker med proratisk ansvar (delt ansvar) OTHER
SAM  Co-owner/tenant in common Sameiere  DIRECTOR
EIKM  Owner municipality Eierkommune  OTHER
BEST  Managing owner in a joint-owned shipping firm/ managing ship owner  Bestyrende reder  DIRECTOR
OBS  Observer Observatør OTHER
BOBE  Receiver/official receiver/trustee in bankruptcy/ liquidator  Bobestyrer  OTHER
REVI Auditor  Revisor OTHER
REGN Accountant  Regnskapsfører OTHER

Request

curl -X GET --header 'Accept: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
'https://api.roaring.io/se/company/engagement/2.0/193701308888'

Response

{
  "hitCount": 2,
  "personalNumber": "193701308888",
  "firstName": "Christina Birgitta Ulrika",
  "givenName": "Birgitta",
  "middleName": "Thomeaus",
  "surName": "Efternamn3542",
  "engagements": [
    {
      "companyId": "5560572850",
      "companyName": "ACM 2001 AB",
      "statusCode": 141,
      "statusText": "Aktivt",
      "roles": [
        {
          "roleCode": 18,
          "roleName": "Ordförande"
        }
      ],
      "town": "STOCKHOLM"
    },
    {
      "companyId": "5567164818",
      "companyName": "Swedec AB",
      "statusCode": 100,
      "statusText": "Aktivt",
      "roles": [
        {
          "roleCode": 10,
          "roleName": "Suppleant"
        }
      ],
      "town": "TROLLHÄTTAN"
    }
  ]
}

These are person identifiers available for the API in the sandbox environment

Person identifier First name Sur name
01017100552 Harald Krane
01025700259 Frida Dyre
01029200781 Halvard Web Brusveen

Nordic

Politically Exposed Person (PEP)

v1.0 Contains information about all Politically Exposed Persons in the Nordics. Used in the KYC process (Know Your Customer).

Common use-cases:

For the search country code always needs to be present, the query parameter can be repeated in order to search for several country codes at the same time. The search needs to include either firstName and lastName or personal number. If these guidelines are not followed the API will present errors describing what is missing.

Endpoint

Get current person information

https://api.roaring.io/nordic/pep/1.0

Relation types

Code Text
1 Father-in-law
2 Father
3 Son-in-law
4 Daughter
5 Mother-in-law
6 Partner
7 Son
8 Known co-worker
9 Daughter-in-law
10 Mother

Role types

Code Text
Base role category
1 Representatives of central banks
2 Representatives of international organizations
3 Representatives of audit authorities
4 Representatives of state-owned companies
5 High diplomats
6 High judges
7 High officers
8 Ministers
9 Members of parliament
10 Heads of State and Government
22 Members of party boards
Detailed role category
1 Ambassador
2 Admiral
3 Apostolic nun
4 Division director state audit authority
5 Deputy Minister
6 Brigadier general
7 Chargé d’affaires
8 Judge in international supreme court
11 Queen
12 Member of an international organization's governing or controlling body
13 Member of Parliament at supranational level
18 Commodore
20 Executive member of central bank
21 General
23 Consul General
24 Lieutenant General
25 Major General
36 Judge in national supreme court
37 Consul
38 Rear Admiral
39 Crown Prince
40 Crown Princess
41 King
42 Judge or member of a constitutional court or constitutional referral body
43 Member of the central bank's governing or controlling body
44 Minister
49 Chairman of the central bank's governing or controlling body
51 President
52 Head of government
53 President of central bank
54 Member of national parliament
55 Senior official of state audit authority
56 Board member of state-owned company
57 Chairman of state-owned company
58 Deputy member of state-owned company
59 Deputy member of central bank's governing or controlling body
74 President and CEO of state-owned company
77 Vice Minister
80 Member of state-owned companies executive management group
81 Vice-admiral
349 Other high diplomat
357 President of National Parliament
380 Department Head
383 Chairman of the party board
384 Deputy Chairman of the Party Board
385 Member of party board
389 Deputy member of party board
411 Director of other state operations
412 Board member of other state-owned operations

SSN types

Code Text
Swe Personal Number
2 Swe Coordination Number

Name types

Code Text
1 Previous name
2 Alternative name
3 Primary name
4 National registry name

Detailed description of all the retrievable data in the API Object Model. The API Object model is also visible in the presentation of each API on the developer site

Detailed data description

Detailed description of all the retrievable data in the API Object Model. The API Object model is also visible in the presentation of each API on the developer site

Model Explanation
PepResults
hitCount
(integer optional)
Amount of returned entities
hits
(Array[PepResult] optional)
Array of search hits
PepResult
pep
(boolean optional)
Categorising entity as person or organisation /
rca
(boolean optional)
Organisation that owns the sancion decision
gender
(string optional)
PEP gender
ssns
(Array[PepSsn] optional)
Array of social security numbers associated with the PEP entity
birthDate
(string optional)
Birth date of the PEP (ISO 8601)
imageLink
(string optional)
Http link to picture of PEP
pepCountries
(Array[string] optional)
Array of countries the entity is PEP in (english text string)
names
(Array[PepName] optional)
Array of names associated with the PEP
roles
(Array[PepRole] optional)
Array of roles the PEP holds
relations
(Array[PepRelation] optional)
Array of related persons to the PEP/RCA
personId
(integer optional)
Local identifier for the PEP/RCA
PepSsn
ssnTypeId
(integer optional)
Id mapping the type of ssn identifier
ssnType
(string optional)
Text describing the type of ssn identifier
currentSSN
(string optional)
the current
previousSSN
(string optional)
PepName
firstName
(string optional)
lastName
(string optional)
nameType
(string optional)
nameTypeId
(integer optional)
PepRole
roleDescription
(integer optional)
countryOfJurisdiction
(integer optional)
fromDateYear
(integer optional)
fromDateMonth
(integer optional)
fromDateDay
(integer optional)
throughDateYear
(integer optional)
throughDateMonth
(integer optional)
throughDateDay (integer optional)
isActive
(boolean optional)
baseRoleCategoryId
(integer optional)
baseRoleCategoryName
(string optional)
detailedRoleCategoryId
(integer optional)
detailedRoleCategoryName
(string optional)
PepRelation
relationPersonId
(string optional)
relationTypeId
(string optional)
relationType
(string optional)

Object for Test

This service fetches test data information from a database containing a set of fictive persons with various different information types available.

Note that this is test data. Thus, information will change over time and can disappear. These are only examples of the responses you can receive in production.

Example: 193103249078

Request

curl -X GET --header 'Accept: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
'https://api.roaring.io/nordic/pep/1.0/search?countryCode=se&firstName=jan&lastName=bananberg'

Response

{
  "pep": true,
  "rca": false,
  "ssns": [
    {
      "ssnTypeId": 1,
      "ssnType": "SwePersonalNumber",
      "currentSsn": "193103249078"
    }
  ],
  "gender": "Male",
  "birthDate": "1931-03-24",
  "imageLink": "https://image.freepik.com/free-icon/protected-person-of-secret-service_318-64589.jpg",
  "pepCountries": [
    "Sweden"
  ],
  "names": [
    {
      "firstName": "Jan",
      "lastName": "Bananberg",
      "nameTypeId": "3",
      "nameType": "Primary name"
    },
    {
      "firstName": "Jan Erik",
      "lastName": "Bananberg",
      "nameTypeId": "4",
      "nameType": "National registry name"
    }
  ],
  "roles": [
    {
      "roleDescription": "Riksdagsledamot",
      "countryOfJurisdiction": "SWE",
      "fromDateYear": 1992,
      "fromDateMonth": 10,
      "fromDateDay": 3,
      "active": false,
      "baseRoleCategoryId": 9,
      "baseRoleCategoryName": "Members of parliament",
      "detailedRoleCategoryId": 54,
      "detailedRoleCategoryName": "Member of national parliament"
    },
    {
      "roleDescription": "Riksdagsledamot",
      "countryOfJurisdiction": "SWE",
      "fromDateYear": 2006,
      "fromDateMonth": 10,
      "fromDateDay": 2,
      "active": false,
      "baseRoleCategoryId": 9,
      "baseRoleCategoryName": "Members of parliament",
      "detailedRoleCategoryId": 54,
      "detailedRoleCategoryName": "Member of national parliament"
    }
  ],
  "relations": [
    {
      "relationPersonId": 55001,
      "relationTypeId": 6,
      "relationType": "Partner"
    },
    {
      "relationPersonId": 55002,
      "relationTypeId": 9,
      "relationType": "Daughter-in-law"
    },
    {
      "relationPersonId": 55003,
      "relationTypeId": 7,
      "relationType": "Son"
    }
  ],
  "personId": 55000
}

This dev data service fetches test data information from a database containing ca 6500 fictive persons with various different information types available.

Here are some personal numbers available in the test data to get your testing going.

First name Last name  Country code Personal number  PEP ID
Jan  Bananberg  SE 193103249078 55000
Karin  Bananberg   SE 192908187541 55001
Lena  Bananberg   SE 197109259288  55002
Erik  Bananberg   SE 196501133372  55003

Company

Sweden

v1.2

This API is used to search for companies with company names and various filters such as location or industry. The API downloads links to other APIs with more information about the company. You can also use this API to create your own prospect lists based on variables such as location, industry or turnover.

The Company Search API has several usecases. It is used for example, to search for individual companies or to select a target group of companies based on a number of different parameters. The metrics provided in the search result can be used in order to filter further calls towards the API.

Common use-cases:

Request parameters

Model Explanation
requestKey
string, optional
Keeping cached result when paging through previous result
pageSize
integer, optional
Number of results to return per page
from
integer, optional
First result post to have in result list page
companyName
string, optional
Company name
town
string, optional
Postal address town e.g. Stockholm
county
string, optional
Postal address county e.g. Stockholm County
zip
string, optional
Postal address zipcodes
industryCode
string, optional
Company main industry SNI code
legalGroupCode
string, optional
Company type code
vatReg
integer, optional
Company is registered for VAT (MOMS Sweden)
statusCode
integer, optional
Company status code
employerContributionReg
string, optional
companyRegistrationDate
string, optional
Handles ranges of dates using : between
netTurnover
string, optional
Net turnover, handles ranges of integers using : between
numberEmployees
string, optional
Number of employees (pcs), handles ranges of integers using : between

Detailed data description

Detailed description of all the retrievable data in the API Object Model. The API Object model is also visible in the presentation of each API on the developer portal.

Endpoint

https://api.roaring.io/se/company/search/1.2

Attributes

Model Explanation
CompanySearchResult
hitCount
integer, optional
number of entities found
hits
Array[Hits], optional
Array of hits on the search
requests
Array[Requests], optional
Array of possible requests to make in order to retrieve a full response with all hits for the data type indicated by the type field
previous
string, optional
url for fetching the next page of search data
next
string, optional
url for fetching the next page of search data
metrics
Metrics, optional
Metrics connected to the search
Hits
companyName
string, optional
Name of the company
legalGroupCode
string, optional
Which kind of company it is
legalGroupText
string, optional
Description of which kind of company it is
town
string, optional
The Town the company resides in
links
Array[Links], optional
array of api-links to fetch information on the company
Requests
type
string, optional
type of data
method
string, optional
Http method to use in the request
url
string, optional
URL to use for the request
payload
Payload, optional
json body to send with the request
Metrics
zipCode
object, optional
Metrics per returned zipCode
legalGroupCode
object, optional
Metrics per returned legalGroupCode
town
object, optional
Metrics per returned town
numberEmployees
object, optional
Metrics per returned interval of numberEmployees
county
object, optional
Metrics per returned county
netTurnover
object, optional
Metrics per returned interval of netTurnover
statusCode
object, optional
Metrics per returned statusCode
industryCode
object, optional
Metrics per returned industryCode
Links
type
string, optional
Name of API the link points to
method
string, optional
API verb
url
string, optional
URL link to the API call for retrieving information on the company
Payload
requestKey
string, optional
identifier used to retrieve a specific list of objects from an endpoint

Example response

The Company Search service retrieves production data. This means that all companies are searchable even in the sandbox.

Search parameters for Test

Example Response | zipCode = 41121 | legalGroupCode = AB | statusCode = 100 | companyRegistrationDate = 1994-12-12

Request

curl -X GET --header 'Accept: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
'https://api.roaring.io/se/company/search/1.2/search? \
zipCode=41121&legalGroupCode=AB&statusCode=100& \
companyRegistrationDate=1994-12-12'

Response

{
    "hitCount": 1,
    "hits": [
        {
            "companyName": "Wilfast Högsbo Aktiebolag",
            "legalGroupCode": "AB",
            "legalGroupText": "Privat aktiebolag",
            "town": "GÖTEBORG",
            "links": [
                {
                    "type": "company_economy_overview",
                    "method": "GET",
                    "url": "https://api.roaring.io/se/company/economy-overview/_re2f2ff73897504ea8b0f6558524dfb56"
                },
                {
                    "type": "company_establishments",
                    "method": "GET",
                    "url": "https://api.roaring.io/se/company/establishment/_re2f2ff73897504ea8b0f6558524dfb56"
                },
                {
                    "type": "company_signatory",
                    "method": "GET",
                    "url": "https://api.roaring.io/se/company/signatory/_re2f2ff73897504ea8b0f6558524dfb56"
                },
                {
                    "type": "company_overview",
                    "method": "GET",
                    "url": "https://api.roaring.io/se/company/overview/_re2f2ff73897504ea8b0f6558524dfb56"
                },
                {
                    "type": "company_board_members",
                    "method": "GET",
                    "url": "https://api.roaring.io/se/company/board-members/_re2f2ff73897504ea8b0f6558524dfb56"
                }
            ]
        }
    ],
    "requests": [
        {
            "type": "company_economy_overview",
            "method": "POST",
            "url": "https://api.roaring.io/se/company/economy-overview",
            "payload": {
                "requestKey": "2fe2db53-bfbe-44dd-8929-ea12e4d7b05a"
            }
        },
        {
            "type": "company_establishments",
            "method": "POST",
            "url": "https://api.roaring.io/se/company/establishment",
            "payload": {
                "requestKey": "2fe2db53-bfbe-44dd-8929-ea12e4d7b05a"
            }
        },
        {
            "type": "company_signatory",
            "method": "POST",
            "url": "https://api.roaring.io/se/company/signatory",
            "payload": {
                "requestKey": "2fe2db53-bfbe-44dd-8929-ea12e4d7b05a"
            }
        },
        {
            "type": "company_overview",
            "method": "POST",
            "url": "https://api.roaring.io/se/company/overview",
            "payload": {
                "requestKey": "2fe2db53-bfbe-44dd-8929-ea12e4d7b05a"
            }
        },
        {
            "type": "company_board_members",
            "method": "POST",
            "url": "https://api.roaring.io/se/company/board-members",
            "payload": {
                "requestKey": "2fe2db53-bfbe-44dd-8929-ea12e4d7b05a"
            }
        }
    ],
    "metrics": {
        "zipCode": {
            "41121": 1
        },
        "town": {
            "göteborg": 1
        },
        "legalGroupCode": {
            "ab": 1
        },
        "numberEmployees": {
            "200-499": 0,
            "5-9": 0,
            "20-49": 0,
            "100-199": 0,
            ">10000": 0,
            "1000-1499": 0,
            "500-999": 0,
            "1500-1999": 0,
            "2000-2999": 0,
            "50-99": 0,
            "4000-4999": 0,
            "<1": 1,
            "3000-3999": 0,
            "1-4": 0,
            "5000-9999": 0,
            "10-19": 0
        },
        "county": {
            "västra götaland": 1
        },
        "netTurnover": {
            "1000000-4999999": 0,
            "<1": 1,
            ">10000000": 0,
            "5000000-9999999": 0,
            "100000-499999": 0,
            "1000-4999": 0,
            "500-999": 0,
            "10000-49999": 0,
            "5000-9999": 0,
            "1-499": 0,
            "50000-99999": 0,
            "500000-999999": 0
        },
        "statusCode": {
            "100": 1
        },
        "industryCode": {
            "00009": 1
        }
    }
}
Legalform Swedish Company name Town Organizational number
Kommanditbolag Kommanditbolaget Porsen 17 Sjömarken 9168937861
Stiftelse Stiftelsen John Söderbergs fond Stockholm 8024045489
Ideell förening Torekovs föreläsningsförening Båstad 8394004322
Aktiebolag Wilfast Högsbo Aktiebolag Göteborg 5565002465
Aktiebolag Swedec AB Trollhättan 5567164818

Company Information

v1.1

Basic business information such as address, status and tax information.

Common use-cases:

Endpoint

https://api.roaring.io/se/company/overview/1.1/

Detailed data description

Detailed description of all the retrievable data in the API Object Model. The API Object model is also visible in the presentation of each API on the developer site

Model Explanation
companyId
string optional
Company identifier (company registration number / organization number)
changeDate
string optional
Date for when the record was last changed
statusCode
string optional

string optional
statusTextHigh
string optional
Company status text
statusTextDetailed
string optional
Company status text detailed
statusDateFrom
string optional
Company status date from
companyHolder
string optional
Name of company holder
companyName
string optional
Company name
severalCompanyName
boolean optional
Indicates if the company have more than one active name
coAddress
string optional
Postal address, C/O address
address
string optional
Postal address, street/P.O BOX
zipCode
string optional
Postal address, zipcode
town
string optional
Postal address, town
communeCode
string optional
Postal address, commune code
commune
string optional
Postal address, commune name
county
string optional
Postal address, county
registeredCoAddress
string optional
Registered address, county
registeredAddress
string optional
Registered address, street
registeredZipCode
string optional
Registered address, zipcode
registeredTown
string optional
Registered address, town
registeredCommuneCode
string optional
Registered address, commune code
registeredCommune
string optional
Registered address, commune
visitAddress
string optional
Visiting address, street name, street number and unit
visitStreet
string optional
Visiting address, street
visitStreetNumber
string optional
Visiting address, number
visitStreetUnit
string optional
Visiting address, unit
visitZipCode
string optional
Visiting address, zip code
visitTown
string optional
Visiting address, town
visitCommune
string optional
Visiting address, commune
visitCounty
string optional
Visiting address, county
phoneNumber
string optional
Telephone number
faxNumber
string optional
Fax number
email
string optional
Email address
webAddress
string optional
Web address
legalGroupCode
string optional
Company type code
legalGroupText
string optional
Company type text
preliminaryTaxReg
string optional
Company is approved for preliminary tax (F-skatt Sweden)
employerContributionReg
string optional
Company is registererd for employer contribution tax (Arb.avg Sweden)
vatReg
string optional
Company is registered for VAT (MOMS Sweden)
vatYN
string optional
VAT Yes or No
startDateVat
string optional
VAT start date
vepChangedDate
string optional
Show the latest date any of preliminaryTaxReg, employerContributionReg or vatReg has had a change
companyRegistrationDate
string optional
Company registration date
companyDeregistrationDate
string optional
Company deregistration date
industryCode
string optional
Company main industry, SNI code
industryText
string optional
Company main industry, SNI text
topDirectorName
string optional
Top director's name
topDirectorFunction
string optional
Top director's function
numberCompanyUnits
integer, optional
Number of company units/workplaces
numberEmployees
string optional
Number of employees (pcs)

Company Status Codes

A list of available status codes for a company is find here

Organization Numbers for Test

Example: Aktiebolag (Active company, not registered for any tax, company code unknown.) | 5565002465

Request

curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer {ACCESS TOKEN}' 'https://api.roaring.io/se/company/overview/1.1/5565002465'

Response

{
  "companyId": "5565002465",
  "changeDate": "2016-12-10",
  "statusCode": "100",
  "statusTextHigh": "Aktivt",
  "statusTextDetailed": "Aktivt",
  "statusDateFrom": "20130401",
  "companyName": "Wilfast Högsbo Aktiebolag",
  "severalCompanyName": false,
  "address": "Stora Badhusgatan 28 A",
  "zipCode": "41121",
  "town": "GÖTEBORG",
  "commune": "GÖTEBORG",
  "county": "VÄSTRA GÖTALAND",
  "phoneNumber": "031-171300",
  "legalGroupCode": "AB",
  "legalGroupText": "Privat aktiebolag",
  "preliminaryTaxReg": "0",
  "companyRegistrationDate": "1994-12-12",
  "industryCode": "00009",
  "industryText": "Huvudnäring okänd",
  "numberEmployees": "0"
}

Example: POST example | 5565002465, 5569994600

Request

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'Authorization: Bearer {ACCESS TOKEN}' -d '{ \ 
   "companyIds": ["5565002465","5569994600"] \ 
 }' 'https://api.roaring.io/se/company/overview/1.1/'

Response

{
  "responseInfo": {
    "requestCount": 2,
    "hitCount": 2,
    "noMatchIds": []
  },
  "companies": [
    {
      "companyId": 5565002465,
      "changeDate": "2016-12-10",
      "statusCode": 100,
      "statusTextHigh": "Aktivt",
      "statusTextDetailed": "Aktivt",
      "statusDateFrom": 20130401,
      "companyName": "Wilfast Högsbo Aktiebolag",
      "severalCompanyName": false,
      "address": "Stora Badhusgatan 28 A",
      "zipCode": 41121,
      "town": "GÖTEBORG",
      "commune": "GÖTEBORG",
      "county": "VÄSTRA GÖTALAND",
      "phoneNumber": "031-171300",
      "legalGroupCode": "AB",
      "legalGroupText": "Privat aktiebolag",
      "preliminaryTaxReg": 0,
      "companyRegistrationDate": "1994-12-12",
      "industryCode": "00009",
      "industryText": "Huvudnäring okänd",
      "numberEmployees": 0
    },
    {
      "companyId": 5569994600,
      "changeDate": "2016-12-10",
      "statusCode": 100,
      "statusTextHigh": "Aktivt",
      "statusTextDetailed": "Aktivt",
      "statusDateFrom": 20150105,
      "companyName": "Atsol AB",
      "severalCompanyName": false,
      "address": "Norra Parkgatan 3, Lgh 1402",
      "zipCode": 21153,
      "town": "MALMÖ",
      "commune": "MALMÖ",
      "county": "SKÅNE",
      "visitAddress": "Roskildevägen",
      "visitStreet": "Roskildevägen",
      "visitZipCode": 21147,
      "visitTown": "Malmö",
      "visitCommune": "MALMÖ",
      "visitCounty": "SKÅNE",
      "legalGroupCode": "AB",
      "legalGroupText": "Privat aktiebolag",
      "preliminaryTaxReg": 1,
      "employerContributionReg": 1,
      "vatReg": 1,
      "vepChangedDate": 20150708,
      "companyRegistrationDate": "2015-01-05",
      "industryCode": 64993,
      "industryText": "Förvaltning av och handel med värdepapper för en begränsad och sluten krets av ägare",
      "numberCompanyUnits": 1,
      "numberEmployees": 1
    }
  ]
}

This dev company data service fetches test company data information from a database containing a set of fictive companies with various different information types available.

Here are some company ID numbers available in the test data to get your testing going.

Note that this is test data. The information shown is per 2017-03-20. Thus, information will change over time and can disappear. These are only examples of the responses you can receive in production.

Legalform Swedish Type of test case Organizational number
Kommanditbolag 9168937861
Handelsbolag Active Company 9697715770
Bostadsrättsförening 7696053631
Samfällighetsförening 717913520
Stiftelse 8024045489
Ideell förening 8394004322
Aktiebolag (Active company, not registered for any tax, company code unknown.) 5565002465
Aktiebolag (Active company, registered for tax.) 5567164818
Aktiebolag (Active company, registered for tax.) 5564866803
Aktiebolag (Active company, registered for tax, head office.) 5569994600
Aktiebolag (Liquidation approved, C/O address) 5590506506
Aktiebolag (Active company, merger completed.) 5560572850
Aktiebolag (Bankruptcy) 5569030264
Enskild firma 7904182396
Enskild firma 6805029268
POST example 5565002465, 5569994600

Company Activity

v1.0

Provides information about what the company is doing and whether the company has any secondary names and shows all the industries in which the company has registered activities.

Common use-cases:

Endpoint

https://api.roaring.io/se/company/activity/1.0/{companyId}

Detailed data description

Detailed description of all the retrievable data. The API Object model is also visible in the presentation of each API on the developer site

Response data

Property Explanation
companyId
string
Company identifier
timestamp
string
Timestamp for latest data update
latestChangeDate
string
Date of latest activity change
status
Object[Status]
Status object explaining status of the data delivery
mainActivity
Object[MainActivity]
Main activity i.e. main SNI code
otherActivities
Array[OtherActivity]
Other activities i.e. other SNI codes
secondaryNames
Array[SecondaryName]
Secondary names, ref to specific part of the companies activity

Status

Property Explanation
code
text

MainActivity

Property Explanation
industryCode SNI code
industryText SNI text

OtherActivity

Property Explanation
industryCode SNI code
industryText SNI text

SecondaryName

Property Explanation
name Name
registrationDate Registration date
deRegistrationDate Deregistration date
activityDescription Activity description

Example

Request

curl -X GET --header 'Accept: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
'https://api.roaring.io/se/company/activity/1.0/5567164818'

Response

{
    "companyId": "5567164818",
    "timestamp": 1568160000,
    "latestChangeDate": "20190912",
    "status": {
        "code": 0,
        "text": "Activity record exists"
    },
    "activityDescription": "Företaget ska bedriva verksamheter som riktar sig till hund och katt. Detta sker genom tjänster såsom hundrastning, utbildning, konsultation, publikationer, fotografering, biluthyrning, hundmassage, hundpensionat, hunddagis och kattpassning.",   
    "secondaryNames": [
        {
        "name": "Vecanis",
        "registrationDate": "20170124",
        "activityDescription": "För den del av verksamheten som avser e-handel med inriktning mot husdjursprodukter."
        },
        {
        "name": "Akiluna",
        "registrationDate": "20171207",
        "activityDescription": "För den del av verksamheten som avser hundträning och beteendekonsultation"
        },
        {
        "name": "Pet Of Gaia",
        "registrationDate": "20160412",
        "activityDescription": "För den del av verksamheten som avser försäljning av husdjurs- artiklar till zoo-handlare, hundskolor samt verksamheter där hundrelaterade produkter används (hundrastning, hundträning)."
        }
    ],  
    "mainActivity": {
        "industryCode": "46380",
        "industryText": "Partihandel med andra livsmedel, bl.a. fisk samt skal- och blötdjur"
    },  
    "otherActivities": [
        {
        "industryCode": "47911",
        "industryText": "Postorderhandel och detaljhandel på Internet med brett sortiment"
        },
        {
        "industryCode": "46499",
        "industryText": "Partihandel med övriga hushållsvaror"
        },
        {
        "industryCode": "96090",
        "industryText": "Övriga konsumenttjänstföretag"
        }
  ]    
}

Test data

These are company numbers available for the API in the sandbox environment.

Legalform Swedish Type of test case Organizational number
Kommanditbolag 9168937861
Handelsbolag Active Company 9697715770
Bostadsrättsförening 7696053631
Samfällighetsförening 717913520
Stiftelse 8024045489
Ideell förening 8394004322
Aktiebolag (Active company, not registered for any tax, company code unknown.) 5565002465
Aktiebolag (Active company, registered for tax.) 5567164818
Aktiebolag (Active company, registered for tax.) 5564866803
Aktiebolag (Active company, registered for tax, head office.) 5569994600
Aktiebolag (Liquidation approved, C/O address) 5590506506
Aktiebolag (Active company, merger completed.) 5560572850
Aktiebolag (Bankruptcy) 5569030264

Financial Information

v1.1

Shows the most important statements and key figures.

Contains financial statements and financial ratios so that you get a good picture of the company’s financial position.

Common use-cases:

Endpoint

https://api.roaring.io/se/company/economy-overview/1.1/

Detailed data description

Detailed description of all the retrievable data in the API Object Model. The API Object model is also visible in the presentation of each API on the developer site

Model Explanation
companyId
string, optional
Company identifier (company registration number / organization number)
changeDate
string, optional
Date for when the record was last changed
bsShareCapital
string, optional
Shared capital
nbrOfEmployees
string, optional
Number of employees
nbrOfEmployeesInterval
string, optiona
Number of employees interval
nbrOfEmployeesOfficeInterval
string, optional
Number of employees office interval
netTurnover
string, optional
Net turnover
turnoverInterval
string, optional
Turnover interval
turnoverPerEmployee
string, optional
Turnover per employee
plOperatingProfit
string, optional
Pl operating Profit
plProfitLossAfterFinItems
string, optional
Pl after financial items
string, optional
bsTotalEquity
string, optional
Bs Total Equity
bsTotalAssets
string, optional
Bs Total assets
bsCashAndBankBalances
string, optional
Bs Cash And Bank Balances
kpiSolidityPercent
string, optional
Kpi Solidity Percent
kpiQuickRatioPercent
string, optional
Kpi Quick Ratio Percent
kpiNetMarginPercent
string, optional
Kpi Net Margin Percent

Organization Numbers for Test

Example: Aktiebolag (Active company, not registered for any tax, company code unknown.) | 5565002465

Request

curl -X GET --header 'Accept: application/json' \
--header 'Authorization: {ACCESS TOKEN}' \
'https://api.roaring.io/se/company/economy-overview/1.1/5565002465'

Response

{
  "companyId": "5565002465",
  "changeDate": "2016-12-10",
  "bsShareCapital": "100",
  "nbrOfEmployees": "0",
  "nbrOfEmployeesInterval": "0 anställda",
  "nbrOfEmployeesOfficeInterval": "Okänt antal kontorsanställda",
  "netTurnover": "0",
  "turnoverPerEmployee": "0",
  "plOperatingProfit": "-7",
  "plProfitLossAfterFinItems": "-7",
  "plNetIncome": "-7",
  "bsTotalEquity": "121",
  "bsTotalAssets": "127",
  "bsCashAndBankBalances": "41",
  "kpiSolidityPercent": "95.3",
  "kpiQuickRatioPercent": "2116.7",
  "kpiNetMarginPercent": "0"
}

This dev company data service fetches test company data information from a database containing a set of fictive companies with various different information types available.

Here are some company ID numbers available in the test data to get your testing going.

Note that this is test data. Thus, information will change over time and can disappear. These are only examples of the responses you can receive in production.

Legalform Swedish Type of test case Organizational number
Kommanditbolag 9168937861
Bostadsrättsförening 7696053631
Samfällighetsförening 717913520
Stiftelse 8024045489
Ideell förening 8394004322
Aktiebolag (Active company, not registered for any tax, company code unknown.) 5565002465
Aktiebolag (Active company, registered for tax.) 5567164818
Aktiebolag (Active company, registered for tax.) 5564866803
Aktiebolag (Active company, registered for tax, head office.) 5569994600
Aktiebolag (Liquidation approved, C/O address) 5590506506
Aktiebolag (Active company, merger completed.) 5560572850
Aktiebolag (Bankruptcy) 5569030264

Local Units

v1.0

Information about a Swedish company's geographic Local Units (Establishments, Workplaces).

Local Units API contains information about a Swedish company's geographic Local Units (Establishments, Workplaces). Is used to keep track of a company's different Local Units and their postal and delivery addresses.

Common use-cases:

Endpoint

https://api.roaring.io/se/company/establishment/1.0/

Detailed data description

Detailed description of all the retrievable data in the API Object Model. The API Object model is also visible in the presentation of each API on the developer site

Model Parameters
companyId
string, optional
Company identifier (company registration number / organization number)
changeDate
string, optional:
Date for when the record was last changed
establishments
Array[inline_model], optional
Array of establishments for the requested company
companyEstablishmentNumber
string,
A specific Company Establishment Number also knowns as CFAR
establishmentOfficeName
string, optional
Name of the office eg. headquarters or store.
establishmentOfficeType
string, optional
Type of office eg. warehouse
establishmentCoAddress
string, optional
Postal address C/O address
establishmentAddress
string, optional
Postal address street/P.O BOX
establishmentZipCode
string, optional
Postal address zipcode
establishmentTown
string, optional
Postal address town
establishmentVisitAddress
string, optional
Visiting address street
establishmentVisitZipCode
string, optional
Visiting address zip code
establishmentVisitTown
string, optional
Visiting address town
phoneNumber
string, optional
Telephone number
faxNumber
string, optional
Fax number
email
string, optional
Email address
industryCode
string, optional
Company main industry SNI code
industryText
string, optional
Company main industry SNI text

commercialBlockText
string, optional numberEmployeesInterval
string, optional | Number of employees in interval

Organization Numbers for Test

Example: Aktiebolag (Active company, registered for tax.) | 5567164818

Request

curl -X GET --header 'Accept: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
'https://api.roaring.io/se/company/establishment/1.0/5567164818'

Response

{
  "companyId": "5567164818",
  "changeDate": "2016-12-10",
  "establishments": [
    {
      "companyEstablishmentNumber": "46803870",
      "establishmentOfficeName": "Swedec AB",
      "establishmentOfficeType": "Huvudkontor",
      "establishmentAddress": "Åkerssjövägen 52",
      "establishmentZipCode": "46153",
      "establishmentTown": "Trollhättan",
      "establishmentVisitAddress": "Åkerssjövägen 52",
      "establishmentVisitZipCode": "46153",
      "establishmentVisitTown": "Trollhättan",
      "phoneNumber": "0706-646428",
      "industryCode": "70100",
      "industryText": "Administrativ företagsverksamhet",
      "commercialBlockText": "Tar emot reklam",
      "numberEmployeesInterval": "1-4 anställda"
    }
  ]
}

This dev company data service fetches test company data information from a database containing a set of fictive companies with various different information types available.

Here are some company ID numbers available in the test data to get your testing going.

Note that this is test data. Thus, information will change over time and can disappear. These are only examples of the responses you can receive in production.

Legalform Swedish Type of test case Organizational number
Bostadsrättsförening 7696053631
Ideell förening 8394004322
Handelsbolag Active company 9697715770
Aktiebolag Active company, registered for tax. 5567164818
Aktiebolag Active company, registered for tax. 5564866803
Aktiebolag Active company, registered for tax, head office. 5569994600
Aktiebolag Active company, merger completed. 5560572850

Board Members

v1.1

Contains information about the companies executives such as the Board, CEO and auditors.

Common use-cases:

Endpoint

https://api.roaring.io/se/company/board-members/1.1/

Detailed API data description

Detailed description of all the retrievable data in the API Object Model. The API Object model is also visible in the presentation of each API on the developer site

Model Explanation
companyId
string, optional
Company identifier (company registration number / organization number)
changeDate
string, optional
Date for when the record was last changed
boardMembers
Array[inline_model_0], optional
Array of board members for the requested company
boardMemberCompanyId
string, optional
personalNumber
string, optional
Personal identity number and co-ordination number.
fullName
string, optional
firstName
string, optional
givenName
string, optional
middleName
string, optional
surName
string, optional
roleCode
integer, optional
Code for type of role
roleName
string, optional
Name of the office
fromDate
string, optional
toDate
string, optional

Role codes

Code Role
0 Innehavare
1 Arbetstagarrepresentant
2 Extern firmatecknare
3 Extern verkställande direktör
4 Extern vice verkställande direktör
5 Ledamot
6 Likvidator
7 Likvidatorssuppleant
8 Revisor
9 Revisorssuppleant
10 Suppleant
12 Verkställande direktör
13 Vice verkställande direktör
14 Bolagsman
15 Kommanditdelägare
16 Komplementär
18 Ordförande
20 Prokurist
21 Huvudansvarig revisor
22 Lekmannarevisor
23 Lekmannarevisorssuppleant
24 Ställföreträdande VD
25 Verkställande ledamot
26 Vice ordförande
27 Särskild delgivningsmottagare
28 Aktuarie
29 Utlandsbosatt inom EES
30 Utlandsbosatt utanför EES
31 Försäkringsrepresentant

Organization Numbers for Test

Example: 5565002465

Request

curl -X GET --header 'Accept: application/json'\
 --header 'Authorization: Bearer {ACCESS TOKEN}' \
 'https://api.roaring.io/se/company/board-members/1.1/5565002465'

Response

{
  "companyId": "5565002465",
  "changeDate": "2016-12-10",
  "boardMembers": [
    {
      "boardMemberCompanyId": "2907304766",
      "personalNumber": "192907304766",
      "firstName": "Helga Viktoria",
      "surName": "Efternamn2609",
      "roleCode": "5",
      "roleName": "Ledamot",
      "fromDate": "1994-12-12"
    },
    {
      "boardMemberCompanyId": "6805029268",
      "personalNumber": "196805029268",
      "firstName": "Petra",
      "surName": "Efternamn2401",
      "roleCode": "10",
      "roleName": "Suppleant",
      "fromDate": "2003-11-01"
    },
    {
      "boardMemberCompanyId": "4812161596",
      "personalNumber": "194812161596",
      "firstName": "Nils Uno",
      "givenName": "Uno",
      "surName": "Efternamn1433",
      "roleCode": "5",
      "roleName": "Ledamot",
      "fromDate": "2003-11-01"
    },
    {
      "boardMemberCompanyId": "7904182396",
      "personalNumber": "197904182396",
      "firstName": "Kuno",
      "surName": "Efternamn2993",
      "roleCode": "5",
      "roleName": "Ledamot",
      "fromDate": "2003-11-01"
    }
  ]
}

This dev company data service fetches test company data information from a database containing a set of fictive persons with various different information types available.

Here are some personal indentity numbers available in the test data to get your testing going.

Note that this is test data. Thus, information will change over time and can disappear. These are only examples of the responses you can receive in production.

Legalform Swedish Type of test case Organizational number
Kommanditbolag 9168937861
Handelsbolag 9697715770
Bostadsrättsförening 7696053631
Aktiebolag (Active company, not registered for any tax, company code unknown.) 5565002465
Aktiebolag (Active company, registered for tax.) 5567164818
Aktiebolag (Active company, registered for tax.) 5564866803
Aktiebolag (Active company, registered for tax, head office.) 5569994600
Aktiebolag (Liquidation approved, C/O address) 5590506506
Aktiebolag (Active company, merger completed.) 5560572850
Aktiebolag (Bankruptcy) 5569030264

Company Group Structure

v1.0

The Company Group Structure lists all companies that are part of a group and its ownership relationships.

The Company Group Structure check is a part of the KYC process (Know-Your-Customer) and mandatory just like checking against PEP and Sanctions lists and controlling if a a company has any Beneficial Owners.

Common use-cases:

Endpoint

https://api.roaring.io/se/company/group-structure/1.0/{companyId}

Detailed data description

Detailed description of all the retrievable data in the API Object Model. The API Object model is also visible in the presentation of each API on the developer site

Model Explanation
companyId
string
Company identifier
timestamp
string
Timestamp for latest data update
companyName
string
Name of group mother company
countryCode
string
Country code where Group mother resides
latestChangeDate
string
Date of latest group structure change
status
Object[Status]
Status object explaining status of the data delivery
groupCompanies
Array[GroupCompanies]
the daughter companies in the group
GroupCompanies
companyId
string
Company identifier for company in group
companyName
string
Name of company in group
motherCompanyId
string
Company identifier for mother company in group
ownedPercentage
integer
percentage of the group company that the mother owns
countryCode
string
Country code where the group company resides
companyLevel
integer
Level in the group that this company resides (mother is level 0)
Status
code
integer
Status code for the data delivery
text
string
Status descriptive text for data delivery

Responses

The response always show the entire group structure where the company that was supplied as argument resides, i.e. any company in a structure can be used to lookup the entire structure. The group mother is presented in top level and then all the other companies are presented in the list "groupCompanies". In order to create a complete tree from the data every company in the group is supplied with the companyId of its closest mother, for simplicity the level where the company resides in the group structure is also supplied in the response. The company level is counted from the group mother which have level 0 and increasing with every step down in the tree. Only companies that are owned to more than 50% are considered to be in a group structure and supplied in the response of this service.

Status

Code Text
0 Group structure exists
1 Company not connected to group structure

Example | Fetch group using group mother companyId

Request

curl -X GET --header 'Accept: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
'https://api.roaring.io/se/company/group-structure/1.0/5567164818'

Response

{
    "companyId": "5567164818",
    "timestamp": 1565481600,
    "companyName": "Swedec AB",
    "countryCode": "SE",
    "latestChangeDate": "20190808",
    "status": {
        "code": 0,
        "text": "Group structure exists"
    },
    "groupCompanies": [
        {
            "companyId": "5591379978",
            "companyName": "E.M.J Racing AB",
            "motherCompanyId": "5567164818",
            "ownedPercentage": 100,
            "countryCode": "SE",
            "companyLevel": 1
        },
        {
            "companyId": "5563568202",
            "companyName": "DeepTech AB",
            "motherCompanyId": "5567164818",
            "ownedPercentage": 100,
            "countryCode": "SE",
            "companyLevel": 1
        }
    ]
}

Here are some company ID numbers available in the test data to get your testing going.

Note that this is test data. These are only examples of the responses you can receive in production.

Legalform Swedish Type of test case Organizational number
AB Company not connected to group structure 5569994600
AB Group structure exists, fetched via mother  5567164818
AB Group structure exists, group daughter company 5565002465

Beneficial Owner - Company

v1.0

See which companies a person is a Beneficial Owner for.

A beneficial owner is someone who ultimately owns or controls a company, association or other type of legal entity. A beneficial owner can also be someone who benefits from someone else acting on their behalf.

Common use-cases:

Endpoint

Get companies Beneficials Owners

https://api.roaring.io/se/beneficialowner/1.0/company/{companyId}

Detailed data description

Detailed description of all the retrievable data in the API Object Model. The API Object model is also visible in the presentation of each API on the developer site. If a beneficial owner does not have a swedish personal number a 6-digit birth date is still available.

Model Explanation
CompanyResponse
legalEntity
Association, optional
otherAssociation
Association, optional
associationCollected
boolean, optional
falseInformation
boolean, optional
representatives
Array[PersonDetails], optional
beneficialOwners
Array[BeneficialOwner], optional
status
Status, optional
registrationDate
string, optional
Association
companyId
string, optional
Company Id
companyName
string, optional
Name of company
type
Status, optional
PersonDetails
personalNumber
string, optional
Personal number
coordinationNumber
string, optional
Coordination number
birthDate
string, optional
Date of birth
firstNames
Array[string], optional
Array of first names
givenName
string, optional
Given name
middleName
string, optional
Middle name
surName
string, optional
Surname
gdNumber
string, optional
GD number
countryResidence
Status, optional
citizenship
Status, optional
BeneficialOwner
person
PersonDetails, optional
extentOfControl
Status, optional
controlTypes
Array[ControlType], optional
association
Association, optional
Status
code
string, optional
Status code
description
string, optional
Description of status code
ControlType
code
string, optional
Control code
description
string, optional
Description of control code
association
Association, optional

Codes

Citizenship, Country of residence

In addition to the country codes and countries that may occur, the following can also be displayed:

Code Explanation
VETEJ Can not be determined
STATSLOS Stateless (applies only to country of residence)
Code Explanation
AB Aktiebolag
AKASSA Erkänd Arbetslöshetskassa
ANNANJUR Annan typ av juridisk person
BAB Bankaktiebolag
BF Bostadsförening
BRF Bostadsrättsförening
EEIG Europeisk ekonomisk intressegruppering
EK Ekonomisk förening
FAB Försäkringsaktiebolag
FAMSTIFT Familjestiftelse
FOF Försäkringsförening
GB Gruvbolag HB Handelsbolag
IF Ideell förening KB Kommanditbolag
KHF Kooperativ hyresrättsförening
MB Medlemsbank
OFB Ömsesidigt försäkringsbolag
OFFKORP Offentlig korporation
OVRJUR Övriga svenska juridiska personer bildade enligt särskild lagstiftning OVRSTIFT
RTSF Registrerade Trossamfund
SAMF Samfällighetsförening
SB Sparbank
SCE Europakooperativ
SE Europabolag SF Sambruksförening
UNDERFORF Understödsföreningar, försäkringsföreningar
UTLJUR Utländsk juridisk person
Code Explanation
TRUST Trust eller liknande juridisk konstruktion

Status Beneficial Owner

Code Explanation Swedish  Explanation English
FINNS Det finns en eller flera verkliga huvudmän There are one or more beneficial owners
FINNS_EJ Det finns ingen verklig huvudman There is no beneficial owner
INGEN_TRÄFF Ingen träff i verklighuvudmannaregistret No registered information of beneficial ownership
EJFASTSTALLD Företaget eller föreningen kan inte komma fram till om det finns någon verklig huvudman eller har inte tillräckligt med uppgifter för att identifiera vem det är The company or association can not judge if there is any benificial owners or do not have enough information to identify who it is.

Extent Of Control

Code Explanation Swedish  Explanation English
INTERVALL1 Mer än 0 % men inte mer än 25 % More than 0% but not more than 25%
INTERVALL2 Mer än 25 % men inte mer än 50 % More than 25% but not more than 50%
INTERVALL3 Mer än 50 % men inte mer än 75 % More than 50% but not more than 75%
INTERVALL4 Mer än 75 % men mindre än 100 % More than 75% but less than 100%
INTERVALL5 100 % 100%

ControlType | Art

Code Explanation
ART10 Personen har kontroll genom aktier, andelar, medlemskap, avtal eller bestämmelse i exempelvis bolagsordning eller stadgar.
ART14 Personen är styrelseledamot eller motsvarande befattningshavare.
ART17 Personen företräder förvaltaren av stiftelsen.
ART20 Personen har rätt att utse eller avsätta mer än hälften av styrelseledamöterna eller motsvarande befattningshavare.
ART25 Personen kan, enligt stiftelseförordnandet, få en väsentlig del av de medel som stiftelsen delar ut. ART30 Personen har kontroll tillsammans med närstående. ART40 Personen har kontroll genom andra företag eller föreningar.
ART70 Personen är instiftare av trusten.
ART71 Personen är förvaltare av trusten eller företrädare för förvaltaren om den är en juridisk person.
ART72 Personen är beskyddare av trusten. ART73 Personen är förmånstagare till trusten.
ART74 Personen utövar kontroll på annat sätt.

Numbers for Test

Example: Companies Beneficials Owners | 5564866803

Request

curl -X GET --header 'Accept: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \ 
'https://api.roaring.io/se/beneficialowner/1.0/company/5564866803'

Response

{
  "legalEntity": {
    "type": {
      "description": "Aktiebolag",
      "code": "AB"
    },
    "companyId": "5564866803",
    "companyName": "Aronfors Bygg och Teknik Aktiebolag"
  },
  "otherAssociation": {
    "type": {
      "description": "Trust eller liknande juridisk konstruktion",
      "code": "TRUST"
    },
    "companyId": "0000000000",
    "companyName": "Trust Fond 2001"
  },
  "associationCollected": false,
  "falseInformation": false,
  "representatives": [
    {
      "personalNumber": "193701308888",
      "birthDate": "1937-01-30",
      "coordinationNumber": "",
      "firstNames": [
        "Christina", "Birgitta", "Ulrika"
      ],
      "givenName": "Birgitta",
      "middleName": "",
      "surName": "Testsson",
      "citizenship": {
        "description": "Kan inte fastställas",
        "code": "VETEJ"
      },
      "countryResidence": {
        "description": "Statslös",
        "code": "STATSLOS"
      },
      "gdNumber": ""
    }
  ],
  "beneficialOwners": [
    {
      "person": {
        "personalNumber": "196805029268",
        "birthDate": "1968-05-02",
        "coordinationNumber": "",
        "firstNames": [
          "Petra"
        ],
        "givenName": "Petra",
        "middleName": "",
        "surName": "Efternamn2401",
        "citizenship": {
          "description": "Norge",
          "code": "NO"
        },
        "countryResidence": {
          "description": "Sverige",
          "code": "SE"
        },
        "gdNumber": ""
      },
      "extentOfControl": {
        "description": "Mer än 50 % men inte mer än 75 %",
        "code": "INTERVALL3"
      },
      "controlTypes": [
        {
          "description": "Personen har kontroll genom aktier, andelar, medlemskap, avtal eller bestämmelse i exempelvis bolagsordning eller stadgar.",
          "code": "ART10"
        },
        {
          "description": "Personen har kontroll genom andra företag eller föreningar.",
          "code": "ART40",
          "association": {
            "companyId": "5567164818",
            "companyName": "Swedec AB"
          }
        }
      ]
    }
  ],
  "status": {
    "description": "Det finns en eller flera verkliga huvudmän.",
    "code": "FINNS"
  },
  "registrationDate": "2018-01-12T11:26:55.773"
}

This dev company data service fetches test company data information from a database containing a set of fictive persons with various different information types available.

Here are some personal indentity numbers available in the test data to get your testing going.

Note that this is test data. Thus, information will change over time and can disappear. These are only examples of the responses you can receive in production.

Type of test case Number
Companies Beneficials Owners 5564866803
Registered that no Beneficial owner exists 5565002465
No information on Beneficial owner in registry 5560572850

Signing Combinations

v1.0

Signing Combinations provides answers to which combinations of individuals, individually or in combination, have the right to sign the company. The service is used to automate the verification that the right people are entitled to sign a company at a given time. Examples of applications are when signing agreements, creating accounts or automated customer registrations.

Common use-cases:

Endpoint

https://api.roaring.io/se/company/signing-combinations/1.0/

Detailed data description

Detailed description of all the retrievable data in the API Object Model. The API Object model is also visible in the presentation of each API on the developer site

Model Explanation
companyId
string, optional
Company identifier
changeDate
string, optional
Date for latest change on signing rights for company
personalNumber
string, optional
Personal number controled for signing rights
individualSigningRight
boolean, optional
True if person has individual signing rights
signingRightDescription
string, optional
Describes if the person can sign alone or together with others
companyId
string, optional
Company identifier
changeDate
string, optional
Date for latest change on signing rights for company
coverage
string, optional
The coverage of the answer, explains if all the possible signing combinations could be found. possible values: complete, partial and none
adminSign
Array, optional
Array of persons that are allowed to sign for the company only in administrative matters
combinations
Array, optional
Possible signing combinations
name
string, optional
signatory name
personalNumber
string, optional
Personal identification number for signatory
positions
Array, optional
Positions that signatory has
roleName
string, optional
role name for board position
roleCode
integer, optional
role code number for board position
anomalies
Array, optional
Potential anomalies concerning this signatory
anomalyCode
string, optional
code identifying possible anomaly
anomalyDescription
integer, optional
description for anomaly code

Anomaly codes

Code Description
1 Company identifier instead of personal identifier
2 Incomplete personal identifier

Coverage

The "coverage" field can have one of three different values explaining if the response contains all different signatory combinations or if there is anything that has not been possible to interpret.

Value Description
complete Response contains all signing combinations for the company
partial There is a possibility that there are signing combinations not included in the response.
none No signing combinations identified for requested company.

Organization Numbers for Test

Example: 5565002465

Request

curl -X GET --header 'Accept: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
'https://api.roaring.io/se/company/signing-combinations/\
1.0/combinations/5565002465'

Response

{
  "companyId": "5565002465",
  "changeDate": "2018-06-10",
  "coverage": "complete",
  "adminSign": null,
  "combinations": [
    [
      {
        "name": "Efternamn2609, Helga Viktoria",
        "positions": [
          {
            "roleCode": 5,
            "roleName": "Ledamot"
          }
        ],
        "personalNumber": "192907304766",
        "anomalies":null
      }
    ],
    [
      {
        "name": "Efternamn2401, Petra",
        "positions": [
          {
            "roleCode": 10,
            "roleName": "Suppleant"
          }
        ],
        "personalNumber": "196805029268",
        "anomalies":null
      }
    ]
  ]
}

Example: 5569030264

Request

curl -X GET --header 'Accept: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
'https://api.roaring.io/se/company/signing-combinations/\
1.0/combinations/5569030264'

Response

{
  "error": "NotFound",
  "message": "No right to sign"
}

This dev company data service fetches test company data information from a database containing a set of fictive persons with various different information types available.

Here are some personal indentity numbers available in the test data to get your testing going.

Note that this is test data. Thus, information will change over time and can disappear. These are only examples of the responses you can receive in production.

Legalform Swedish Type of test case Organizational number
Kommanditbolag Active company, includes Anomaly information 9168937861
Handelsbolag Active company 9697715770
Aktiebolag Active company, not registered for any tax, company code unknown. 5565002465
Aktiebolag Active company, registered for tax. 5567164818
Aktiebolag Active company, registered for tax. 5564866803
Aktiebolag Active company, registered for tax, head office. 5569994600
Aktiebolag Active company, merger completed. 5560572850
Aktiebolag Bankruptcy) 5569030264
Enskild firma Active company 6805029268

Signatory Text

v1.1

Contains complete information about a swedish company's all company signatories in text form.

Is used to make sure that it is the right person you do business with and that they can sign an agreement.

Common use-cases:

Endpoint

https://api.roaring.io/se/company/signatory/1.1/

Detailed data description

Detailed description of all the retrievable data in the API Object Model. The API Object model is also visible in the presentation of each API on the developer site

Model Explanation
companyId
string, optional
Company identifier (company registration number / organization number)
changeDate
string, optional
Date for when the record was last changed
companySignatory
string, optional
Signatory for the company

Organization Numbers for Test

Example: 5565002465

Request

curl -X GET --header 'Accept: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
'https://api.roaring.io/se/company/signatory/1.1/5565002465'

Response

{
  "changeDate": "2016-12-10",
  "companyId": "5565002465",
  "companySignatory": "Firman tecknas av styrelsen  Firman tecknas var för sig av  >Wilson, Erik Sternhard Mattias  >Wilson, Karl Viktor Jonas"
}

This dev company data service fetches test company data information from a database containing a set of fictive persons with various different information types available.

Here are some personal indentity numbers available in the test data to get your testing going.

Note that this is test data. Thus, information will change over time and can disappear. These are only examples of the responses you can receive in production.

Legalform Swedish Type of test case Organizational number
Kommanditbolag 9168937861
Bostadsrättsförening 7696053631
Aktiebolag Active company, not registered for any tax, company code unknown. 5565002465
Aktiebolag Active company, registered for tax. 5567164818
Aktiebolag Active company, registered for tax. 5564866803
Aktiebolag Active company, registered for tax, head office. 5569994600
Aktiebolag Liquidation approved, C/O address 5590506506
Aktiebolag Active company, merger completed. 5560572850
Aktiebolag Bankruptcy 5569030264

Credit Decision Company

v1.1

Automated credit decisions if the company is to be granted a loan, credit or invoice.

With credit decision you get an automatic answer to grant a credit or not. Often, a well-proven standard template for companies is used. It is possible to get a unique credit template with parameters and rules that shall be included in the decision.

Common use-cases:

Endpoint

https://api.roaring.io/se/company/credit-decision/1.1/{companyId}

Detailed data description

Detailed description of all the retrievable data in the API Object Model. The API Object model is also visible in the presentation of each API on the developer site

Model Explanation
companyId
string, optional
Company identifier
statusCode
string, optional
Company status code
statusText
string, optional
Company status text
rejections
CompanyRejection, optional
address
string, optional
Postal address street/P.O BOX.
zipCode
string, optional
Postal address zipcode
town
string, optional
Postal address town
causeOfReject
string, optional
rejectText
string, optional
rejectComment
string, optional

Responses

Hard coded denial response codes for companies. After control of the common responses the next step is to control if the company is active or not. Here the status of the company is verified. If the company is inactive (no longer a living company) the block containing code and text for the current company status will be returned. The request will not move on to validate the company against the credit template. The denial means that a company has a bankruptcy concluded, liquidation concluded, the company has been stricken off, a concluded fusion or that the company has been delisted.

Company Denial Codes

Code Description
S200 Inactive
S203 Dormant
S231 Liquidation concluded
S241 Merger concluded
S291 Bankruptcy concluded
S292 Bankruptcy concluded
S300 Delisted
S336 Company stricken off according to the Companies Act 13:18
S337 Company stricken off
S350 Stricken off according to the Partnership and Non-registered Partnership Act 17:2
S351 Stricken off according to the Economic Association (co-operative) Act 11:18
S352 Delisted
S353 Delisted due to new owner
S354 Delisted due to fusion with foreign company
S360 Delisted due to liquidation/bankruptcy of foreign company
S361 Delisted due to discontinuation of business operation
S362 Delisted, the branch office has no managing director
S363 Delisted, according to court order
S364 Delisted, annual report lacking
S370 Delisted at own request
S371 Delisted by request from Bolagsverket (Companies House) S373 Avfört Stricken off
S374 Stricken off, re-registered as a jointstock bank S377 Avregistrat pga ombildning Delisted due to conversion

Additional denial codes concerning sole proprietorship

Code Description
S2 Protected
S3 Locked
S4 Deceased
S5 Removed from register
S6 Emigrated
S7 Social security number changed

Organization Numbers for Test

Example: Approved | 5564866803

Request

curl -X GET --header 'Accept: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
'https://api.roaring.io/se/company\
/credit-decision/1.1/5564866803?template=Roaring'

Response

{
  "zipCode": "45534",
  "companyId": "5564866803",
  "rejections": [],
  "address": "Hededalsvägen 20",
  "town": "MUNKEDAL",
  "statusText": "Approved",
  "statusCode": "1"
}

Example: Trial | 7696245120

Request

curl -X GET --header 'Accept: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
'https://api.roaring.io/se/company\
/credit-decision/1.1/7696245120?template=Roaring'

Response

{
  "companyId": "7696245120",
  "rejections": [],
  "statusText": "Trial",
  "statusCode": "4"
}

Example: Not Approved | 5565002465

Request

curl -X GET --header 'Accept: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
'https://api.roaring.io/se/company\
/credit-decision/1.1/5565002465?template=Roaring'

Response

{
  "companyId": "5565002465",
  "rejections": [
    {
      "rejectComment": "",
      "causeOfReject": "9",
      "rejectText": "Wrong username or password"
    }
  ],
  "statusText": "Not Approved",
  "statusCode": "2"
}

This dev company data service fetches test company data information from a database containing a set of fictive companies with various different information types available.

Here are some company ID numbers available in the test data to get your testing going.

Note that this is test data. The information shown is per 2017-03-20. Thus, information will change over time and can disappear. These are only examples of the responses you can receive in production.

Paramters for request countryCode: se companyId: (example) 5564866803 template: (anything)

Status Reject text Organizational number
Approved 5564866803
Trial 7696245120
Not Approved Incorrect info XML code 9696373076
Not Approved No access to this product 5563260701
Not Approved Wrong username or password 5565002465
Not Approved Wrong block 5567164818
Not Approved Wrong template 5567664601
Not Approved Security validation not ok 5561289744

Here are some more test numbers in our Sandbox

Status Reject text Organizational number
Not Approved Incorrect info XML code 9696373076
Not Approved An error occurred, please try again later 9168937861
Not Approved No match record 8024045489
Not Approved Your account does not allow information access to this company 5590964275
Not Approved No access to this company type 5569979734
Not Approved No active templates found 5590672613
Not Approved Inactive 5569466856
Not Approved Dormant 717913520
Not Approved Liquidation concluded  5590506506
Not Approved Merger concluded 5560572850
Not Approved Bankruptcy concluded 5569030264
Not Approved Bankruptcy concluded 8394004322
Not Approved Delisted 5561979740
Not Approved Company stricken off according to the Companies Act 13:18 9697313006
Not Approved  Company stricken off 5561614206
Not Approved Stricken off according to the Partnership and Non-registered Partnership Act 17:2 7904182396
Not Approved Stricken off according to the Economic Association (co-operative) Act 5569015075
Not Approved Delisted 3701308888
Not Approved Delisted due to new owner 2907304766
Not Approved Delisted due to fusion with foreign company 6805029268
Not Approved Delisted due to liquidation/bankruptcy of foreign company 4812161596
Not Approved Delisted due to discontinuation of business operation 5561881607
Not Approved Delisted, the branch office has no managing director 9111029196
Not Approved Delisted, according to court order 9111022399
Not Approved Delisted, annual report lacking 5561344309
Not Approved Delisted at own request 3604139208
Not Approved Delisted by request from Bolagsverket 8512122394
Not Approved Stricken off 7911012388
Not Approved Stricken off, re-registered as a joint- stock bank 7806082397
Not Approved Delisted due to conversion 9211629192###

Monitor Company Information (Deprecated)

v1.0

With the API Monitor Company Information you get information about all changes in the company data that has happened after the date you provide in the request. The response includes information about all APIs that have any new information about the company. You can automate your company monitoring by setting your own rules when to check for changes and when to update your information. This gives you the power to check and update your records when you want instead of having to adjust to your data suppliers monitoring rules.

Common use-cases:

Endpoint

https://api.roaring.io/se/company/event/1.0/changes

Detailed data description

Detailed description of all the retrievable data in the API Object Model. The API Object model is also visible in the presentation of each API on the developer site

Model Explanation
companyId
string, optional
Company identifier ,
code
string, optional
Change code for the event ,
changeDate
string, optional
Date for when the event occurred ,
dataSet
Array[string], optional
List of all Roaring datasets affected by the event

Change Codes

Change Code Beskrivning Swedish Description English API
ADRC Adress, ändrad Address, changed Overview
SHCD Aktiekapital, minskat   Share capital, reduction Economy
SHCN Aktiekapital, nybildning Share capital, new Economy
SHCI Aktiekapital, nyemission Share capital, new issue Economy
EMCC Arb. avgift, ändrad Employment tax, changed Overview
PRTN Beslutad arbetsgivaravgift inkommen, första fillfället PAYE registered, first occasion Overview
ANAN  Bokslut, nytt Annual account, new Economy
ANAC Bokslut, ändrat Annual account, changed Economy
FAXR Faxnummer, borttaget Fax number, removed Overview, Establishments
FAXN Faxnummer, nytt Fax number, new Overview, Establishments
FAXC Faxnummer, ändrat Fax number, changed Overview, Establishments
CTXC F-skatt, ändrad Company tax, changed Overview
NAMC Företagsnamn, ändrat Company name, changed Overview
ASIC Företagstecknare ändrad alternativt ny eller ändrad vakanstext Authorised signatories amended or new/amended vacancy text Signatory, Board Members
REPC Företrädaruppgifter, ändrade Company representatives, changed Signatory, Board Members
REGC Förändring av företagets registreringsdatum Date of registration, changed Overview
MERC Information om fusion, ändrad Merge information, changed Overview
VATC Moms, ändrad VAT, changed Overview
RESC Registrerat säte, ändrat Place of residence, changed Overview
STAC Status, ändrad Status, changed Overview
BOAC Styrelse, ändrad Board, changed Board Members
PHOR Telefonnummer, borttaget Phone number, removed Overview, Establishments
PHON Telefonnummer, nytt Phone number, new Overview, Establishments
PHOC Telefonnummer, ändrat Phone number, changed Overview, Establishments

Organization Numbers for Test

Request example: 556500-2465, 556999-4600

curl -X POST --header 'Content-Type: application/json' \
--header 'Accept: application/json' --header 'Authorization: Bearer {ACCESS TOKEN}' \ 
 'https://api.roaring.io/se/company/event/1.0/changes' \ 
 -d '{
   "requests": [ \ 
     { \ 
       "companyId": "5565002465", \ 
       "date": "2018-07-11" \ 
     }, \  
     { \ 
       "companyId": "5569994600", \ 
       "date": "2018-07-11" \ 
     } \ 
   ] \ 
 }'

Response example:

{
  "responseInfo": {
    "requestCount": 1,
    "hitCount": 6,
    "noMatchIds": []
  },
  "responses": [
    {
      "companyId": "5565002465",
      "code": "ANAN",
      "changeDate": "20180611",
      "dataSet": [
        "company-economy-overview"
      ]
    },
    {
      "companyId": "5565002465",
      "code": "ASIC",
      "changeDate": "20180808",
      "dataSet": [
        "company-signatory",
        "company-board-members"
      ]
    },
    {
      "companyId": "5565002465",
      "code": "REPC",
      "changeDate": "20180808",
      "dataSet": [
        "company-signatory",
        "company-board-members"
      ]
    },
    {
      "companyId": "5565002465",
      "code": "REPC",
      "changeDate": "20181003",
      "dataSet": [
        "company-signatory",
        "company-board-members"
      ]
    },
    {
      "companyId": "5565002465",
      "code": "ADRC",
      "changeDate": "20180131",
      "dataSet": [
        "company-overview"
      ]
    },
    {
      "companyId": "5565002465",
      "code": "ASIC",
      "changeDate": "20181003",
      "dataSet": [
        "company-signatory",
        "company-board-members"
      ]
    }
  ]
  }

This dev company data service fetches test company data information from a database containing a set of fictive companies with various different information types available.

Here are some personal indentity numbers available in the test data to get your testing going.

Note that this is test data. Thus, information will change over time and can disappear. These are only examples of the responses you can receive in production.

Organization Number  Change Date
916893-7861  datum 2018-07-11
556500-2465  datum 2018-07-11
556057-2850  datum 2018-07-11
5565002465, 5569994600  datum 2018-07-11
5569030264  datum 2018-07-11
769605-3631 datum 2018-06-11

Norway

v1.0

This API is used to search for companies with company names and various filters such as location or industry. The API downloads links to other APIs with more information about the company. You can also use this API to create your own prospect lists based on variables such as location, industry or turnover.

The Company Search API has several usecases. It is used for example, to search for individual companies or to select a target group of companies based on a number of different parameters. The metrics provided in the search result can be used in order to filter further calls towards the API.

Common use-cases:

Request parameters

Model Explanation
requestKey
string, optional
Keeping cached result when paging through previous result
pageSize
integer, optional
Number of results to return per page
from
integer, optional
First result post to have in result list page
companyName
string, optional
Company name
registeredTown
string, optional
Postal address town e.g. Oslo
county
string, optional
Postal address county e.g. Oslo County
zip
string, optional
Postal address zipcodes
industryCode
string, optional
Company main industry SNI code
legalGroupCode
string, optional
Company type code
vatReg
integer, optional
Company is registered for VAT
statusCode
integer, optional
Company status code
companyRegistrationDate
string, optional
Handles ranges of dates using : between

Detailed data description

Detailed description of all the retrievable data in the API Object Model. The API Object model is also visible in the presentation of each API on the developer portal.

Endpoint

https://api.roaring.io/no/company/search/1.0

Attributes

Model Explanation
CompanySearchResult
hitCount
integer, optional
number of entities found
hits
Array[Hits], optional
Array of hits on the search
requests
Array[Requests], optional
Array of possible requests to make in order to retrieve a full response with all hits for the data type indicated by the type field
previous
string, optional
url for fetching the next page of search data
next
string, optional
url for fetching the next page of search data
metrics
Metrics, optional
Metrics connected to the search
Hits
companyName
string, optional
Name of the company
legalGroupCode
string, optional
Which kind of company it is
legalGroupText
string, optional
Description of which kind of company it is
registeredTown
string, optional
The Town the company resides in
links
Array[Links], optional
array of api-links to fetch information on the company
Requests
type
string, optional
type of data
method
string, optional
Http method to use in the request
url
string, optional
URL to use for the request
payload
Payload, optional
json body to send with the request
Metrics
registeredZipCode
object, optional
Metrics per returned zipCode
legalGroupCode
object, optional
Metrics per returned legalGroupCode
registeredTown
object, optional
Metrics per returned town
statusCode
object, optional
Metrics per returned statusCode
industryCode
object, optional
Metrics per returned industryCode
Links
type
string, optional
Name of API the link points to
method
string, optional
API verb
url
string, optional
URL link to the API call for retrieving information on the company
Payload
requestKey
string, optional
identifier used to retrieve a specific list of objects from an endpoint

Example response

The Company Search service retrieves production data. This means that all companies are searchable even in the sandbox.

Search parameters for Test

Example Response | Juniors, Kongsberg

Request

curl -X GET --header 'Accept: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
'https://api.roaring.io/no/company/search/1.0/search?name=JUNIORS&town=KONGSBERG'

Response

{
  "hitCount": 2,
  "hits": [
    {
      "companyName": "JUNIORS AS",
      "legalGroupCode": "AS",
      "legalGroupText": "Aksjeselskap",
      "registeredTown": "KONGSBERG",
      "links": [
        {
          "type": "company_signing_combinations",
          "method": "GET",
          "url": "https://api.roaring.io/no/company/signing-combinations/combinations/_r7f793630c92ee88559d6590696b70057"
        },
        {
          "type": "company_overview",
          "method": "GET",
          "url": "https://api.roaring.io/no/company/overview/_r7f793630c92ee88559d6590696b70057"
        }
      ]
    },
    {
      "companyName": "JUNIORS AS",
      "legalGroupCode": "BEDR",
      "legalGroupText": "Underavdeling",
      "registeredTown": "KONGSBERG",
      "links": [
        {
          "type": "company_signing_combinations",
          "method": "GET",
          "url": "https://api.roaring.io/no/company/signing-combinations/combinations/_r52e68883f20d9587c166d3dc8a6e2167"
        },
        {
          "type": "company_overview",
          "method": "GET",
          "url": "https://api.roaring.io/no/company/overview/_r52e68883f20d9587c166d3dc8a6e2167"
        }
      ]
    }
  ],
  "requests": [
    {
      "type": "company_overview",
      "method": "POST",
      "url": "https://api.roaring.io/no/company/overview",
      "payload": {
        "requestKey": "6b2c11cf-75e7-4751-a113-3cae3c0c80c3"
      }
    }
  ],
  "metrics": {
    "registeredZipCode": {
      "3611": 2
    },
    "legalGroupCode": {
      "as": 1,
      "bedr": 1
    },
    "registeredTown": {
      "kongsberg": 2
    },
    "statusCode": {
      "A": 2
    },
    "industryCode": {
      "47.710": 2
    }
  }
}

Example Response | metallco as, Oslo, zipcode 0668

Request

curl -X GET --header 'Accept: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
'https://api.roaring.io/no/company/search/1.0/search?companyName=metallco%20as&registeredTown=oslo&registeredZipCode=0668'

Response

{
  "hitCount": 2,
  "hits": [
    {
      "companyName": "METALLCO AS",
      "legalGroupCode": "AS",
      "legalGroupText": "Aksjeselskap",
      "registeredTown": "OSLO",
      "links": [
        {
          "type": "company_signing_combinations",
          "method": "GET",
          "url": "https://api.roaring.io/no/company/signing-combinations/combinations/_r7c66642480fb6d02861e35bfd79f9014"
        },
        {
          "type": "company_overview",
          "method": "GET",
          "url": "https://api.roaring.io/no/company/overview/_r7c66642480fb6d02861e35bfd79f9014"
        }
      ]
    },
    {
      "companyName": "METALLCO AS",
      "legalGroupCode": "BEDR",
      "legalGroupText": "Underavdeling",
      "registeredTown": "OSLO",
      "links": [
        {
          "type": "company_signing_combinations",
          "method": "GET",
          "url": "https://api.roaring.io/no/company/signing-combinations/combinations/_rc1d095896e0d0ab1b1d9d3ae26be7eb5"
        },
        {
          "type": "company_overview",
          "method": "GET",
          "url": "https://api.roaring.io/no/company/overview/_rc1d095896e0d0ab1b1d9d3ae26be7eb5"
        }
      ]
    }
  ],
  "requests": [
    {
      "type": "company_overview",
      "method": "POST",
      "url": "https://api.roaring.io/no/company/overview",
      "payload": {
        "requestKey": "d4f30d5f-8458-40ca-95bd-5566e350df53"
      }
    }
  ],
  "metrics": {
    "registeredZipCode": {
      "0668": 2
    },
    "legalGroupCode": {
      "as": 1,
      "bedr": 1
    },
    "registeredTown": {
      "oslo": 2
    },
    "statusCode": {
      "A": 2
    },
    "industryCode": {
      "38.320": 2
    }
  }
}
Legalform Swedish Company name Town Organizational number
Bedrift Juniors AS Kongsberg 971697555
Aksjeselskap Metallco AS Oslo 810392312

Company Information

v1.0

Basic business information such as address, status and tax information.

Common use-cases:

Endpoint

https://api.roaring.io/no/company/overview/1.0

Detailed data description

Detailed description of all the retrievable data in the API Object Model. The API Object model is also visible in the presentation of each API on the developer site

Model Explanation
companyId
string optional
Company identifier (company registration number / organization number)
changeDate
string optional
Date for when the record was last changed
statusCode
string optional
Company status code
statusTextHigh
string optional
Company status text
statusTextDetailed
string optional
Company status text detailed
statusDateFrom
string optional
Company status date from
companyName
string optional
Company name
coAddress
string optional
Postal address C/O address
address
string optional
Postal address street/P.O BOX
zipCode
string optional
Postal address zipcode
town
string optional
Postal address town
commune
string optional
Postal address commune name
county
string optional
Postal address county
visitAddress
string optional
Visiting address street name street number and unit
visitStreet
string optional
Visiting address street
visitStreetNumber
string optional
Visiting address number
visitStreetUnit
string optional
Visiting address unit
visitZipCode
string optional
Visiting address zip code
visitTown
string optional
Visiting address town
visitCommune
string optional
Visiting address commune
visitCounty
string optional
Visiting address county
phoneNumber
string optional
Telephone number
faxNumber
string optional
Fax number
email
string optional
Email address
webAddress
string optional
Web address
legalGroupCode
string optional
Company type code
legalGroupText
string optional
Company type text
preliminaryTaxReg
string optional
Company is approved for preliminary tax (F-skatt Sweden)
employerContributionReg
string optional
Company is registererd for employer contribution tax (Arb.avg Sweden)
vatReg
string optional
Company is registered for VAT (MOMS Sweden)
vepChangedDate
string optional
Show the latest date any of preliminaryTaxReg employerContributionReg or vatReg has had a change
companyRegistrationDate
string optional
Company registration date
companyDeregistrationDate
string optional
Company deregistration date
industryCode
string optional
Company main industry NACE code
industryText
string optional
Company main industry NACE text
topDirectorName
string optional
Top director's name
topDirectorFunction
string optional
Top director's function
numberCompanyUnits
string optional
Number of company units/workplaces
numberEmployees
string optional
Number of employees (pcs)

Company Status Codes

A list of available status codes for a company is find here

Organization Numbers for Test

Example: Aksjeselskap | 810059672

Request

curl -X GET --header 'Accept: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
'https://api.roaring.io/no/company/overview/1.0/810059672'

Response shell { "numberCompanyUnits": "1", "statusCode": "A", "registeredTown": "EIDSVÅG I ROMSDAL", "registeredZipCode": "6460", "phoneNumber": "71232456", "startDateVat": "2016-03", "topDirectorFunction": "Daglig leder/administrerende direktør", "industryText": "Utleie av egen eller leid fast eiendom ellers", "statusTextDetailed": "Active", "coAddress": null, "zipCode": null, "vatYN": "no", "industryTextEng": "Other letting of real estate", "county": null, "industryCode": "68.209", "registeredCommuneCode": "1543", "communeCode": null, "statusTextHigh": "Active", "changeDate": "2017-10-14", "companyName": "AASEN & FARSTAD AS", "statusDateFrom": null, "vatReg": "0", "legalGroupCode": "AS", "address": null, "legalGroupTextEng": "Limited company", "registeredCommune": "Nesset", "commune": null, "companyRegistrationDate": "19950219", "town": null, "registeredCoAddress": null, "companyId": "810059672", "topDirectorName": "Farstad, Svein Olav", "legalGroupText": "Aksjeselskap", "registeredAddress": "Nedre Liedgardsveg 2", "companyDeregistrationDate": null, "faxNumber": "71232654" }

This dev company data service fetches test company data information from a database containing a set of fictive companies with various different information types available.

Here are some company ID numbers available in the test data to get your testing going.

Note that this is test data. The information shown is per 2017-03-20. Thus, information will change over time and can disappear. These are only examples of the responses you can receive in production.

Legalform Norwegian Organizational number
Underavdeling 971697555
Enkeltpersonsforetak 919434104
Aksjeselskap 810059672
Aksjeselskap 810392312
Kirkelig Fellesråd 987569166
Administrativ Enhet Offentlig Sektor 990492263
Selskap Med Begrenset Ansvar 970232222
Forening/Lag/Innretning 811556912
Annet Foretak Iflg. Særsk. Lov 818711832

Company Board Members

v1.0

Contains information about the companies executives such as the Board, CEO and auditors

Common use-cases:

Endpoint

https://api.roaring.io/no/company/board-members/1.0/{companyId}

Detailed data description

Detailed description of all the retrievable data. The API Object model is also visible in the presentation of each API on the developer site

Response data

Property Explanation
companyId
string
Company identifier
status
Object[Status]
Object describing status for the data delivery
changeDate
string
Date for latest board members related change
boardMembers
Array[BoardMember]
Board members

Status

Property Explanation
code Status code
text Status text

BoardMember

Property Explanation
id
string
Person or company identifier
isCompany
boolean
Denotes whether member is person or company
firstName
string
First name
surName
string
Last name
fullName
string
Full name
roles
Array[Role]
Roles

Role

Property Explanation
roleCode
string
Role code
roleName
string
Role name
fromDate
string
Role access date

Example

Request

curl -X GET --header 'Accept: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
'https://api.roaring.io/no/company/board-members/1.0/810392312'

Response

{
  "companyId": "810392312",
  "status": {
    "code": 0,
    "text": "BoardMembers found"
  },
  "changeDate": "2019-10-20",
  "boardMembers": [
    {
      "firstName": "Harald",
      "surName": "Krane",
      "fullName": "Krane, Harald",
      "id": "01017100552",
      "isCompany": false,
      "roles": [
        {
          "roleCode": "MEDL",
          "roleName": "Board member(s)",
          "fromDate": "2018-09-30"
        }
      ]
    },
    {
      "firstName": "Frida",
      "surName": "Dyre",
      "fullName": "Dyre, Frida",
      "id": "01025700259",
      "isCompany": false,
      "roles": [
        {
          "roleCode": "DAGL",
          "roleName": "General Manager/CEO",
          "fromDate": "2017-08-28"
        },
        {
          "roleCode": "LEDE",
          "roleName": "Chairman of the board",
          "fromDate": "2018-01-02"
        }
      ]
    }
  ]
}

Test data

These are company identifiers available for the API in the sandbox environment

Company id Company name Commune
810392312 Metallco AS Oslo
971697555 Juniors AS Kongsberg

Signing Combinations

v1.0 Signing Combinations provides answers to which combinations of individuals, individually or in combination, have the right to sign the company. The service is used to automate the verification that the right people are entitled to sign a company at a given time. Examples of applications are when signing agreements, creating accounts or automated customer registrations.

Common use-cases:

Endpoint

https://api.roaring.io/no/company/signing-combinations/1.0

Detailed data description

Detailed description of all the retrievable data in the API Object Model. The API Object model is also visible in the presentation of each API on the developer site

Model Explanation
companyId
string, optional
Company identifier
changeDate
string, optional
Date for latest change on signing rights for company
coverage
string, optional
The coverage of the answer, explains if all the possible signing combinations could be found. possible values: complete, partial and none
adminSign
Array[CompanySigningCombinationPerson], optional
Contains persons that are allowed to sign for the company only in administrative matters
combinations
Array[Inline Model 1], optional
Possible signing combinations
prokura
Array[Inline Model 2], optional
Possible prokura signing combinations
name
string, optional
Signatory name
personalNumber (string, optional Personal identification number for signatory
positions
Array[Inline Model 3], optional
Positions that signatory holds
anomalies
Array[Inline Model 4], optional
Potential anomalies concerning this signatory
roleName
string, optional
role name for board position
roleCode
string, optional
role code number for board position
anomalyCode
integer, optional
code identifying possible anomaly
anomalyDescription
string, optional
description for anomaly code

Anomaly codes

Code Description
1 Company identifier instead of personal identifier
2 Incomplete personal identifier

Coverage

The "coverage" field can have one of three different values explaining if the response contains all different signatory combinations or if there is anything that has not been possible to interpret.

Value Description
complete Response contains all signing combinations for the company
partial There is a possibility that there are signing combinations not included in the response.
none No signing combinations identified for requested company.

Organization Numbers for Test

Example: 810059672

Request

curl -X GET --header 'Accept: application/json' \
--header 'Authorization: Bearer {ACCESS TOKEN}' \
'https://api.roaring.io/no/company/signing-combinations/1.0/\
combinations/810059672'

Response

{
  "companyId": "810059672",
  "changeDate": "2018-10-12",
  "coverage": "Complete",
  "combinations": [
    [
      {
        "name": "Bror Johansen",
        "positions": [
          {
            "roleCode": "DAGL",
            "roleName": "Daglig leder/administrerende direktør"
          },
          {
            "roleCode": "LEDE",
            "roleName": "Styreleder"
          }
        ],
        "personalNumber": "31120000767",
        "anomalies": null
      }
    ]
  ],
  "prokura": []
}

This dev company data service fetches test company data information from a database containing a set of fictive persons with various different information types available.

Here are some personal indentity numbers available in the test data to get your testing going.

Note that this is test data. Thus, information will change over time and can disappear. These are only examples of the responses you can receive in production.

Legalform Norwegian Organizational number
Underavdeling 971697555
Enkeltpersonsforetak 919434104
Aksjeselskap 810059672
Aksjeselskap 810392312
Kirkelig Fellesråd  987569166
Annet Foretak Iflg. Særsk. Lov 818711832

Miscellaneous

Global

Sanctions Lists

v1.0

Check if a person or organisation is on the EU or UN sanction lists and financial connection is prohibited.

Common use-cases:

Endpoint

https://api.roaring.io/global/sanctions-lists/1.0

Detailed data description

Detailed description of all the retrievable data in the API Object Model. The API Object model is also visible in the presentation of each API on the developer site

Model Explanation
SanctionResult
hitCount
integer, optional
Amount of returned entities
hits
Array[inline_model], optional
Array of search hits
inline_model
entityType
string, optional
Categorising entity as person or organisation
sanctionOrganisation
string, optional
Organisation that owns the sancion decision
gender
string, optional
Sanction entity gender
legalBasis
string, optional
Legal basis for being on the sanction list
pdfLink
string, optional
Link to the PDF version of the sanction report
programme
string, optional
Sanction program under which the entity is placed
remark
string, optional
Eventual remark on the entity
versionNumber
string, optional
Entity version (changes on entity update)
unListType
string, optional
referenceNumber
string, optional
Sanction organisation reference number
comment
string, optional
Comment placed by the sanction organisation
listedDate
string, optional
names
Array[SanctionName], optional
Array of names associated with the sanction entity
aliases
Array[SanctionAlias], optional
Array of aliases associated with the
sanction
entity
addresses
Array[SanctionAddress], optional
Array of addresses associated with the sanction entity
birthDataItems
Array[SanctionBirthDataItem], optional
Array of birth data associated with the sanction entity
citizenDataItems
Array[SanctionCitizenDataItem], optional
Array of citizen data associated with the sanction entity
entityNationality
Array[SanctionNationality], optional
Array of nationality data associated with the sanction entity
entityDesignations
Array[SanctionDesignation], optional
Array of designation data associated with the sanction entity
updateHistoryItems
Array[SanctionUpdateHistoryItem], optional
Array of historical updates associated with the sanction entity
documentations
Array[SanctionDocument], optional
Array of documents associated with the sanction entity
SanctionName
firstName
string, optional
secondName
string, optional
lastName
string, optional
wholeName
string, optional
thirdName
string, optional
fourthName
string, optional
originalScriptName
string, optional
title
string, optional
legalBasis
string, optional
pdfLink
string, optional
programme
string, optional
remark
string, optional
listedDate
string, optional
language
string, optional
SanctionAlias
name
string, optional
quality
string, optional
dateOfBirth
string, optional
cityOfBirth
string, optional
countryOfBirth
string, optional
note
string, optional
SanctionAddress
street
string, optional
number
string, optional
zipcode
string, optional
city
string, optional
stateProvince
string, optional
country
string, optional
other
string, optional
legalBasis
string, optional
pdfLink
string, optional
programme
string, optional
remark
string, optional
listedDate
string, optional
SanctionBirthDataItem
date
string, optional
year
string, optional
fromYear
string, optional
toYear
string, optional
place
string, optional
city
string, optional
stateProvince
string, optional
country
string, optional
typeOfDate
string, optional
noteDate
string, optional
notePlace
string, optional
legalBasis
string, optional
pdfLink
string, optional
programme
string, optional
remark
string, optional
listedDate
string, optional
SanctionCitizenDataItem
country
string, optional
legalBasis
string, optional
pdfLink
string, optional
programme
string, optional
remark
string, optional
listedDate
string, optional
SanctionNationality
nationality
string, optional
SanctionDesignation
designation string, optional
SanctionUpdateHistoryItem
updatedDate
string, optional
updatedItem
string, optional
SanctionDocument
passportId
string, optional
number
string, optional
issuingCountry
string, optional
typeOfDocument
string, optional
typeOfDocument2
string, optional
dateOfIssue
string, optional
cityOfIssue
string, optional
countryOfIssue
string, optional
legalBasis
string, optional
pdfLink
string, optional
programme
string, optional
remark
string, optional
listedDate
string, optional

Programme codes

Code Programme name
Afg Afghanistan
Bdi Burundi
Blr Belarus
Caf Central african republic
Chem Chemical weapons
Civ Ivory coast
Cod Emocratic republic of congo
Com Comoros
Code Programmes
Egy Egypt
Eri Eritrea
Euaq European autonomous al-qaeda
Gin Guinea
Gnb Guinea-bissau
Hti Haiti
Icty Persons indicted by international criminal court
Irn Iran
Irq Iraq - former president saddam hussein
Lbn Lebanon - suspects assassination
Lbr Liberia - former president taylor
Lby Libya
Mmr Myanmar/burma
Prk Democratic people´s republic of korea
Rus Russia
Sdn Sudan
Som Somalia
Ssd South sudan
Syr Syrian arab republic
Taqa Al qaeda
Terr Terrorist groups (foreign terrorists)
Tun Tunisia
Ukr Ukraine
Unli United nations listing of sanctioned individuals and entities
Ven Venezuela
Yem Yemen
Yug Yugoslavia (serbia and montenegro)
Zwe Zimbabwe

Objects for Test

Example

Request

curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer {ACCESS TOKEN}' \ 
'https://api.roaring.io/global/sanctions-lists/1.0/search?name=Leo%20Efternamn2636'

Response

{
  "hitCount": 1,
  "hits": [
    {
      "entityType": "Person",
      "sanctionOrganisation": "EU",
      "gender": "Male",
      "legalBasis": "596/2013 (OJ L172)",
      "pdfLink": "http://eur-lex.europa.eu/LexUriServ/LexUriServ.do?uri=OJ:L:2013:172:0001:0003:EN:PDF",
      "programme": "TAQA",
      "names": [
        {
          "firstName": "Leo",
          "secondName": "Muhammed Awad",
          "lastName": "Efternamn2636",
          "wholeName": "Leo Efternamn2636",
          "title": "Shaykh",
          "legalBasis": "844/2007 (OJ L186)",
          "pdfLink": "http://eur-lex.europa.eu/LexUriServ/LexUriServ.do?uri=OJ:L:2007:186:0024:0028:EN:PDF",
          "programme": "TAQA",
          "listedDate": "2007-07-18"
        },
        {
          "wholeName": "Leo Efternamn2636",
          "legalBasis": "844/2007 (OJ L186)",
          "pdfLink": "http://eur-lex.europa.eu/LexUriServ/LexUriServ.do?uri=OJ:L:2007:186:0024:0028:EN:PDF",
          "programme": "TAQA",
          "listedDate": "2007-07-18"
        }
      ],
      "birthDataItems": [
        {
          "date": "1957-03-10",
          "country": "YEM",
          "legalBasis": "844/2007 (OJ L186)",
          "pdfLink": "http://eur-lex.europa.eu/LexUriServ/LexUriServ.do?uri=OJ:L:2007:186:0024:0028:EN:PDF",
          "programme": "TAQA",
          "listedDate": "2007-07-18"
        }
      ],
      "updateHistoryItems": [
        {
          "updatedDate": "2018-06-20T04:00:13.353",
          "updatedItem": "Entity"
        },
        {
          "updatedDate": "2018-06-20T04:00:13.353",
          "updatedItem": "Name"
        }
      ]
    }
  ]
}

Request

curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer {ACCESS TOKEN}' \ 
'https://api.roaring.io/global/sanctions-lists/1.0/search?name=The%20Group%20for%20the%20Preservation%20of%20Vegetables'

Response

{
  "hitCount": 1,
  "hits": [
    {
      "entityType": "Organisation",
      "sanctionOrganisation": "FN",
      "gender": "Unknown",
      "versionNumber": 1,
      "unListType": "El-Baba",
      "referenceNumber": "QDe.004",
      "comment": "Review pursuant to Security Council resolution 1822 (2008) was concluded on 21 Jun. 2010. INTERPOL-UN Security Council Special Notice web link: https://www.interpol.int/en/notice/search/une/5278330",
      "listedDate": {
        "year": 2001,
        "month": 10,
        "day": 6
      },
      "names": [
        {
          "firstName": "EL-BABA",
          "listedDate": "2001-10-06"
        }
      ],
      "aliases": [
        {
          "name": "Chock",
          "quality": "a.k.a."
        },
        {
          "name": "Al Radience",
          "quality": "a.k.a."
        },
        {
          "name": "Organic explanation",
          "quality": "a.k.a."
        },
        {
          "name": "The Group for the Preservation of Vegetables",
          "quality": "a.k.a."
        },
        {
          "name": "The Organic Army for the Liberation of Vegetables",
          "quality": "a.k.a."
        },
        {
          "name": "El Raidababa",
          "quality": "a.k.a."
        }
      ],
      "updateHistoryItems": [
        {
          "updatedDate": "2018-06-18T13:19:11.627"
        },
        {
          "updatedDate": "2018-06-18T13:19:11.627"
        },
        {
          "updatedDate": "2018-06-18T13:19:11.627",
          "updatedItem": "Entity"
        }
      ]
    }
  ]
}

This dev company data service fetches test company data information from a database containing a set of fictive persons with various different information types available.

Here are some personal indentity numbers available in the test data to get your testing going.

Note that this is test data. Thus, information will change over time and can disappear. These are only examples of the responses you can receive in production.

Type of test case Search criteria
Person Leo Efternamn2636
Organisation The Group for the Preservation of Vegetables