People rest API

Credit Worthiness Check

The API return the person's credit worthiness in JSON format, as specified by Bisnode ID.

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).

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

API endpoints

https://api.bisnode.fi/people/info/v3/credit-worthiness - production environment
https://api-test.bisnode.fi/people/info/v3/credit-worthiness - test environment

API response

Data element	Description
bisnodeId	The unique person id.
CreditWorthiness	Person's credit worthiness check are shown in classes 11-1. Class 11: low risk. Class 1: high risk.

API request parameters

Parameter	Description
id	Bisnode ID	X
X = Mandatory

GET https://api-test.bisnode.fi/people/info/v3/credit-worthiness/{id}

API request and response example

curl 'https://api-test.bisnode.fi/people/info/v3/credit-worthiness/FI2101005032547' -H 'x-api-key: 1234567890ABC'

Successful request and the API return results in JSON format.

{
    "bisnodeId": "FI2101005032547",
    "creditWorthiness": 10,
    "creditWorthinessScale": {
        "1": "High risk",
        "11": "Low risk",
        "null": "Unknown"
    }
}

Swagger documentation - read more!»