dVeracity Semantic API

Use this when you need to know what each dVeracity plan includes or what the free allowance covers. Show dVeracity plans, what each plan includes and the free-tier allowance.

Use this when a call was refused for credits or plan, to tell the user exactly what is missing. Use it after a 402 to tell your human exactly what is missing.

Use this when a user wants an import record or an annual EU CBAM declaration (Reg. (EU) 2023/956) checked against an approved policy before filing. Do not use for carbon-footprint calculations or for regulations compliance_policies does not list. Runs the policy's regulation-derived Rego, not the generic OFP validator. The decision is passed, denied, unevaluable, not_applicable or error; an error is a refusal, never compliance, and error.code names it (policy_not_release_eligible, policy_no_rendered_checks, policy_no_faithful_checks, policy_coverage_inconsistent, policy_hash_mismatch, policy_hash_unverified). A pass covers only the encoded checks: read coverage.note. Requires the compliance:evaluate scope; every call counts against the plan limit. For an annual CBAM declaration set entity_type to cbam_declaration and send declaration + lines.

Use this when a user wants to retrieve or audit a previous regulatory evaluation by its id. Only the caller who ran it can read it; another account's id answers not found. Requires compliance:read.

Use this when a user needs data checked against a regulation, for example EU CBAM, to find the approved policy to run. Do not use for Open Footprint sector rules; use ofp_policies. Returns only APPROVED policies; drafts and rejected never appear. An empty list means none published, not that no obligations exist; never invent rules. Requires compliance:read.

Use this when you need the full rules, provenance and coverage of one approved regulatory policy. Returns Rego only when the source was retained; otherwise rego_unavailable: source_not_retained. A policy without Rego is not loaded into the engine; enforcement says whether its structured rules still run. Do not reconstruct the Rego. Requires compliance:read.

Use this when a user asks which provisions of a regulation an evaluation actually checks and which it does not. Shows which provisions are encoded and which are not: a pass on the encoded checks is not compliance with excluded provisions. Requires the compliance:read scope.

Deprecated: use billing_status, which also shows plan and free allowance. Removal planned for 0.9.

Use this when an organisation needs to confirm which verified legal entity and agent identity dVeracity is attributing calls to. Only relevant when vLEI identity is configured.

Use this when you need to see which sustainability data standards and versions validate_data can check, before calling it.

Use this when you need one entity's fields, types, keys and relationships, for example to design a table or an API payload. Pass domain when known: ambiguous names fail rather than guessing (ofp_models reports ambiguousNameCount).

Use this when a user asks which version of the Open Footprint standard they are designing against.

Use this when a user is building an app, database or integration on the Open Footprint standard and needs to know what the model covers. Start here before any other ofp_ tool. The response summary carries the served counts.

Use this when a user asks which validation rules apply to a sector's emissions records. Do not use for regulations; use compliance_policies. inputs lists the e-ledger fields each policy reads (e.g. co2e_kg, direction), not canonical Open Footprint names. published:false means no rules are published; do not invent guardrails.

Use this when you need the Open Footprint entity for a concept such as "Scope 3 emissions", "facility" or "product footprint". Do not use for emission factors or calculations. Matches entity names, descriptions and field names; use ofp_entity for the full definition.

Use this when you need one sector's classification, status and reference artifacts.

Use this when a user asks which industries Open Footprint covers or whether a sector has a reference implementation. implemented means a reference implementation exists; planned or placeholder means nothing is published.

Use this when you have a source-system field and need to find where it belongs in the Open Footprint model. Codes carried by more than ten fields are generic classifications; aligning to one asserts less than it appears.

Use this when mapping fields from SAP, another ERP or a supplier feed onto Open Footprint. A high fieldCount is a generic fallback; pass maxFieldCount (10 is a good start) for codes specific enough to align on.

Use this when a user wants an emissions or footprint record (JSON) checked against the Open Footprint model or a sector's guardrails before storing, exchanging or reporting it. Do not use for general data-quality questions without a payload. Checks structure, declared constraints, enum membership and calculations; with a sector, its guardrails. Always read `checked` and `checks_not_run` per call, and `schema.coverage.constraintsDeclared`, rather than assuming a range check ran. Not checked: undeclared ranges, unit coherence, live referential integrity, factor provenance. Never report a payload as compliant unless sector_policy is in `checked` and policy.outcome is passed. `schemaValid` is the structural verdict; `valid` is deprecated.

Use this when a user asks a specific question about verified oil-and-gas emissions data, for example methane emissions for a site, company or period (PPDM, OGMP 2.0). Call semantic_templates first to see what the data can answer. Do not use for general climate questions. On payment_required, tell your operator what the call needs; do not retry the same call. Prefer a specific site, company or period.

Use this when you want to see which kinds of questions the verified emissions data can answer, before calling semantic_query.

Use this when a user wants a payload checked against a standard other than Open Footprint; call list_standards first to see which are supported. For Open Footprint payloads use ofp_validate. Only masterData or referenceData; call list_standards first.