Skip to main content
POST
/
users
/
check
Bulk check phone numbers on WhatsApp
curl --request POST \
  --url https://api.wsapi.chat/users/check \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Instance-Id: <x-instance-id>' \
  --data '
{
  "phones": [
    "1234567890",
    "9876543210"
  ]
}
'
[
  {
    "query": "<string>",
    "isInWhatsApp": true,
    "jid": "<string>"
  }
]

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

Body

application/json
​
phones
string[]
required

List of phone numbers to check

Minimum array length: 1

Response

Bulk check results

​
query
string

The phone number that was queried

​
isInWhatsApp
boolean

Whether the phone number is registered on WhatsApp

​
jid
string

JID of the user (only present if registered)