Skip to content

Validate statutory filing payload

POST/payroll/filings/{id}/validate

Runs automated validation checks on a filing's payload against the authority's schema requirements before submission. Returns a validation report with per-field errors. Fix all errors before submitting — authorities typically reject malformed filings with penalties.

Request

Path parameters

NameTypeRequiredDescription
idintegerYes

The numeric ID of the filing to validate.

Responses

200 Filing validation report

Content type application/json, object · FilingValidationResultV1.

FieldTypeRequiredDescription
filing_idintegerNo
validbooleanNo

True if all validation checks passed with no errors.

errorsarray of objectNo

Blocking validation errors that must be fixed before submission.

errors[].fieldstringNo
errors[].messagestringNo
warningsarray of objectNo

Non-blocking warnings that may cause authority rejection in some jurisdictions.

warnings[].fieldstringNo
warnings[].messagestringNo

Example

{
  "filing_id": 19,
  "valid": true,
  "errors": [],
  "warnings": [
    {
      "field": "employer_tin",
      "message": "TIN format should be 10 digits without dashes for GRA PAYE submissions."
    }
  ]
}

404 Filing not found

Example request

curl -X POST "https://{tenant}.faciotech.net/api/v1/payroll/filings/{id}/validate" \
  -H "Accept: application/json"
Loading