API routes (Click a route to expand it, click here to expand/collapse all)
Default APIs
GET/ ⎘
Provides the API-specification. Only enabled if API exposure is enabled.
Parameter Location Type Requirements Optional Default value Description
format URI-Query string
enum: [ "KateAPI", "InternalAPIMap", "OpenAPI", "Swagger" ]
 Yes "KateAPI" Documentation format. We support KateAPI documentation, Swagger/OpenAPI documentation and raw output of the internal API-map cache.
openApiVersion URI-Query int
enum: [ 2, 3 ]
 Yes 2 Version 3 is crappy with request bodies, so we prefer version 2 (which only sucks regarding Response definitions; hence we prefer KateAPI documentation).
Response HTTP Type Description
Success 200 object The API-documentation.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
No
Uncategorized APIs
GET/test ⎘
test
Response HTTP Type Description
Success 200 Address Obtain a full address from the supplier given.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
No
Authentication scheme:
JWTAuth
Required flags:
None ⎘
[01] Suggestions based on text/location
GET/landRegisters/suggest ⎘Authentication required
For each supplier provided, retrieve a list of suggested addresses based on the input given.
Parameter Location Type Requirements Optional Default value Description
countryCode URI-Query string
minLength: 2
maxLength: 2
 No Country code.
query URI-Query string
minLength: 3
 No Query LandRegister input, example: Perceel Ammerstol (AMS01) A 1.
suppliers URI-Query string[]
enum: [ "kadaster" ]
 Yes [] An array of suppliers( $suppliers[] = google, $suppliers[] = ... ), landRegister suggestions are fetched for each supplier given. If empty, suppliers are selected based on the country.
limit URI-Query int Yes 5 Limit the amount of suggestions.
mapWidth URI-Query int
min: 256
 Yes 1000 Optional width of your map in order to give a more accurate zoomLevel.
mapHeight URI-Query int
min: 256
 Yes 800 Optional height of your map in order to give a more accurate zoomLevel.
Response HTTP Type Description
Success 200 string[] An array with the suppliers as keys and for value the result of suggestions as array with the keys: $displayString and $lookupId. The $displayString shows the address as string and $lookupUrl which can be used to get more information about the address on the /lookup endpoint.
NoExternalAPIAvailableException 502 External API is not available.
InvalidSupplierException 400 The supplier given is invalid.
InvalidCountryCodeException 400 The country code given is invalid.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
None ⎘
GET/reverseGeo/{supplier}/{type} ⎘Authentication required
Retrieve items of type given type (LandRegister) based on lat/lon
Parameter Location Type Requirements Optional Default value Description
supplier URI-Path string
enum: [ "kadaster" ]
 No The supplier you want to use to find the type based on location
type URI-Path string
enum: [ "LandRegister" ]
 No The type of entity you are looking for.
latitude URI-Query float
minimum: -90
maximum: 90
 No Location latitude.
longitude URI-Query float
minimum: -180
maximum: 180
 No Location longitude.
legacyOutput URI-Query bool Yes true If true, it will output in the legacy way.
Response HTTP Type Description
Success 200 type[] / LandRegister[] The items found on that location, using the given supplier and type.
NoExternalAPIAvailableException 502 External API is not available.
InvalidSupplierException 400 The supplier given is invalid.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
None ⎘
GET/suggest ⎘Authentication required
For each supplier provided, retrieve a list of suggested addresses based on the input given.
Parameter Location Type Requirements Optional Default value Description
countryCode URI-Query string
minLength: 2
maxLength: 2
 No Country code.
addressString URI-Query string
minLength: 4
 No Address input, example: binnenkant 1A1, 1011BG, amsterdam.
suppliers URI-Query string[]
enum: [ "google", "kadaster", "manual" ]
 Yes [] An array of suppliers( $suppliers[] = google, $suppliers[] = ... ), address suggestions are fetched for each supplier given. If empty, suppliers are selected based on the country.
