Headers

• Authorization string Required

  Authorize your API calls with an Arta API token

Responses

• 201 application/json

  The created address verification

  Hide headers attributes Show headers attributes

  • content-type string
  • x-arta-request-id string

    A unique identifier for the Arta API call

  Hide response attributes Show response attributes object

  • created_at string

    A NaiveDatetime-formatted timestamp describing when the resource was created with microsecond precision

  • id string(uuid)

    The id of the address verification in UUID format

  • input object

    The original address as submitted

    Hide input attributes Show input attributes object

    • address_line_1 string

      Primary street address line

    • address_line_2 string | null

      Secondary address line (apartment, suite, unit, etc.)

    • address_line_3 string | null

      Tertiary address line. Used for some international formats

    • city string | null

      City or locality name

    • country string

      ISO 3166-1 alpha-2 country code

    • postal_code string | null

      Postal or ZIP code

    • region string | null

      State, province, or region code

  • match_level string

    The granularity of the address match, from most to least precise

    Values are delivery_point, premise, thoroughfare, locality, administrative_area, or none.

  • recommendation object

    The verified and corrected address with geocoding data. Fields may be null if verification failed

    Hide recommendation attributes Show recommendation attributes object

    • address_line_1 string | null

      Corrected primary street address

    • address_line_2 string | null

      Corrected secondary address line

    • address_line_3 string | null

      Corrected tertiary address line

    • city string | null

      Corrected city or locality

    • country string

      ISO 3166-1 alpha-2 country code

    • is_residential boolean | null

      Whether the address is classified as residential. US addresses only; null for international or when unknown

    • latitude number(float) | null

      Latitude coordinate of the verified address

    • longitude number(float) | null

      Longitude coordinate of the verified address

    • postal_code string | null

      Corrected postal code. For US addresses, may include the +4 extension (e.g., 10001-1234)

    • region string | null

      Corrected state, province, or region

  • reference string | null

    An optional client-provided reference string for correlating with your own records

  • shortcode string

    A human-readable identifier for the address verification prefixed with the organization's shortcode

  • status string

    The verification outcome

    Values are success, partial, or failed.

  • updated_at string

    A NaiveDatetime-formatted timestamp describing when the resource was last updated with microsecond precision

• 400 application/json

  Bad Request

  Hide headers attributes Show headers attributes

  • content-type string
  • x-arta-request-id string

    A unique identifier for the Arta API call

  Hide response attribute Show response attribute object

  • errors object
    Hide errors attribute Show errors attribute object

    • detail string
• 403 application/json

  Forbidden

• 422 application/json

  Unprocessible entity

  Hide response attribute Show response attribute object

  • errors object
    Hide errors attribute Show errors attribute object

    • detail string

      A human-readable explanation specific to this occurrence of the problem