Household

Get household information from SSN

The code retrieves household information connected to social security number

import valueguard

vgClient = valueguard.Client()
vgClient.authenticate("<username>", "<password>")


print(vgClient.household(search_criteria={"ssn":"yyyymmddxxxx"}))

Field list

Field name	Description	Example
address	Full address	Doktor Liborius gata 20 B lgh 1202
street	Name of the street	Doktor Liborius gata
number	Street number associated with the address	20
letter	Specific entrance of the building, if applicable	B
apartment_nr	Specific apartment number within the building	1202
postal_code	Postal code for the area	41323
postal_area	The postal area in which the address is located	Göteborg
municipality_code	Municipality code	1480
home_registration_date	Date when the residence was registered	2022-09-01

Search criteria fields

Field name	Description	Example
SSN	Social Security number	yyyymmddxxxx

Raw request

Get

curl https://api.valueguard.se/v1/household?access_token={access_token}&SSN={SSN}