Skip to content

Submit Numbers

POST/v1/detect

Submit an array of phone numbers or email addresses for detection. Processed asynchronously. Cost is pre-deducted; unchecked rows are automatically refunded.

Returns HTTP 202 Accepted.

FieldTypeRequiredDescription
productstringYesProduct slug. See the bulk product list.
countrystringRequired for phoneISO 3166-1 alpha-2 country code, for example CN or US — the full list is on the Country Codes page. Omit it for email products.
phonesarrayYesArray of phone numbers or email addresses from a single series.
{
"mode": "async",
"task_id": "xKj9aP3qLm7v",
"idempotent_replay": false,
"message": "Task queued. Poll GET /api/v1/tasks/xKj9aP3qLm7v for progress.",
"recovery_pending": false,
"summary": {
"total": 5000,
"cost_deducted": 0.500000
}
}
FieldTypeDescription
modestringAlways async for bulk submissions.
task_idstringToken you poll and download with. This is the {token} path parameter of the task endpoints.
idempotent_replaybooleantrue when the submission reused an earlier task instead of creating a new one.
recovery_pendingbooleantrue when the task is queued but its accounting is still being reconciled.
messagestringHuman-readable next step.
summary.totalintegerRows accepted.
summary.cost_deductednumberAmount pre-deducted for the submission.

Store task_id — it is the only handle you get on the work, and it is not recoverable from your numbers afterwards.