# BAG API

## GET /bag-data

> Returns data from the Basic Registration of Addresses and Buildings (BAG) after entering the postal code and house number.

```json
{"openapi":"3.0.3","info":{"title":"Matrixian API","version":"0.0.1"},"servers":[{"url":"https://api.matrixian.com/v1","description":"Matrixian API"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"{{API_KEY}}"}},"schemas":{"BagDataResponse":{"properties":{"building":{"description":"Building","allOf":[{"$ref":"#/components/schemas/Building"}]},"numberDesignation":{"description":"Number designation","allOf":[{"$ref":"#/components/schemas/NumberDesignation"}]},"object":{"description":"Object","allOf":[{"$ref":"#/components/schemas/Object"}]},"place":{"description":"Place","allOf":[{"$ref":"#/components/schemas/Place"}]},"publicSpace":{"description":"Public space","allOf":[{"$ref":"#/components/schemas/PublicSpace"}]},"sourceHolder":{"description":"Source holder","allOf":[{"$ref":"#/components/schemas/SourceHolder"}]}},"type":"object","required":["building","numberDesignation","object","place","publicSpace","sourceHolder"],"title":"BagDataResponse"},"Building":{"properties":{"beginDate":{"type":"string","title":"Begindate","description":"Beginning date"},"buildYear":{"type":"integer","title":"Buildyear","description":"Indication of the year in which the building will originally be delivered in, or is architectually ready. Also known as construction year. "},"documentDate":{"type":"string","title":"Documentdate","description":"Date of document"},"documentNumber":{"type":"string","title":"Documentnumber","description":"Number of the document"},"id":{"type":"string","title":"Id","description":"Identification"},"mutationDate":{"title":"Mutationdate","description":"Mutatation date","type":"string","nullable":true},"noted":{"type":"boolean","title":"Noted","description":"Any information that was stated."},"status":{"type":"string","title":"Status","description":"Status of the building."}},"type":"object","required":["beginDate","buildYear","documentDate","documentNumber","id","noted","status"],"title":"Building"},"NumberDesignation":{"properties":{"beginDate":{"type":"string","title":"Begindate","description":"Beginning date"},"documentDate":{"type":"string","title":"Documentdate","description":"Date of document"},"documentNumber":{"type":"string","title":"Documentnumber","description":"Number of the document"},"houseLetter":{"title":"Houseletter","description":"House letter","type":"string","nullable":true},"houseNumber":{"type":"integer","title":"Housenumber","description":"House number"},"houseNumberExtension":{"title":"Housenumberextension","description":"House number extention","type":"string","nullable":true},"id":{"type":"string","title":"Id","description":"Identification"},"mutationDate":{"title":"Mutationdate","description":"Mutation date","type":"string","nullable":true},"noted":{"type":"boolean","title":"Noted","description":"Any information that was stated"},"objectType":{"type":"string","title":"Objecttype","description":"Type of the object"},"postcode":{"type":"string","title":"Postcode","description":"Zipcode"},"relatedPublicSpace":{"type":"string","title":"Relatedpublicspace","description":"Number of the public space it is related to."},"status":{"type":"string","title":"Status","description":"Status of the number designated."}},"type":"object","required":["beginDate","documentDate","documentNumber","houseNumber","id","noted","objectType","postcode","relatedPublicSpace","status"],"title":"NumberDesignation"},"Object":{"properties":{"beginDate":{"type":"string","title":"Begindate","description":"Beginning date"},"documentDate":{"type":"string","title":"Documentdate","description":"Date of the document."},"documentNumber":{"type":"string","title":"Documentnumber","description":"Number of the document"},"id":{"type":"string","title":"Id","description":"Identification"},"location":{"description":"Location","allOf":[{"$ref":"#/components/schemas/Location"}]},"mutationDate":{"title":"Mutationdate","description":"Mutation date","type":"string","nullable":true},"noted":{"type":"boolean","title":"Noted","description":"Any information that was stated"},"relatedBuilding":{"type":"string","title":"Relatedbuilding","description":"Number of the building it is related to"},"relatedMainAddress":{"type":"string","title":"Relatedmainaddress","description":"Number of the address it is related to"},"status":{"type":"string","title":"Status","description":"Status of the object."},"usePurpose":{"type":"string","title":"Usepurpose","description":"Use function of the building"},"useSurface":{"type":"integer","title":"Usesurface","description":"Use surface of the building"}},"type":"object","required":["beginDate","documentDate","documentNumber","id","location","noted","relatedBuilding","relatedMainAddress","status","usePurpose","useSurface"],"title":"Object"},"Location":{"properties":{"x":{"type":"number","title":"X"},"y":{"type":"number","title":"Y"}},"type":"object","required":["x","y"],"title":"Location"},"Place":{"properties":{"beginDate":{"type":"string","title":"Begindate","description":"Beginning date"},"documentDate":{"type":"string","title":"Documentdate","description":"Date of the document"},"documentNumber":{"type":"string","title":"Documentnumber","description":"Number of the document"},"id":{"type":"string","title":"Id","description":"Identification"},"mutationDate":{"title":"Mutationdate","description":"Mutation date","type":"string","nullable":true},"name":{"type":"string","title":"Name","description":"Name of the place"},"noted":{"type":"boolean","title":"Noted","description":"Any information that was stated"},"status":{"type":"string","title":"Status","description":"Status of the place"}},"type":"object","required":["beginDate","documentDate","documentNumber","id","name","noted","status"],"title":"Place"},"PublicSpace":{"properties":{"beginDate":{"type":"string","title":"Begindate","description":"Beginning date"},"documentDate":{"type":"string","title":"Documentdate","description":"Date of the document"},"documentNumber":{"type":"string","title":"Documentnumber","description":"Number of the document"},"id":{"type":"string","title":"Id","description":"Identification"},"mutationDate":{"title":"Mutationdate","description":"Mutation date","type":"string","nullable":true},"name":{"type":"string","title":"Name","description":"Name of the public space"},"noted":{"type":"boolean","title":"Noted","description":"Any information that was stated"},"relatedPlace":{"type":"string","title":"Relatedplace","description":"Number of the place it is related to"},"status":{"type":"string","title":"Status","description":"Status of the public space"}},"type":"object","required":["beginDate","documentDate","documentNumber","id","name","noted","relatedPlace","status"],"title":"PublicSpace"},"SourceHolder":{"properties":{"id":{"type":"string","title":"Id","description":"Id of the source holder"},"name":{"type":"string","title":"Name","description":"Name of the source holder"}},"type":"object","required":["id","name"],"title":"SourceHolder"},"ErrorObject":{"properties":{"code":{"type":"integer","title":"Code"},"message":{"type":"string","title":"Message"},"errors":{"items":{"$ref":"#/components/schemas/ErrorDetail"},"type":"array","title":"Errors"}},"type":"object","required":["code","message","errors"],"title":"ErrorObject"},"ErrorDetail":{"properties":{"reason":{"type":"string","title":"Reason"},"message":{"type":"string","title":"Message"}},"type":"object","required":["reason","message"],"title":"ErrorDetail"}}},"paths":{"/bag-data":{"get":{"description":"Returns data from the Basic Registration of Addresses and Buildings (BAG) after entering the postal code and house number.","operationId":"bagData","parameters":[{"description":"Zipcode","required":true,"style":"form","explode":true,"schema":{"type":"string"},"name":"postalCode","in":"query"},{"description":"House number","required":true,"style":"form","explode":true,"schema":{"type":"integer"},"name":"houseNumber","in":"query"},{"description":"House letter","required":false,"style":"form","explode":true,"schema":{"type":"string"},"name":"houseLetter","in":"query"},{"description":"House number extention","required":false,"style":"form","explode":true,"schema":{"type":"string"},"name":"houseNumberExt","in":"query"}],"responses":{"200":{"description":"BagDataResponse","content":{"application/json":{"schema":{"properties":{"statusCode":{"type":"integer"},"headers":{"additionalProperties":{"type":"string"},"type":"object","description":"HTTP headers returned by Lambda/API Gateway."},"isBase64Encoded":{"type":"boolean"},"body":{"properties":{"id":{"type":"string","nullable":true},"params":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"data":{"$ref":"#/components/schemas/BagDataResponse"},"error":{"additionalProperties":{"type":"string"},"type":"object"},"meta":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"status":{"type":"string"}},"type":"object","required":["data","status"]}},"type":"object","required":["statusCode","headers","isBase64Encoded","body"]}}}},"400":{"description":"HTTP 400","content":{"application/json":{"schema":{"properties":{"statusCode":{"type":"integer"},"headers":{"additionalProperties":{"type":"string"},"type":"object","description":"HTTP headers returned by Lambda/API Gateway."},"isBase64Encoded":{"type":"boolean"},"body":{"properties":{"id":{"type":"string","nullable":true},"params":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"data":{"additionalProperties":{"type":"string"},"type":"object"},"error":{"$ref":"#/components/schemas/ErrorObject"},"meta":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"status":{"type":"string"}},"type":"object","required":["error","status"]}},"type":"object","required":["statusCode","headers","isBase64Encoded","body"]}}}},"401":{"description":"HTTP 401","content":{"application/json":{"schema":{"properties":{"statusCode":{"type":"integer"},"headers":{"additionalProperties":{"type":"string"},"type":"object","description":"HTTP headers returned by Lambda/API Gateway."},"isBase64Encoded":{"type":"boolean"},"body":{"properties":{"id":{"type":"string","nullable":true},"params":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"data":{"additionalProperties":{"type":"string"},"type":"object"},"error":{"$ref":"#/components/schemas/ErrorObject"},"meta":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"status":{"type":"string"}},"type":"object","required":["error","status"]}},"type":"object","required":["statusCode","headers","isBase64Encoded","body"]}}}},"403":{"description":"HTTP 403","content":{"application/json":{"schema":{"properties":{"statusCode":{"type":"integer"},"headers":{"additionalProperties":{"type":"string"},"type":"object","description":"HTTP headers returned by Lambda/API Gateway."},"isBase64Encoded":{"type":"boolean"},"body":{"properties":{"id":{"type":"string","nullable":true},"params":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"data":{"additionalProperties":{"type":"string"},"type":"object"},"error":{"$ref":"#/components/schemas/ErrorObject"},"meta":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"status":{"type":"string"}},"type":"object","required":["error","status"]}},"type":"object","required":["statusCode","headers","isBase64Encoded","body"]}}}},"404":{"description":"HTTP 404","content":{"application/json":{"schema":{"properties":{"statusCode":{"type":"integer"},"headers":{"additionalProperties":{"type":"string"},"type":"object","description":"HTTP headers returned by Lambda/API Gateway."},"isBase64Encoded":{"type":"boolean"},"body":{"properties":{"id":{"type":"string","nullable":true},"params":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"data":{"additionalProperties":{"type":"string"},"type":"object"},"error":{"$ref":"#/components/schemas/ErrorObject"},"meta":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"status":{"type":"string"}},"type":"object","required":["error","status"]}},"type":"object","required":["statusCode","headers","isBase64Encoded","body"]}}}},"500":{"description":"HTTP 500","content":{"application/json":{"schema":{"properties":{"statusCode":{"type":"integer"},"headers":{"additionalProperties":{"type":"string"},"type":"object","description":"HTTP headers returned by Lambda/API Gateway."},"isBase64Encoded":{"type":"boolean"},"body":{"properties":{"id":{"type":"string","nullable":true},"params":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"data":{"additionalProperties":{"type":"string"},"type":"object"},"error":{"$ref":"#/components/schemas/ErrorObject"},"meta":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"status":{"type":"string"}},"type":"object","required":["error","status"]}},"type":"object","required":["statusCode","headers","isBase64Encoded","body"]}}}}}}}}}
```

