Skip to content

One workflow, in the dashboard and the API

Try checks in the dashboard, then connect your server to the same single and bulk checks through the API.

Start with a single check

Send requests to https://api.numdetect.com with an API key kept on your server. You can create several keys in the dashboard, one per system, and delete any of them. Do not put a key into frontend code.

cURL
curl "https://api.numdetect.com/api/v1/checks" \
  -H "Authorization: Bearer $NUMDETECT_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "phone": "+12025550147",
  "products": [
    "whatsapp"
  ]
}'

Illustrative request with a sample number. Replace $NUMDETECT_API_KEY with your key; each run is a real, charged check.

What a check returns

Every input gets one entry per product. Read registered first: true and false are conclusive, null is unknown. A single check charges only true and false; a bulk group is charged in full once its batch completes.

200 OK
{
  "id": "10000000-0000-4000-8000-000000000001",
  "input_kind": "phone",
  "input": "+12025550147",
  "country": "US",
  "charged": 4000,
  "results": [
    {
      "product_id": "whatsapp",
      "status": "success",
      "result": true,
      "price": 4000,
      "charged": 4000
    }
  ]
}
status
success: a definite answer; unknown: no conclusive answer; failed: the product could not be reached. Only success is charged.
result
true: an account was found; false: no account; null when status is not success.
info
Extra fields some products return, such as the WhatsApp Business signal.
price
This product's price for the check, in USD micros (1,000,000 = $1).
charged
What was actually charged: the price for a definite answer, otherwise 0.

01

Explore in the dashboard

Run a few single checks in the dashboard to see the inputs and answers before writing your integration.

02

Read the current catalogue

Fetch the product list to see which products are on sale, their input types, countries and prices. Do not hard-code them from the public website.

03

Create and follow a task

Send an Idempotency-Key when creating a check or a bulk job. If a response is lost, retry with the same key instead of a new one.

Bulk phone workflow

  1. 1

    Upload the CSV or text file with the products, the number column and the most you accept to pay.

  2. 2

    The list is split by country; each country is checked by each product you chose.

  3. 3

    Follow the job until it finishes, or receive a webhook.

  4. 4

    Download one result file with every original row and one answer column per product.

Keep keys on your server

  • Up to 10 Bearer API keys per account, each deletable at any time.
  • A signed webhook is sent when a bulk job finishes.
  • Result files are downloaded through a link valid for 10 minutes.

Use environment variables for credentials, and delete a key in the dashboard if it is exposed. Include check or job IDs when asking for support; never paste API keys into screenshots or public examples.

Ready to check your numbers?

Start right after sign-up, no approval needed. Top up your balance, then check real numbers.

Sign up free and start ↗