Skip to main content
GET
/
users
/
{phone}
/
check
Check if a phone number is on WhatsApp
curl --request GET \
  --url https://api.wsapi.chat/users/{phone}/check \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Instance-Id: <x-instance-id>'
{
  "isInWhatsApp": true
}

Authorizations

​
X-Api-Key
string
header
required

Instance or customer-level API key. Either the instance's own API key or the customer's API key is accepted. Must be paired with the X-Instance-Id header to identify the target instance.

Headers

​
X-Instance-Id
string
default:{{instanceId}}
required

The ID of the WhatsApp instance to use

Path Parameters

​
phone
string
required

Phone number (e.g. 1234567890)

Pattern: ^\+?\d{7,15}$

Response

WhatsApp presence check result

​
isInWhatsApp
boolean