Skip to main content

User Address

The User Address Answer is used to submit residential address information for individual users.

Fields​

FieldTypeRequiredDescription
fieldTypeIdstringYesMust be set to "UserAddress" (from FieldTypeEnum)
countryIdstringYesCountry — 2-letter ISO country code, e.g. KW (the only exception is Crimea, UA-43)
citystringYesCity name
statestringYesState, province, or region
zipcodestringYesPostal or ZIP code
addressstringYesStreet address including building number and street name

Example Usage​

{
"fieldId": "x4y5z6a7-8b9c-0d1e-2f3g-4h5i6j7k8l9m",
"answer": {
"fieldTypeId": "UserAddress",
"countryId": "AE",
"city": "Dubai",
"state": "Dubai",
"zipcode": "12345",
"address": "123 Sheikh Zayed Road, Downtown Dubai"
}
}

Notes​

  • All fields are required to provide a complete address.
  • The countryId should be a valid country code recognized by the system (typically ISO 3166-1 alpha-2 codes).
  • The format and validation of address components may vary depending on the selected country.
  • This model is used for individual user addresses, not company addresses (which would use the Company Address Answer).