## The BagDataResponse object

```json
{"openapi":"3.0.3","info":{"title":"Matrixian API","version":"0.0.1"},"components":{"schemas":{"BagDataResponse":{"properties":{"building":{"description":"Building","allOf":[{"$ref":"#/components/schemas/Building"}]},"numberDesignation":{"description":"Number designation","allOf":[{"$ref":"#/components/schemas/NumberDesignation"}]},"object":{"description":"Object","allOf":[{"$ref":"#/components/schemas/Object"}]},"place":{"description":"Place","allOf":[{"$ref":"#/components/schemas/Place"}]},"publicSpace":{"description":"Public space","allOf":[{"$ref":"#/components/schemas/PublicSpace"}]},"sourceHolder":{"description":"Source holder","allOf":[{"$ref":"#/components/schemas/SourceHolder"}]}},"type":"object","required":["building","numberDesignation","object","place","publicSpace","sourceHolder"],"title":"BagDataResponse"},"Building":{"properties":{"beginDate":{"type":"string","title":"Begindate","description":"Beginning date"},"buildYear":{"type":"integer","title":"Buildyear","description":"Indication of the year in which the building will originally be delivered in, or is architectually ready. Also known as construction year. "},"documentDate":{"type":"string","title":"Documentdate","description":"Date of document"},"documentNumber":{"type":"string","title":"Documentnumber","description":"Number of the document"},"id":{"type":"string","title":"Id","description":"Identification"},"mutationDate":{"title":"Mutationdate","description":"Mutatation date","type":"string","nullable":true},"noted":{"type":"boolean","title":"Noted","description":"Any information that was stated."},"status":{"type":"string","title":"Status","description":"Status of the building."}},"type":"object","required":["beginDate","buildYear","documentDate","documentNumber","id","noted","status"],"title":"Building"},"NumberDesignation":{"properties":{"beginDate":{"type":"string","title":"Begindate","description":"Beginning date"},"documentDate":{"type":"string","title":"Documentdate","description":"Date of document"},"documentNumber":{"type":"string","title":"Documentnumber","description":"Number of the document"},"houseLetter":{"title":"Houseletter","description":"House letter","type":"string","nullable":true},"houseNumber":{"type":"integer","title":"Housenumber","description":"House number"},"houseNumberExtension":{"title":"Housenumberextension","description":"House number extention","type":"string","nullable":true},"id":{"type":"string","title":"Id","description":"Identification"},"mutationDate":{"title":"Mutationdate","description":"Mutation date","type":"string","nullable":true},"noted":{"type":"boolean","title":"Noted","description":"Any information that was stated"},"objectType":{"type":"string","title":"Objecttype","description":"Type of the object"},"postcode":{"type":"string","title":"Postcode","description":"Zipcode"},"relatedPublicSpace":{"type":"string","title":"Relatedpublicspace","description":"Number of the public space it is related to."},"status":{"type":"string","title":"Status","description":"Status of the number designated."}},"type":"object","required":["beginDate","documentDate","documentNumber","houseNumber","id","noted","objectType","postcode","relatedPublicSpace","status"],"title":"NumberDesignation"},"Object":{"properties":{"beginDate":{"type":"string","title":"Begindate","description":"Beginning date"},"documentDate":{"type":"string","title":"Documentdate","description":"Date of the document."},"documentNumber":{"type":"string","title":"Documentnumber","description":"Number of the document"},"id":{"type":"string","title":"Id","description":"Identification"},"location":{"description":"Location","allOf":[{"$ref":"#/components/schemas/Location"}]},"mutationDate":{"title":"Mutationdate","description":"Mutation date","type":"string","nullable":true},"noted":{"type":"boolean","title":"Noted","description":"Any information that was stated"},"relatedBuilding":{"type":"string","title":"Relatedbuilding","description":"Number of the building it is related to"},"relatedMainAddress":{"type":"string","title":"Relatedmainaddress","description":"Number of the address it is related to"},"status":{"type":"string","title":"Status","description":"Status of the object."},"usePurpose":{"type":"string","title":"Usepurpose","description":"Use function of the building"},"useSurface":{"type":"integer","title":"Usesurface","description":"Use surface of the building"}},"type":"object","required":["beginDate","documentDate","documentNumber","id","location","noted","relatedBuilding","relatedMainAddress","status","usePurpose","useSurface"],"title":"Object"},"Location":{"properties":{"x":{"type":"number","title":"X"},"y":{"type":"number","title":"Y"}},"type":"object","required":["x","y"],"title":"Location"},"Place":{"properties":{"beginDate":{"type":"string","title":"Begindate","description":"Beginning date"},"documentDate":{"type":"string","title":"Documentdate","description":"Date of the document"},"documentNumber":{"type":"string","title":"Documentnumber","description":"Number of the document"},"id":{"type":"string","title":"Id","description":"Identification"},"mutationDate":{"title":"Mutationdate","description":"Mutation date","type":"string","nullable":true},"name":{"type":"string","title":"Name","description":"Name of the place"},"noted":{"type":"boolean","title":"Noted","description":"Any information that was stated"},"status":{"type":"string","title":"Status","description":"Status of the place"}},"type":"object","required":["beginDate","documentDate","documentNumber","id","name","noted","status"],"title":"Place"},"PublicSpace":{"properties":{"beginDate":{"type":"string","title":"Begindate","description":"Beginning date"},"documentDate":{"type":"string","title":"Documentdate","description":"Date of the document"},"documentNumber":{"type":"string","title":"Documentnumber","description":"Number of the document"},"id":{"type":"string","title":"Id","description":"Identification"},"mutationDate":{"title":"Mutationdate","description":"Mutation date","type":"string","nullable":true},"name":{"type":"string","title":"Name","description":"Name of the public space"},"noted":{"type":"boolean","title":"Noted","description":"Any information that was stated"},"relatedPlace":{"type":"string","title":"Relatedplace","description":"Number of the place it is related to"},"status":{"type":"string","title":"Status","description":"Status of the public space"}},"type":"object","required":["beginDate","documentDate","documentNumber","id","name","noted","relatedPlace","status"],"title":"PublicSpace"},"SourceHolder":{"properties":{"id":{"type":"string","title":"Id","description":"Id of the source holder"},"name":{"type":"string","title":"Name","description":"Name of the source holder"}},"type":"object","required":["id","name"],"title":"SourceHolder"}}}}
```

