Sign in

v1

latestOpenAPI 3.1.02026-07-24317911.4 MB
Addresses

Validate Address

post/domains/{domain}/addresses/validate

Path parameters

domainstring required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

Example:example.com

Request body

emergency-address-idstring

A hash for the identifier of the address for both carrier and NS side.

address-namestring required
caller-namestring required
address-line-1string required
address-line-2string
address-country-abbreviationstring required
address-state-province-abbreviationstring required
address-citystring required
address-postal-codestring required
address-location-descriptionstring required

Response

domainstring required
objectstring required
emergency-address-idstring required
address-formatted-pidfloobject required

Standardized values and fields of the address. May be different depending on carrier

address-namestring required
caller-namestring required
address-line-1string required
address-line-2string required
address-country-abbreviationstring required
address-state-province-abbreviationstring required
address-citystring required
address-postal-codestring required
carrierstring required