Workflow Overview
Bulk detection runs asynchronously: you submit numbers, receive a token, poll for progress, then download the result file.
Endpoints at a Glance
Section titled “Endpoints at a Glance”| Endpoint | Method | Purpose |
|---|---|---|
/v1/balance | GET | Check your current balance |
/v1/detect | POST | Submit a JSON array of phone numbers or email addresses |
/v1/detect/file | POST | Submit a TXT/CSV file upload |
/v1/tasks/{token} | GET | Poll task status |
/v1/tasks/{token}/result | GET | Get the result download URL |
/v1/tasks/{token}/download | GET | Download the result file itself |
Both submission endpoints return HTTP 202 Accepted — the work outlives the request.
Before You Submit
Section titled “Before You Submit”- Volume: at least the selected product’s minimum (500, 1,000 or 2,000 depending on the product — see the bulk product list) and at most 2,000,000 rows.
- Number format: include the international country code, e.g.
+8613800138000. - Country: pass the ISO 3166-1 alpha-2 code (for example
CNorUS) for phone products, and omit it entirely for email products.