Profiling service

The Profile service is meant to distill household information from the bank transactions of a household or client. The input of this service is the output of the convert service. The result is now a profile based on a few characteristics needed to calculate the Nibud reference numbers. The profile has the following details (if available):

• Household composition with number of adults (incl gender) and number of children
• Number of children in the following age categories:
  • 0 to 5 years old
  • 6 to 11 years old
  • 12 to 17 years old
  • 18 years and older
• Information about the residence
• Information on the vehicles (Car and motorcycle)
• Average income per month
• Average rent/mortgage per month

This profile can be expanded with additional information.

Calling the Profiling Service

Endpoint:      https://linx.invers.nl:8100/api/linx/profile
Method:        POST

Header:        ApiKey:        string     (required)
               X-Request-ID:  string     (required)
               ClientId:      string     (optional)
               InputHash:     string     (optional)

Body:          Data:          byte[]     (required)

Errors:        400, 403 or 500

Information

Field	Type	Description
BesteedbaarInkomen	Decimal	Net disposable income per month
Hoofdpersonen	Array of Main characters	Main household characters
Huisgenoten	Array of Housemates	Housemates of the household
Kinderen	Array of Children	Children
Autos	Array of Cars	Cars
Woning	Residence	Information on the residence
Incomes	Array	Information on the income sources

Main characters

Field	Type	Description
Valid	boolean	Internal parameter
Geboortedatum	date	Date of birth
Geslacht	Enum	0 = Man 1 = Woman
EigenRisico	Enum	Own risk medical expenses of last year

Housemates

Field	Type	Description
Geboortedatum	date	Date of birth
Geslacht	Enum	0= Man 1 = Woman

Children

Field	Type	Description
Valid	boolean	Internal parameter
Geboortedatum	date	Date of birth
Woonsituatie	Enum	0 = Living at home1 = Moved out
Leeftijd	Enum	0 = Unknown 1 = 0 to 5 2 = 6 to 11 3 = 12 to 17 4 = 18 or older

Cars

Field	Type	Description
Valid	boolean	Internal Parameter
KilometersPerJaar	Integer	Annual kilometers driven
Nieuwwaarde	Decimal	Value when new
Status	Enum	0 = New 1 = second-hand
Soort	String	String describing the type of car
Kilometer	String	String describing the distance the car has approximately driven
Voertuig	Voertuig	Information on the vehicle according to the RDW

Vehicle

Field	Type	Description
Kenteken	String	License plate
Voertuigsoort	String	Vehicle type: • Personenauto (passenger car) • Bedrijfsauto (Company car) • Bus • Aanhangwagen (trailer) • Motorfiets (Motorcycle) • Driewielig motorvoertuig (Threewheeled motorcycle) • Bromfiets (moped)
Merk	String	Brand
Handelsbenaming	String	Trade name given by the manufacturer, may deviate from the name on the vehicle
Inrichting	String	Description of the edition of design
Datum_Tenaamstelling	Date	Date of registration latest owner
Zuinigheidslabel	String	Economy label
CatalogusPrijs	Decimal	List price
aantal_zitplaatsen	Integer	Number of seats
vervaldatum_APK	date	Expiry date APK(Standard Periodical Inspection)
type	String	Internal parameter
variant	String	Internal parameter
taxi_indicator	boolean	Internal parameter
wam_verzekerd	boolean	Internal parameter
api_gekentekende_voertuigen_brandstof	URL	Link to RDW API
brandstof	string	Type of Fuel

Fuel

Field	Type	Description
brandstof_omschrijving	String	Type of fuel
brandstof_volgnummer	Integer	Internal parameter
brandstofverbruik_buiten	Integer	Internal parameter
brandstofverbruik_gecombineerd	Integer	Internal parameter
brandstofverbruik_stad	Integer	Internal parameter
co2_uitstoot_gecombineerd	Integer	Internal parameter
emissiecode_omschrijving	String	Internal parameter
geluidsniveau_stationair	Integer	Internal parameter
Kenteken	String	License plate
milieuklasse_eg_goedkeuring_licht	String	Internal parameter
nettomaximumvermogen	Integer	Internal parameter
toerental_geluidsniveau	Integer	Internal parameter

Residence

