Skip to content

Household Registration

Adrian Gortzak edited this page Feb 8, 2024 · 3 revisions

Get household registration date

The code retrieves household registration of address

import valueguard

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


vgClient.household_registration(search_criteria={"address":'Doktor Liborius gata 20 B',
                                                        "postal_area":'Göteborg',
                                                        "postal_code":'41321'})

Field list

Field name Description Example
home_registration_date Date when the first current users residence was registered 2022-09-01

Search criteria fields

Address needs to be supplied with one or both of city and postal_code.

Field name Description Example
address Full address, exact match Doktor Liborius gata 20 B lgh 1202
postal_area The postal area in which the address is located Göteborg
postal_code Postal code for the area 41323

Raw request

Get

curl https://api.valueguard.se/v1/household/registration?access_token={access_token}&address={address}&postal_area={postal_area}&postal_code={postal_code}
Clone this wiki locally