ofp_validate
Verifies data payloads against the canonical Open Footprint model and sector guardrails, reporting passed, denied, not applicable, or unevaluable when required inputs are missing.
Instructions
Check a data payload against the canonical Open Footprint model and, when a sector is named, that sector's published guardrails. Costs API credits per call. The response reports four distinct outcomes and never conflates them: guardrails passed, guardrails denied, guardrails do not cover this record type (not_applicable), or guardrails could not be evaluated because the payload lacks the inputs the rules read (unevaluable, with policy.missingInputs — canonical Open Footprint entities do not carry the e-ledger fields such as co2e_kg that the rules test). schema.coverage says which declared constraints were enforced and which the model does not declare (it declares no numeric ranges). If policy.ran is false or the outcome is unevaluable, do not report the payload as compliant — valid is null in that case.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| domain | No | Model domain; required when the entity name is ambiguous | |
| entity | Yes | Canonical entity name, e.g. "Product Carbon Footprint" | |
| sector | No | Sector id to apply guardrails from, e.g. "extractives" | |
| payload | Yes | The instance to check, as an object | |
| entityType | No | The record type the guardrails discriminate on, e.g. "directEmission". Without it the entity name is used, which usually matches nothing — the response then reports policy.outcome "not_applicable" and lists the types the rules do cover. |