Skip to navigation
Identity verification APIAddress

Restart a declined presence check

Starts a fresh presence check from scratch on the same pin, for a check declined with then: fail, with the declined check’s settings. Nothing the declined check gathered counts. An always-on arrangement carries on with its cadence. The new check is billed only on its own verdict. The workflow the decline failed stays decided; to decide a verification on the new check, send the verification back or start a new session. To keep the workflow waiting instead, decline with then: restart.

Fires entity.address_presence_started with startedVia: "restart". The call is recorded in your audit log.

Error codes

errorStatusMeaning
watch_not_found404The entity does not exist or has no presence check.
not_restartable409Only a declined check can be restarted.
another_check_running409Another check is already running for the entity.
stopped409The check was stopped.
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.

Response

Success
watchIdstring
The identifier of the presence check.
previousWatchIdstring
The declined check this one replaces.
restartedboolean
Always true.
deadlineAtdatetime
When the new check must decide by.

Errors

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