Pause continuous monitoring for an identity

Pauses continuous AML monitoring on this person. Monitoring is a person-level state — pause/resume operates on the identity, not on individual screening checks. Sets `monitoring_paused_reason='manual'` and calls the underlying provider's disable_monitoring on the stored search ID. Manual pauses are preserved across archive/restore cycles — restoring an archived identity does NOT re-enable monitoring that was manually paused beforehand. To bulk-disable monitoring across many identities, archive them instead. The archive cascade pauses monitoring with `reason='archived'` so a later restore re-enables it automatically.

Authentication

X-API-Keystring

Organization API key. Keys are prefixed with vk_live_ (production) or vk_sandbox_ (sandbox).

Path parameters

identity_idstringRequired

Identity ID (idn_*) or external reference.

Headers

Verifa-VersiondateOptional

API version date string (e.g. 2026-02-01). If omitted, the version pinned to your API key is used.

Idempotency-KeystringOptional<=255 characters

Unique key for idempotent requests. Cached for 24 hours. Sending the same key with different parameters returns 422.

Response

Monitoring paused.
idstring
monitoring_enabledboolean

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error