Validate Address

POST

/domains/{domain}/addresses/validate

Last modified:2023-12-21 20:52:14

OperationId:ValidateAddress

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/json

Example

{
    "domain": "sampleDomain",
    "address-name": "We Work Office",
    "caller-name": "We Work Secretary",
    "address-line-1": "8910 UNIVERSITY CENTER LN",
    "address-line-2": "STE 400",
    "address-country-abbreviation": "US",
    "address-state-province-abbreviation": "CA",
    "address-city": "San Diego",
    "address-postal-code": "92122-1025",
    "address-location-description": "front left desk"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://awqacore01.crexendocloud.com/ns-api/v2/domains/sampleDomain/addresses/validate' \
--header 'Content-Type: application/json' \
--data-raw '{
    "domain": "sampleDomain",
    "address-name": "We Work Office",
    "caller-name": "We Work Secretary",
    "address-line-1": "8910 UNIVERSITY CENTER LN",
    "address-line-2": "STE 400",
    "address-country-abbreviation": "US",
    "address-state-province-abbreviation": "CA",
    "address-city": "San Diego",
    "address-postal-code": "92122-1025",
    "address-location-description": "front left desk"
}'

Responses

🟢200OK

application/json

Body

Example

{
    "domain": "sampleDomain",
    "object": "address",
    "singular": 1,
    "action": "validate",
    "http_method": "POST",
    "controller": "addresses",
    "format": "json",
    "apiVer": "v2",
    "address-name": "We Work Office",
    "caller-id-number": "We Work Secretary",
    "address-line-1": "8910 UNIVERSITY CENTER LN",
    "address-line-2": "STE 400",
    "address-country-abbreviation": "US",
    "address-state-province-abbreviation": "CA",
    "address-city": "San Diego",
    "address-postal-code": "92122-1025",
    "address-location-description": "front left desk",
    "emergency-address-id": "a-6525c1ae9d7ff",
    "address-formatted-pidflo": {
        "HouseNumber": 8910,
        "StreetName": "UNIVERSITY CENTER",
        "StreetSuffix": "LN",
        "City": "SAN DIEGO",
        "StateCode": "CA",
        "Zip": 92122,
        "PlusFour": 1012,
        "County": [],
        "Country": "US",
        "AddressType": "E911",
        "LocationId": "a-6525c1ae9d7ff",
        "ValidationStatus": "VALID",
        "Adjusted": "true"
    },
    "address-provisioned-carrier-name": "bandwidth"
}

🟠404Record not found

🟠400Bad Request

🟠401Authentication Required

Modified at 2023-12-21 20:52:14

Get Addresses for Domain

Create Address for Domain