Skip to main content
POST
/
addresses
/
{id}
/
validate
cURL
curl --request POST \
  --url https://api.useanima.sh/v1/addresses/{id}/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agentId": "<string>"
}
'
{
  "valid": true,
  "standardized": {
    "label": "<string>",
    "street1": "<string>",
    "street2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "country": "<string>"
  },
  "confidence": 0.5,
  "suggestions": [
    {
      "street1": "<string>",
      "street2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postalCode": "<string>",
      "country": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Path Parameters

id
string
required

Address identity identifier

Body

application/json

Input for identifying a specific address identity

agentId
required

Agent identifier that owns this address

Pattern: ^[0-9a-z]+$

Response

200 - application/json

OK

Address validation result with standardized address and suggestions

valid
boolean
required

Whether the address is considered valid

standardized
object
required

Standardized version of the address

confidence
number
required

Confidence score between 0 and 1

Required range: 0 <= x <= 1
suggestions
object[]
required

Alternative address suggestions