· 3 min read
WhatsApp Bulk Number Checker Details API
Check if a global phone number is on WhatsApp and get detailed profile information including signatures and status updates.
Check if a global phone number is a registered WhatsApp account and get detailed profile information.
API URL
POST https://api.ekycpro.com/wa/api/detail/tasks
Main Features
The WhatsApp Bulk Number Checker Details API offers comprehensive verification capabilities:
Account Information
Detailed WhatsApp account information including:
- Account status verification
- User signatures
- Status update timestamps
Bulk Processing
Process multiple numbers simultaneously through file upload, making it efficient for large-scale verification.
Real-time Status Updates
Monitor the progress of your bulk verification tasks with real-time status updates.
Usage Steps
File Upload
Upload a text file containing phone numbers in E.164 format:
Request Example
curl --location 'https://api.ekycpro.com/wa/api/detail/tasks' \
--header 'X-API-Key: API-KEY' \
--form 'user_id="USER_ID"' \
--form 'file=@"input.txt"'
Request Parameters
Parameter | Description |
---|---|
user_id | string , User ID |
file | file , Upload file, each line should contain one phone number in E.164 format |
Status Checking
Monitor the processing status of your task:
curl --location 'https://api.ekycpro.com/wa/api/detail/tasks/{TASK_ID}?user_id=USER_ID' \
--header 'X-API-Key: API-KEY'
Response Examples
Task Creation Response
{
"created_at": "2024-10-19T18:24:56.450567423Z",
"updated_at": "2024-10-19T18:24:56.450567423Z",
"task_id": "cs9viu7i61pkfs4oavvg",
"user_id": "test",
"status": "pending",
"total": 0,
"success": 0,
"failure": 0
}
Processing Status Response
{
"created_at": "2024-10-19T18:24:56.450567423Z",
"updated_at": "2024-10-19T18:33:22.86152082Z",
"task_id": "cs9viu7i61pkfs4oavvg",
"user_id": "test",
"status": "processing",
"total": 20000,
"success": 6724,
"failure": 0
}
Completed Task Response
{
"created_at": "2024-10-19T18:24:56.450567423Z",
"updated_at": "2024-10-19T18:53:43.141760071Z",
"task_id": "cs9viu7i61pkfs4oavvg",
"user_id": "test",
"status": "exported",
"total": 20000,
"success": 20000,
"failure": 0,
"result_url": "https://example-link-to-results.xlsx"
}
Result Fields
Field | Description | Example |
---|---|---|
Number | Phone number in E.164 format | +41798284651 |
signature | Signature of WhatsApp status | ”Hey there! I am using WhatsApp” |
status_update | Last status update time | 2025-01-19 |
whatsapp | Whether number has active WhatsApp account | yes, no |
API Response Format
Field | Description |
---|---|
created_at | Timestamp when task was created |
updated_at | Timestamp of last task status update |
task_id | Unique task identifier |
user_id | ID of user |
status | Task status: pending/processing/completed/exported |
total | Total phone numbers processed |
success | Numbers successfully identified |
failure | Numbers that failed processing |
result_url | (Optional) Download URL for results when status is exported |
Status Codes
Status | Description |
---|---|
200 | charge , Request successful, task created or status retrieved |
400 | free , Bad request, invalid parameters or file format |
500 | free , Internal server error, retry later |
Integration Notes
Each line in the input file should contain one phone number in E.164 format.
Monitor task status using the provided task_id.
Download results from the result_url when status is “exported”.
Handle different status codes appropriately in your application.
FAQ
1. What is the processing capacity of the API?
The API can handle large batches of numbers efficiently, with real-time status updates on processing progress.
2. What format should the input file be in?
The input file should be a text file with one phone number per line in E.164 format (e.g., +41798284651).
3. What information does the API return?
The API returns detailed account information including:
- WhatsApp account status
- User signature (e.g., “Hey there! I am using WhatsApp”)
- Last status update timestamp
4. What is the pricing for the API?
The price is $2 USD per 10,000 numbers for detailed WhatsApp account information including status updates and signatures.
For more information about pricing and higher volume processing, please contact us.