Get / Update / Delete Check

Get, update, or delete a structuring check. Same path supports GET (detail), PUT (update), and DELETE operations with appropriate scopes.

Retrieve, update, or remove a validation check by its UUID. Use GET to inspect a check's current configuration, PUT to modify its name, severity, config, or active status, and DELETE to soft-delete it. Soft-deleted checks set is_active to false and stop running against new results, but their historical check outcomes remain intact.

DELETE is a soft-delete. The check is deactivated (is_active = false) rather than permanently removed. Existing result check outcomes referencing this check are preserved.

GET/v1/structuring/checks/{id}

Response

Response fields

idstringCheck UUID.

user_schema_idstring | nullSchema scope for this check, if any.

namestringCheck name.

descriptionstring | nullOptional description.

typestringCheck type: field_format, value_range, cross_field, or ai_coherence.

severitystringSeverity level: warning or error.

configobject | nullType-specific configuration.

is_activebooleanWhether the check is active. PUT can set this to false; DELETE soft-deletes by setting it to false and returns { deleted: true }.

sort_orderintegerDisplay and evaluation order.

created_atstringISO 8601 creation timestamp.

updated_atstringISO 8601 last update timestamp.

linksobjectRelated resource URLs (self).

Response (GET / PUT)

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "user_schema_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "name": "Amount range check",
  "description": "Validates total amount is within expected range",
  "type": "value_range",
  "severity": "warning",
  "config": { "field": "total_amount", "min": 0, "max": 1000000 },
  "is_active": true,
  "sort_order": 0,
  "created_at": "2024-09-01T10:00:00.000Z",
  "updated_at": "2024-09-15T09:00:00.000Z",
  "links": {
    "self": "/v1/structuring/checks/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}

Response (DELETE)

{
  "deleted": true
}

Errors

Error responses

401unauthorizedMissing or invalid API key.

404not_foundValidation check not found or does not belong to your organization.

429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Use PUT to adjust thresholds (e.g. widening a value_range config) or to deactivate a check by setting is_active to false without deleting it. Historical check outcomes referencing this check are preserved regardless of updates or soft-deletion, so audit trails remain intact.

List Checks

Create Check