Zernio
Zernio
API Reference

Phone Numbers

Numbers

List phone numbersGETGet phone numberGETPurchase phone numberPOSTResolve a number claimGETRelease phone numberDELETE

Availability

List offerable number countriesGETCheck country availabilityGETSearch available numbersGET

Stock Watches

List stock watchesGETWatch an out-of-stock countryPOSTStop watching a countryDELETE

KYC

Get KYC form specGETSubmit KYCPOSTPre-validate KYC addressPOSTPre-review a KYC packetPOSTUpload a KYC documentPOSTView a KYC document on fileGETCreate a hosted KYC linkPOST

Remediation

Get declined requirementsGETResubmit a declined numberPOSTReply to the regulatory reviewerPOSTRespond to the regulatory reviewer (message + corrections)POST

Porting

Check portabilityPOSTCountry porting requirementsGETPort numbers inPOSTList port-in ordersGETResolve a port claimGETA port-in order's pending requirementsGETUpload a porting documentPOSTCancel a port-inDELETE

Other

Request the WhatsApp verification code for a numberPOST
Dashboard
llms.txtOpenAPI
OverviewPlatformsAPI ReferenceResources
Phone Numbers

Watch an out-of-stock country

Get notified the first time an out-of-stock country has deliverable numbers again: an email to the account holder plus the phone_number.stock_available webhook. Stock is re-checked every 6h. One watch per country and number type; a repeat request returns the existing watch (200). The watch is consumed when it fires, so re-create it if you miss the stock. Up to 20 watches at once.

Countries and types marked fulfilment: request by GET /v1/phone-numbers/countries can also be watched, but anything with preOrderable: true does not need a watch: submit KYC and the carrier sources the number to order.

Pass areaCode (with numberType) to watch one sold-out area, for example an entry of soldOutAreas from GET /v1/phone-numbers/availability. Area stock is checked live on the same 6h cadence.


POST
/v1/phone-numbers/stock-watches

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.phonenumbers.createPhoneNumberStockWatch({  body: {    country: 'string',  },});console.log(data);
{  "id": "string",  "country": "string",  "countryName": "string",  "numberType": "local",  "areaCode": "string",  "createdAt": "2019-08-24T14:15:22Z",  "preOrderable": true}
Was this page helpful?

List stock watches

Previous Page

Stop watching a country

Next Page

country*string

ISO 3166-1 alpha-2 code of a country listed by GET /v1/phone-numbers/countries.

Length2 <= length <= 2
numberType?string

Narrow the watch to one number type. Omit to be notified when any type in the country is back.

Value in

  • "local"
  • "mobile"
  • "national"
  • "toll_free"
areaCode?string

Narrow the watch to one area code (NDC). Requires numberType.

Match^\d{1,4}$