Get 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",
"details": [
{
"label": "string",
"value": "string"
}
],
"options": [
{
"fromPhoneNumber": "string",
"details": [
{
"label": "string",
"value": "string"
}
]
}
]
}
}{
"error": "Unauthorized"
}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
Submit KYC POST
Submit the end customer's KYC (textual values, uploaded documents, address) for a Tier 3/4 country. Documents are streamed straight to the number provider and are not stored by Zernio. Builds + submits a regulatory requirement group and claims a pending_regulatory slot; the number is ordered + activated once the provider approves (asynchronous). A customer may hold several same-country numbers in review at once; a double-submit of the SAME attempt is deduped via `submissionId`. For an ID-card document requirement, carriers commonly require BOTH sides: combine the front and back into a single file before uploading (the dashboard does this automatically). A one-sided ID is a common decline reason; fix it via POST /v1/whatsapp/phone-numbers/{id}/remediate. Before submitting, call GET /v1/whatsapp/phone-numbers/availability to check the country has deliverable inventory and, for geographic-match countries, which area the address must be in — otherwise the submission can pass review yet never be assignable a number.