Skip to main content
Preview an explicit check selection

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Body

application/json
selection
object
required

Response

Exact scope, exclusions and confirmation fingerprint.

options
object
required

What each check mode would run in this scope, whichever mode is selected.

fingerprint
string
required
sample_invoice_ids
string<uuid>[] | null
required
agreements
object[]
required
invoice_count
integer
required
check_count
integer
required
exceeds_limit
boolean
required
maximum_checks
integer
required
maximum_runs
integer
required
exclusions
object[]
required
deletable_alert_count
integer
required
kept_alert_count
integer
required
kept_user_alert_count
integer
required
cancelled_check_count
integer
required
other_topic_alert_count
integer
required