Structural (format-only) address validation: normalizes the country to ISO 3166-1 alpha-2, checks US state codes and ZIP shape, and verifies required fields are present. It does NOT check that the address exists or is deliverable, and suggestions is currently always empty (reserved for a future postal-data provider).

post/addresses/{id}/validate

Request

  • Base URL: https://api.useanima.sh/v1
  • URL: https://api.useanima.sh/v1/addresses/{id}/validate
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

idstring required

Address identity identifier

Request body

Response

OK

validboolean required

Whether the address passed structural (format-only) validation: ISO 3166-1 alpha-2 country, US state code + ZIP shape for US addresses, non-empty street/city. This is NOT a deliverability or postal-database check.

confidencenumber required

Confidence score between 0 and 1

Changes

No recorded changes to this operation across all 1 revision of this API.