Validate an address

Validates an address for emergency services.

POST /addresses/actions/validate

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.addresses.actions.validate({
  country_code: 'US',
  postal_code: '78701',
  street_address: '600 Congress Avenue',
});

console.log(response.data);

200

{
  "data": {
    "result": "valid",
    "suggested": {
      "street_address": "600 Congress Avenue",
      "extended_address": "14th Floor",
      "locality": "Austin",
      "administrative_area": "TX",
      "postal_code": "78701",
      "country_code": "US"
    },
    "record_type": "address_validation",
    "errors": [
      {
        "title": "Invalid street address",
        "source": {
          "pointer": "/street_address"
        },
        "code": "20207",
        "description": "The street address provided is invalid."
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Parameters that can be defined during address validation

street_address · string · required

The primary street address information about the address.

Example:

"600 Congress Avenue"

postal_code · string · required

The postal code of the address.

Example:

"78701"

country_code · string · required

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

Example:

"US"

extended_address · string

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

Example:

"14th Floor"

locality · string

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

Example:

"Austin"

administrative_area · string

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

Example:

"TX"

Response

200

application/json

Action response

data · Validate address action result · object

Show child attributes