API ReferenceValidationApiV1Validate
Validate SFRS document
Validates an SFRS document (filing or investor statement) against schema and business rules
Request Body
application/json
document*object
The SFRS document to validate
documentType?string
Type of document. Use "auto" to detect automatically.
Default
"auto"Value in
"filing" | "investor-statement" | "auto"Response Body
application/json
application/json
curl -X POST "http://localhost:3000/api/v1/validate" \ -H "Content-Type: application/json" \ -d '{ "document": {} }'{
"valid": true,
"documentType": "string",
"errors": [
{
"code": "string",
"path": "string",
"message": "string",
"severity": "string"
}
],
"warnings": [],
"info": [],
"summary": {
"errorCount": 0,
"warningCount": 0,
"infoCount": 0
}
}{
"error": "string",
"message": "string"
}