limit URI-Query int Yes 5 Limit the amount of suggestions.
mapWidth URI-Query int
min: 256
 Yes 1000 Optional width of your map in order to give a more accurate zoomLevel.
mapHeight URI-Query int
min: 256
 Yes 800 Optional height of your map in order to give a more accurate zoomLevel.
Response HTTP Type Description
Success 200 string[] An array with the suppliers as keys and for value the result of suggestions as array with the keys: $displayString and $lookupId. The $displayString shows the address as string and $lookupUrl which can be used to get more information about the address on the /lookup endpoint.
NoExternalAPIAvailableException 502 External API is not available.
InvalidSupplierException 400 The supplier given is invalid.
InvalidCountryCodeException 400 The country code given is invalid.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
None ⎘
[02] Lookup using identifier
GET/landRegisters/lookup/{supplier} ⎘Authentication required
Retrieve the full LandRegisters based on their lookupIds and all linked addresses.
Parameter Location Type Requirements Optional Default value Description
supplier URI-Path string
enum: [ "kadaster" ]
 No The supplier to fetch the LandRegister using the $lookupId.
legacyOutput URI-Query bool Yes true If true, it will output in the legacy way.
lookupIds URI-Query string[] No lookupIds, will be used to find the LandRegister.
Response HTTP Type Description
Success 200 {"landRegisters": LandRegister[], "addresses":Address[]} The LandRegisters matching the lookupIds and all Addresses that are linked to those.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
None ⎘
GET/landRegisters/lookup/{supplier}/{lookupId} ⎘Authentication required
Retrieve the full LandRegister based on its lookupId and all linked addresses.
Parameter Location Type Requirements Optional Default value Description
supplier URI-Path string
enum: [ "kadaster" ]
 No The supplier to fetch the LandRegister using the $lookupId.
legacyOutput URI-Query bool Yes true If true, it will output in the legacy way.
lookupId URI-Path string
minLength: 1
pattern: ^[A-Za-z-0-9]*$
 No lookupId, will be used to find the LandRegister.
Response HTTP Type Description
Success 200 {"landRegisters": LandRegister[], "addresses":Address[]} The LandRegister matching the lookupId and all Addresses that are linked to that.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
None ⎘
GET/lookup/{supplier} ⎘Authentication required
Retrieve the full addresses based on the lookupIds.
Parameter Location Type Requirements Optional Default value Description
supplier URI-Path string
enum: [ "google", "kadaster", "manual" ]
 No The supplier to fetch the addresses using the $lookupId.
forceRefetch URI-Query bool Yes false If true, it will fetch the addresses again and remove the old one.
legacyOutput URI-Query bool Yes true If true, it will output in the legacy way.
lookupIds URI-Query string[] No All the lookupIds you want to look up.
Response HTTP Type Description
Success 200 Address[] Obtain the full list of addresses from the supplier given.
NoExternalAPIAvailableException 502 External API is not available.
InvalidSupplierException 400 The supplier given is invalid.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
None ⎘
GET/lookup/{supplier}/landRegisters ⎘Authentication required
Retrieve the full addresses based on the lookupIds and the linked LandRegisters.
Parameter Location Type Requirements Optional Default value Description
supplier URI-Path string
enum: [ "google", "kadaster", "manual" ]
 No The supplier to fetch the addresses using the $lookupId.
forceRefetch URI-Query bool Yes false If true, it will fetch the addresses again and remove the old one.
legacyOutput URI-Query bool Yes true If true, it will output in the legacy way.
lookupIds URI-Query string[] No LookupIds of addresses.
Response HTTP Type Description
Success 200 {"addresses":Address[], "landRegisters": LandRegister[]} The addresses matching the lookupIds and all LandRegisters that are linked to those.
NoExternalAPIAvailableException 502 External API is not available.
InvalidSupplierException 400 The supplier given is invalid.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
None ⎘
GET/lookup/{supplier}/{lookupId} ⎘Authentication required
Retrieve the full address based on the lookupId.
Parameter Location Type Requirements Optional Default value Description
supplier URI-Path string
enum: [ "google", "kadaster", "manual" ]
 No The supplier to fetch the address using the $lookupId.
