Phone & voice · Phone Numbers

Check country availability

Checks country availability.

GEThttps://api.pozy.ai/v1/phone-numbers/availability

checkPhoneNumberAvailability

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the telephony resource group disabled get 403 resource_group_disabled. Authentication

Query parameters

Name	Type	Notes
`country`required	string
`numberType`	string	One of `local`, `mobile`, `national`, `toll_free`
`sms`	boolean

Example

curl -X GET "https://api.pozy.ai/v1/phone-numbers/availability?country=US" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/phone-numbers/availability?country=US", {
  headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.get(
    "https://api.pozy.ai/v1/phone-numbers/availability",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    params={
        "country": "US",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

countrystring
numberTypestring
availableboolean
preOrderableboolean
addressConstraintstring
One of geo, country, none.
areasarray of string
areaOptionsarray of object
- ndcstring
- namestring
- countinteger
soldOutAreasarray of object
- ndcstring
- namestring
- preOrderableboolean
areaAvailabilityobject
- inStockarray of object
  5 child fields
  - ndcstring
  - namestring
  - countinteger
  - ndcsarray of string
  - aliasesarray of string
- preOrderarray of object
  4 child fields
  - ndcstring
  - namestring
  - ndcsarray of string
  - aliasesarray of string
- outOfStockarray of object
  5 child fields
  - ndcstring
  - namestring
  - listedinteger
  - ndcsarray of string
  - aliasesarray of string

200 response

{
  "country": "US",
  "numberType": "string",
  "available": true,
  "preOrderable": true,
  "addressConstraint": "geo",
  "areas": [
    "string"
  ],
  "areaOptions": [
    {
      "ndc": "string",
      "name": "Acme",
      "count": 42
    }
  ],
  "soldOutAreas": [
    {
      "ndc": "string",
      "name": "Acme",
      "preOrderable": true
    }
  ],
  "areaAvailability": {
    "inStock": [
      {
        "ndc": "string",
        "name": "Acme",
        "count": 42,
        "ndcs": [
          "string"
        ],
        "aliases": [
          "string"
        ]
      }
    ],
    "preOrder": [
      {
        "ndc": "string",
        "name": "Acme",
        "ndcs": [
          "string"
        ],
        "aliases": [
          "string"
        ]
      }
    ],
    "outOfStock": [
      {
        "ndc": "string",
        "name": "Acme",
        "listed": 1,
        "ndcs": [
          "string"
        ],
        "aliases": [
          "string"
        ]
      }
    ]
  }
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is scoped to other profiles or has this resource group disabled.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.

More in Phone Numbers

GETList phone numbers GETGet phone number DELRelease phone number POSTPurchase phone number GETResolve a number claim GETList offerable number countries GETSearch available numbers GETGet KYC form spec POSTSubmit KYC GETView a KYC document on file POSTUpload a KYC document POSTPre-validate KYC address POSTCreate a hosted KYC link GETList port-in orders POSTPort numbers in POSTCheck portability GETResolve a port claim POSTUpload a porting document GETCountry porting requirements GETA port-in order's pending requirements DELCancel a port-in POSTPre-review a KYC packet GETGet declined requirements POSTResubmit a declined number POSTReply to the regulatory reviewer POSTRespond to the regulatory reviewer (message + corrections)GETList stock watches POSTWatch an out-of-stock country DELStop watching a country POSTRequest the WhatsApp verification code for a number