Skip to content

Telegram Username API: Profile and Account Status

Check Telegram usernames and return profile, activity, VIP, and frozen-status fields in bulk.. The task uses the standard asynchronous batch workflow.

Input format

Upload a text file with one usernames per line. Normalize values before upload; for phone numbers, E.164 format is recommended.

@example_user
@another_user

Create a task

POST https://api.checknumber.ai/v1/tasks

Terminal window
curl --location 'https://api.checknumber.ai/v1/tasks' \
--header 'X-API-Key: YOUR_API_KEY' \
--form 'file=@"./input.txt"' \
--form 'task_type="tg_username_full"'

The API returns a task ID. Keep this ID and use it to poll the task status.

Upload response

{
"task_id": "d4g8o46p2jvh04o9uolg",
"status": "pending",
"total": 5000,
"estimated_amount": {
"amount": "0.500000",
"currency": "USD"
},
"message": "Task created successfully"
}

Check task status

POST https://api.checknumber.ai/v1/gettasks

Terminal window
curl --location 'https://api.checknumber.ai/v1/gettasks' \
--header 'X-API-Key: YOUR_API_KEY' \
--form 'task_id="d4g8o46p2jvh04o9uolg"'

Poll until status becomes exported. Do not treat pending or processing as a completed result.

Processing response

{
"task_id": "d4g8o46p2jvh04o9uolg",
"status": "processing",
"total": 5000,
"success": 2500,
"failure": 0
}

Exported response

{
"task_id": "d4g8o46p2jvh04o9uolg",
"status": "exported",
"total": 5000,
"success": 5000,
"failure": 0,
"result_url": "https://example-link-to-results.zip",
"actual_amount": {
"amount": "2.000000",
"currency": "USD"
}
}

Result Fields

FieldDescriptionExample
usernameInput username from the submitted file.example_user
activatedWhether the input was detected as active or registered.yes
nicknameReturned result field: nickname.sample value
avatarReturned result field: avatar.sample value
genderReturned result field: gender.sample value
ageReturned result field: age.sample value
skin_colorReturned result field: skin_color.sample value
user_idReturned result field: user_id.sample value
active_daysReturned result field: active_days.sample value
is_vipReturned result field: is_vip.sample value
is_frozenReturned result field: is_frozen.sample value

Note: Verified against live sample; full profile, activity, VIP, and frozen fields are now confirmed.

Result file handling

Download the file from result_url only after the task is exported. Preserve the returned column names when processing the file downstream.

Response fields

FieldDescription
created_atTimestamp when the task was created.
updated_atTimestamp of the latest task status update.
task_idUnique task identifier.
statuspending, processing, exported, or failed.
totalTotal input values processed.
successValues processed successfully.
failureValues that failed processing.
result_urlDownload URL when the task is exported.
actual_amountFinal settled amount, when available.
estimated_amountEstimated amount returned when the task is created.

Status codes

StatusDescription
200Request successful.
202Task created successfully and estimated charge applied.
400Invalid file, unsupported task type, or too few valid entries.
401Missing or invalid API key.
402Insufficient account balance.
404Task not found.
413Uploaded file is too large.
500Internal server error; retry later.

Operational notes

  • The task is asynchronous; use the task ID for status polling.
  • Check product-specific input limits before uploading.
  • Failed rows are reported in the exported result and reflected in the task counters.
  • The fields above are based on the current live sample and may change when the upstream export schema changes.