ZEzernio
Phone Numbers

Get KYC form spec

Changed on

For a Tier 3/4 country, the fields the end customer must provide (Telnyx regulatory requirements) before a number can be ordered: text, date, address, or file (document) per requirement.

get/v1/phone-numbers/kyc

Request

  • Base URL
    https://zernio.com/api
  • URL
    https://zernio.com/api/v1/phone-numbers/kyc
  • Auth
    HTTP bearer

Query parameters

countrystring required
numberType'local' | 'mobile' | 'national' | 'toll_free'

Requirements and reuse eligibility are per (country, type). Omitted = the country's default type. Pass the same value on the POST.

Response

The KYC form spec.

countrystring
numberTypestring
pendingReviewboolean

true when this account already has a number for this country in regulatory review (status pending_regulatory).

  • Scope is the whole account across all profiles, and the country only (any number type), so it is not a per-end-client signal on a multi-tenant setup.
  • Informational only: it never blocks a submission, and several same-country numbers may sit in review at once.

For a per-end-client view, call GET /v1/phone-numbers with profileId and status=pending_regulatory; that view also lists numbers declined in the last 30 days.

Changes

  • f8c8f34fb41aRevision changes
    • warning

      added the new account enum value to the / response property for the response status

  • d556591af3f6Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status