WhatsApp Phone Numbers

Create a hosted KYC link

Changed on

Deprecated alias of /v1/phone-numbers/kyc/share; same contract. New integrations should use that path.

Create a single-use, 7-day hosted KYC link that your end customer completes WITHOUT a Zernio login. Useful when the person who holds the ID and address is not your team. They fill the regulated verification on a Zernio-hosted page; the number provisions under YOUR account once they submit. Only regulated (KYC) countries are valid: a country that does not require KYC returns 400.

White-label the page with branding (your company name, logo, brand color). Supply redirect_url to send the end customer back to your own site after a successful submit (completion params are appended; see below). Listen for the whatsapp.number.kyc_submitted webhook to react when the form is completed.

post/v1/whatsapp/phone-numbers/kyc/share

Request

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

Request body

profileIdstring required
countrystring required

ISO 3166-1 alpha-2 country code (must be a regulated/KYC country).

areaCodestring

Area code (NDC) the eventual number must be in. Hard constraint carried by the link; the end customer filling the form makes no area choice. Options come from GET /v1/phone-numbers/availability (areaOptions).

language'en' | 'es' | 'pt-BR'

Language of the hosted page: its copy, the carrier requirement texts (translated once per country and cached), the pre-submit review notes and the status emails to the end customer. Omitted: the browser language of the end customer, falling back to English. The end customer can also switch with ?lang= on the page.

redirect_urlstring uri

Where to send the end customer's browser after a successful submit. On completion Zernio appends kyc=submitted and country=<ISO-2> as query params. When omitted, the hosted page shows a built-in confirmation screen instead.

Response

Hosted KYC link created.

urlstring

The hosted link to send your end customer.

tokenstring
expiresAtstring date-time

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