Get regulated-number KYC form spec
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.
API key authentication - use your Zernio API key as a Bearer token
In: header
Query Parameters
Response Body
application/json
application/json
import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.whatsappphonenumbers.getWhatsAppNumberKycForm({ query: { country: 'string', profileId: 'profile_abc123', },});console.log(data);{
"country": "string",
"numberType": "string",
"fields": [
{
"requirementId": "string",
"label": "string",
"kind": "text",
"description": "string",
"example": "string",
"localTo": "string"
}
],
"reusable": {
"available": true,
"fromPhoneNumber": "string"
}
}{
"error": "Unauthorized"
}Get number status GET
Live snapshot of a connected number straight from Meta: the phone-number node (display number, display name + approval, quality rating, messaging-limit tier, throughput, official-business badge, connection status, health_status) and its owning WhatsApp Business Account (name, business verification, timezone, health_status). Fetched live because Meta updates quality/tier/name/health over time; the call also refreshes the cached values shown on the connection card.
Get the declined requirements to fix GET
For a number in `regulatory_declined`, returns ONLY the requirements the reviewer flagged declined, as a form spec (same shape as the KYC form GET). The customer fixes just those — Telnyx supports correcting a declined requirement group and re-submitting it (no new number/group). Falls back to the full spec if the provider exposes no per-requirement flags.