API reference

Self-service signup — no email required. Receive an account plus a freshly minted key (format nol_…), returned exactly once and stored only as a hash, so save it (the key + account UUID is your identity, and there is no recovery path). Optionally pass an email for subscription renewal reminders. New accounts start on the free tier with a zero balance; add credit with /api/v1/account/topup to use billed endpoints. No key required (rate-limited to 3/hour per IP).

curl -X POST https://numbers.online/api/v1/account/signup \
  -H "Content-Type: application/json" \
  -d '{}'

Returns the authenticated account: prepaid balance (microdollars), trailing-30-day usage, your keys (display fields only, never the raw key), and any MSP tenants. Use it to monitor spend and decide when to top up.

curl https://numbers.online/api/v1/account \
  -H "X-API-Key: YOUR_API_KEY"

Create a Stripe Checkout session to add prepaid credit. Amount is in US cents: $5 minimum (500) to $500 (50000) per checkout; credit applies when Stripe confirms payment. Standard-tier billed endpoints return 402 when the balance is exhausted. Top up to resume.

curl -X POST https://numbers.online/api/v1/account/topup \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{"amount_cents": 2000}'

Step 1 of binding a business number to your account: send a one-time code by voice (default) or sms to a number your account controls. Account-level keys only. A verified business number is what raises your pooled rate limits (+60/min, +2,000/day lookups, +100/day reports), unlocks the accountable report lane, and enables pre-call enrollment. Returns 429 with Retry-After on cooldown/velocity.

curl -X POST https://numbers.online/api/v1/account/verify-phone/start \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{"phone": "+14155550142", "channel": "voice"}'

Step 2: submit the code to verify and bind the number to your account. Free accounts may bind exactly one number (402 if you already have one and none is paid); a number already claimed by another account returns 409 (the Sybil floor). On success the number counts toward your pooled limits and can be enrolled for call-provenance.

curl -X POST https://numbers.online/api/v1/account/verify-phone/confirm \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{"phone": "+14155550142", "code": "123456"}'

Parse and validate a single number, returning format variants, country, line type, carrier and validity. (/api/parse remains as a frozen legacy alias with a {success:} envelope.)

curl -X POST https://numbers.online/api/v1/parse \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{"phoneNumber": "+14155552671"}'

Parse up to 100 numbers in one request. Returns a result per number plus a summary. (/api/parse/bulk remains as a frozen legacy alias with a {success:} envelope.)

curl -X POST https://numbers.online/api/v1/parse/batch \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{"phoneNumbers": ["+14155552671", "+442071234567"]}'

All supported countries with calling codes and example numbers. (/api/countries remains as a frozen legacy alias with a {success:} envelope.)

curl https://numbers.online/api/v1/countries \
  -H "X-API-Key: YOUR_API_KEY"

Single-number lookup: validity, formats, line type, range carrier (a supplementary signal, not porting-aware), country, CNAM, normalized STIR/SHAKEN verstat, and a low-confidence supplementary spam signal. Invalid numbers return 200 with valid:false and are not billed. Billed per dip: $0.004 with a fresh CNAM dip, $0.002 when served from cache or without a CNAM supplier; free tier is unbilled (rate-limited). Optional ?verstat= and ?max_cache_age= query params; Idempotency-Key header for at-most-once billing.

curl https://numbers.online/api/v1/lookup/+14155552671 \
  -H "X-API-Key: YOUR_API_KEY"

Bulk lookup for list processing: submit up to 100 numbers and receive the same shape as the single lookup per number (in input order) plus a billing summary. This is a list-processing surface, not a call-path surface. Large batches dip suppliers with bounded concurrency and can take seconds. Billed per valid number ($0.004 fresh CNAM dip / $0.002 otherwise); invalid numbers are free. Optional verstat / max_cache_age; Idempotency-Key header for at-most-once billing.

curl -X POST https://numbers.online/api/v1/lookup/batch \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{"numbers": ["+14155552671", "+442071234567"]}'

