Create Check
Create a validation check for the structuring pipeline. Supports field_format, value_range, cross_field, and ai_coherence check types.
POST
/v1/structuring/checksResponse
Response fields (201 Created)
idstringCheck UUID.
user_schema_idstring | nullSchema scope, if provided.
namestringCheck name.
descriptionstring | nullOptional description.
typestringCheck type.
severitystringSeverity level.
configobject | nullType-specific configuration.
is_activebooleanAlways true for newly created checks.
sort_orderintegerDisplay and evaluation order.
created_atstringISO 8601 creation timestamp.
updated_atstringISO 8601 last update timestamp.
linksobjectRelated resource URLs (self).
Response (201 Created)
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"user_schema_id": null,
"name": "Amount range check",
"description": null,
"type": "value_range",
"severity": "warning",
"config": { "field": "total_amount", "min": 0, "max": 1000000 },
"is_active": true,
"sort_order": 0,
"created_at": "2024-09-14T12:00:00.000Z",
"updated_at": "2024-09-14T12:00:00.000Z",
"links": {
"self": "/v1/structuring/checks/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}Errors
Error responses
400bad_requestNo specific customer context available (master-view API key used on a create operation).
401unauthorizedMissing or invalid API key.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.