People rest API

Credit Remarks

The API return information of the person's credit remarks in JSON format, as specified by social security 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/people/info/v2/remarks/ - production environment
  • https://api-test.bisnode.fi/people/info/v2/remarks/ - test environment

API request

Parameter Description  
id Social security number X
purposeCode Define what the purpose of the request is. The credit remark requests can be made only with a valid reason. Valid purposes are listed below: 1=Application for credit, 2=Credit sale control, 3=Debt collection, 5=Key-person of a company, 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
user The name or id of the person or system who made the request. e.g., John Doe or Loan Process System. Must provide as precise information as possible so that the requester (end-user) can be identified. X

GET https://api-test.bisnode.fi/people/info/v2/remarks/{id}?purposeCode={purposeCode}&user={user}

API response

Data element Description
socialSecurityNumber The person's social security number.
bisnodeId The person's Bisnode Id.
dateOfBirth The person's date of birth.
creditClass This severity classification is formed from the person's remarks. Classification helps to understand the severity of credit remarks related to the person. Available options: 0=no remarks, 1=minor remarks, 2=normal remarks, 3=major remarks or multiple remarks, 4=serious remarks
remarkId Remark ID. e.g. 14601863
amount Amount of euros (€). e.g. 100
caseId Case ID. e.g. 2014/123456
additionalInfo The element contains additional information about the remark.
creditor Creditor e.g., Länsi-Suomen veronkanto- ja perintäyksikkö
remarkSource Source of the remark. e.g., Ulosottovirasto
remarkCode Remark code. e.g. UMV
caseTypeCode Case type code. e.g. MUU
remarkType Type of the remark. e.g. PaymentRemark
remarkDate The date when the remark has registered into the official register.
remarkPaidDate The date when the remark has paid. The element contains the REF information.
remarkValidToDate The date until the remark is valid.
remarkExpiresDate The date when the remark expires.
incidentId  
incidentGroup  

API request and response example

https://api-test.bisnode.fi/people/info/v2/remarks/160162-9968?purposeCode=1&user=FI975100

Successful request and the API return results in JSON format

