Specification

The specification of the BRP API Personen is an OpenAPI document. On the portal it is rendered interactively; below are the human-readable texts it contains, translated to English. Field names, enum values and API paths are technical identifiers and remain unchanged.

title

• aanhef (salutation)aanhef
• aanschrijfwijze (form of address)aanschrijfwijze
• Address line 1adresregel 1
• Address line 2adresregel 2
• Address line 3adresregel 3
• adressering beperktaddressing (limited)
• addressingadressering
• Use in running textgebruik in lopende tekst
• Date (polymorphic) type definitiondatum (polymorf) type definitie
• Date type definitiondatum type definitie
• Period type definitionperiode type definitie
• birth base type definitiongeboorte basis type definitie
• birth (limited) type definitiongeboorte beperkt type definitie
• birth type definitiongeboorte type definitie
• age type definitionleeftijd type definitie
• ConfidentialGeheim
• third party type definitionderde type definitie
• authority parent type definitiongezagouder type definitie
• authority relationship type definitiongezagsrelatie type definitie
• adult (of age) type definitionmeerderjarige type definitie
• minderjarige type definitionminderjarige type definitie
• explanation type definitiontoelichting type definitie
• immigrationimmigration
• in onderzoek (under investigation) type definitionin onderzoek type definitie
• European right to voteeuropees kiesrecht
• Exclusion from the right to voteuitsluiting kiesrecht
• childkind
• name base type definitionnaam basis
• name-related type definitionsnaam gerelateerde type definities
• name (limited person) type definitionname (limited person) type definition
• full name type definitionvolledige naam type definitie
• Initialsvoorletters
• Treated as a Dutch nationalbehandeld als nederlander
• Nationality knownnationaliteit bekend
• Nationality unknownnationaliteit onbekend
• Nationality (polymorphic)nationaliteit (polymorf)
• Statelessstaatloos
• Established not a Dutch nationalvastgesteld niet nederlander
• suspension of maintenance base type definitionopschorting bijhouding basis type definitie
• suspension of maintenance type definitionopschorting bijhouding type definitie
• parentouder
• deathoverlijden
• entering into marriage or partnership type definitionaangaan huwelijk of partnerschap type definitie
• dissolution of marriage or partnership type definitionontbinding huwelijk of partnerschap type definitie
• partner type definitionpartner type definitie
• addressable object identification query parameter type definitionadresseerbaar object identificatie query parameter type definitie
• Date query parameter type definitiondatum query parameter type definitie
• Field query parameter definitionField query parameter definitie
• municipality of registration query parameter type definitiongemeente van inschrijving query parameter type definitie
• gender query parameter type definitiongeslacht query parameter type definitie
• geslachtsnaam query parameter type definitiongeslachtsnaam query parameter type definitie
• house number designation identification query parameter type definitionnummeraanduiding identificatie query parameter type definitie
• street query parameter type definitionstraat query parameter type definitie
• voornamen optional query parameter type definitionvoornamen optioneel query parameter type definitie
• given names mandatory query parameter type definitionvoornamen verplicht query parameter type definitie
• voorvoegsel query parameter type definitionvoorvoegsel query parameter type definitie
• Adres (address)Adres
• Indication established as not residing at the addressindicatie vastgesteld verblijft niet op adres
• Locatie (location)Locatie
• VerblijfplaatsBuitenlandVerblijfplaatsBuitenland

Showing 60 of 137 title texts.

summary

• Search for personsZoek personen
• Retrieve data non-securelyHaal data niet-secure op
• Retrieve data securelyHaal data secure op

description

