Addresses

Everything about Addresses

Lookup Address

SecurityapiKey
Request
Request Body schema: application/json
required

cmd

Array of objects (ValueParam)
object
featureOn
Array of strings
Items Value: "SWITCH_OFF_DATA_CURATION"
groupBy
string
Enum: "ADMINISTRATIVE_AREA" "LOCALITY" "POST_CODE" "THOROUGHFARE" "COUNTRY"
Array of objects (ValueParam)
page
integer
Default: 0
pageSize
integer
Default: 10
object (ValueParam)
search
string

Generic search string

Array of objects (ThoroughfareParam)
Responses
200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post/addresses/lookup
Request samples
application/json
{
  • "search": "string",
  • "country": {
    },
  • "groupBy": "ADMINISTRATIVE_AREA",
  • "localities": [
    ],
  • "administrativeAreas": [
    ],
  • "thoroughfares": [
    ],
  • "postCode": {
    },
  • "page": 0,
  • "pageSize": 10,
  • "featureOn": [
    ]
}
Response samples
application/json
{
  • "page": 0,
  • "pageSize": 0,
  • "pages": 0,
  • "total": 0,
  • "values": [
    ]
}

Set Values in Correct Buckets from Address String Based on Reference Data.

SecurityapiKey
Request
Request Body schema: application/json
required
addressString
string
outputLanguageTechnicalKey
string
Default: "kr"
Responses
200

OK

post/kr/addresses/identify
Request samples
application/json
{
  • "addressString": "string",
  • "outputLanguageTechnicalKey": "kr"
}
Response samples
application/json
{
  • "addressString": "string",
  • "outputLanguageTechnicalKey": "string",
  • "address": {
    }
}