## The OpenbareRuimte object

```json
{"openapi":"3.0.3","info":{"title":"Matrixian API","version":"0.0.1"},"components":{"schemas":{"OpenbareRuimte":{"properties":{"openbareRuimteNaam":{"title":"Openbareruimtenaam","type":"string","maxLength":80,"minLength":1,"nullable":true},"gerelateerdeWoonplaatsNaam":{"title":"Gerelateerdewoonplaatsnaam","type":"string","maxLength":80,"minLength":1,"nullable":true}},"type":"object","title":"OpenbareRuimte"}}}}
```

## The Building object

```json
{"openapi":"3.0.3","info":{"title":"Matrixian API","version":"0.0.1"},"components":{"schemas":{"Building":{"properties":{"beginDate":{"type":"string","title":"Begindate","description":"Beginning date"},"buildYear":{"type":"integer","title":"Buildyear","description":"Indication of the year in which the building will originally be delivered in, or is architectually ready. Also known as construction year. "},"documentDate":{"type":"string","title":"Documentdate","description":"Date of document"},"documentNumber":{"type":"string","title":"Documentnumber","description":"Number of the document"},"id":{"type":"string","title":"Id","description":"Identification"},"mutationDate":{"title":"Mutationdate","description":"Mutatation date","type":"string","nullable":true},"noted":{"type":"boolean","title":"Noted","description":"Any information that was stated."},"status":{"type":"string","title":"Status","description":"Status of the building."}},"type":"object","required":["beginDate","buildYear","documentDate","documentNumber","id","noted","status"],"title":"Building"}}}}
```

