GET city street houseNumber houseNumberSuffix

GET /addresses/nl/{city}/{street}/{houseNumber}/{houseNumberSuffix}

Retrieves info for a Dutch Address based on a City, Street and Housenumber and HouseNumber suffix

Authorization

All Valdit APIs use OAuth 2.0 for Authorizations. Paragraph 4.2 contains detailed information on using the Valdit OAuth 2.0 Identity system for API Authorization.

OAuth 2.0 Scopes

Scopes are used to grant an application different levels of access to data on behalf of the Customer. The POST Operation requires the ‘addresses_nl:geocode’ scope to be used when requesting an access- token.

The access token must be included in the Authorization header of the request.

Request

The request must include the following parameters:

Parameter	Description	Location	Type	Mandatory
city	Name of City	path	string	yes
street	Name of Street	path	string	yes
houseNumber	Housenumber	path	integer	yes
houseNumberSuffix	HouseNumber Suffix	Path	String	Yes

Response

The table below lists all the HTTP Response Codes that can be returned, together with a description of the result of the API call and the Response-type that defines the Model that is used for the returned data. The Response Models are described in detail in chapter 6.

Response Code	Description	Response Model
200	Success. The Response contains the data on the Dutch Address.	addressNlSuccessResponse
400	Bad Request. The response will provide information on why the call failed	addressNlFailResponse
401	Unauthorized. No OAuth 2.0 access-token was provided or the access-token was invalid or has expired	failResponse
402	An Address that matches the specified parameters could not be found	failResponse
404	The Distance that matches the specified parameters could not be found	failResponse
500	A server error has occurred. The response will contain additional information on the error	JSend Error-response

Table 3: GET Operation Responses