Get phone number
Retrieve the current status of a purchased phone number. Poll this to
track Meta pre-verification (US sync path) and, for regulated (Tier 3/4)
numbers, the async lifecycle: pending_regulatory → active (or
regulatory_declined). When a regulated number has an Onfido ID step,
onfidoVerificationUrl appears here once the order is placed — forward
it to the end user. (Or subscribe to the whatsapp.number.* webhooks
instead of polling.)
API key authentication - use your Zernio API key as a Bearer token
In: header
Path Parameters
Phone number record ID
Response Body
application/json
application/json
application/json
import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.whatsappphonenumbers.getWhatsAppPhoneNumber({ path: { phoneNumberId: 'phonenumber_abc123', },});console.log(data);{
"phoneNumber": {
"id": "string",
"phoneNumber": "string",
"status": "pending_payment",
"country": "string",
"metaPreverifiedId": "string",
"metaVerificationStatus": "string",
"onfidoVerificationUrl": "string",
"endUserFirstName": "string",
"endUserLastName": "string",
"regulatoryDeclineReason": "string",
"provisionedAt": "2019-08-24T14:15:22Z"
}
}{
"error": "Unauthorized"
}{
"error": "Not found"
}Purchase phone number POST
Initiate purchasing a WhatsApp phone number. Payment-first flow: the user does not pick a specific number. The system either creates a Stripe Checkout Session (first number) or increments the existing subscription quantity and provisions inline (subsequent numbers). Requires a paid plan. The maximum number of phone numbers is determined by the user's plan.
Release phone number DELETE
Release a purchased phone number. This will: 1. Disconnect any linked WhatsApp social account 2. Decrement the Stripe subscription quantity (or cancel if last number) 3. Release the number from Telnyx 4. Mark the number as released