Cancel a monitor

post

https://api.wingspan.app/v3/onboarding/identity-verification-monitors/{monitorId}/cancel

Terminal transition — the monitor moves to Cancelled and stops producing alerts permanently. A new monitor (with the same subject.type, subject.id, and tier) can be created afterwards.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

monitorId

string

required

Unique identifier of an identity verification monitor

Headers

Idempotency-Key

string

length between 1 and 255

^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

If-Match

string

Strong ETag from a prior GET or write response. Mismatch returns 412 Precondition Failed. Pass * to accept any current state.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Monitor cancelled

401Unauthenticated

403Forbidden

404Resource not found

409Conflict

412Optimistic-concurrency precondition failed (If-Match mismatch)

501This operation is not yet available