Validate address

Checks an address with the platform's emergency calling carrier and returns it in the carrier's standard form. It does not save the address. Send the result to POST /domains/{domain}/addresses to save it.

Requires Office Manager, Site Manager, Reseller, or Super User scope. It counts as a create, so read-only scopes and Basic User scope cannot call it.

The carrier is set for the whole platform, so you cannot choose it. Send address-line-1, address-line-2, address-city, address-state-province-abbreviation, address-postal-code, and address-country-abbreviation. The house number is read from address-line-1 up to the first space. address-name and caller-name are returned as sent. Send emergency-address-id to check an existing address again. Without it, the response carries a new one, a- followed by 13 hexadecimal characters.

A valid address returns 200 with address-formatted-pidflo, the standardized address as an object whose keys depend on the carrier, and carrier. An address the carrier rejects also returns 200, with valid: false and the carrier's reason. Fix the address and validate again. A platform with no carrier set up answers valid: false with reason Vendor not configured.

With the bandwidth carrier the check takes a few seconds, and it registers the address with the carrier under its emergency-address-id.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//addresses/validate' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "address-name": "Main Office", "caller-name": "Front Desk", "address-line-1": "123 Example St", "address-line-2": "Suite 100", "address-city": "Example City", "address-state-province-abbreviation": "CA", "address-postal-code": "90210", "address-country-abbreviation": "US" }'

{ "domain": "example.com", "address-name": "Main Office", "caller-name": "Front Desk", "address-line-1": "123 Example St", "address-line-2": "Suite 100", "address-city": "Example City", "address-state-province-abbreviation": "CA", "address-postal-code": "90210", "address-country-abbreviation": "US", "emergency-address-id": "a-6525c1ae9d7ff", "address-formatted-pidflo": { "HouseNumber": "123", "StreetName": "EXAMPLE", "StreetSuffix": "ST", "City": "EXAMPLE CITY", "StateCode": "CA", "Zip": "90210", "PlusFour": "1234", "County": [], "Country": "US", "AddressType": "E911", "LocationId": "a-6525c1ae9d7ff", "ValidationStatus": "VALID", "Adjusted": "true" }, "carrier": "bandwidth" }

Request

Responses