Skip to main content
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
phone-exists
Number on WhatsApp?
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/phone-exists \
  --header 'Client-Token: <api-key>'
{
  "exists": true,
  "phone": "<string>",
  "lid": "<string>"
}

​
Overview

This method returns whether a number has WhatsApp or not.
Use this API whenever you want to check if a number has WhatsApp, usually for form validation. Do not use this API if you want to verify before sending a message, as Z-API already validates the number’s existence for each message sent.

​
Attributes

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Query Parameters

​
phone
string
required
Contact phone number in DDI DDD NUMBER format. E.g.: 551199999999

​
Response

​
200

​
exists
boolean
Whether the number has WhatsApp
​
phone
string
Formatted number per WhatsApp’s response
​
lid
string
WhatsApp’s unique private identifier (null if exists = false)
[
  {
    "exists": true,
    "phone": "5544999999999",
    "lid": "999999999@lid"
  }
]

​
405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

​
415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.