Search available numbers
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/phone-numbers/countries). Voice
capability is always required; pass sms=true to only see numbers that
can also text (SMS support is per-number, not per-country).
API key authentication - use your Zernio API key as a Bearer token
In: header
Query Parameters
"US"Number type; defaults to the country's WhatsApp-safe type
Area code
City
Pattern to match within the number
true narrows the pool to SMS-capable numbers. Each result still carries its full features list for per-number capability badging.
20value <= 100Response Body
application/json
application/json
import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.phonenumbers.searchAvailablePhoneNumbers();console.log(data);{
"country": "string",
"numberType": "string",
"requireSms": true,
"numbers": [
{
"phoneNumber": "string",
"features": [
"string"
]
}
]
}{
"error": "Unauthorized"
}List phone numbers GET
List all phone numbers purchased by the authenticated user. By default, released numbers are excluded. Connected (bring-your-own) WhatsApp numbers are returned in the separate `connected` array; they are not billed and have no provisioning lifecycle.
Create a hosted KYC link POST
Create a single-use, 7-day hosted KYC link that your end customer completes WITHOUT a Zernio login — useful when the person who holds the ID and address is not your team. They fill the regulated verification on a Zernio-hosted page; the number provisions under YOUR account once they submit. Only regulated (KYC) countries are valid: a country that does not require KYC returns 400. White-label the page with `branding` (your company name, logo, brand color). Supply `redirect_url` to send the end customer back to your own site after a successful submit (completion params are appended — see below). Listen for the `whatsapp.number.kyc_submitted` webhook to react when the form is completed.