Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

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

Query Parameters

countryCode
string
required

ISO 3166-1 alpha-2 country code to check requirements for

Pattern: ^[A-Za-z]{2}$
numberType
enum<string>
default:local

Phone number type to check requirements for

Available options:
local,
mobile,
national,
toll_free,
shared_cost

Response

200 - application/json

OK

Provisioning requirements for a country/number-type combination

countryCode
string
required

ISO 3166-1 alpha-2 country code queried

numberType
enum<string>
required

Phone number type — regulatory requirements vary by type within a country

Available options:
local,
mobile,
national,
toll_free,
shared_cost
tier
enum<string>
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

Available options:
NONE,
ADDRESS,
IDENTITY,
DOCS,
UNSUPPORTED
requirements
object[]
required

Requirement fields to satisfy before ordering; empty when tier is NONE

approvedBundleId
string

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