Skip to main content
GET
Check whether a number is on WhatsApp

Authorizations

userSecurityToken
string
query
required

Your account security token, sent as the userSecurityToken query or form parameter.

Query Parameters

phone
string
required

Phone number; normalized to E.164 server-side.

Response

Check result

success
boolean
exists
boolean
reason
enum<string> | null
Available options:
invalid_format,
not_on_whatsapp
name
string | null
profile_picture_url
string | null
verification_unavailable
boolean | null
auth_failure
boolean | null

Present alongside verification_unavailable when the check failed due to provider authentication.

message
string | null