Skip to main content
POST
Check whether numbers are on WhatsApp

Authorizations

Authorization
string
header
required

The access_token returned by POST /oauth2/token, sent as Authorization: Bearer <access_token>. It is an opaque string, not a JWT.

Body

application/json
phones
string[]
required

Phone numbers to check, any country. International form is best; the spellings accepted by phone screening also work. Duplicates are checked once.

Required array length: 1 - 50 elements
fresh
boolean
default:false

Ask again for every number instead of using a stored answer. Each new answer is billed to Provident, so use it sparingly.

Response

One answer per number sent, in the order sent

data
object[]
required

One row per number sent, in the order sent.

meta
object
required