Skip to content

Sideline CheckNumber API: Bulk Phone Verification

Check whether phone numbers are registered on Sideline using the batch task API.. The task uses the standard asynchronous batch workflow.

Input format

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

+14155552671
+442071838750

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="sideline"'

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
NumberInput phone number from the submitted file.+14155552671
activatedWhether the input was detected as active or registered.yes

Note: Confirmed from the current product sample; fields are Number and activated.

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.