People rest API

Credit remarks check

The API return information of the person's credit remarks in JSON format, as specified by Bisnode ID or person identification 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).

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/ihmiset/v1/getconsumercreditremarks - production environment
https://api-test.bisnode.fi/ihmiset/v1/getconsumercreditremarks - test environment

API response

Data element	Description
Name	Full name
PersonId	Social security number
Bisnode ID	Personal ID.
Maksuhäiriömerkinnät	Amount of person's credit remarks.
Viimeisin maksuhäiriömerkintä	Date of the person's latest remark.
Muut merkinnät	Amount of the person's other marks.
Edunvalvontatieto	Is the person under trusteeship (N/Y).
Liiketoimintakielto	Is the person under ban on business operations (N/Y).
Maksuhäiriökoodi ja -selite	Remark code and definition in Finnish and in English.
Summa	Amount of euros (€).
Merkinnän päivämäärä	Date of the remark.
Velkoja	Name of the creditor.
Lähde	Data source.

API request parameters

Parameter	Description
id	Bisnode ID or social security number*.	X
purpose	Purpose code: 1=Application for credit, 2=Credit sale control, 3=Debt collection, 5=Key-person of a company, 6=Applicant's own approval, 7=Agreement of lease, 8=Evaluation of employer/job-seeker, 9=Authority's right for information, A=Guarantee or pledge, B=Definition of agreement	X
X = Mandatory, * = Only in the credit check use

API request and response example

https://api.bisnode.fi/ihmiset/v1/getconsumercreditremarks?id=FI2101003700186&purpose=6

Successful request and the API return results in JSON format

{
    "name": "Sallinen Janne Jaakko Olavi",
    "personId": "120188-XXXX",
    "bisnodeId": "FI2101003700186",
    "paymentRemarksCount": 16,
    "paymentRemarkLatest": "20150108",
    "otherRemarksCount": 0,
    "isUnderGuardianship": "N",
    "isBannedOnBusinessOperations": "N",
    "remarksOnPayment": {
        "remarkCode": "UMV",
        "remarkDescrFi": "Ulosotossa todettu este",
        "remarkDescrEn": "Enforcement action, barred for lack of means",
        "sum": 231,
        "dateOfRemark": "20111222",
        "creditor": "Kekkonen Orvokki",
        "source": "Pohjois-Karjalan ulosottovirasto"
    }
}