Menu
Consumer update service

REST API: endpoints, request and response examples

Sending data

API endpoints

  • POST https://api.bisnode.fi/update/v1/register/{register id}/batch

API request parameters

ParameterDescription 
register id Register id number X
_op UPSERT or DELETE X
ReferenceKey Unique reference key X

POST https://api.bisnode.fi/update/v1/register/{register id}/batch

API request and response examples

POST https://api.bisnode.fi/update/v1/register/424/batch

[
  {
    "_op": "DELETE",
    "ReferenceKey":  "012c533f-5f04-45cb-af12-cbf548108d31"
  }
]

 

Successful request and the API return results in JSON format.

{
    Warnings: [],    Errors: []
}

POST https://api.bisnode.fi/update/v1/register/424/batch

[
  {
    "_op": "UPSERT",
    "ReferenceKey": "012c533f-5f04-45cb-af12-cbf548108d31",
    "FirstName": "Helmi Maarit",
    "LastName": "Meikäläinen",
    "StreetAddress": "Kumpulantie 3",
    "PostalCode": "00150",
    "PostOffice": "HELSINKI"
  }
]

 

Successful request and the API return results in JSON format.

{
    Warnings: [],    Errors: []
}

 

Fetching data

API endpoints

  • GET https://api.bisnode.fi/update/v1/register/{register id}/items

API request parameters

ParameterDescription 
register id Register id number X

GET https://api.bisnode.fi/update/v1/register/{register id}/items

API request and response example

GET https://api.bisnode.fi/update/v1/register/424/items

Successful request and the API return results in JSON format.

{
    "Headers": [
        "ReferenceKey",
        "FirstName",
        "LastName",
        "StreetAddress",
        "PostalCode",
        "PostOffice",
        "BisnodeId",
        "TelephoneNumber",
        "HouseholdId",
        "Municipality",
        "County",
        "Country",
        "DateOfAddress",
        "DateOfDeath",
        "HouseholdSize",
        "Person_IncomePrediction",
        "Household_IncomePrediction",
        "Person_IncomeFromCapitalPrediction",
        "Household_IncomeFromCapitalPrediction",
        "Person_DebtPrediction",
        "Household_DebtPrediction",
        "Person_EducationPrediction",
        "Household_EducationPrediction",
        "FamilyWithChildrenPrediction",
        "FamilyWithChildrenUnder10Prediction",
        "FamilyWithChildren10To17Prediction",
        "ResidencyPrediction",
        "CarOwnershipPrediction",
        "HousingType",
        "BRIC_PurchasingPower",
        "BRIC_PaymentDefaultRisk",
        "BRIC_LifeStage",
        "BRIC_HousingType",
        "BRIC_EducationLevel",
        "BRIC_HomeOwnership",
        "BRIC_ResidentialArea",
        "Suomi360",
        "DirectMarketingPreference",
        "TeleMarketingPreference",
        "firstname",
        "lastname",
        "address",
        "zip",
        "city"
    ],
    "Warnings": [],
    "Rows": [
        {
            "ReferenceKey": "012c533f-5f04-45cb-af12-cbf548108d31",
            "FirstName": "Marja",
            "LastName": "Meikäläinen",
            "StreetAddress": "Kumpulantie 3",
            "PostalCode": "00520",
            "PostOffice": "Helsinki",
            "BisnodeId": "FI2101002870340",
            "TelephoneNumber": "0408294699",
            "HouseholdId": "136443405",
            "Municipality": "Helsinki",
            "County": "Uusimaa",
            "Country": "FI",
            "DateOfAddress": "2016-02-16",
            "DateOfDeath": "",
            "HouseholdSize": "3",
            "Person_IncomePrediction": "9",
            "Household_IncomePrediction": "10",
            "Person_IncomeFromCapitalPrediction": "9",
            "Household_IncomeFromCapitalPrediction": "9",
            "Person_DebtPrediction": "",
            "Household_DebtPrediction": "",
            "Person_EducationPrediction": "8",
            "Household_EducationPrediction": "8",
            "FamilyWithChildrenPrediction": "8",
            "FamilyWithChildrenUnder10Prediction": "7",
            "FamilyWithChildren10To17Prediction": "10",
            "ResidencyPrediction": "",
            "CarOwnershipPrediction": "7",
            "HousingType": "1",
            "BRIC_PurchasingPower": "3",
            "BRIC_PaymentDefaultRisk": "0",
            "BRIC_LifeStage": "3",
            "BRIC_HousingType": "1",
            "BRIC_EducationLevel": "3",
            "BRIC_HomeOwnership": "1",
            "BRIC_ResidentialArea": "3",
            "Suomi360": "6",
            "DirectMarketingPreference": "7",
            "TeleMarketingPreference": "3",
            "_o_firstname": "Marja",
            "_o_lastname": "Meikäläinen",
            "_o_address": "Kotipolku 67",
            "_o_zip": "00890",
            "_o_city": "Helsinki"
        },
        {
            "ReferenceKey": "0136f4e2-ddc7-4ef4-9aab-62eaa4da0d44",
            "FirstName": "Teuvo",
            "LastName": "Meikäläinen",
            "StreetAddress": "Kumpulantie 3",
            "PostalCode": "00520",
            "PostOffice": "Helsinki",
            "BisnodeId": "FI2101002013972",
            "TelephoneNumber": "0400132099",
            "HouseholdId": "120579495",
            "Municipality": "Helsinki",
            "County": "Uusimaa",
            "Country": "FI",
            "DateOfAddress": "2016-02-01",
            "DateOfDeath": "",
            "HouseholdSize": "2",
            "Person_IncomePrediction": "4",
            "Household_IncomePrediction": "7",
            "Person_IncomeFromCapitalPrediction": "9",
            "Household_IncomeFromCapitalPrediction": "9",
            "Person_DebtPrediction": "",
            "Household_DebtPrediction": "",
            "Person_EducationPrediction": "3",
            "Household_EducationPrediction": "3",
            "FamilyWithChildrenPrediction": "4",
            "FamilyWithChildrenUnder10Prediction": "4",
            "FamilyWithChildren10To17Prediction": "5",
            "ResidencyPrediction": "",
            "CarOwnershipPrediction": "7",
            "HousingType": "5",
            "BRIC_PurchasingPower": "",
            "BRIC_PaymentDefaultRisk": "",
            "BRIC_LifeStage": "",
            "BRIC_HousingType": "",
            "BRIC_EducationLevel": "",
            "BRIC_HomeOwnership": "",
            "BRIC_ResidentialArea": "",
            "Suomi360": "6",
            "DirectMarketingPreference": "10",
            "TeleMarketingPreference": "1",
            "_o_firstname": "Teuvo",
            "_o_lastname": "Meikäläinen",
            "_o_address": "Kauppakatu 63",
            "_o_zip": "00980",
            "_o_city": "Helsinki"
        }
    ]
}

Remember! x-api-key parameter must be sent in the API's request custom header element. If the x-api-key value is valid then the 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.

Tulosta

Läs mer om våra tjänster på www.bisnode.com Bisnode