Skip to main content

Pending Approvals

List structuring results awaiting manual approval. These are results that did not pass all gate rules automatically.

Retrieve the queue of structuring results that failed one or more gate rules and require manual review. Each item in the response represents a failed check outcome, linking a structuring result to the check that flagged it. Use this endpoint to build approval workflows or monitor data quality issues.

The pending approvals endpoint returns up to 100 items per call. If you have a high volume of flagged results, implement polling or use the auto_approve_after_hours gate setting to prevent queue buildup.
GET/v1/structuring/approvals/pending

Response

Response fields

dataarrayArray of failed check result rows awaiting review (up to 100).
data[].idstringCheck result UUID.
data[].result_idstringUUID of the structuring result.
data[].check_idstringUUID of the check that failed.
data[].passedbooleanAlways false for pending approval items.
data[].detailsobject | nullAdditional failure detail.
data[].created_atstringISO 8601 timestamp.
data[].check_namestringName of the failing check.
data[].severitystringSeverity of the failing check.

Response

{
  "data": [
    {
      "id": "d4e5f6a7-b8c9-0123-defa-234567890123",
      "result_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "check_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "passed": false,
      "details": { "field": "total_amount", "value": 1500000, "max": 1000000 },
      "created_at": "2024-09-14T12:05:00.000Z",
      "check_name": "Amount range check",
      "severity": "warning"
    }
  ]
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Each item links a structuring result to the specific check that failed, so a single result can appear multiple times if it failed multiple checks. Use the result_id to group items by result, then call POST /v1/structuring/approvals/{id}/approve or /reject to action each one. Approving a result clears all its pending items and triggers the gate's on_approve action.

Related

Approve / Reject
Gate Rules