Autocomplete
/v2/address/autocomplete
Target audience: Developers
Release version: 4.7.5
Autocomplete¶
Introduction¶
This endpoint takes a zip-code and the beginning of a street address and returns a array of possible street adresses based on the Finnish Posti address file.
URI¶
| Environment | URI |
|---|---|
| Stage | https://payway-api.stage.adeprimo.se/external/api/v2/address/autocomplete |
| Production | https://backend.worldoftulo.com/external/api/v2/address/autocomplete |
Requirements¶
| Identity | Scope |
|---|---|
| No | /external/address/r |
Parameters¶
| Field | Required | Type | Description |
|---|---|---|---|
| zip_code | Required | String | The zip-code where the street is located |
| street | Required | String | The beginning of a street address, if less than 3 characters no results will be returned |
Curl Example¶
curl --request GET \
--url https://payway-api.stage.adeprimo.se/external/api/v2/address/autocomplete \
--header 'accept: application/json' \
--header 'authorization: Bearer token' \
--header 'content-type: application/json' \
--data '{
"zip_code": "65100",
"street": "Strand"
}'
Example Response¶
"items": {
["Strandgatan", "Strandgatan 2", "..."]
}
A successful response item will contain a array of possible street addresses. Note that supplying a street value that is less than 3 characters will return no results, only a empty array.
Errors¶
This API uses the common error conventions of the Payway API