## The NumberDesignation object

```json
{"openapi":"3.0.3","info":{"title":"Matrixian API","version":"0.0.1"},"components":{"schemas":{"NumberDesignation":{"properties":{"beginDate":{"type":"string","title":"Begindate","description":"Beginning date"},"documentDate":{"type":"string","title":"Documentdate","description":"Date of document"},"documentNumber":{"type":"string","title":"Documentnumber","description":"Number of the document"},"houseLetter":{"title":"Houseletter","description":"House letter","type":"string","nullable":true},"houseNumber":{"type":"integer","title":"Housenumber","description":"House number"},"houseNumberExtension":{"title":"Housenumberextension","description":"House number extention","type":"string","nullable":true},"id":{"type":"string","title":"Id","description":"Identification"},"mutationDate":{"title":"Mutationdate","description":"Mutation date","type":"string","nullable":true},"noted":{"type":"boolean","title":"Noted","description":"Any information that was stated"},"objectType":{"type":"string","title":"Objecttype","description":"Type of the object"},"postcode":{"type":"string","title":"Postcode","description":"Zipcode"},"relatedPublicSpace":{"type":"string","title":"Relatedpublicspace","description":"Number of the public space it is related to."},"status":{"type":"string","title":"Status","description":"Status of the number designated."}},"type":"object","required":["beginDate","documentDate","documentNumber","houseNumber","id","noted","objectType","postcode","relatedPublicSpace","status"],"title":"NumberDesignation"}}}}
```

