> ## Documentation Index
> Fetch the complete documentation index at: https://docs.useanima.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Post addresses validate

> 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).



## OpenAPI

````yaml /openapi.json post /addresses/{id}/validate
openapi: 3.1.1
info:
  title: Anima API
  version: 0.1.0
  description: >-
    The Anima API provides programmatic access to unified infrastructure for AI
    agents: create and manage agents; send and receive email; place phone calls
    and send/receive SMS and voice; store and retrieve vault credentials; manage
    agent identity; and configure webhooks for real-time events. Authenticate
    using a Bearer token or an API key passed via the X-API-Key header.
  contact:
    name: Anima Labs
    url: https://useanima.sh
    email: support@useanima.sh
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://api.useanima.sh/v1
    description: Production
security:
  - BearerAuth: []
  - ApiKeyAuth: []
paths:
  /addresses/{id}/validate:
    post:
      description: >-
        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).
      operationId: address.validate
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            description: Address identity identifier
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                agentId:
                  anyOf:
                    - type: string
                      pattern: ^[0-9a-z]+$
                    - type: string
                      pattern: ^[cC][^\s-]{8,}$
                  description: Agent identifier that owns this address
              required:
                - agentId
              description: Input for identifying a specific address identity
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  valid:
                    type: boolean
                    description: >-
                      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.
                  standardized:
                    type: object
                    properties:
                      type:
                        enum:
                          - BILLING
                          - SHIPPING
                          - MAILING
                          - REGISTERED
                        type: string
                        description: Address type
                      label:
                        anyOf:
                          - type: string
                          - type: 'null'
                        description: User-defined label
                      street1:
                        type: string
                        description: Primary street address line
                      street2:
                        anyOf:
                          - type: string
                          - type: 'null'
                        description: Secondary street address line
                      city:
                        type: string
                        description: City name
                      state:
                        type: string
                        description: State or province
                      postalCode:
                        type: string
                        description: Postal or ZIP code
                      country:
                        type: string
                        description: 2-character ISO country code
                    required:
                      - type
                      - label
                      - street1
                      - street2
                      - city
                      - state
                      - postalCode
                      - country
                    description: Standardized version of the address
                  confidence:
                    type: number
                    minimum: 0
                    maximum: 1
                    description: Confidence score between 0 and 1
                  suggestions:
                    type: array
                    items:
                      type: object
                      properties:
                        street1:
                          type: string
                          description: Suggested street address
                        street2:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Suggested secondary address
                        city:
                          type: string
                          description: Suggested city
                        state:
                          type: string
                          description: Suggested state
                        postalCode:
                          type: string
                          description: Suggested postal code
                        country:
                          type: string
                          description: Suggested country code
                      required:
                        - street1
                        - street2
                        - city
                        - state
                        - postalCode
                        - country
                    description: >-
                      Reserved: alternative address suggestions. Currently
                      ALWAYS an empty array — the built-in validator is
                      structural only (provider `anima_lite`) and does not
                      generate alternatives. Populated only if/when a
                      postal-data provider is integrated.
                required:
                  - valid
                  - standardized
                  - confidence
                  - suggestions
                description: >-
                  Address validation result. Validation is
                  structural/format-only (provider `anima_lite`): it normalizes
                  the country code and US state, and checks field shapes — it
                  does not verify the address exists or is deliverable.
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT Bearer token obtained from authentication. Pass as: Authorization:
        Bearer <token>
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'API key for programmatic access. Pass as: X-API-Key: <your-key>'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.