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

countryCodestring 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

OK

countryCodestring 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

approvedBundleIdstring

The org's approved regulatory bundle satisfying this combination, when one exists

Changes

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