## The Object object

```json
{"openapi":"3.0.3","info":{"title":"Matrixian API","version":"0.0.1"},"components":{"schemas":{"Object":{"properties":{"beginDate":{"type":"string","title":"Begindate","description":"Beginning date"},"documentDate":{"type":"string","title":"Documentdate","description":"Date of the document."},"documentNumber":{"type":"string","title":"Documentnumber","description":"Number of the document"},"id":{"type":"string","title":"Id","description":"Identification"},"location":{"description":"Location","allOf":[{"$ref":"#/components/schemas/Location"}]},"mutationDate":{"title":"Mutationdate","description":"Mutation date","type":"string","nullable":true},"noted":{"type":"boolean","title":"Noted","description":"Any information that was stated"},"relatedBuilding":{"type":"string","title":"Relatedbuilding","description":"Number of the building it is related to"},"relatedMainAddress":{"type":"string","title":"Relatedmainaddress","description":"Number of the address it is related to"},"status":{"type":"string","title":"Status","description":"Status of the object."},"usePurpose":{"type":"string","title":"Usepurpose","description":"Use function of the building"},"useSurface":{"type":"integer","title":"Usesurface","description":"Use surface of the building"}},"type":"object","required":["beginDate","documentDate","documentNumber","id","location","noted","relatedBuilding","relatedMainAddress","status","usePurpose","useSurface"],"title":"Object"},"Location":{"properties":{"x":{"type":"number","title":"X"},"y":{"type":"number","title":"Y"}},"type":"object","required":["x","y"],"title":"Location"}}}}
```

