v5

latestOpenAPI 3.1.02026-07-262421791.5 MB

address

Create or Update an Address

Adds address info to user profile.

List of required fields are different for different countries. Use the address requirements endpoint to dynamically discover required fields.

For updating personal profiles, consider using the personal profile update endpoint instead. It allows submitting the address information alongside other profile data.

State field is required for US, CA, BR, and AU addresses.

Occupations is required for CA, IN, JP, ID, IL, MX, and within the US for the state NM.

post/v1/addresses

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 required

User profile ID.

Example request

{
  "profile": 12345678,
  "details": {
    "country": "US",
    "firstLine": "50 Sunflower Ave",
    "postCode": "10025",
    "city": "Phoenix",
    "state": "AZ",
    "occupations": [
      {
        "code": "Software Engineer",
        "format": "FREE_FORM"
      }
    ]
  }
}

Response

OK - Address successfully created or updated.

idinteger

Address ID.

profileinteger

User profile ID.

Example response

{
  "id": 10000001,
  "profile": 12345678,
  "details": {
    "country": "US",
    "firstLine": "50 Sunflower Ave",
    "postCode": "10025",
    "city": "Phoenix",
    "state": "AZ",
    "occupations": [
      {
        "code": "Software Engineer",
        "format": "FREE_FORM"
      }
    ]
  }
}