People rest API

Credit remarks

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

  • - production environment
  • - test environment

API response

Data elementDescription
Social Security Number Social security number. e.g 160162-9968
Bisnode ID Bisnode ID. e.g. FI2101006369103
Date Of Birth Date of birth. e.g. 1962-01-16T00:00:00Z
Remark ID Remark ID. e.g. 14601863
Amount Amount of euros (€). e.g. 0
Case ID Case ID. e.g. null
Additional info Other info. e.g. null
Creditor Creditor. e.g. null
Remark source Source of the remark. e.g. Oikeusrekisterikeskus
Remark code Remark code. e.g. LTV
Case type code Case type code. e.g. MUU
Remark type Type of the remark. e.g. BusinessBanRemark
Remark date Date of the remark. e.g. 2016-09-06T00:00:00Z
Remark paid date Remard paid date. e.g. null
Remark valid to date Date of the remark valid to date. e.g. null
Remark expires date Date of the remark expires date. e.g. null
Incident Id Incident ID. e.g. null

API request parameters

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

API request and response example

Successful request and the API return results in JSON format

  "socialSecurityNumber": "160162-9968",
  "bisnodeId": "FI2101006369103",
  "dateOfBirth": "1962-01-16T00:00:00Z",
  "remarks": [
      "remarkId": 14601863,
      "amount": 0,
      "caseId": null,
      "additionalInfo": null,
      "creditor": null,
      "remarkSource": "Oikeusrekisterikeskus",
      "remarkCode": "LTV",
      "caseTypeCode": "MUU",
      "remarkType": "BusinessBanRemark",
      "remarkDate": "2016-09-06T00:00:00Z",
      "remarkPaidDate": null,
      "remarkValidToDate": null,
      "remarkExpiresDate": null,
      "incidentId": null

Swagger documentation -