Skip to main content
GET
Check number availability for a ZIP code

Authorizations

Authorization
string
header
required

Bearer token obtained from POST /api/v1.1/auth/token.

Query Parameters

simId
string
required

SIM product name to check against — this selects which carrier is asked.

zipCode
string

A 5-digit US ZIP code. Omit to check nationwide availability.

Pattern: ^\d{5}$

Response

Availability answer.