## The Place object

```json
{"openapi":"3.0.3","info":{"title":"Matrixian API","version":"0.0.1"},"components":{"schemas":{"Place":{"properties":{"beginDate":{"type":"string","title":"Begindate","description":"Beginning date"},"documentDate":{"type":"string","title":"Documentdate","description":"Date of the document"},"documentNumber":{"type":"string","title":"Documentnumber","description":"Number of the document"},"id":{"type":"string","title":"Id","description":"Identification"},"mutationDate":{"title":"Mutationdate","description":"Mutation date","type":"string","nullable":true},"name":{"type":"string","title":"Name","description":"Name of the place"},"noted":{"type":"boolean","title":"Noted","description":"Any information that was stated"},"status":{"type":"string","title":"Status","description":"Status of the place"}},"type":"object","required":["beginDate","documentDate","documentNumber","id","name","noted","status"],"title":"Place"}}}}
```

## The SourceHolder object

```json
{"openapi":"3.0.3","info":{"title":"Matrixian API","version":"0.0.1"},"components":{"schemas":{"SourceHolder":{"properties":{"id":{"type":"string","title":"Id","description":"Id of the source holder"},"name":{"type":"string","title":"Name","description":"Name of the source holder"}},"type":"object","required":["id","name"],"title":"SourceHolder"}}}}
```