BRP Reisdocumenten Web API Features

The Reisdocumenten bevragen Web API makes it possible to consult travel document data in the Basisregistratie Personen (BRP). Travel documents are looked up by their travel document number or by the citizen service number of their holder.

General Data Protection Regulation (GDPR)

The ‘Reisdocumenten bevragen’ Web API has been designed in accordance with the REST principles. In order to comply with the GDPR as well, concessions have been made with regard to applying the REST principles. The main concession is that the POST method and not the GET method is used to query travel documents. This ensures that no personally identifiable information (PII) ends up in the URL of a request, and therefore not in server logs either.

Searching for travel documents

Travel documents can be looked up by the citizen service number of their holder. The following operation is used for this:

• zoek met burgerservicenummer:
  • overview
  • error cases

The result of this operation is a Reisdocument collection or list.

Consulting travel documents

If the travel document number of the travel document to be queried is known, the following operation must be used:

• raadpleeg met reisdocumentnummer:
  • overview
  • error cases

The result of this operation is a Reisdocument collection or list.

Filtering the fields of the travel documents found

With every query, use the fields parameter (this is mandatory) to state which fields of the travel document or documents found must be supplied. To protect the privacy of the holder of the travel documents requested, only fields may be requested for which your organization has purpose limitation. With the fields parameter you limit the fields to be requested to what is needed for the task to be carried out.

An additional advantage of this data minimization is that you contribute to sustainability. The fewer fields you request, the less the server and the network are loaded.

You request a field by supplying the full path of that field in the fields parameter. The full path of a field is the combination of the name of the field and the names of its parent fields, with a '.' character between the field names. Examples of full paths are:

• houder.burgerservicenummer (full path of the burgerservicenummer field of the houder of a travel document)

Filtering date fields

The Reisdocumenten bevragen Web API has the following date types:

• VolledigeDatum
• DatumOnbekend
• JaarDatum
• JaarMaandDatum

and the following value table type:

• Waardetabel (soort reisdocument, aanduiding inhouding of vermissing)

When one or more fields of these types are requested, all fields of the type requested are always supplied. See the raadpleeg met reisdocumentnummer fields, zoek met burgerservicenummer fields and fields error cases feature files for more information.

Fields supplied by default

The following fields are supplied automatically where they apply:

• geheimhoudingPersoonsgegevens
• inOnderzoek
• opschortingBijhouding

Automatically supplied fields may not be requested with the fields parameter. See the fields error cases feature file for examples.

No value, null, false and empty object values

To keep the payload of a response small, it was decided not to supply fields with the following values in the response:

• fields not requested. These fields have null as their value.
• requested fields that the travel document requested does not have. These fields have null as their value. Example: the inhoudingOfVermissing.datum field is requested for a travel document that has not been withheld and has not been reported lost.
• requested or automatically supplied fields that have the false value. Example: the geheimhoudingPersoonsgegevens field is not supplied where the holder has not requested confidentiality.
• requested fields that concern a group of fields the person does not have. Example: the inhoudingOfVermissing fields are requested for a travel document that has not been withheld and has not been reported lost.
• requested fields that have no aanduiding in onderzoek.