An Address Resource represents users' physical location within a country. Some local authorities require the user’s name and address to be on file with Twilio to purchase and own a phone number. Address requirements are exposed as a property on the AvailablePhoneNumber resource.
Addresses contain the name of your company or your customer's company in addition to location information and an optional friendly name. Each Address created on an account or subaccount can be used for any phone numbers purchased on that account. After creating an address, it can be used to satisfy the requirements for multiple phone numbers and phone numbers with address requirements can be purchased using the IncomingPhoneNumber resource.
In some countries, to comply with local regulations, addresses are validated to ensure the integrity and accuracy of the data provided. In those countries, if the address you provide does not pass validation, it is not accepted as an Address and the error code 21628 is returned. If the address submitted is not an exact match but is similar to a valid address, we'll create the Address using the valid address we found, unless you include the AutoCorrectAddress=false parameter in the request. In that case, we'll provide it as a suggested address in error code 21629. If the suggested address is indeed the address of your company or your customer's company, then use the suggested format to create a valid Address.
The Address list resource represents all of the Addresses that you have created on your account within Twilio. You can POST to Addresses to create a new address or modify an existing address.
Response Definition
| Property | Type | Description |
|---|---|---|
account_sid | string | The unique identifier of the account responsible for this address. |
api_version | string | The version of the API used for this resource. |
city | string | The city associated with this address. |
country | string | The country associated with this address. |
date_created | datetime | The date and time when this address was created. |
date_updated | datetime | The date and time when this address was last updated. |
friendly_name | string | A human-readable description for the address. |
line_1 | string | The first line of the address (e.g., street address). |
line_2 | string | The second line of the address (optional). |
postal_code | string | The postal code associated with this address. |
region | string | The region (state or province) associated with this address. |
sid | string | The unique identifier for this address. |
uri | string | The URI for this resource. |