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:

LevelSENOFIDK
adm1Län (county)Fylke (county)Maakunta (county)Region (region)
adm2Kommun (municipality)Kommune (municipality)Kunta (municipality)Kommune (municipality)
adm3Församling (parish)Sogn (parish)N/ASogne (parish)
adm4Distrikt (district)N/ASeutukunta (district)N/A
adm5Församling 2015 (parish 2015)N/AN/AN/A

Address types

The address_type of an address:

CodeDescription
NALocation address - General
NBLocation address - City
NCLocation address - Rural
NARLocation address - General, reserved
NBRLocation address - City, reserved
NCRLocation address - Rural, reserved
BAPO Box address - General
BBPO Box address - Main operator
BCPO Box address - Other operator
BDLarge customer address - Organisation with their own postal code
BEPO Box address - Package dispenser
AAAdministrative address - General
ABAdministrative address - Internal address
ACAdministrative address - Competition mail (tävlingspost)
ADAdministrative address - Reply mail (svarspost/frisvar/svarsförsändelser)
XEAddress type unknown
XXAny 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.

CodeMeaning
302Exactly one match
300One or more suggestions
404Nothing found
400Bad request; status_text says why
403The API key is deactivated
200Validate 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.

CodeText
131Number of suggestions are too many to display
200Street address is missing
201Unknown format for the street address
202Street address had misspellings, errors or was incorrect
203Street address contains abbreviations
204Street address had minor errors that were corrected
208Street address is a post office box
209Both street address and post office box address included in the same field
250Missing street number
251Invalid format for the street number
252Incorrect street number
253Street number not applicable on the given address
254Street number is reserved and not yet in use
260Missing letter in the street number
261Unknown format for letter in street number
262Incorrect letter in street number
263Letter not applicable on the street number for the given address
270Secondary street number is missing
271Unknown format for the secondary street number
272Incorrect secondary street number
273Secondary street number cannot be applied to the given address
300Postal code is missing
301Unknown format for the postal code
302Postal code is incorrect
304Postal code had minor errors that were corrected
306Postal code is incomplete
307Customer specific postal code
308Postal code includes country prefix
400Locality is missing
401Unknown format for locality
402Incorrect locality
403Locality had abbreviations
404Locality 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.


Did this page help you?