Skip to main content
Version: v3

Profiling service

The Profiling Service is designed to extract detailed household information from bank transaction data, enabling the generation of a profile for calculating Nibud reference numbers. This service processes data to infer household composition, financial information, and other relevant characteristics. It can be further extended to provide input for the Budget Service.

Calling the Profiling Service

Please refer to the API reference for the Profile service for all technical details on how to call this service.

Key Profile Details:

  • Household Composition: Includes the number of adults (with gender) and children, grouped by age ranges:
    • 0 to 5 years old
    • 6 to 11 years old
    • 12 to 17 years old
    • 18 years and older
  • Residence Information: Details about the household's dwelling, such as type of property, size, and year of build.
  • Vehicles: Information about cars and motorcycles, including type, state, and annual mileage.
  • Average Monthly Income: The net disposable income of the household.
  • Average Rent/Mortgage: The household's average expenditure on housing.

This profile can be expanded with additional information for the Budget Service.

Response Schema:

The response contains detailed household profile information:

  • Net Disposable Income: besteedbaarInkomen
  • Head of Household: hoofdpersonen (Array of adults, with birthdate and gender).
  • Other Household Members: huisgenoten (Array of household members, including partners).
  • Children: kinderen (Array of children, with their ages, gender, and living situation).
  • Vehicles: autos (Details of cars, including annual kilometers driven and value).
  • Residence: woning (Details about the household's residence, including year built, energy label, rent/mortgage costs).
  • Incomes: incomes (Array of income sources).

Expected Enum values

Car

FieldValueTypeDescription
Geen0IntGeen
Mini1IntMini
Compact2IntCompact
Compact_middenklasse3IntCompact middenklasse
Middenklasse4IntMiddenklasse

State of Car

FieldValueTypeDescription
Nieuw0IntNieuw
Tweedehands1IntTweedehands

Kilometers

FieldValueTypeDescription
Less_Then_100000Int< 10.000>
Between_10000_And_200001Int10.000 - 20.000
More_Then_200002Int> 20.000

Type of Residence

FieldValueTypeDescription
VrijstaandGroot0IntVrijstaand
VrijstaandKlein1IntVrijstaand, kleiner dan 150 m2
TweeOnderEenKap2IntHoekwoning
RijtjeswoningTussen3IntTussenwoning
RijtjeswoningHoek4IntRijtjeswoning hoek
Maisonette5IntMaisonette
Galerij6IntAppartement
Portiekwoning7IntPortiekwoning
OverigFlat8IntOverige flat
Kamer9IntKamer

Year of Build

FieldValueTypeDescription
Na20016IntNa 2001
Van1946TotEnMet19651Int1946-1965
Van1966TotEnMet19752Int1966-1975
Van1976TotEnMet19793Int1976-1979
Van1980TotEnMet19884Int1980-1988
Van1989TotEnMet20005Int1989-2000
Voor19450IntVoor 1945

Type of Property

FieldValueTypeDescription
Huurwoning0IntHuur
Koopwoning1IntKoop