Skip to main content

Result Checks

Get validation check outcomes for a specific structuring result showing check name, pass/fail status, and messages.

Retrieve the validation check outcomes for a specific structuring result. Each outcome records whether a configured check passed or failed for that result, along with the check's name and severity. Use this to understand why a result was flagged or to build audit trails for data quality.

GET/v1/structuring/results/{id}/checks

Response

Response fields

dataarrayArray of check result objects.
data[].idstringCheck result UUID.
data[].dataspace_result_idstringUUID of the structuring result this outcome belongs to.
data[].check_idstringUUID of the validation check that was evaluated.
data[].passedbooleanWhether the check passed.
data[].detailsobject | nullAdditional detail about why the check passed or failed.
data[].created_atstringISO 8601 timestamp.
data[].checkobjectEmbedded validation check object.
data[].check.namestringCheck name.
data[].check.severitystringCheck severity: warning or error.

Response

{
  "data": [
    {
      "id": "d4e5f6a7-b8c9-0123-defa-234567890123",
      "dataspace_result_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "check_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "passed": true,
      "details": null,
      "created_at": "2024-09-14T12:05:00.000Z",
      "check": {
        "name": "Amount range check",
        "severity": "warning"
      }
    }
  ]
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
404not_foundStructuring result not found or does not belong to your organization.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Check outcomes are computed automatically when a structuring result is produced -- no manual trigger is needed. Use the embedded check.name and check.severity fields to render pass/fail badges in a review UI. Failed checks with severity: "error" are the ones that cause results to appear in GET /v1/structuring/approvals/pending.

Related

List Checks
Pending Approvals