v5

latestOpenAPI 3.1.02026-07-262421791.5 MB

address

Get Address Requirements

Returns the list of fields required to create a valid address. Use this as a starting point to discover required fields.

The response contains 4 required top-level fields:

country (select field with list of values)
city (text field)
postCode (text field)
firstLine (text field)

If a field has refreshRequirementsOnChange: true, call the POST endpoint with that field's value to discover additional required fields.

For a step-by-step walkthrough, see the Address Requirements guide.

get/v1/address-requirements

Headers

X-External-Correlation-Idstring uuid

Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Response

OK - Successfully retrieved address requirements.

typestring

Always "address".

Example response

[
  {
    "type": "address",
    "fields": [
      {
        "name": "Country",
        "group": [
          {
            "key": "country",
            "type": "select",
            "refreshRequirementsOnChange": true,
            "required": true,
            "example": "Germany",
            "valuesAllowed": [
              {
                "key": "US",
                "name": "United States"
              },
              {
                "key": "GB",
                "name": "United Kingdom"
              }
            ]
          }
        ]
      }
    ]
  }
]