Submit KYC
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.
API key authentication - use your Zernio API key as a Bearer token
In: header
Idempotency token for this submission attempt. A retry/double-submit with the same token returns the same number; omit and each call creates a new number.
Provision several same-country numbers from one submission (1-5). The single verification covers all of them; each number is billed only when it activates. Numbers that fail to order are skipped (best-effort).
11 <= value <= 5Reuse a prior approved verification for this country (skips document/field collection; places the order immediately).
Which approved verification to reuse when several exist: the phone number it was originally approved for (GET reusable.options[].fromPhoneNumber). Omitted = newest. No match = 409.
End user's legal first name. Required when the country has an action/ID-verification (Onfido) requirement.
End user's legal last name. Same condition as endUserFirstName.
requirementId → textual value
One per document requirement. Each is EITHER inline base64 OR a documentId returned by POST /v1/whatsapp/phone-numbers/kyc/upload-document (use the upload endpoint for large files to stay under the request-size limit).
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.submitWhatsAppNumberKyc({ body: { profileId: 'profile_abc123', country: 'string', },});console.log(data);{
"status": "kyc_submitted",
"phoneNumber": {
"id": "string",
"status": "string",
"country": "string"
},
"numbers": [
{
"id": "string",
"status": "string",
"phoneNumber": "string",
"country": "string"
}
]
}{
"error": "Unauthorized"
}Get KYC form spec GET
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.
Upload a KYC document POST
Upload ONE document and get back its provider document id, to reference from POST /v1/whatsapp/phone-numbers/kyc via `documents[].documentId`. Send the RAW file bytes as the request body (not base64); put the filename in the `X-Filename` header. Uploading documents one-per-request keeps each request under the ~4.5MB body limit. The document streams straight to the number provider and is not stored by Zernio.