Skip to main content
GET
/
api
/
instances
/
{instanceId}
/
contacts
/
check
/
{phone}
Check if a phone number exists on WhatsApp
curl --request GET \
  --url https://api.wappfy.io/api/instances/{instanceId}/contacts/check/{phone} \
  --header 'Authorization: Bearer <token>'
{
  "numberExists": true,
  "chatId": "[email protected]"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
instanceId
string<uuid>
required

The WhatsApp instance UUID

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
phone
string
required

Phone number (e.g., 5511999999999)

Response

Number check result

​
numberExists
boolean
required

Whether the phone number is registered on WhatsApp

Example:

true

​
chatId
string

Chat ID if number exists

Example:

"[email protected]"