List Checks

List validation checks in the structuring pipeline. Checks define rules like field_format, value_range, cross_field, and ai_coherence.

The structuring pipeline validates extracted data through configurable checks and approval gates. Checks define validation rules; gates aggregate checks and determine whether records require manual approval before delivery. Also exposes per-result check outcomes, the pending-approvals queue, approve/reject actions, and the manual delivery trigger for an approved run.

Use this endpoint to retrieve all validation checks configured for your organization. Checks are evaluated against every structuring result to flag data quality issues before delivery. You can scope checks to a specific schema to apply different validation logic per document type.

GET/v1/structuring/checks

Response

Response fields

dataarrayArray of validation check objects, ordered by sort_order then created_at.

data[].idstringCheck UUID.

data[].user_schema_idstring | nullSchema scope for this check, if any.

data[].namestringCheck name.

data[].descriptionstring | nullOptional description.

data[].typestringCheck type: field_format, value_range, cross_field, or ai_coherence.

data[].severitystringSeverity level: warning or error.

data[].configobject | nullType-specific configuration object.

data[].is_activebooleanWhether the check runs against new results.

data[].sort_orderintegerDisplay and evaluation order.

data[].created_atstringISO 8601 creation timestamp.

data[].updated_atstringISO 8601 last update timestamp.

data[].linksobjectRelated resource URLs (self).

Response

{
  "data": [
    {
      "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-01T10:00:00.000Z",
      "links": {
        "self": "/v1/structuring/checks/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      }
    }
  ]
}

Errors

Error responses

401unauthorizedMissing or invalid API key.

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

Create Check

List Gates