lookupId URI-Path string
minLength: 16
pattern: ^[_A-Za-z-0-9]*$
 No lookupId, will be used to find the address.
legacyOutput URI-Query bool Yes true If true, it will output in the legacy way.
forceRefetch URI-Query bool Yes false If true, it will fetch the address again and remove the old one.
Response HTTP Type Description
Success 200 Address Obtain a full address from the supplier given.
NotFoundException 404 Address is not found.
NoExternalAPIAvailableException 502 External API is not available.
InvalidSupplierException 400 The supplier given is invalid.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
None ⎘
[03] Lookup using Address details
GET/lookup ⎘Authentication required
Fetch additional data for the address given based on the suppliers, on success the returned Address with additionalData is enriched.
Parameter Location Type Requirements Optional Default value Description
suppliers URI-Query string[]
enum: [ "google", "kadaster", "manual" ]
 Yes [] An array of suppliers( $suppliers[] = google, $suppliers[] = ... ), address suggestions are fetched for each supplier given. If empty, suppliers are selected based on the country.
countryCode URI-Query string
minLength: 2
maxLength: 2
 No Country code.
city URI-Query string
minLength: 1
maxLength: 128
 No City.
street URI-Query string
minLength: 1
maxLength: 128
 No Street.
postalCode URI-Query string
minLength: 5
maxLength: 16
 Yes "" Postal code.
number URI-Query string
minLength: 0
maxLength: 32
pattern: ^[0-9]*$
 Yes "" Address number.
addition URI-Query string
minLength: 1
maxLength: 16
 Yes "" Address addition.
additionLetter URI-Query string
minLength: 1
maxLength: 16
 Yes "" Address additional letter.
legacyOutput URI-Query bool Yes true If true, it will output in the legacy way.
forceRefetch URI-Query bool Yes false If true, it will fetch the address again and remove the old one.
Response HTTP Type Description
Success 200 Address[] Obtain the address fully enriched based on the supplier given. Additional data is fetched for the address and stored in the key: additionalData.
NoExternalAPIAvailableException 502 External API is not available.
InvalidSupplierException 400 The supplier given is invalid.
InvalidCountryCodeException 400 The country code given is invalid.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
None ⎘
GET/multiLookup ⎘Authentication required
Fetch additional data for the addresses given based on the suppliers, on success the addresses with additional data are enriched.
Parameter Location Type Requirements Optional Default value Description
payload URI-Query string
format: json
maxLength: 4194304
 No A list of addresses to enrich, keys match the enrich parameters.
countryCode URI-Query string
minLength: 2
maxLength: 2
 No Country code.
suppliers URI-Query string[]
enum: [ "google", "kadaster", "manual" ]
 Yes [] An array of suppliers( $suppliers[] = google, $suppliers[] = ... ), address suggestions are fetched for each supplier given. If empty, suppliers are selected based on the country.
legacyOutput URI-Query bool Yes true If true, it will output in the legacy way.
Response HTTP Type Description
Success 200 Address[] Obtain an array of addresses fully enriched based on the supplier given. Additional data is fetched for each address and stored in the key: additionalData.
NoExternalAPIAvailableException 502 External API is not available.
InvalidSupplierException 400 The supplier given is invalid.
InvalidCountryCodeException 400 The country code given is invalid.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
None ⎘
[04] Manage custom Addresses
POST/register ⎘Authentication required
Register the address.
Parameter Location Type Requirements Optional Default value Description
countryCode POST-body string
minLength: 2
maxLength: 2
 No Country code.
city POST-body string
minLength: 2
maxLength: 128
 No City.
street POST-body string
minLength: 2
maxLength: 128
 No Street.
postalCode POST-body string
minLength: 5
maxLength: 16
 Yes "" Postal code.
