API REFERENCE · Monitoring

Pause, resume, change cadence or queue a check now using the current revision

Complete request parameters, body fields, response formats, examples, and errors for PATCH /monitoring/{id}.

Base URL: https://www.sanctionskit.com/api/v1. Documentation examples are saved and require no API key to read.

PATCH/monitoring/{id}Pause, resume, change cadence or queue a check now using the current revision

Authentication: Authorization: Bearer YOUR_API_KEY (required). Use a server-side key for the intended environment and scopes.

Required API key scope: monitors:write. Policy-backed monitors use their approved cadence. Resume and immediate retries revalidate current policy and coverage. runNow queues work and does not itself establish a completed result.

Request parameters

Path parameters: id
Query parameters: None.
Headers: Authorization (required), Idempotency-Key
JSON body fields: expectedRevision, status, intervalHours, runNow

Send JSON body fields as application/json, not as query parameters. Field definitions and nested properties follow below.

Headers, path and query parameters

idpathRequired

string

Opaque resource identifier owned by the authenticated organization.

Format: uuid.

Idempotency-KeyheaderRequired

string

Reuse for identical retries. Reuse with different input returns 409.

Pattern: ^[\w:.-]{8,128}$. Minimum length: 8. Maximum length: 128.

Request body

Required body. JSON properties belong in the request body, separately from headers and URL parameters.

JSON request body. Send Content-Type: application/json with UTF-8 encoding; fields marked required must be present. Omit optional fields unless needed. Null is accepted only where explicitly shown. Unknown properties are rejected for validated request objects. Duplicate keys and nesting beyond 32 levels are rejected. Maximum body size: 65,536 bytes (64 KiB).

application/jsonView MonitorControl schema

Request body fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Revision-guarded controls. In addition to expectedRevision, supply at least one of status, intervalHours or runNow.

expectedRevisionRequired

integer

Current revision from GET /monitoring. A stale value returns stale_revision; reload before applying your change.

Minimum: 1. Maximum: 9007199254740991.

statusConditional

string

Set paused to stop scheduled work or active to resume. Resume revalidates policy, coverage, counterparty and monitor allowance.

Values: "active", "paused".

intervalHoursConditional

6 or 24 or 168

Supported schedule interval in hours: 6, 24 or 168. Policy-backed monitors must keep their approved policy cadence.

intervalHours fields and rules

Allowed alternatives

6
Must equal 6.
24
Must equal 24.
168
Must equal 168.

runNowConditional

true

When true, queue a fresh check for an active monitor. Omit if not requested; false is not accepted. The response confirms queued control work, not a completed screening.

Must equal true.

Allowed alternatives

Provide status.
Provide intervalHours.
Provide runNow.

Additional fields are not accepted.

Example request

{
  "expectedRevision": 1,
  "status": "paused"
}

Responses

200Successful response. JSON object with the required data key. All properties marked required are present, including keys whose value may be null. Unmarked properties can be omitted; clients should tolerate additional response properties.

Response headers

X-Request-Id

string

Server-generated request correlation identifier.

Format: uuid.

application/json

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

dataRequired

objectView ResourceUpdated schema

data fields and rules

data.idRequired: string
Format: uuid.
data.updatedRequired: true
Must equal true.

Example response

Recorded from the real application handler against an isolated synthetic database. IDs, times and nonfunctional temporary secrets are normalized. No customer data or live provider request.

{
  "data": {
    "id": "00000000-0000-4000-8000-000000000001",
    "updated": true
  }
}

400invalid_request — Correct the request fields, resource identifiers, JSON body or query parameters before retrying. idempotency_key_required — Include an Idempotency-Key matching this operation’s documented format. sandbox_coverage_required — Use package sandbox@1 in the sandbox; choose approved sources or a qualified package in production.

Response headers

X-Request-Id

string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired

object

error fields and rules

error.codeRequired

string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired

string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired

string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional

object[] or object or string or number or boolean or null

Optional JSON details for client and validation failures. Validation failures return an array of { path, message } issues; other 4xx codes may return a code-specific object. Server failures omit details. Never assume this key is present.

error.details fields and rules

Allowed alternatives

object[]
Maximum items: 50.
Each array item: object.
error.details[].pathRequired
string
Dot-separated invalid field path, including array indexes.
Maximum length: 160.
error.details[].messageRequired
string
Validation problem for this field.
Maximum length: 300.
object
Additional keys are allowed; their values are not a fixed contract.
string or number or boolean or null
May be null.

error.detailsTruncatedOptional

boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Correct the request fields, resource identifiers, JSON body or query parameters before retrying.

{
  "error": {
    "code": "invalid_request",
    "message": "The request is invalid.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

idempotency key required

Synthetic error example. Include an Idempotency-Key matching this operation’s documented format.

{
  "error": {
    "code": "idempotency_key_required",
    "message": "Provide an Idempotency-Key of 8 to 128 URL-safe characters.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

sandbox coverage required

Synthetic error example. Use package sandbox@1 in the sandbox; choose approved sources or a qualified package in production.

{
  "error": {
    "code": "sandbox_coverage_required",
    "message": "Sandbox accepts only the explicitly synthetic sandbox@1 package.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

401authentication_required — Send Authorization: Bearer with a valid API key. An omitted header can produce authentication_required; invalid supplied credentials produce invalid_api_key. invalid_api_key — Use an active key for the intended environment.

Response headers

X-Request-Id

string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

WWW-Authenticate

string

Bearer authentication challenge.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired

object

error fields and rules

error.codeRequired

string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired

string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired

string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional

object[] or object or string or number or boolean or null

error.details fields and rules

Allowed alternatives

object[]
Maximum items: 50.
Each array item: object.
error.details[].pathRequired
string
Dot-separated invalid field path, including array indexes.
Maximum length: 160.
error.details[].messageRequired
string
Validation problem for this field.
Maximum length: 300.
object
Additional keys are allowed; their values are not a fixed contract.
string or number or boolean or null
May be null.

error.detailsTruncatedOptional

boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Send Authorization: Bearer with a valid API key. An omitted header can produce authentication_required; invalid supplied credentials produce invalid_api_key.

{
  "error": {
    "code": "authentication_required",
    "message": "Sign in to continue.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

invalid api key

Synthetic error example. Use an active key for the intended environment.

{
  "error": {
    "code": "invalid_api_key",
    "message": "The API key is invalid, expired, or revoked.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

402subscription_required — Use the synthetic sandbox or arrange an active production subscription before retrying.

Response headers

X-Request-Id

string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired

object

error fields and rules

error.codeRequired

string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired

string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired

string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional

object[] or object or string or number or boolean or null

error.details fields and rules

Allowed alternatives

object[]
Maximum items: 50.
Each array item: object.
error.details[].pathRequired
string
Dot-separated invalid field path, including array indexes.
Maximum length: 160.
error.details[].messageRequired
string
Validation problem for this field.
Maximum length: 300.
object
Additional keys are allowed; their values are not a fixed contract.
string or number or boolean or null
May be null.

error.detailsTruncatedOptional

boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Use the synthetic sandbox or arrange an active production subscription before retrying.

{
  "error": {
    "code": "subscription_required",
    "message": "An active subscription is required for production screening.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

403permission_denied — Ask an organization owner to grant the required role or API-key scope. insufficient_scope — Use a key with the scope stated in this operation.

Response headers

X-Request-Id

string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired

object

error fields and rules

error.codeRequired

string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired

string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired

string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional

object[] or object or string or number or boolean or null

error.details fields and rules

Allowed alternatives

object[]
Maximum items: 50.
Each array item: object.
error.details[].pathRequired
string
Dot-separated invalid field path, including array indexes.
Maximum length: 160.
error.details[].messageRequired
string
Validation problem for this field.
Maximum length: 300.
object
Additional keys are allowed; their values are not a fixed contract.
string or number or boolean or null
May be null.

error.detailsTruncatedOptional

boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Ask an organization owner to grant the required role or API-key scope.

{
  "error": {
    "code": "permission_denied",
    "message": "Your role does not allow this action.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

insufficient scope

Synthetic error example. Use a key with the scope stated in this operation.

{
  "error": {
    "code": "insufficient_scope",
    "message": "The API key does not grant this action.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

404not_found — Check the identifier and selected environment. The resource must belong to your organization and remain available.

Response headers

X-Request-Id

string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired

object

error fields and rules

error.codeRequired

string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired

string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired

string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional

object[] or object or string or number or boolean or null

error.details fields and rules

Allowed alternatives

object[]
Maximum items: 50.
Each array item: object.
error.details[].pathRequired
string
Dot-separated invalid field path, including array indexes.
Maximum length: 160.
error.details[].messageRequired
string
Validation problem for this field.
Maximum length: 300.
object
Additional keys are allowed; their values are not a fixed contract.
string or number or boolean or null
May be null.

error.detailsTruncatedOptional

boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Check the identifier and selected environment. The resource must belong to your organization and remain available.

{
  "error": {
    "code": "not_found",
    "message": "Monitor not found.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

405method_not_allowed — Use a method in the Allow response header. OPTIONS lists supported methods; HEAD follows GET authorization and returns no body.

Response headers

X-Request-Id

string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

Allow

string

Comma-separated supported HTTP methods.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired

object

error fields and rules

error.codeRequired

string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired

string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired

string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional

object[] or object or string or number or boolean or null

error.details fields and rules

Allowed alternatives

object[]
Maximum items: 50.
Each array item: object.
error.details[].pathRequired
string
Dot-separated invalid field path, including array indexes.
Maximum length: 160.
error.details[].messageRequired
string
Validation problem for this field.
Maximum length: 300.
object
Additional keys are allowed; their values are not a fixed contract.
string or number or boolean or null
May be null.

error.detailsTruncatedOptional

boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Use a method in the Allow response header. OPTIONS lists supported methods; HEAD follows GET authorization and returns no body.

{
  "error": {
    "code": "method_not_allowed",
    "message": "This method is not supported for this endpoint.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

408invalid_request — Reconnect and retry using the same idempotency key and identical input where supported.

Response headers

X-Request-Id

string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired

object

error fields and rules

error.codeRequired

string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired

string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired

string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional

object[] or object or string or number or boolean or null

error.details fields and rules

Allowed alternatives

object[]
Maximum items: 50.
Each array item: object.
error.details[].pathRequired
string
Dot-separated invalid field path, including array indexes.
Maximum length: 160.
error.details[].messageRequired
string
Validation problem for this field.
Maximum length: 300.
object
Additional keys are allowed; their values are not a fixed contract.
string or number or boolean or null
May be null.

error.detailsTruncatedOptional

boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Reconnect and retry using the same idempotency key and identical input where supported.

{
  "error": {
    "code": "invalid_request",
    "message": "The request body was not received within 10 seconds.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

409idempotency_conflict — Reuse a key only with identical input. Use a new key for genuinely new work. screening_policy_changed — Reload GET /policies and use the current version after reviewing its coverage. monitor_paused — Set status=active with runNow or resume the monitor first. stale_revision — Reload and send its current expectedRevision. monitor_limit_reached — Reduce active monitors or review plan allowance. counterparty_unavailable — Restore the linked counterparty first.

Response headers

X-Request-Id

string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired

object

error fields and rules

error.codeRequired

string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired

string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired

string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional

object[] or object or string or number or boolean or null

error.details fields and rules

Allowed alternatives

object[]
Maximum items: 50.
Each array item: object.
error.details[].pathRequired
string
Dot-separated invalid field path, including array indexes.
Maximum length: 160.
error.details[].messageRequired
string
Validation problem for this field.
Maximum length: 300.
object
Additional keys are allowed; their values are not a fixed contract.
string or number or boolean or null
May be null.

error.detailsTruncatedOptional

boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Reuse a key only with identical input. Use a new key for genuinely new work.

{
  "error": {
    "code": "idempotency_conflict",
    "message": "This idempotency key was used with a different request.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

screening policy changed

Synthetic error example. Reload GET /policies and use the current version after reviewing its coverage.

{
  "error": {
    "code": "screening_policy_changed",
    "message": "The policy has a newer version. Review its coverage before screening again.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

monitor paused

Synthetic error example. Set status=active with runNow or resume the monitor first.

{
  "error": {
    "code": "monitor_paused",
    "message": "Resume this monitor before running a check.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

stale revision

Synthetic error example. Reload and send its current expectedRevision.

{
  "error": {
    "code": "stale_revision",
    "message": "This monitor changed. Reload before saving.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

monitor limit reached

Synthetic error example. Reduce active monitors or review plan allowance.

{
  "error": {
    "code": "monitor_limit_reached",
    "message": "The monitoring allowance has been reached.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

counterparty unavailable

Synthetic error example. Restore the linked counterparty first.

{
  "error": {
    "code": "counterparty_unavailable",
    "message": "Restore the linked counterparty before resuming monitoring.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

413response_too_large — Reduce the requested page size or use the documented segmented case archive. No evidence is silently truncated. invalid_request — Reduce the JSON request size to the documented limit.

Response headers

X-Request-Id

string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired

object

error fields and rules

error.codeRequired

string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired

string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired

string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional

object[] or object or string or number or boolean or null

error.details fields and rules

Allowed alternatives

object[]
Maximum items: 50.
Each array item: object.
error.details[].pathRequired
string
Dot-separated invalid field path, including array indexes.
Maximum length: 160.
error.details[].messageRequired
string
Validation problem for this field.
Maximum length: 300.
object
Additional keys are allowed; their values are not a fixed contract.
string or number or boolean or null
May be null.

error.detailsTruncatedOptional

boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Reduce the requested page size or use the documented segmented case archive. No evidence is silently truncated.

{
  "error": {
    "code": "response_too_large",
    "message": "This response exceeds the size limit. Request a smaller page or a segmented export.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

invalid request

Synthetic error example. Reduce the JSON request size to the documented limit.

{
  "error": {
    "code": "invalid_request",
    "message": "REQUEST_TOO_LARGE",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

415invalid_request — Use Content-Type: application/json and an uncompressed UTF-8 body.

Response headers

X-Request-Id

string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired

object

error fields and rules

error.codeRequired

string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired

string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired

string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional

object[] or object or string or number or boolean or null

error.details fields and rules

Allowed alternatives

object[]
Maximum items: 50.
Each array item: object.
error.details[].pathRequired
string
Dot-separated invalid field path, including array indexes.
Maximum length: 160.
error.details[].messageRequired
string
Validation problem for this field.
Maximum length: 300.
object
Additional keys are allowed; their values are not a fixed contract.
string or number or boolean or null
May be null.

error.detailsTruncatedOptional

boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Use Content-Type: application/json and an uncompressed UTF-8 body.

{
  "error": {
    "code": "invalid_request",
    "message": "Send application/json with UTF-8 encoding.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

422screening_policy_required — Load GET /policies and supply the current id and version with the required coverage. policy_entity_type_unsupported — Choose an approved policy with required sources for this subject type. policy_coverage_mismatch — For production policy-based requests use explicit sources, include all required sources and only permitted optional sources; do not substitute a package. screening_policy_unavailable — Reload the current policy before retrying. Do not substitute a different scope silently. invalid_coverage — Check GET /sources and select coverage available to the requested environment and subject type. unsupported_entity_type — Check source capabilities and remove incompatible sources, or choose coverage for this subject type. matching_variant_limit — Provide a more precise name or identifier and retry. candidate_limit_exceeded — Add reliable identifying information before screening again. No all-clear result was produced. monitoring_policy_cadence — Retain the policy cadence or update the approved policy before changing it.

Response headers

X-Request-Id

string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired

object

error fields and rules

error.codeRequired

string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired

string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired

string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional

object[] or object or string or number or boolean or null

error.details fields and rules

Allowed alternatives

object[]
Maximum items: 50.
Each array item: object.
error.details[].pathRequired
string
Dot-separated invalid field path, including array indexes.
Maximum length: 160.
error.details[].messageRequired
string
Validation problem for this field.
Maximum length: 300.
object
Additional keys are allowed; their values are not a fixed contract.
string or number or boolean or null
May be null.

error.detailsTruncatedOptional

boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Load GET /policies and supply the current id and version with the required coverage.

{
  "error": {
    "code": "screening_policy_required",
    "message": "Choose an approved organization screening policy.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

policy entity type unsupported

Synthetic error example. Choose an approved policy with required sources for this subject type.

{
  "error": {
    "code": "policy_entity_type_unsupported",
    "message": "This policy has no required coverage for the selected subject type.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

policy coverage mismatch

Synthetic error example. For production policy-based requests use explicit sources, include all required sources and only permitted optional sources; do not substitute a package.

{
  "error": {
    "code": "policy_coverage_mismatch",
    "message": "Include every required source and only permitted optional sources for this policy.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

screening policy unavailable

Synthetic error example. Reload the current policy before retrying. Do not substitute a different scope silently.

{
  "error": {
    "code": "screening_policy_unavailable",
    "message": "The selected policy version is unavailable.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

invalid coverage

Synthetic error example. Check GET /sources and select coverage available to the requested environment and subject type.

{
  "error": {
    "code": "invalid_coverage",
    "message": "Choose a supported coverage package or explicit sources.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

unsupported entity type

Synthetic error example. Check source capabilities and remove incompatible sources, or choose coverage for this subject type.

{
  "error": {
    "code": "unsupported_entity_type",
    "message": "The selected source does not support this subject type. No screening was completed.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

matching variant limit

Synthetic error example. Provide a more precise name or identifier and retry.

{
  "error": {
    "code": "matching_variant_limit",
    "message": "This name has too many spelling variants for complete screening. No screening was completed.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

candidate limit exceeded

Synthetic error example. Add reliable identifying information before screening again. No all-clear result was produced.

{
  "error": {
    "code": "candidate_limit_exceeded",
    "message": "This query has too many candidates for reliable screening. Add a precise identifier or more complete name.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

monitoring policy cadence

Synthetic error example. Retain the policy cadence or update the approved policy before changing it.

{
  "error": {
    "code": "monitoring_policy_cadence",
    "message": "This monitor must use the cadence in its approved screening policy.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

429rate_limited — Wait for the request window to reset and retry with backoff.

Response headers

X-Request-Id

string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

Retry-After

string

When present, a delay in seconds or an HTTP-date before which the client should not retry. Service-unavailable responses default to a one-second delay unless another safe value is supplied. A usage allowance error may require quota recovery instead of retrying.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired

object

error fields and rules

error.codeRequired

string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired

string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired

string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional

object[] or object or string or number or boolean or null

error.details fields and rules

Allowed alternatives

object[]
Maximum items: 50.
Each array item: object.
error.details[].pathRequired
string
Dot-separated invalid field path, including array indexes.
Maximum length: 160.
error.details[].messageRequired
string
Validation problem for this field.
Maximum length: 300.
object
Additional keys are allowed; their values are not a fixed contract.
string or number or boolean or null
May be null.

error.detailsTruncatedOptional

boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Wait for the request window to reset and retry with backoff.

{
  "error": {
    "code": "rate_limited",
    "message": "The per-minute request limit has been reached.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

500internal_error — Retry with backoff. For writes reuse the same idempotency key and identical input; include requestId when contacting support.

Response headers

X-Request-Id

string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired

object

error fields and rules

error.codeRequired

string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired

string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired

string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional

object[] or object or string or number or boolean or null

error.details fields and rules

Allowed alternatives

object[]
Maximum items: 50.
Each array item: object.
error.details[].pathRequired
string
Dot-separated invalid field path, including array indexes.
Maximum length: 160.
error.details[].messageRequired
string
Validation problem for this field.
Maximum length: 300.
object
Additional keys are allowed; their values are not a fixed contract.
string or number or boolean or null
May be null.

error.detailsTruncatedOptional

boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Retry with backoff. For writes reuse the same idempotency key and identical input; include requestId when contacting support.

{
  "error": {
    "code": "internal_error",
    "message": "The request could not be completed.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

503temporarily_unavailable — Honor Retry-After when present and retry with bounded backoff. Follow this endpoint’s retry contract; preserve the same key and input for idempotent writes. Contact support with requestId if the failure persists. coverage_unavailable — Do not treat this failure as no-match. Retry only when the selected coverage is available. stale_coverage — Wait for fresh selected coverage. Do not interpret this failure as a no-match result. production_screening_disabled — Wait until production screening is available; the synthetic sandbox remains separate.

Response headers

X-Request-Id

string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

Retry-After

string

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired

object

error fields and rules

error.codeRequired

string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired

string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired

string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional

object[] or object or string or number or boolean or null

error.details fields and rules

Allowed alternatives

object[]
Maximum items: 50.
Each array item: object.
error.details[].pathRequired
string
Dot-separated invalid field path, including array indexes.
Maximum length: 160.
error.details[].messageRequired
string
Validation problem for this field.
Maximum length: 300.
object
Additional keys are allowed; their values are not a fixed contract.
string or number or boolean or null
May be null.

error.detailsTruncatedOptional

boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Honor Retry-After when present and retry with bounded backoff. Follow this endpoint’s retry contract; preserve the same key and input for idempotent writes. Contact support with requestId if the failure persists.

{
  "error": {
    "code": "temporarily_unavailable",
    "message": "The service is temporarily unavailable. Retry shortly.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

coverage unavailable

Synthetic error example. Do not treat this failure as no-match. Retry only when the selected coverage is available.

{
  "error": {
    "code": "coverage_unavailable",
    "message": "The selected coverage is temporarily unavailable. No screening was completed.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

stale coverage

Synthetic error example. Wait for fresh selected coverage. Do not interpret this failure as a no-match result.

{
  "error": {
    "code": "stale_coverage",
    "message": "The selected coverage is stale. No screening was completed.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

production screening disabled

Synthetic error example. Wait until production screening is available; the synthetic sandbox remains separate.

{
  "error": {
    "code": "production_screening_disabled",
    "message": "Production screening is temporarily unavailable. No screening was completed.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

Back to request parameters