Caller-name (CNAM) lookup that ALWAYS returns text/plain so a PBX can paste the body verbatim as the caller name. Built for FreeSWITCH mod_cidlookup and similar header-less clients. The body is the resolved name (ACME CORP), the name prefixed with an operator-chosen tag when a spam_tag is set and the signal crosses spam_threshold (Spam? ACME CORP), or the literal UNAVAILABLE sentinel. Like the other header-less integration endpoints (SBC redirect, Retell, Vapi), it also accepts the key as a ?key= query param (use a dedicated, rotated key). Optional ?country, ?spam_tag, ?spam_threshold, ?max_cache_age. Billed like /api/v1/lookup, and fail-open: a slow or failing supplier yields UNAVAILABLE, never an error on the call path. See the integrations page.

curl "https://numbers.online/api/v1/cid/12025550123?key=YOUR_API_KEY"

Call right before you dial. Returns a first-party do-not-contact preference scrub on the destination `to` number (the verified owner’s own preference held by us, not the government/licensed do-not-call registry), one of SUPPRESS (a verified owner asked not to be marketed to), NO_MATCH (no suppression on record, NOT a consent grant), or UNKNOWN, plus a separate supplementary government/licensed compliance signal. When the `from` is one of your own enrolled, OTP-verified business numbers, a hashed (from→to) call-provenance edge is recorded for 7 days; at report time it lets us attribute calls you actually placed and shield your number from reports about calls you did not (likely spoofing). Free/bundled, not metered. Account-pooled on its own pre-call budget. Requires a key with the precall use case. context is outbound_voice | outbound_sms and selects which suppression list is scrubbed (echoed back as dnc_channel). Fail-open. The original /api/v1/precall/lookup path stays a permanent alias of this endpoint.

curl -X POST https://numbers.online/api/v1/outbound/lookup \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{"from": "+14155550100", "to": "+14155552671", "context": "outbound_voice"}'

Owner-only control: enroll (or revoke) one of your own OTP-verified business numbers for call-provenance. Enrolling attests that the number only ever places calls after a Numbers Online pre-call check, so the absence of a recorded edge becomes meaningful evidence a reported call was not yours. Account-level keys only (a tenant sub-key returns 403); the number must be a verified number bound to your account (else 404). This is a supplementary signal, never a block or a verdict. The original /api/v1/precall/enroll path stays a permanent alias; the same toggle is also available resource-shaped at PATCH /api/v1/account/phones/{e164}.

curl -X POST https://numbers.online/api/v1/outbound/enroll \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{"number": "+14155550100", "enrolled": true}'

The verified business numbers bound to your account — the inventory verify-phone writes into — each with its call-provenance enrollment state (e164, verified_at, precall_enrolled, precall_enrolled_at). Account-level keys only. Deliberately no POST and no DELETE: numbers enter exclusively via the OTP bind and leave via the reassignment lifecycle. PATCH /api/v1/account/phones/{e164} with {"precall_enrolled": true|false} flips enrollment on a bound number (strict update; 404 if the number is not yours).

curl https://numbers.online/api/v1/account/phones \
  -H "X-API-Key: YOUR_API_KEY"

Report a number with one or more tags using a single-use `receipt_id` from a prior POST /api/v1/inbound/lookup on the same number. Tags only, no free-text body. The receipt is an anti-replay nonce and rate control, not proof a call happened. Accounts with a verified business number report in the accountable lane (reporter-weighted, earns credibility); free/personal accounts report in the crowd lane (a bounded, deferring, credibility-firewalled supplementary signal that cannot sink a verified number on its own). You cannot report a number bound to your own account. Daily report quota is pooled per account: 10/day free, +100/day per verified business number. Returns { ok, lane, report_id }; a stale/used/mismatched receipt returns 409, an over-quota request 429.

curl -X POST https://numbers.online/api/v1/report \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{"e164":"+14155552671","tags":["robocall"],"receipt_id":"nol_rec_…"}'

