WhatsApp Bulk eKYCPro Avatar (Age and Gender) API: Profile Analysis & Demographics

Check the avatar information of the WhatsApp of the input global number, whether it is whatsapp account, the profile picture URL, gender, age, hair color, skin color. as well as the type of profile picture.

Пример загрузки файла:

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

Пример проверки статуса задачи:

curl --location 'https://api.ekycpro.com/wa/api/deep/tasks/cs9viu7i61pkfs4oavvg' \
--header 'X-API-Key: API-KEY'

Ответ при успешной загрузке файла:

{
  "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
}

Ответ для статуса обработки:

{
  "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
}

Ответ при завершении задачи (включает URL скачивания результата):

{
  "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"
}

URL запроса загрузки файла

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

Параметры запроса загрузки файла

Параметр	Описание
user_id	string, User ID
file	file, Загрузите файл; каждая строка должна содержать номер в формате E.164

URL запроса проверки статуса

GET https://api.ekycpro.com/wa/api/deep/tasks/{TASK_ID}

Параметры запроса проверки статуса

Параметр	Описание
user_id	string, User ID

Поля результата

Поле	Описание	Пример
Number	Phone number in E.164 format	+41798284651
age	Estimated age range based on profile picture	25
avatar	URL of WhatsApp profile picture	https://example.com/avatar.jpg
category	Type classification of profile picture	individual portrait, pet avatar, object, etc.
gender	Gender detected from profile picture	male, female
hair_color	Hair color detected from profile picture	black, brown, blonde, etc.
skin_color	Ethnicity/race detected from profile picture	white, black, etc.
whatsapp	Whether number has active WhatsApp account	yes, no

Формат ответа

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: Queued and waiting processing: Currently processing completed: Processing finished exported: Results available for download
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

Коды статуса

Статус	Описание
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