Skip to navigation
Identity verification APIAddress

Switch always-on address monitoring on or off

On turns the presence check of the entity into a chain that repeats on the chosen cadence, starting a check from the captured pin when none is running. Off stops the chain renewing; a check already in progress still runs to its result.

The call is idempotent: switching on what is already on returns the same check with minted: false, and switching off with nothing renewing returns stopped: 0.

Always-on monitoring is billed per entity per year of cover at the rate for the cadence, in production only; the first check is billed when it resolves. The call is recorded in your audit log.

Error codes

errorStatusMeaning
invalid_request400The body failed validation. details carries the field-level breakdown.
entity_not_found404No live entity has this reference in this organisation and environment.
no_address_pin422Monitoring was switched on but the entity has no captured address pin and no check to continue.
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.
enabledbooleanRequired

True to start or continue always-on monitoring, false to stop it renewing.

cadenceDaysintegerOptional

Days between checks. Any value is snapped to the nearest of 30, 60, 90, 180 and 365; the default is 90.

Response

Success
AlwaysOnEnabledobject
OR
AlwaysOnDisabledobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
503
Service Unavailable Error