Call-setup decision for a SIP redirect server / SBC (Kamailio, OpenSIPS, dSIPRouter, Sansay, Oracle/Acme Packet, ProSBC), consumed by the operator-run shim recipe on the integrations page. Given the calling number it returns a ClearIP-compatible decision (allow / flag / redirect / block) plus the exact SIP code the shim maps to: 603 Decline, 302 redirect (you supply the Contact), or your allow code (503 default, or 404 route-advance). Optional verstat, spam_threshold, redirect_threshold, allow_code, block_reassigned, block_invalid; X-SBC-Budget-Ms header. Requires a key with the sbc_redirect use case (every lookup-entitled key has it). Billed $0.010 per decision on the standard tier; free tier rate-limited. A 603 block only ever follows a deterministic or authoritative fact; the low-confidence spam signal can only raise a flag/redirect. Fail-open: a timeout or error returns decision=allow. Supports opt-in operator HMAC signing (X-Operator-* headers).

curl -X POST https://numbers.online/api/v1/sbc/redirect \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{"number": "+14155552671"}'

Operator-grade HMAC request signing for the calling key. GET returns the key’s HKDF-derived signing secret (exposed only to the key holder, equivalent exposure to the key itself), the canonical scheme, and whether signing is currently required; the secret is never stored (re-derived on demand). POST /api/v1/account/signing {"enabled": true|false} toggles whether signed surfaces (e.g. /api/v1/sbc/redirect) require a valid X-Operator-Signature on this key. This management route is never itself signature-gated, so a key can always disable signing or re-fetch its secret.

curl https://numbers.online/api/v1/account/signing \
  -H "X-API-Key: YOUR_API_KEY"

A signed, PII-free, independently-verifiable record of the supplementary number-status checks this account performed over a window (aggregated from signed lookup receipts; numbers appear only as hashes). An operator can reference it in their OWN robocall-mitigation program documentation (47 CFR 64.6305). It is NOT an FCC certification and does not make anyone compliant; the operator signs their own attestation. Optional ?from / ?to (ISO 8601; window capped at 400 days). Account-level keys only. Verify each receipt signature, the bundle signature, and the Merkle root against /api/v1/publickey.

curl "https://numbers.online/api/v1/compliance/evidence?from=2025-06-01T00:00:00Z" \
  -H "X-API-Key: YOUR_API_KEY"

List the account’s tenants (downstream customers / sites), each with a trailing-30-day usage rollup and sub-key count. Only account-level keys may manage tenants; a tenant sub-key cannot.

curl https://numbers.online/api/v1/account/tenants \
  -H "X-API-Key: YOUR_API_KEY"

Create a tenant so per-customer usage, billing rollups, rate limits, and suppression lists are attributed separately while all spend draws on the one account balance. Read one tenant’s detail with GET /api/v1/account/tenants/{id}; enable/disable it with PATCH /api/v1/account/tenants/{id} {"status":"active"|"disabled"} (disabling also disables its sub-keys).

curl -X POST https://numbers.online/api/v1/account/tenants \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{"name": "Dental office"}'

Mint an API key scoped to one tenant. The sub-key inherits the account’s tier and bills against the account’s single prepaid balance; it can perform lookups only (a PBX credential, not an account credential, so it cannot manage tenants or top up). The raw key is returned exactly once.

curl -X POST https://numbers.online/api/v1/account/tenants/TENANT_ID/keys \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{"name": "Front desk PBX"}'

Add a number to a tenant’s suppression list (POST), list entries (GET, which returns labels + timestamps only; numbers are stored as SHA-256 hashes and never returned), or remove one (DELETE the same number). A suppressed number gets no enrichment (no CNAM dip, no spam score) and no charge when looked up through that tenant’s sub-keys.

curl -X POST https://numbers.online/api/v1/account/tenants/TENANT_ID/suppressions \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{"number": "+14155552671", "label": "front desk"}'

Fetch a signed, privacy-safe lookup receipt by its unguessable id. The id is the capability, so no API key is needed and the evidence can be shared with counsel. PII-free: the number appears only as number_hash = sha256(E.164). Verify response_signature over signed_payload with the Ed25519 key from /api/v1/publickey, then recompute sha256(your number) and match number_hash. A supplementary signal, not a compliance assertion.

curl https://numbers.online/api/v1/receipts/nol_rec_8sd91kfh20aJ

