Get Address Requirements (with context)

Request

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.

Security

UserToken or PersonalToken

Headers

X-External-Correlation-Idstring, (uuid), <= 36 characters

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

Example:f47ac10b-58cc-4372-a567-0e02b2c3d479

Bodyapplication/json

profileinteger, (int64)

User profile ID.

Example:12345678

detailsobjectrequired

Address details to provide context for requirements lookup. Additional fields beyond those listed are accepted.

curl -i -X POST \
  https://api.wise.com/v1/address-requirements \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-External-Correlation-Id: f47ac10b-58cc-4372-a567-0e02b2c3d479' \
  -d '{
    "details": {
      "country": "US"
    }
  }'

Responses

OK - Successfully retrieved address requirements.

Headers

X-External-Correlation-Idstring, (uuid), <= 36 characters

Echoed back when X-External-Correlation-Id was included in the request. Learn more.

Example:"f47ac10b-58cc-4372-a567-0e02b2c3d479"

x-trace-idstring

Unique trace identifier assigned by Wise. Useful when contacting support about a specific request.

Example:"fba501b6d453b96789f52338f019341f"

Bodyapplication/json

Array [

typestring

Always "address".

Example:"address"

fieldsArray of objects

List of fields required for the address.

]

Response

[
  {
    "type": "address",
    "fields": [
      { … }
    ]
  }
]