Skip to content

Glossary

Terms are defined as the API uses them. Where a word also has a looser everyday meaning, the API’s meaning is the one that applies.

TermMeaning
identifierThe single thing a realtime check is about: one phone number or one email address. A bulk submission carries a list of them.
seriesWhether an identifier is a phone or an email. Products, endpoints and requests are all series-specific, and a request may only mix series in the sense that it must not mix them at all.
productOne detection target — a platform, plus the kind of check performed against it. “WhatsApp Number Checker” and “WhatsApp Activity Details” are two different products, even though both concern WhatsApp.
realtime productA product used through the synchronous endpoints. Addressed by its numeric ID.
bulk productA product used through the asynchronous endpoints. Addressed by its slug.
IDThe integer that identifies a realtime product, printed as #47 in the catalog. IDs are what product_ids takes.
slugThe string that identifies a bulk product, for example waValid. Slugs are what the product field takes.
moderealtime or async. A product belongs to exactly one, and the mode decides which endpoints accept it.
TermMeaning
registeredWhat detection actually answers: is this identifier registered on this platform? It is not a statement about whether the number or address is syntactically valid, reachable, or in service.
validConfirmed registered. Charged.
invalidConfirmed not registered. Charged — a negative answer is still an answer.
unknownThe provider could not resolve it. Not charged; refunded.
cachedThe verdict was served from a stored fact rather than by asking a supplier. A cache hit is still charged.
comboOne realtime request, one identifier, and the one-to-ten products it was checked against. A combo can partly succeed — see partial_succeeded.
TermMeaning
reserveTake the amount up front before the work runs. Every submission is reserved against the account balance.
settleDecide an individual item’s final charge once its verdict is known.
refundReturn the reserved amount for an item that produced no usable verdict.
billing_statusPer-item field: charged or refunded. Read this rather than inferring from the HTTP status.
total_reservedReserved before the work ran. Always equals total_charged + total_refunded.
charged_amountNet charge. refunded_amount is the net refund.
TermMeaning
request_idUUID identifying one realtime submission. Quote it in support requests.
task_idThe token identifying one bulk submission, returned on submit. Also the {token} path parameter of the task endpoints — one value, two names in the documentation.
Idempotency-KeyA caller-supplied header, required on realtime calls, that makes a retry safe: the same key with the same body returns the stored result instead of charging again.
replayedThe response came from a stored result rather than fresh work. replayed on a realtime response, idempotent_replay on a bulk submission. A replay never moves money.
recovery_pendingThe bulk task is queued, but its accounting is still being reconciled.
TermMeaning
submittedRows you sent.
prefilteredRows dropped before detection — malformed lines, for example.
dedupedDuplicate rows removed.
totalRows actually checked: submitted minus prefiltered minus deduped.
processedRows the upstream channel has finished so far.
unknown_unprocessedRows that never resolved. These are the ones refunded.
TermMeaning
per-key limitThe budget attached to your API key. This is the one to plan against.
per-IP limitA coarser ceiling shared by every key behind one address. Not an access control.
retentionHow long a record survives. Realtime logs and replay results: 30 days. Bulk result files: 7 days.
  • Response format — the envelope, and how money and timestamps are encoded
  • Error codes — the same vocabulary applied to failures