Field	Type	Description
wozWaarde	Decimal	Valuation of Immovable Property
woz	String	Internal parameter
valid	boolean	Internal parameter
bouwjaar	Enum	Build in: 0 = Before 1945 1 = 1945 to 1965 2 = 1966 to 1975 3 = 1976 to 1979 4 = 1980 to 1988 5 = 1989 to 2000 6 = After 2000
energielabel	Enum	Energy label: 0 = Unknown 1 = A 2 = B 3 = C 4 = D 5 = E 6 = F 7 = G
Soort	Enum	0 = Rented 1 = Owned
Typewoning	Enum	Residence Type: Detached, larger than 150 m2 = 0 Detached, smaller 150 m2 = 1 Semidetached = 2 Terraced house = 3 Terraced house corner = 4 Maisonette = 5 Gallery appartment = 6 Staircase entrance flat = 7 Other flat = 8 Room = 9
huurPerMaand	Decimal	Monthly rent
hypotheekPerMaand	Decimal	Monthly mortgage
gemeenteId	Integer	Residence township
adres	String	Address of the residence

Address

Field	Type	Description
id	Integer	Address identifier
default	boolean	Internal parameter
street	string	Streetname
houseNumber	String	House number
houseNumberAddition	String	House number addition
zipcode	String	Zip/Postal code
city	String	Place
municipality	String	Township
province	String	Province/County
country	String	Country code ISO 2 characters
type	string	Type of object
purpose	String	Purpose of the building
surfaceArea	Integer	Number of m2
latitude	Float	Latitude, if available
longitude	Float	Longitude, if available

Output

{
  "besteedbaarInkomen": 0,
  "hoofdpersonen": [
    {
      "valid": true,
      "geboortedatum": "YYYY-MM-DDTHH:MM:SS+HH:MM",
      "geslacht": "man",
      "eigenRisico": "categorie1"
    }
  ],
  "huisgenoten": [
    {
      "valid": true,
      "geboortedatum": "YYYY-MM-DDTHH:MM:SS+HH:MM",
      "geslacht": "man"
    }
  ],
  "kinderen": [
    {
      "valid": true,
      "geboortedatum": "YYYY-MM-DDTHH:MM:SS+HH:MM",
      "geslacht": "man",
      "schooltype": "basis",
      "woonsituatie": "thuiswonend",
      "leeftijd": "nul_tot_en_met_vijf",
      "kinderbijslag": 0,
      "toelichting": "string"
    }
  ],
  "autos": [
    {
      "valid": true,
      "kilometersPerJaar": 0,
      "nieuwwaarde": 0,
      "status": "nieuw",
      "soort": "geen",
      "kilometer": "less_Then_10000",
      "voertuig": {
        "kenteken": "string",
        "voertuigsoort": "string",
        "merk": "string",
        "handelsbenaming": "string",
        "inrichting": "string",
        "datum_tenaamstelling": "YYYY-MM-DDTHH:MM:SS+HH:MM",
        "zuinigheidslabel": "string",
        "catalogusprijs": 0,
        "aantal_zitplaatsen": 0,
        "vervaldatum_apk": "YYYY-MM-DDTHH:MM:SS+HH:MM",
        "type": "string",
        "variant": "string",
        "taxi_indicator": "string",
        "wam_verzekerd": "string",
        "api_gekentekende_voertuigen_brandstof": "string",
        "brandstof": [
          {
            "brandstof_omschrijving": "string",
            "brandstof_volgnummer": 0,
            "brandstofverbruik_buiten": 0,
            "brandstofverbruik_gecombineerd": 0,
            "brandstofverbruik_stad": 0,
            "co2_uitstoot_gecombineerd": 0,
            "emissiecode_omschrijving": "string",
            "geluidsniveau_stationair": 0,
            "kenteken": "string",
            "milieuklasse_eg_goedkeuring_licht": "string",
            "nettomaximumvermogen": 0,
            "toerental_geluidsniveau": 0
          }
        ]
      }
    }
  ],
  "woning": {
    "wozWaarde": 0,
    "woz": "less_Then_150000",
    "valid": true,
    "bouwjaar": "na2001",
    "energielabel": "a",
    "soort": "huurwoning",
    "typeWoning": "vrijstaandGroot",
    "huurPerMaand": 0,
    "hypotheekPerMaand": 0,
    "gemeenteId": 0,
    "adres": {
      "id": "string",
      "default": true,
      "street": "string",
      "houseNumber": "string",
      "houseNumberAddition": "string",
      "zipcode": "string",
      "city": {
        "id": "string",
        "name": "string"
      },
      "municipality": {
        "id": "string",
        "name": "string"
      },
      "province": {
        "id": "string",
        "name": "string"
      },
      "country": "string",
      "type": "string",
      "purpose": "unknown",
      "surface": 0,
      "surfaceArea": 0,
      "latitude": 0,
      "longitude": 0
    }
  },
  "incomes": [
    {
      "id": 0,
      "partner": true,
      "title": "string",
      "tooltip": "string",
      "unit": "none",
      "div": 0,
      "value": 0,
      "categories": [
        {
          "id": 0,
          "amount": 0
        }
      ]
    }
  ]
}