Skip to main content
POST
phone.emergency-address.validate

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
address
object
required

Personal postal address to validate; it is not saved or provisioned.

view
enum<string>
default:emergency

Emergency address validation, or address normalization and suggestions. Default emergency.

Available options:
emergency,
geocode

Response

The result

view
string
required

Emergency address validation result.

Allowed value: "emergency"
validationStatus
enum<string>
required

Address validation only; this never means emergency service was activated.

Available options:
validated,
not_validated,
unknown
normalizedAddress
object

Returned normalized postal address, when complete.

latitude
number

Returned latitude in decimal degrees.

Required range: -90 <= x <= 90
longitude
number

Returned longitude in decimal degrees.

Required range: -180 <= x <= 180