Submit regulated-number 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). Idempotent per (owner, country).
API key authentication - use your Zernio API key as a Bearer token
In: header
Reuse a prior approved verification for this country (skips document/field collection; places the order immediately).
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
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"
}
}{
"error": "Unauthorized"
}Search available numbers to purchase GET
Search the provider's inventory for numbers available to purchase in a country (default US). Optional filters narrow the results. The country must be offerable (see GET /v1/whatsapp/phone-numbers/countries).
List flow responses GET
List the responses customers submitted when completing a flow (parsed from the nfm_reply messages received via webhook), newest first. Scope to a single flow with `flowId` — this matches responses whose flow_token carries the `<flowId>:` prefix that Zernio stamps on auto-generated tokens at send time. Responses sent with a custom integrator-supplied flow_token are not attributed to a flow.