Scoring RYG

The API returns company's scoring information in JSON format, as specified by business id or duns number.

In order to use the API you must have the valid environment-specific username and password. Before any API requests, you need to obtain an API KEY. You will get a valid API KEY (it's called a ticket) by using the ticket API (Please, read how to use ticket API instructions).

The API KEY must be sent in the request custom header element (named ticket or x-api-key). If the API KEY value is valid then API request will be successful (http status code 200), otherwise it will fail (http status code 401). All API requests must be made over HTTPS. Request the username and password

Endpoints

https://api.bisnode.fi/company/info/v3/scoring-ryg - production environment
https://api-test.bisnode.fi/company/info/v3/scoring-ryg - test environment

Request parameters

Parameter	Description
id	Business id or duns number	X
X = Mandatory

GET https://api-test.bisnode.fi/company/info/v3/scoring-ryg/{id}

Response

Element	Description
businessId	The company's business id
dunsNumber	The company's duns number
scoring	The element can contain the following options: R, Y or G. R: red, Y: yellow, G: green
scoring_date

Request and response example

curl 'https://api-test.bisnode.fi/company/info/v3/scoring-ryg/2014838-7' -H 'x-api-key: 1234567890ABC'

Successful request and the API return results in JSON format.

{
    "businessId": "2014838-7",
    "dunsNumber": "539506084",
    "scoring": {
        "scoring": "G",
        "scoring_date": "2020-03-05T03:39:06Z"
    },
    "scoringHistory": [
        {
            "scoring": "Y",
            "scoring_date": "2020-01-21T13:58:27Z"
        }
    ]
}

SWAGGER - Developer REST API documentation - read more »

Please note that data coverage varies between companies. Data coverage depends e.g. on company form. Remember the codes and descriptions API returns all companies REST APIs code values and descriptions - read more.