Skip to navigation
Identity verification APIAddress

Stop presence monitoring

Stops the presence check that is currently running for the entity and cancels any always-on renewal that is scheduled. A stopped check never resolves, so it is not billed as a check. The body is optional and may carry a reason.

The call is idempotent: with nothing running it succeeds and returns revoked: false with an empty watches list. The call is recorded in your audit log.

Error codes

errorStatusMeaning
entity_not_found404No live entity has this reference in this organisation and environment.
secret_key_required403A publishable key was used. This API accepts secret keys only.
environment_mismatch403The key belongs to an environment this host does not serve.
rate_limited429The request rate limit for this key was reached. Retry after a short wait.
rate_limit_store_unavailable503Rate limiting is temporarily unavailable. Retry shortly.

A missing or unknown key returns 401 with a plain sentence in error rather than a code.

Requires a secret (sk_) key. A publishable key receives 403 secret_key_required.

Authentication

AuthorizationBearer
Send the API key as a Bearer token. Each operation states whether a publishable key is enough or a secret key is required.

Path parameters

externalUserIdstringRequired
Your own stable reference for the person or business, as sent when the entity was registered.

Request

This endpoint expects an object.
reasonstringOptional
Why monitoring is being stopped. Kept with the record, trimmed to 500 characters, and never sent to webhooks.

Response

Success
revokedboolean
True when something was stopped, false when nothing was running.
watcheslist of objects
One entry per check or renewal that was stopped. Empty when nothing was running.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
503
Service Unavailable Error