number POST-body string
minLength: 0
maxLength: 32
pattern: ^[0-9]*$
 Yes "" Address number.
latitude POST-body float
minimum: -90
maximum: 90
 No Address latitude.
longitude POST-body float
minimum: -180
maximum: 180
 No Address longitude.
addition POST-body string
minLength: 1
maxLength: 16
 Yes "" Address addition.
additionLetter POST-body string
minLength: 1
maxLength: 16
 Yes "" Address additional letter.
additionalData POST-body string
format: json
 Yes "" Additional data.
municipality POST-body string Yes "" Address municipality.
province POST-body string Yes "" Address province.
legacyOutput POST-body bool Yes true If true, it will output in the legacy way.
Response HTTP Type Description
Success 200 Address The Address that was registered.
AlreadyRegisteredException 200 Address is already registered.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
None ⎘
POST/unregister/{lookupId} ⎘Authentication required
Unregister the address based on the lookupId.
Parameter Location Type Requirements Optional Default value Description
lookupId URI-Path string
minLength: 1
pattern: ^[A-Za-z-0-9]*$
 No lookupId, will be used to find the address.
Response HTTP Type Description
Success 200 boolean Boolean value if the address was unregistered.
NotFoundException 404 Address is not found.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
None ⎘
[05] Bulk: address-string suggest + lookup
GET/firstSuggestion ⎘Authentication required
Check for each supplier provided, fetch the first address suggested. This effectively combines suggest and lookup
Parameter Location Type Requirements Optional Default value Description
countryCode URI-Query string
minLength: 2
maxLength: 2
 No Country code.
addressString URI-Query string
minLength: 4
 No Address input, example: binnenkant 1A1, 1011BG, amsterdam.
suppliers URI-Query string[]
enum: [ "google", "kadaster", "manual" ]
 Yes [] An array of suppliers( $suppliers[] = google, $suppliers[] = ... ), address suggestions are fetched for each supplier given. If empty, suppliers are selected based on the country.
mapWidth URI-Query int
min: 256
 Yes 1000 Optional width of your map in order to give a more accurate zoomLevel.
mapHeight URI-Query int
min: 256
 Yes 800 Optional height of your map in order to give a more accurate zoomLevel.
Response HTTP Type Description
Success 200 ?Address A full address from the supplier given.
NoExternalAPIAvailableException 502 External API is not available.
InvalidSupplierException 400 The supplier given is invalid.
InvalidCountryCodeException 400 The country code given is invalid.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
None ⎘
POST/bulk/firstSuggestion ⎘Authentication required
Check for each supplier provided, retrieve a list of suggested addresses based on the input given, fetch the first address suggested. This effectively combines suggest and lookup
Parameter Location Type Requirements Optional Default value Description
countryCode POST-body string
minLength: 2
maxLength: 2
 No Country code.
addressStrings POST-body string[]
minLength: 4
 No Address input, example: binnenkant 1A1, 1011BG, amsterdam.
suppliers POST-body string[]
enum: [ "google", "kadaster", "manual" ]
 Yes [] An array of suppliers( $suppliers[] = google, $suppliers[] = ... ), address suggestions are fetched for each supplier given. If empty, suppliers are selected based on the country.
mapWidth POST-body int
min: 256
 Yes 1000 Optional width of your map in order to give a more accurate zoomLevel.
mapHeight POST-body int
min: 256
 Yes 800 Optional height of your map in order to give a more accurate zoomLevel.
Response HTTP Type Description
Success 200 { [addressString:string]: ?Address] A Map addressString to Address (or null)
NoExternalAPIAvailableException 502 External API is not available.
InvalidSupplierException 400 The supplier given is invalid.
InvalidCountryCodeException 400 The country code given is invalid.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
None ⎘
Authentication schemes (Click an authentication scheme to expand it)
JWTAuth
Result wrappers (Click a result-wrapper to expand it)
Success
Error