Skip to main content

Validate an address

POST 

/addresses/actions/validate

Validates an address for emergency services.

Request

Body

required

Parameters that can be defined during address validation

    street_address street_addressrequired

    The primary street address information about the address.

    extended_address extended_address

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

    locality locality

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

    administrative_area administrative_area

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

    postal_code postal_coderequired

    The postal code of the address.

    country_code country_coderequired

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

Responses

200: Action response

Schema

    data

    object

    result stringrequired

    Possible values: [valid, invalid]

    Indicates whether an address is valid or invalid.

    suggested

    object

    required

    Provides normalized address when available.

    street_address street_address

    The primary street address information about the address.

    extended_address extended_address

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

    locality locality

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

    administrative_area administrative_area

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

    postal_code postal_code

    The postal code of the address.

    country_code country_code

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

    record_type string

    Identifies the type of the resource.

    errors

    Error[]

  • Array [

  • code intrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object
  • ]

422: Bad request

Loading...