Sign in

v5

latestOpenAPI 3.1.02026-07-262421791.5 MB
address

Get Address Requirements (with context)

Returns the list of fields required to create a valid address, based on the provided context.

Use this endpoint to dynamically discover additional required fields based on selected values. For example:

  • Posting {"details": {"country": "US"}} will add "state" to the list of fields.
  • Posting {"details": {"country": "CA"}} will add "occupations" to the list of fields.

Continue calling this endpoint with field values until all fields with refreshRequirementsOnChange: true have been populated.

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

post/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.

Request body

profileinteger

User profile ID.

Example request

{
  "profile": 12345678,
  "details": {
    "country": "US",
    "state": "AZ"
  }
}

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"
              }
            ]
          }
        ]
      }
    ]
  }
]