Check country availability
Changed onPre-purchase check, so you can warn BEFORE a customer invests in KYC (regulated review is async, 1-3 days). Tells you whether we have deliverable inventory, and what address the customer needs:
- addressConstraint: geo → the registered address MUST be in one of the returned areas (the only place we have stock). A different-area address passes pre-approval but the number can never be assigned.
- addressConstraint: country → any in-country address works.
- addressConstraint: none → field-only / instant country, no address. Call this before starting the KYC form for regulated countries.
Without an API key it answers from cache only and returns just country, numberType and areaOptions, for building an area picker before signup.
Request
- Base URL: https://zernio.com/api
- URL: https://zernio.com/api/v1/phone-numbers/availability
- Auth: one of:
- none
- HTTP bearer
Query parameters
ISO-2 country code.
Check a specific offered type (stock and address constraints are per type). Omitted = the country's default type.
Pass true when the buyer wants SMS: availability, areas, and areaOptions then describe the SMS-capable pool (an SMS purchase orders from it), not the wider voice-only pool.
Response
Availability + address constraint.
Changes
- warning
added the new
accountenum value to the/response property for the response status
- warning
- info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status
- info