Glossary
Administrative divisions
With administrative=true (needs a permission) addresses carry adm1_code … adm5_code and adm1_name … adm5_name. What each level means per country:
| Level | SE | NO | FI | DK |
|---|---|---|---|---|
| adm1 | Län (county) | Fylke (county) | Maakunta (county) | Region (region) |
| adm2 | Kommun (municipality) | Kommune (municipality) | Kunta (municipality) | Kommune (municipality) |
| adm3 | Församling (parish) | Sogn (parish) | N/A | Sogne (parish) |
| adm4 | Distrikt (district) | N/A | Seutukunta (district) | N/A |
| adm5 | Församling 2015 (parish 2015) | N/A | N/A | N/A |
Address types
The address_type of an address:
| Code | Description |
|---|---|
| NA | Location address - General |
| NB | Location address - City |
| NC | Location address - Rural |
| NAR | Location address - General, reserved |
| NBR | Location address - City, reserved |
| NCR | Location address - Rural, reserved |
| BA | PO Box address - General |
| BB | PO Box address - Main operator |
| BC | PO Box address - Other operator |
| BD | Large customer address - Organisation with their own postal code |
| BE | PO Box address - Package dispenser |
| AA | Administrative address - General |
| AB | Administrative address - Internal address |
| AC | Administrative address - Competition mail (tävlingspost) |
| AD | Administrative address - Reply mail (svarspost/frisvar/svarsförsändelser) |
| XE | Address type unknown |
| XX | Any other address that has not been classified |
Reserved addresses (NAR, NBR, NCR) are allocated for future use and not yet in use. Validate and Suggest leave them out unless you list them in address_types[]. Validating a reserved number without asking for it gives error 254.
Response status
The status field of a response. See Response status for how it relates to the HTTP status.
| Code | Meaning |
|---|---|
| 302 | Exactly one match |
| 300 | One or more suggestions |
| 404 | Nothing found |
| 400 | Bad request; status_text says why |
| 403 | The API key is deactivated |
| 200 | Validate Address with suggestions=false: the address is invalid, no match or suggestions returned |
Error codes
Validate responses list what was wrong with the input in errors: an object of code → text at the top, and a list of codes on each suggestion. The texts are in English. Errors are only included when your API key has the error-codes permission.
| Code | Text |
|---|---|
| 131 | Number of suggestions are too many to display |
| 200 | Street address is missing |
| 201 | Unknown format for the street address |
| 202 | Street address had misspellings, errors or was incorrect |
| 203 | Street address contains abbreviations |
| 204 | Street address had minor errors that were corrected |
| 208 | Street address is a post office box |
| 209 | Both street address and post office box address included in the same field |
| 250 | Missing street number |
| 251 | Invalid format for the street number |
| 252 | Incorrect street number |
| 253 | Street number not applicable on the given address |
| 254 | Street number is reserved and not yet in use |
| 260 | Missing letter in the street number |
| 261 | Unknown format for letter in street number |
| 262 | Incorrect letter in street number |
| 263 | Letter not applicable on the street number for the given address |
| 270 | Secondary street number is missing |
| 271 | Unknown format for the secondary street number |
| 272 | Incorrect secondary street number |
| 273 | Secondary street number cannot be applied to the given address |
| 300 | Postal code is missing |
| 301 | Unknown format for the postal code |
| 302 | Postal code is incorrect |
| 304 | Postal code had minor errors that were corrected |
| 306 | Postal code is incomplete |
| 307 | Customer specific postal code |
| 308 | Postal code includes country prefix |
| 400 | Locality is missing |
| 401 | Unknown format for locality |
| 402 | Incorrect locality |
| 403 | Locality had abbreviations |
| 404 | Locality had minor errors that were corrected |
Note that error codes such as 302 (postcode) and 404 (locality) are not the same thing as the response status codes with the same numbers.
Updated 1 day ago