{
    "socialSecurityNumber": "160162-9968",
    "bisnodeId": "FI2101006369103",
    "dateOfBirth": "1962-01-16T00:00:00Z",
    "creditClass": 4,
    "remarks": [
        {
            "remarkId": 15737667,
            "amount": 12513,
            "caseId": null,
            "additionalInfo": null,
            "creditor": null,
            "remarkSource": "Ulosottovirasto",
            "remarkCode": "UMP",
            "caseTypeCode": "MUU",
            "remarkType": "PaymentRemark",
            "remarkDate": "2019-09-22T12:55:32.457Z",
            "remarkPaidDate": null,
            "remarkValidToDate": "2022-09-22T12:55:32.457Z",
            "remarkExpiresDate": "2022-09-22T12:55:32.457Z",
            "incidentId": "55326",
            "incidentGroup": null
        },
        {
            "remarkId": 15737665,
            "amount": 552,
            "caseId": null,
            "additionalInfo": null,
            "creditor": "Helslingin kaupunki",
            "remarkSource": null,
            "remarkCode": "UMS",
            "caseTypeCode": "MUU",
            "remarkType": "PaymentRemark",
            "remarkDate": "2019-09-22T12:55:32.457Z",
            "remarkPaidDate": null,
            "remarkValidToDate": "2022-09-22T12:55:32.457Z",
            "remarkExpiresDate": "2022-09-22T12:55:32.457Z",
            "incidentId": "15737665",
            "incidentGroup": 4321
        },
        {
            "remarkId": 15737662,
            "amount": 0,
            "caseId": null,
            "additionalInfo": "Vakuusvelka",
            "creditor": null,
            "remarkSource": "Oikeusrekisterikeskus",
            "remarkCode": "HVP",
            "caseTypeCode": "MUU",
            "remarkType": "OtherRemark",
            "remarkDate": "2019-09-22T12:55:32.457Z",
            "remarkPaidDate": null,
            "remarkValidToDate": null,
            "remarkExpiresDate": null,
            "incidentId": "126557",
            "incidentGroup": null
        },
        {
            "remarkId": 15737663,
            "amount": 0,
            "caseId": null,
            "additionalInfo": null,
            "creditor": null,
            "remarkSource": "Oikeusrekisterikeskus",
            "remarkCode": "HAK",
            "caseTypeCode": "MUU",
            "remarkType": "OtherRemark",
            "remarkDate": "2019-09-22T12:55:32.457Z",
            "remarkPaidDate": null,
            "remarkValidToDate": null,
            "remarkExpiresDate": null,
            "incidentId": "126557",
            "incidentGroup": null
        },
        {
            "remarkId": 15737668,
            "amount": 0,
            "caseId": null,
            "additionalInfo": null,
            "creditor": null,
            "remarkSource": "Oikeusrekisterikeskus",
            "remarkCode": "KHV",
            "caseTypeCode": "MUU",
            "remarkType": "OtherRemark",
            "remarkDate": "2019-09-22T12:55:32.457Z",
            "remarkPaidDate": null,
            "remarkValidToDate": null,
            "remarkExpiresDate": null,
            "incidentId": "445236",
            "incidentGroup": null
        },
        {
            "remarkId": 15737669,
            "amount": 0,
            "caseId": null,
            "additionalInfo": null,
            "creditor": null,
            "remarkSource": "Oikeusrekisterikeskus",
            "remarkCode": "KJS",
            "caseTypeCode": "MUU",
            "remarkType": "OtherRemark",
            "remarkDate": "2019-09-22T12:55:32.457Z",
            "remarkPaidDate": null,
            "remarkValidToDate": null,
            "remarkExpiresDate": null,
            "incidentId": "445236",
            "incidentGroup": null
        },
        {
            "remarkId": 15737670,
            "amount": 0,
            "caseId": null,
            "additionalInfo": null,
            "creditor": null,
            "remarkSource": "Oikeusrekisterikeskus",
            "remarkCode": "LTV",
            "caseTypeCode": "MUU",
            "remarkType": "BusinessBanRemark",
            "remarkDate": "2019-09-22T12:55:32.457Z",
            "remarkPaidDate": null,
            "remarkValidToDate": null,
            "remarkExpiresDate": null,
            "incidentId": null,
            "incidentGroup": null
        },
        {
            "remarkId": 15737666,
            "amount": 105,
            "caseId": "2014/123456",
            "additionalInfo": null,
            "creditor": "Länsi-Suomen veronkanto- ja perintäyksikkö",
            "remarkSource": null,
            "remarkCode": "UMV",
            "caseTypeCode": "MUU",
            "remarkType": "PaymentRemark",
            "remarkDate": "2019-09-22T12:55:32.457Z",
            "remarkPaidDate": null,
            "remarkValidToDate": "2022-09-22T12:55:32.457Z",
            "remarkExpiresDate": "2022-09-22T12:55:32.457Z",
            "incidentId": "15737666",
            "incidentGroup": 4321
        },
        {
            "remarkId": 15737664,
            "amount": 105,
            "caseId": "2014/123456",
            "additionalInfo": "k",
            "creditor": "Lindoff Oy",
            "remarkSource": "Pohjois-Savon käräjäoikeus",
            "remarkCode": "SVK",
            "caseTypeCode": "VSS",
            "remarkType": "PaymentRemark",
            "remarkDate": "2019-09-22T12:55:32.457Z",
            "remarkPaidDate": null,
            "remarkValidToDate": "2022-09-22T12:55:32.457Z",
            "remarkExpiresDate": "2022-09-22T12:55:32.457Z",
            "incidentId": null,
            "incidentGroup": null
        }
    ]
}

SWAGGER - Developer REST API documentation - read more »