Skip to main content
POST
/
v3
/
address-resolutions
Resolve addresses
curl --request POST \
  --url https://api.ctrl-hub.com/v3/address-resolutions \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'X-Session-Token: <api-key>' \
  --data '
{
  "data": {
    "type": "<string>",
    "attributes": {
      "addresses": [
        "<string>"
      ]
    }
  }
}
'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "input_address": "<string>",
        "uprn": "<string>",
        "resolved_address": "<string>",
        "confidence": 50,
        "confidence_zone": "<string>",
        "recommendation_code": "<string>",
        "is_reliable": true
      }
    }
  ],
  "jsonapi": {
    "version": "<string>"
  }
}

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Body

application/vnd.api+json

The addresses to resolve.

data
object
required

Response

Address resolution results.

JSON API response object

data
A list of address resolution results ยท object[]
required
jsonapi
object
required