Get an insurance monitor

get

https://api.wingspan.app/v3/compliance/insurance-monitors/{monitorId}

Retrieve a single InsuranceMonitor by ID, including its current compliance status and the per-policy validation results in jobs.

Readable by EITHER party — the payer running the monitor and the payee whose coverage it watches. Anyone else gets 404.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

monitorId

string

required

Unique identifier of an identity verification monitor

Query Params

expand

array of strings, unique

Inline related resources on a single InsuranceMonitor read. Supported values are Configuration — the coverage requirements this monitor validates against — and Coverage, the linked InsuranceCoverage. Unsupported values return 422 instead of being silently ignored. Expansions are not available on list/search rows.

Either value is safe to request unconditionally: a monitor with no linked coverage simply comes back with the coverage key absent. A supported value that resolves nothing is a 200 with the key omitted; only an unsupported value is a 422.

Headers

X-Wingspan-Account

string

^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

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

200Insurance monitor details

401Unauthenticated

403Forbidden

404Resource not found

422Validation error