Skip to main content
POST
Look up numbers

Authorizations

X-Auth-ID
string
header
required

Your Vobiz account Auth ID (MA_XXXXXXXX).

X-Auth-Token
string
header
required

Your Vobiz account Auth Token.

Path Parameters

auth_id
string
required

Your account Auth ID. It must match the X-Auth-ID header.

Example:

"MA_XXXXXXXX"

Body

application/json

Numbers to check against the mobile network.

numbers
string[]
required

Numbers to check, in E.164 format (+14155550123) or national format read with defaultCountry. At most 100 per request. A missing or empty array returns 400 with numbers is required; more than 100 returns 422 with too many numbers: at most 100 per request. Duplicates (the same E.164 number, or the same invalid text) are checked once.

Required array length: 1 - 100 elements
Example:
defaultCountry
enum<string>
default:US

ISO 3166-1 alpha-2 country code, matched case-insensitively, used to read numbers written without a + country code. Defaults to US. A code outside the list returns 422 with unsupported defaultCountry.

Available options:
US,
CA,
GB,
IN,
AU,
NZ,
IE,
DE,
FR,
ES,
IT,
NL,
BE,
CH,
AT,
SE,
NO,
DK,
FI,
PL,
PT,
BR,
MX,
AR,
CO,
CL,
SG,
MY,
ID,
PH,
TH,
VN,
JP,
KR,
CN,
HK,
AE,
SA,
QA,
IL,
TR,
ZA,
NG,
KE,
EG,
PK,
BD,
LK,
NP
fresh
boolean
default:false

true skips the cache and asks the network again. By default a result for the same number from the last 24 hours is reused and returned with cached: true.

Response

One result per distinct input.

One result per distinct input, in the order you sent them.

results
object[]