Get BAG information

reference

string

Conditional

Internal identifier of the complex. Either reference or externalIdentifier must be provided. If both are given, the complex must match both values.

externalIdentifier

string

Conditional

External identifier of the complex, as set by the integrating system. Either reference or externalIdentifier must be provided. If both are given, the complex must match both values.

retrievedOn

string (date-time)

Yes

Timestamp indicating when Bloxs last retrieved this record from the BAG. ISO 8601 format, UTC.

address

string

No

Address as registered in the BAG, including street, house number and any addition, postal code, and city. Returned by the BAG as a single formatted string, not as separate sub-fields.

premises

array of object

No

Premises (building) details registered in the BAG for this object. Empty or omitted when no premises data is available.

premises.premisesId

string

No

BAG building identification number (Pand ID).

premises.premises_OriginalBuildYear

string

No

Original construction year of the premises, as registered in the BAG.

premises.premises_Status

string

No

Status of the premises, as registered in the BAG.

residenceId

string

No

Occupancy unit identification number, referred to in the BAG as the VBO ID.

residence_Uses

string

No

Registered use of the residence, for example housing (woonfunctie).

residence_Surface

integer

Yes

Surface area of the residence, in square meters, as registered in the BAG.

residence_Status

string

No

Status of the residence, as registered in the BAG.

numberDesignationId

string

No

Number designation identification number, as registered in the BAG.

numberDesignation_PostalCode

string

No

Postal code linked to the number designation, as registered in the BAG.

numberDesignation_HouseNumber

integer

Yes

House number linked to the number designation, as registered in the BAG.

numberDesignation_HouseNumberCharacter

string

No

House number character linked to the number designation, for example "A", as registered in the BAG.

numberDesignation_HouseNumberAddition

string

No

House number addition linked to the number designation, as registered in the BAG. Can include more than a number, for example "bis" or "264H".

numberDesignation_Status

string

No

Status linked to the number designation, as registered in the BAG.

publicSpaceId

string

No

Identification number of the public space the object is located in, as registered in the BAG.

publicSpace_Name

string

No

Name of the public space the object is located in, as registered in the BAG. Typically the street name.

publicSpace_Status

string

No

Status of the public space the object is located in, as registered in the BAG.

city_Name

string

No

Name of the city the object is located in, as registered in the BAG.

city_Status

string

No

Status of the city the object is located in, as registered in the BAG.

sourceHolders

array of object

No

Municipalities holding source data for this object, as registered in the BAG. Empty or omitted when no source holder data is available.

sourceHolders.sourceHolder_Code

string

No

Identification code of the municipality, as registered in the BAG.

sourceHolders.sourceHolder_Name

string

No

Name of the municipality, as registered in the BAG.

parcels

array of object

No

Cadastral parcels the object is located on, as registered in the BAG. Empty or omitted when no parcel data is available.

parcels.cadastralNumber

string

No

Cadastral number of the parcel.

parcels.parcel_Area

number (double)

Yes

Surface area of the parcel, in square meters.

parcels.municipality_Name

string

No

Cadastral municipality of the parcel. Can differ from the regular municipality, for example after a municipal merger.

parcels.condominiumIds

array of string

No

Condominium identification numbers registered for the parcel. Multiple values can be returned for a single parcel.