WhatsApp Deep Detection

Check the details of the WhatsApp of the input global number, whether it is whatsapp account, the profile picture URL, gender, and age. as well as the type of profile picture.

Upload Detection File Code example:

curl --location 'https://api.ekycpro.com/api/tasks' \
--header 'X-API-Key: API-KEY' \
--form 'user_id="USER_ID"' \
--form 'file=@"input.txt"'

Check Task Status Code example:

curl --location 'https://api.ekycpro.com/api/tasks/s4oR_IDoee0?userUSER_ID' \
--header 'X-API-Key: API-KEY'

Response for the upload detection file successful

{
    "created_at": "2024-10-19T18:24:56.450567423Z",
    "updated_at": "2024-10-19T18:24:56.450567423Z",
    "task_id": "cs9viu7i61pkfs4oavvg",
    "user_id": "test1",
    "status": "pending",
    "total": 0,
    "success": 0,
    "failure": 0
}

Response for the processing status

{
    "created_at": "2024-10-19T18:24:56.450567423Z",
    "updated_at": "2024-10-19T18:33:22.86152082Z",
    "task_id": "cs9viu7i61pkfs4oavvg",
    "user_id": "test1",
    "status": "processing",
    "total": 20000,
    "success": 6724,
    "failure": 0
}

Provide a response indicating the task is completed and include the download URL for the results.

{
    "created_at": "2024-10-19T18:24:56.450567423Z",
    "updated_at": "2024-10-19T18:53:43.141760071Z",
    "task_id": "cs9viu7i61pkfs4oavvg",
    "user_id": "test1",
    "status": "exported",
    "total": 20000,
    "success": 20010,
    "failure": 0,
    "result_url": "https://example-link-to-results.xlsx"
}

Upload file request url

POST https://api.ekycpro.com/api/tasks

Check task status request url

POST https://api.ekycpro.com/api/tasks/{TASK_ID}

Request parameters

parameter	description
user_id	string, user id defile by yourself
file	file, upload file, each line in the uploaded file should contain one phone number, and the numbers must be in E.164 format.

Response format

Response Format

Field	Description
created_at	Timestamp indicating when the task was created.
updated_at	Timestamp of the last update to the task status.
task_id	Unique identifier for the task.
user_id	The ID of the user who initiated the task.
status	Current status of the task. Possible values are: pending: Task is queued and waiting to be processed. processing: Task is currently being processed. completed: Task processing is finished. exported: Task results have been processed and are available for download.
total	Total number of phone numbers processed in the task.
success	Number of phone numbers successfully identified with WhatsApp attributes.
failure	Number of phone numbers that could not be identified or processed.
result_url	(Optional) URL to download the task results, provided when the task status is exported.

Status code

status	description
200	charge, Request was successful, task created or task status retrieved successfully.
400	free, Bad request, usually due to incorrect parameters or file format.
500	free, Internal server error, retry the request after some time.