Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Telnyx Addresses API

Operations to work with Address records. Address records are emergency-validated addresses meant to be associated with phone numbers. They are validated for emergency usage purposes at creation time, although you may validate them separately with a custom workflow using the ValidateAddress operation separately. Address records are not usable for physical orders, such as for Telnyx SIM cards, please use UserAddress for that. It is not possible to entirely skip emergency service validation for Address records; if an emergency provider for a phone number rejects the address then it cannot be used on a phone number. To prevent records from getting out of sync, Address records are immutable and cannot be altered once created. If you realize you need to alter an address, a new record must be created with the differing address.

Telnyx Addresses API is one of 168 APIs that Telnyx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Addresses. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 4 paths, and defines 25 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.telnyx.com/v2.

6 operations 4 paths 25 schemas 1 DELETE2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.telnyx.com/v2
Authentication
HTTP Bearer, HTTP Bearer, OAuth 2.0, HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 6

Telnyx Addresses API declares 6 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP bearer tokens (branded-calling_bearerAuth). It supports OAuth 2.0 (oauthClientAuth) using the authorizationCode and clientCredentials flows, exposing 1 scope. It accepts HTTP bearer tokens (JWT) (outbound-voice-profiles_bearerAuth). It accepts HTTP bearer tokens (pronunciation-dicts_bearerAuth). It accepts HTTP bearer tokens (JWT) (stored-payment-transactions_bearerAuth). By default, every request must be authenticated.

  • branded-calling_bearerAuth — API key passed as a Bearer token in the Authorization header
  • oauthClientAuth — OAuth 2.0 authentication for Telnyx API and MCP integrations
  • pronunciation-dicts_bearerAuth — Telnyx API v2 key. Obtain from https://portal.telnyx.com

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Addresses 6

Operations to work with Address records. Address records are emergency-validated addresses meant to be associated with phone numbers. They are validated for emergency usage purpos…

GET
/addresses
List all addresses
FindAddresses 3 params → 200400401404
POST
/addresses
Creates an address
CreateAddress body → 200422
POST
/addresses/actions/validate
Validate an address
ValidateAddress body → 200422
DELETE
/addresses/{id}
Deletes an address
DeleteAddress 1 param → 200401404422
GET
/addresses/{id}
Retrieve an address
GetAddress 1 param → 200401404422
POST
/addresses/{id}/actions/accept_suggestions
Accepts this address suggestion as a new emergency address for Operator Connect and finishes the uploads of the numbers associated with it to Microsoft.
acceptAddressSuggestions 1 param body → 200202404

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are Address (19 properties), AddressCreate (15 properties), ValidateAddressRequest (6 properties), ValidateAddressField (6 properties). Each schema is shown below with its type and property counts.

postal_code
string
The postal code of the address.
neighborhood
string
The neighborhood of the address. This field is not used for addresses in the US but is used for some international addresses.
ValidateAddressField
object
6 properties
ValidateAddressResult
object
4 properties 2 required
locality
string
The locality of the address. For US addresses, this corresponds to the city of the address.
Error
object
5 properties 2 required
administrative_area
string
The locality of the address. For US addresses, this corresponds to the state of the address.
customer_reference
string
A customer reference string for customer look ups.
first_name
string
The first name associated with the address. An address must have either a first last name or a business name.
AddressCreate
object
15 properties 6 required
ValidateAddressRequest
object
6 properties 3 required
AcceptSuggestionsRequest
object
1 property
street_address
string
The primary street address information about the address.
ResourceNotFoundError
object
1 property
Address
object
19 properties
AddressSuggestionResponse
object
1 property
address_book
boolean
Indicates whether or not the address should be considered part of your list of addresses that appear for regular use.
last_name
string
The last name associated with the address. An address must have either a first last name or a business name.
phone_number
string
The phone number associated with the address.
country_code
string
The two-character (ISO 3166-1 alpha-2) country code of the address.
extended_address
string
Additional street address information about the address such as, but not limited to, unit number or apartment number.
PaginationMeta
object
4 properties
business_name
string
The business name associated with the address. An address must have either a first last name or a business name.
validate_address
boolean
Indicates whether or not the address should be validated for emergency use upon creation or not. This should be left with the default value of true unless you…
borough
string
The borough of the address. This field is not used for addresses in the US but is used for some international addresses.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-addresses-api-openapi.yml Raw ↑

Other APIs Telnyx publishes across the network.

Telnyx Access Tokens API
Telnyx Advanced Number Orders API
Telnyx Assistants API
Telnyx Audio API
Telnyx Audit Logs API
Telnyx Authentication Providers API
Telnyx AutoRechargePreferences API
Telnyx Billing API
Telnyx Billing Groups API
Telnyx Brands API
Telnyx Bucket SSL Certificate API
Telnyx Bucket Usage API