v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

UserAddresses

Creates a user address

Creates a user address.

post/user_addresses

Request body

administrative_areastring

The locality of the user address. For US addresses, this corresponds to the state of the address.

boroughstring

The borough of the user address. This field is not used for addresses in the US but is used for some international addresses.

business_namestring required

The business name associated with the user address.

country_codestring required

The two-character (ISO 3166-1 alpha-2) country code of the user address.

customer_referencestring

A customer reference string for customer look ups.

extended_addressstring

Additional street address information about the user address such as, but not limited to, unit number or apartment number.

first_namestring required

The first name associated with the user address.

last_namestring required

The last name associated with the user address.

localitystring required

The locality of the user address. For US addresses, this corresponds to the city of the address.

neighborhoodstring

The neighborhood of the user address. This field is not used for addresses in the US but is used for some international addresses.

phone_numberstring

The phone number associated with the user address.

postal_codestring

The postal code of the user address.

skip_address_verificationboolean

An optional boolean value specifying if verification of the address should be skipped or not. UserAddresses are generally used for shipping addresses, and failure to validate your shipping address will likely result in a failure to deliver SIM cards or other items ordered from Telnyx. Do not use this parameter unless you are sure that the address is correct even though it cannot be validated. If this is set to any value other than true, verification of the address will be attempted, and the user address will not be allowed if verification fails. If verification fails but suggested values are available that might make the address correct, they will be present in the response as well. If this value is set to true, then the verification will not be attempted. Defaults to false (verification will be performed).

street_addressstring required

The primary street address information about the user address.

Example request

{
  "administrative_area": "TX",
  "borough": "Guadalajara",
  "business_name": "Toy-O'Kon",
  "country_code": "US",
  "customer_reference": "MY REF 001",
  "extended_address": "14th Floor",
  "first_name": "Alfred",
  "last_name": "Foster",
  "locality": "Austin",
  "neighborhood": "Ciudad de los deportes",
  "phone_number": "+12125559000",
  "postal_code": "78701",
  "street_address": "600 Congress Avenue"
}

Response

Successful response

Example response

{
  "data": {
    "administrative_area": "TX",
    "borough": "Guadalajara",
    "business_name": "Toy-O'Kon",
    "country_code": "US",
    "created_at": "2018-02-02T22:25:27.521Z",
    "customer_reference": "MY REF 001",
    "extended_address": "14th Floor",
    "first_name": "Alfred",
    "id": "c3527e69-dc5a-4b3e-8f44-99d209f83c1d",
    "last_name": "Foster",
    "locality": "Austin",
    "neighborhood": "Ciudad de los deportes",
    "phone_number": "+12125559000",
    "postal_code": "78701",
    "record_type": "user_address",
    "street_address": "600 Congress Avenue",
    "updated_at": "2018-02-02T22:25:27.521Z"
  }
}