• Can be used as the salutation in a letter addressed to the person.Kun je gebruiken als aanhef in een brief gericht aan persoon.
• Composed name and form of address that can be used in communication with the person.Samengestelde naam en aanspreekvorm die je kunt gebruiken in de communicatie met de persoon.
• This line must be placed as a separate line above the composed name. It occurs only for persons with a title of nobility or a predicate.Deze regel moet als aparte regel boven de samengestelde naam worden geplaatst. Komt alleen voor bij personen m
• The first part of an address is a combination of the street and house number.Het eerste deel van een adres is een combinatie van de straat en huisnummer.
• The second part of an address is a combination of the place of residence, possibly together with the postal code.Het tweede deel van een adres is een combinatie van woonplaats eventueel in combinatie met de postcode.
• The third part of an address is optional. It concerns one or more geographical areas of the address abroad.Het derde deel van een adres is optioneel. Het gaat om een of meer geografische gebieden van het adres in het
• Indicates which data about the adressering is under investigation.Geeft aan welke gegevens over de adressering in onderzoek zijn.
• Name of the person that can be used when referring to the person in running text, in a letter for example.Naam van persoon die je kunt gebruiken als je in lopende tekst (bijvoorbeeld in een brief) aan persoon referee
• A date that can be one of the following date types: - unknown date - 'complete' date in accordance with ISO 8601 - date of which the day is unknown - date of which the month and day are unknownEen datum die één van de volgende datum types kan zijn: - onbekend datum - 'volledig' datum conform ISO-8601 -
• Date in accordance with ISO 8601Datum conform iso8601
• Representation of an entirely unknown daterepresentatie voor een volledig onbekend datum
• Representation of a date of which the month and day are unknownrepresentatie voor een datum waarvan maand en dag onbekend zijn
• Representation of a date of which the day is unknownrepresentatie voor een datum waarvan de dag onbekend is
• Date in accordance with ISO 8601, to be used as a reference date, datumVan or datumTot for exampledatum conform ISO-8601 te gebruiken als bijv. peildatum, datumVan en datumTot
• Date in accordance with ISO 8601Datum conform ISO-8601
• The start date of the period.De begindatum van de periode.
• The end date of the period.De einddatum van de periode.
• Date on which the person was born.Datum waarop de persoon is geboren.
• Data about the birth. * **datum** - date on which the person was born. * **land** - country where the person was born. Filled with values from the national table 'Landen'. * **plaats** - municipality where the person was born. Filled with values from the national table "Gemeenten" for a municipality in the Netherlands, or, where the person was born outside the Netherlands, the description of a foreign place name or designation.Gegevens over de geboorte. * **datum** - datum waarop de persoon is geboren. * **land** - land waar de persoon
• Age in years at the moment of the query.Leeftijd in jaren op het moment van bevragen.
• Indication that personal data may not be provided to third parties or social institutions.Indicatie dat persoonsgegevens niet mogen worden verstrekt aan derden / maatschappelijke instellingen.
• Indicates that the authority relationship is under investigation.Geeft aan dat de gezagsrelatie in onderzoek is.
• Indicates that the person registered from abroad.Geeft aan dat de persoon zich vanuit het buitenland heeft ingeschreven.
• Indicates that the person has returned from a situation of unknown residenceGeeft aan dat de persoon is teruggekeerd uit een situatie van onbekende verblijfplaats
• Indicates whether the data about the child of the person is under investigation.Geeft aan of de gegevens over het kind van de persoon in onderzoek zijn.
• Indicates which data about the name is under investigation.Geeft aan welke gegevens over de naam in onderzoek zijn.
• Data about the name of the person.Gegevens over de naam van de persoon.
• Combination of predicate, given names, title of nobility, prefixes and surname, without the addition of any partner name.Combinatie van predicaat, voornamen, adellijke titel, voorvoegsels en geslachtsnaam, zonder toevoeging van een
• The Initials of the person, derived from the given names.De voorletters van de persoon, afgeleid van de voornamen.
• Filled with values from the national table 'Nationaliteiten'.wordt gevuld met waarden uit de landelijke tabel 'Nationaliteiten'.
• Indicates which data about the nationality is under investigation.Geeft aan welke gegevens over de nationaliteit in onderzoek zijn.
• The reason on the basis of which the person obtained the nationality. Filled with values from the national table 'Reden opnemen/beëindigen nationaliteit'.De reden op grond waarvan de persoon de nationaliteit gekregen heeft. Wordt gevuld met waarden uit de landelij
• The date on which the maintenance of the personal data was stopped.De datum waarop de bijhouding van de persoonsgegevens is gestaakt.
• The date on which the family-law relationship came into being.De datum waarop de familierechtelijke betrekking is ontstaan.
• Indicates which data of the parent is under investigation.Geeft aan welke gegevens van de de ouder in onderzoek zijn.
• Date on which the person died.datum waarop de persoon is overleden.
• Indicates which data about the death of the person is under investigation.Geeft aan welke gegevens over het overlijden van de persoon in onderzoek zijn.
• The date on which the marriage was solemnized or the partnership was entered into.De datum waarop het huwelijk is voltrokken of het partnerschap is aangegaan.
• Indicates which data about the solemnization of the marriage or the entering into of the partnership is under investigation.Geeft aan welke gegevens over het voltrekken van het huwelijk of aangaan van het partnerschap in onderzoek zij
• The date on which the marriage or the partnership was dissolved.De datum waarop het huwelijk of het partnerschap is ontbonden.
• Indicates which data about the dissolution of the marriage or the entering into of the partnership is under investigation.Geeft aan welke gegevens over het onbinden van het huwelijk of aangaan van het partnerschap in onderzoek zijn.
• Indicates which data about the marriage or the partnership is under investigation.Geeft aan welke gegevens over het huwelijk of het partnerschap in onderzoek zijn.
• The identification code of an addressable object, excluding the default value (0000000000000000)De identificatiecode van een adresseerbaar object uitgezonderd de standaardwaarde (0000000000000000)
• The path to a desired field in period-separated format. For example "burgerservicenummer", "geboorte.datum", "partners.naam.voornamen".Het pad naar een gewenst veld in punt-gescheiden formaat. Bijvoorbeeld "burgerservicenummer", "geboorte.datum"
• A code indicating in which municipality the person lives, or the last municipality where the person lived, or the municipality where the person was first registered.Een code die aangeeft in welke gemeente de persoon woont, of de laatste gemeente waar de persoon heeft gewoond
• Indicates that the person is male or female, or that the gender is (as yet) unknown.Geeft aan dat de persoon een man of een vrouw is, of dat het geslacht (nog) onbekend is.
• The surname from which any prefixes present have been separated. **Use of the wildcard is permitted with input of at least 3 letters.** **Searching with text fields is case-insensitive.**De (geslachts)naam waarvan de eventueel aanwezige voorvoegsels zijn afgesplitst. **Gebruik van de wildcard is
• The unique identification of a house number designation (and the associated address) in the BAG.De unieke identificatie van een nummeraanduiding (en het bijbehorende adres) in de BAG.
• A name given by the municipality to a public space. **Use of the wildcard is permitted with input of at least 7 letters.** **Searching with text fields is case-insensitive.**Een naam die door de gemeente aan een openbare ruimte is gegeven. **Gebruik van de wildcard is toegestaan bij
• The set of names that precedes the surname, separated by spaces. **Use of the wildcard is permitted.** **Searching with text fields is case-insensitive.**De verzameling namen die, gescheiden door spaties, aan de geslachtsnaam voorafgaat. **Gebruik van de wildcard
• The set of names that precedes the surname, separated by spaces. **Use of the wildcard is permitted with input of at least 3 letters.** **Searching with text fields is case-insensitive.**De verzameling namen die, gescheiden door spaties, aan de geslachtsnaam voorafgaat. **Gebruik van de wildcard
• Part of the surname that precedes the rest of the surname. **Searching with text fields is case-insensitive.**Deel van de geslachtsnaam dat vooraf gaat aan de rest van de geslachtsnaam. **Zoeken met tekstvelden is case-i
• Data about the address of a person.Gegevens over het adres van een persoon.
• Date of the declaration or ex officio notification of residence and address.de datum van aangifte of ambtshalve melding van verblijf en adres.
• Indicates that it has been established that the person is no longer registered at the recorded address or location.Geeft aan dat is vastgesteld dat de persoon niet meer op de geregistreerde adres/locatie staat ingeschreven.
• Data about the residence or dwelling location of a person.Gegevens over het verblijf of de woonlocatie van een persoon.
• Date on which the data about the verblijfplaats became valid.datum waarop de gegevens over de verblijfplaats geldig zijn geworden.
• Date on which the validity of the data about the verblijfstitel ended.Datum waarop de geldigheid van de gegevens over de verblijfstitel is beëindigd.
• Date on which the data about the verblijfstitel became valid.Datum waarop de gegevens over de verblijfstitel geldig zijn geworden.
• Indicates which data about the verblijfstitel is under investigation.Geeft aan welke gegevens over de verblijfstitel in onderzoek zijn.

Showing 60 of 161 description texts.