Other/API Reference - Ideal Postcodes

Resolve Address (USA)

v1.0.0

Resolves an address autocompletion by its address ID.

Resolved addresses (including global addresses) are returned in a US format (up to 2 address lines) using US nomenclature (like zipcode, state and city).

Input

{
  "type": "object",
  "properties": {
    "address": {
      "type": "string"
    }
  },
  "required": [
    "address"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "code",
    "message",
    "result"
  ],
  "properties": {
    "code": {
      "type": "integer",
      "format": "int32",
      "enum": [
        2000
      ]
    },
    "message": {
      "type": "string",
      "enum": [
        "Success"
      ]
    },
    "result": {
      "type": "object"
    }
  }
}