Skip to main content
POST
Validate a candidate record against a state's schema

Authorizations

x-api-key
string
header
required

Path Parameters

name
string
required

Response

Success.

data
RecordValidation · object
required

Whether a candidate document fits a state's effective schema, with every reason it does not.

fits is true exactly when reasons is empty; reasons lists EVERY way the document fails, ordered by JSON path, so a misfit is one answer rather than one-failure-at-a-time.