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

# Get phonerequirements



## OpenAPI

````yaml /openapi.json get /phone/requirements
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: []
tags:
  - name: Agents
    description: Create and manage AI agents with email and phone capabilities
  - name: Inboxes
    description: Manage email inboxes and their configurations
  - name: Messages
    description: Send, receive, and search email messages
  - name: Webhooks
    description: Register and manage webhook subscriptions for real-time events
  - name: Organizations
    description: Manage organizations and team settings
  - name: Domains
    description: Configure and verify custom email domains
  - name: Phone
    description: Manage phone numbers and SMS/voice capabilities
  - name: Invoices
    description: Track invoices, match receipts, and reconcile payments
  - name: Billing
    description: View usage, tiers, and billing information
  - name: Security
    description: Configure security policies and access controls
  - name: Vault
    description: Store and retrieve encrypted secrets
  - name: API Keys
    description: Create and manage API keys for programmatic access
paths:
  /phone/requirements:
    get:
      operationId: phone.requirements
      parameters:
        - name: countryCode
          in: query
          required: true
          schema:
            type: string
            pattern: ^[A-Za-z]{2}$
            description: ISO 3166-1 alpha-2 country code to check requirements for
          allowEmptyValue: true
          allowReserved: true
        - name: numberType
          in: query
          required: false
          schema:
            default: local
            enum:
              - local
              - mobile
              - national
              - toll_free
              - shared_cost
            type: string
            description: Phone number type to check requirements for
          allowEmptyValue: true
          allowReserved: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  countryCode:
                    type: string
                    description: ISO 3166-1 alpha-2 country code queried
                  numberType:
                    enum:
                      - local
                      - mobile
                      - national
                      - toll_free
                      - shared_cost
                    type: string
                    description: >-
                      Phone number type — regulatory requirements vary by type
                      within a country
                  tier:
                    enum:
                      - NONE
                      - ADDRESS
                      - IDENTITY
                      - DOCS
                      - UNSUPPORTED
                    type: string
                    description: >-
                      Provisioning requirement tier: NONE = order instantly,
                      ADDRESS = local address required, IDENTITY = identity
                      details required, DOCS = document upload required,
                      UNSUPPORTED = provider does not sell this combination
                  requirements:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Provider requirement identifier
                        name:
                          type: string
                          description: Human-readable requirement name
                        fieldType:
                          type: string
                          description: >-
                            Provider field type (document, address, or textual
                            today)
                        description:
                          type: string
                          description: What the requirement asks for
                        example:
                          type: string
                          description: Example of an acceptable value
                        acceptanceCriteria:
                          type: object
                          additionalProperties: {}
                          description: >-
                            Provider acceptance criteria (limits, allowed
                            values)
                      required:
                        - id
                        - name
                        - fieldType
                      description: One regulatory requirement field for ordering a number
                    description: >-
                      Requirement fields to satisfy before ordering; empty when
                      tier is NONE
                  approvedBundleId:
                    type: string
                    description: >-
                      The org's approved regulatory bundle satisfying this
                      combination, when one exists
                required:
                  - countryCode
                  - numberType
                  - tier
                  - requirements
                description: >-
                  Provisioning requirements for a country/number-type
                  combination
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>'

````