dVeracity Semantic API

Start a one-time credit purchase and return a checkoutUrl, plus a paymentLink when the deployment configures one. No charge happens until a human completes the payment; show the URL to your operator. Prefer this over retrying the metered tool after a 402.

Start a membership subscription checkout and return only the checkoutUrl. Recurring charges always need human approval: do not complete the checkout yourself, and do not retry the metered tool until your operator confirms the plan is active.

Execute one named APPROVED compliance policy against one record and return the decision, the per-check results, the inputs the record lacked, remediation, the policy version and hash that decided, and the policy coverage. This runs that policy's regulation-derived Rego — not the generic OFP validator and not a fan-out over frameworks. Paid plans only; requires the compliance:evaluate scope, and every call counts against the plan limit. The decision is one of passed, denied, unevaluable (the record lacks inputs a check needs — supply them and retry), not_applicable (the CN code is outside Annex I) or error. An error is a refusal before a verdict: error.code names it, including policy_not_release_eligible, policy_no_rendered_checks, policy_no_faithful_checks, policy_coverage_inconsistent, policy_hash_mismatch and policy_hash_unverified. Do not treat an error as compliant. allow is true only for passed. The decision is the worst of the policy, data and evidence layers, and decision_basis.decided_by names the layer(s) that produced it: a policy whose checks all passed can still be denied by a data finding. A pass means the encoded checks passed: read coverage.note for the provisions the policy does not encode. Per-check outcome may be not_applicable when the check's trigger did not hold; that is not a met obligation. The result is stored as an audit record; retrieve it with compliance_evaluation. An annual CBAM declaration is evaluated by setting entity_type to "cbam_declaration" and sending declaration + lines instead of entity: every line runs through the record layers against the carbon_measure record it points at (record_id), then the declaration layer checks the de minimis (Reg (EU) 2023/956 Art 2a / Annex VII), the Art 6(1) 30 September deadline, the annual total, each line's quantity against its linked imports, the import year and duplicate customs references. Its decision is the worst line decision combined with the declaration findings, and the per-line results are stored in the same audit record with their record ids.

One APPROVED regulatory compliance policy in full: its Rego source, the structured rules the extractor produced, the record types and input fields the Rego reads, and provenance (source regulation document, extraction model and confidence, approval time, policy hash). Paid plans only; requires the compliance:read scope. A draft id — or a row that never went through approval, such as a retired seeded stub — answers "not found" exactly like an unknown id. A policy approved before its source was retained is returned without Rego and says so (rego_unavailable: source_not_retained). Such a policy is NOT loaded into the policy engine; the response says in `enforcement` whether its structured validation rules are still evaluated. Do not reconstruct the Rego yourself.

The published release register of one APPROVED compliance policy: every extracted provision with its legal reference, review verdict and disposition, the treatment rendered in the Rego (or why it was excluded), its status (enforced, attested, unsupported or informational), the fields it needs, and the approved hash, version and effective date. Use it to see what an evaluation actually covers and which provisions are NOT encoded — a pass on the encoded checks is not compliance with the excluded provisions. Paid plans only; requires the compliance:read scope.

Show which canonical fields carry one O-DEF semantic code (free). This is the reverse lookup a connector needs: given a field in a source system, find where in the Open Footprint model it belongs. Codes carried by more than ten fields are returned with an explicit caution — they are generic classifications, and aligning to one asserts far less than it appears to.

Show dVeracity plans, credit packs, the per-credit price and the free-tier allowance (free, anonymous). Call this before a metered tool so you know what a credit buys and what checkout options you can show your human operator.

Show this account's current plan, credit balance and remaining monthly free allowance (free). Use it after a 402 to tell your human exactly what is missing.

Retrieve one stored compliance evaluation by id — the audit record compliance_evaluate wrote. Only the caller who ran it can read it; another account's id answers "not found" exactly like an unknown one. Paid plans only; requires the compliance:read scope. Returns the decision, the stored result (per-check outcomes, missing inputs, remediation, policy version and hash), the evidence references and the input hash.

List APPROVED regulatory compliance policies — rules AI-extracted from a regulation (for example EU Green Bonds, CSRD/ESRS) and approved by a dVeracity admin. This is the regulation-derived corpus; the Open Footprint sector guardrails from ofp_policies cite no regulation by design. Requires the VaaS plan or higher (VaaS, API or Enterprise); an Explorer account gets a 403 naming requiredTier, not data. Requires the compliance:read scope — a connector authorised before that scope existed must be re-authorised. Returns name, framework, domain, effective dates, the source regulation document, rule count and approval time per policy. Drafts and rejected policies are never returned. An empty list is a real answer (published:false with a reason): treat it as "none published", never as "no obligations exist", and do not invent rules to fill the gap.

Show the remaining dVeracity API credit balance for this account (free).

Show this agent's verified vLEI identity (agent AID, Legal Entity LEI, authorized scopes) if KERI mode is configured — free. In KERI mode every metered call is attributed to this identity in dVeracity's audit trail.

List the sustainability data standards dVeracity can validate against (free).