The Ed25519 public key (SPKI PEM) used to sign inbound-lookup responses and lookup receipts, so any verifier can check a signature without out-of-band key exchange. public_key_pem is null when no signing key is configured (responses ship "unsigned"). No key required.

curl https://numbers.online/api/v1/publickey

The flagship inbound endpoint: signed, privacy-safe caller intelligence for an inbound call/message event. It returns identity type, a 0-100 risk score (higher = worse), PII-free evidence signals, and a recommended action, with a signed receipt id. The receipt id is a single-use, anti-replay nonce you can later spend once via POST /api/v1/report to attach a community report to this number. It is not proof the call occurred. A verified individual returns only "Verified & online", never a name. Optional STIR/SHAKEN verstat / attestation folds into the score. Requires an API key with the inbound_lookup use case. Billed $0.004 per dip on the standard tier; free tier rate-limited. Known and unknown numbers return the same 200 shape (anti-enumeration).

curl -X POST https://numbers.online/api/v1/inbound/lookup \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{"number": "+14155551212", "context": "inbound_voice"}'

Model Context Protocol over Streamable HTTP (JSON-RPC 2.0). Stateless and read-only. Methods: initialize, ping, tools/list (public discovery) and tools/call (requires a key with the "mcp" use case). Five tools: phone_lookup, line_type, caller_risk, dnc_check, reassigned_check. dnc_check and reassigned_check return "unknown" (and are unbilled) until a licensed data partner is configured. Each billable call meters the bundled mcp_call rate ($0.015). All output is a supplementary, low-confidence signal, and the agent keeps every routing and dialing decision. GET returns 405 (response-only, no server-initiated SSE). Client configs and copy-paste system prompts are at /ai-agents.

curl -X POST https://numbers.online/api/v1/mcp \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{"jsonrpc": "2.0", "id": 1, "method": "tools/call",
       "params": {"name": "phone_lookup", "arguments": {"number": "+14155552671"}}}'

Adapter for Retell’s call_inbound webhook: resolves the inbound caller and returns dynamic_variables (caller_name, caller_line_type, caller_spam_score, caller_risk, caller_on_dnc, caller_reassigned, caller_signal) for the agent prompt, plus a receipt_id. It ALWAYS returns HTTP 200 with a (possibly empty) variables block (a non-2xx would keep the caller ringing), so auth failure or a supplier timeout degrade to neutral variables (fail-open). Authenticate via Authorization: Bearer or ?key= on the webhook URL.

curl -X POST "https://numbers.online/api/v1/integrations/retell/inbound?key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"event": "call_inbound",
       "call_inbound": {"from_number": "+14155552671", "to_number": "+14155550100"}}'

Adapter for a Vapi custom function tool (an alternative to pointing Vapi at /api/v1/mcp). Accepts Vapi’s tool-calls payload and returns the phone_lookup bundle as a JSON-stringified result per toolCallId, with a signed receipt id. Each call meters the bundled mcp_call rate. Fail-open: a bad argument or supplier hiccup yields a graceful result string. Authenticate via Authorization: Bearer or ?key=.

curl -X POST https://numbers.online/api/v1/integrations/vapi/tool \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{"message": {"type": "tool-calls",
       "toolCallList": [{"id": "call_1", "arguments": {"number": "+14155552671"}}]}}'

A consent-first do-not-contact preference scrub against verified owners’ own preferences held by us — not the government/licensed do-not-call registry, which you still check yourself. For each number, returns SUPPRESS (verified owner has a suppression preference, so remove it), NO_MATCH (no suppression preference on record), or UNKNOWN (not resolvable). Optional channel: voice (default) | sms | whatsapp. Up to 1,000 per request. Billed $0.001 per number on the standard tier; the free tier draws from an account-pooled allowance counted in numbers (1,000/min, 5,000/day floor; verified business numbers scale it). This is a compliance aid, not a legal determination. Requires an API key. (/api/scrub remains as a frozen legacy alias.)

curl -X POST https://numbers.online/api/v1/scrub \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{"numbers": ["+16285550177", "+12135559988"], "channel": "voice"}'