UserAddressCreate

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/telnyx/json-schema/telnyx-user-address-create-schema.json",
  "title": "UserAddressCreate",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-useraddresses-api-openapi.yml#/components/schemas/UserAddressCreate",
  "properties": {
    "administrative_area": {
      "$ref": "#/$defs/user-addresses_administrative_area"
    },
    "borough": {
      "$ref": "#/$defs/user-addresses_borough"
    },
    "business_name": {
      "$ref": "#/$defs/user-addresses_business_name"
    },
    "country_code": {
      "$ref": "#/$defs/user-addresses_country_code"
    },
    "customer_reference": {
      "$ref": "#/$defs/customer_reference"
    },
    "extended_address": {
      "$ref": "#/$defs/user-addresses_extended_address"
    },
    "first_name": {
      "$ref": "#/$defs/user-addresses_first_name"
    },
    "last_name": {
      "$ref": "#/$defs/user-addresses_last_name"
    },
    "locality": {
      "$ref": "#/$defs/user-addresses_locality"
    },
    "neighborhood": {
      "$ref": "#/$defs/user-addresses_neighborhood"
    },
    "phone_number": {
      "$ref": "#/$defs/user-addresses_phone_number"
    },
    "postal_code": {
      "$ref": "#/$defs/user-addresses_postal_code"
    },
    "skip_address_verification": {
      "$ref": "#/$defs/skip_address_verification"
    },
    "street_address": {
      "$ref": "#/$defs/user-addresses_street_address"
    }
  },
  "required": [
    "first_name",
    "last_name",
    "business_name",
    "street_address",
    "locality",
    "country_code"
  ],
  "type": "object",
  "$defs": {
    "customer_reference": {
      "description": "A customer reference string for customer look ups.",
      "type": "string"
    },
    "skip_address_verification": {
      "default": false,
      "description": "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).",
      "type": "boolean"
    },
    "user-addresses_administrative_area": {
      "description": "The locality of the user address. For US addresses, this corresponds to the state of the address.",
      "type": "string"
    },
    "user-addresses_borough": {
      "description": "The borough of the user address. This field is not used for addresses in the US but is used for some international addresses.",
      "type": "string"
    },
    "user-addresses_business_name": {
      "description": "The business name associated with the user address.",
      "type": "string"
    },
    "user-addresses_country_code": {
      "description": "The two-character (ISO 3166-1 alpha-2) country code of the user address.",
      "type": "string"
    },
    "user-addresses_extended_address": {
      "description": "Additional street address information about the user address such as, but not limited to, unit number or apartment number.",
      "type": "string"
    },
    "user-addresses_first_name": {
      "description": "The first name associated with the user address.",
      "type": "string"
    },
    "user-addresses_last_name": {
      "description": "The last name associated with the user address.",
      "type": "string"
    },
    "user-addresses_locality": {
      "description": "The locality of the user address. For US addresses, this corresponds to the city of the address.",
      "type": "string"
    },
    "user-addresses_neighborhood": {
      "description": "The neighborhood of the user address. This field is not used for addresses in the US but is used for some international addresses.",
      "type": "string"
    },
    "user-addresses_phone_number": {
      "description": "The phone number associated with the user address.",
      "type": "string"
    },
    "user-addresses_postal_code": {
      "description": "The postal code of the user address.",
      "type": "string"
    },
    "user-addresses_street_address": {
      "description": "The primary street address information about the user address.",
      "type": "string"
    }
  }
}