Get one canonical entity in full (free): fields with types and required flags, primary key, relationships, and the physical database table implementing it. Pass `domain` whenever you know it — many entity names are defined in more than one domain (Country is in four; the ofp_models summary reports the current count as ambiguousNameCount), and without it the call fails rather than guessing which one you meant.

Show which snapshot of the Open Footprint standard this deployment serves (free): source commit, date, and entity/sector counts. Use it when you need to know how current the model you are designing against is.

List the Open Footprint canonical model domains and which database dialects have published DDL (free). Start here when building an app on the Open Footprint standard: it tells you what the model covers before you look up individual entities. The response summary carries the served counts (domains, entities, fields); they follow the vendored snapshot, which ofp_model_provenance identifies.

Get a sector's policy guardrails as Rego source (free), with policies[].inputs listing the record types and input fields each policy reads — e-ledger fields such as co2e_kg and direction, not canonical Open Footprint field names; a payload without them is reported unevaluable by ofp_validate. When a sector has no published guardrails this returns published:false with a reason — that is a real answer, not an error. Treat it as "no rules are published", never as "there are no constraints", and do not invent guardrails to fill the gap.

Search the canonical Open Footprint entities by concept (free). Matches entity names, descriptions and field names. Use this to find the right entity before fetching its full definition with ofp_entity.

Get one sector in full (free): its classification, status, reference artifacts and nested industries. Use ofp_sectors first to find the sector id.

List industry sectors and their reference implementations (free). Each carries a status: "implemented" means a reference implementation exists, while "planned" or "placeholder" mean the sector is named in the taxonomy but nothing is published for it. Check the status before assuming a sector has content.

List the O-DEF semantic codes carried by the canonical model (free). Use this when mapping fields from another system — SAP, an ERP, a supplier feed — onto Open Footprint: a code is the shared address two systems can align on. Every code comes with fieldCount, the number of canonical fields sharing it. A high count means a generic fallback that asserts almost nothing, so pass maxFieldCount (10 is a good start) to get only codes specific enough to be a real alignment target.

Check a data payload against the canonical Open Footprint model and, when a sector is named, that sector's published Rego guardrails. Costs API credits per call. WHAT IT CHECKS: structure (required fields, primary key, declared types); the constraints the model declares (identifier patterns, enums, date formats, lengths); value ranges where the model declares a bound (a quantity outside the declared minimum or maximum is rejected; how many fields declare a bound moves with the vendored snapshot, so this check runs on some entities and not others — read `checked` and `schema.coverage.constraintsDeclared` on each response rather than assuming it ran); temporal consistency (a validity period whose end precedes its start is rejected); enum membership (a foreign key into a vocabulary that publishes its members is checked against that member set, so a well-formed identifier for a referent that does not exist is caught); calculation reproducibility (where the record carries a quantity, an emission factor value and a stated CO2e result, quantity × factor = result is reproduced within 1% and a record that contradicts itself is rejected; this tests arithmetic only — a self-consistent record is not thereby a correct one, because whether the factor suits this source and period is factor provenance and whether the quantity came from the meter it claims needs the data plane, and neither is checked); and, with a sector, the guardrails. WHAT IT DOES NOT CHECK in this release: value ranges on fields whose model declares no bound (an out-of-range quantity passes, reported per call as no_range_declared or no_numeric_fields), unit coherence, referential integrity (foreign keys are pattern-checked and, where a vocabulary publishes one, member-checked, but never resolved against live records), factor provenance, or materiality. The response says so per call: `checked` lists the checks that ran and `checks_not_run` lists every catalogued check that did not, each with a machine-readable `reason` and a `detail` explaining the gap. That reason vocabulary belongs to the validator and grows with it, so read the `reason` off the response rather than matching it against a fixed list. `schemaValid` is the structural verdict; `assuranceLevel` (schema-only | schema-and-value | schema-value-and-policy | full) is the depth earned. `valid` is deprecated (kept through 0.5.x, removed no earlier than 0.6.0) — it only ever covered the checks that ran. Every violation and warning carries severity (error | warning). Unknown fields are warnings, never violations, and each carries `didYouMean` candidates when the model has a plausible match; `schema.normalisations` discloses keys that resolved only through case and separator folding. `advisories` carries findings that are true of the payload but do not bear on its validity: today `deprecated_field`, severity warning, naming a `successor` when the model names one — an advisory never changes `schemaValid`. Guardrails report four distinct outcomes, never conflated: passed, denied, not_applicable (the rules do not cover this record type), or unevaluable (the payload lacks the e-ledger inputs the rules read, e.g. co2e_kg — listed in policy.missingInputs). Never report a payload as compliant unless sector_policy is in `checked` and policy.outcome is passed.

Ask a natural-language question about verified emissions data (Open Footprint / PPDM / OGMP-methane knowledge graphs). Costs API credits per call; on payment_required, follow offers[] or show checkoutUrl to your operator — do not retry the same call. Prefer specific questions (a site, a company, a time range) over broad ones.

List the query templates the semantic layer supports (free). Useful to learn what kinds of questions the knowledge graph can answer before spending credits on semantic_query.

Validate a data payload against a supported sustainability standard (Validation-as-a-Service). Costs API credits per call. Use list_standards first to see supported standards and versions.