List accepted postal codes for address creation in a country
GET {{baseUrl}}/v1/regulation/zipcode?countryCodeA3=<string>&pageNumber=0&pageSize=20
For some DID Groups with an address=LOCAL requirement, the ListZipcodes returns no items. This indicates that the regulation is not strict about the Zipcode matching the local address and hence any valid zip code can be entered (it will not be checked).
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
areaCode | string | This is the area code of the DID which can be retrieved using the listDidGroup or listDid methods. Since an area code can be the same for two different countries, the country should also be specified. If the whole list for a given country is needed, then you can leave the area code unspecified. | |
countryCodeA3 | string | This is the country code A3 of the country for which the list of zip codes and cities is needed. In practice, the area code will also be needed to identify specifically which cities and zip codes are a match. | |
pageNumber | number | The page number, starting at 0. | |
pageSize | number | The page size (max number of entities that are displayed in the response). |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
apikey | string | Authentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under Account Settings. Please use our API quickstart guide for more help. | |
Accept | string |
RESPONSES
status: OK
{"cityZipCodes":[{"cityName":"Aachen","zipCode":"52062"},{"cityName":"Aachen","zipCode":"52063"},{"cityName":"Aachen","zipCode":"52064"},{"cityName":"Aachen","zipCode":"52065"},{"cityName":"Aachen","zipCode":"52066"},{"cityName":"Aachen","zipCode":"52067"},{"cityName":"Aachen","zipCode":"52068"},{"cityName":"Aachen","zipCode":"52069"},{"cityName":"Aachen","zipCode":"52070"},{"cityName":"Aachen","zipCode":"52071"},{"cityName":"Aachen","zipCode":"52072"},{"cityName":"Aachen","zipCode":"52073"},{"cityName":"Aachen","zipCode":"52074"},{"cityName":"Aachen","zipCode":"52075"},{"cityName":"Aachen","zipCode":"52076"},{"cityName":"Aachen","zipCode":"52077"},{"cityName":"Aachen","zipCode":"52078"},{"cityName":"Aachen","zipCode":"52079"},{"cityName":"Aachen","zipCode":"52080"},{"cityName":"Aachen-Kornelimünster","zipCode":"52076"}],"resultCount":16022}