---
title: "GET /phone/requirements"
method: GET
path: "/phone/requirements"
---

# GET /phone/requirements

`GET /phone/requirements`

## Request

- Base URL: `https://api.useanima.sh/v1`
- URL: `https://api.useanima.sh/v1/phone/requirements`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

## Query parameters

- `countryCode` string, required: ISO 3166-1 alpha-2 country code to check requirements for
- `numberType` 'local' | 'mobile' | 'national' | 'toll_free' | 'shared_cost': Phone number type to check requirements for

## Response `200`

OK

- object: Provisioning requirements for a country/number-type combination
  - `countryCode` string, required: ISO 3166-1 alpha-2 country code queried
  - `numberType` 'local' | 'mobile' | 'national' | 'toll_free' | 'shared_cost', required: Phone number type — regulatory requirements vary by type within a country
  - `tier` 'NONE' | 'ADDRESS' | 'IDENTITY' | 'DOCS' | 'UNSUPPORTED', required: 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` object[], required: Requirement fields to satisfy before ordering; empty when tier is NONE
    - `id` string, required: Provider requirement identifier
    - `name` string, required: Human-readable requirement name
    - `fieldType` string, required: Provider field type (document, address, or textual today)
    - `description` string: What the requirement asks for
    - `example` string: Example of an acceptable value
    - `acceptanceCriteria` object: Provider acceptance criteria (limits, allowed values)
  - `approvedBundleId` string: The org's approved regulatory bundle satisfying this combination, when one exists

---

[API](https://skmtc.dev/useanima/apis/anima-api.md) · [All operations](https://skmtc.dev/useanima/apis/anima-api/llms.txt) · [OpenAPI document](https://skmtc.dev/useanima/apis/anima-api/revisions/aaa148188980?raw)