Skip to content
VeraFrame Docs

JSON API mode

JSON API mode is for integrations. Instead of a natural-language request, you send a structured payload together with input and output schemas. VeraFrame validates both schemas, runs the verification pipeline, and returns a schema-compliant JSON response with a trust report attached.

Use JSON API mode when:

  • An upstream system is producing data that needs to be verified before downstream consumption.
  • You are building a workflow where VeraFrame sits between an AI system and a system of record.
  • You need verification behavior programmatically, from a backend, without a UI in the loop.

JSON API mode requires the rest_api feature and is available on the Integration and Compliance Edition tiers.

What you give it

  • request — a natural-language description of what the output JSON should represent.
  • input_payload — the input data as structured JSON.
  • input_schema (optional) — a JSON Schema describing the expected shape of the input. If provided, the input is validated before processing.
  • output_schema — a JSON Schema describing the required shape of the output. This is enforced: VeraFrame will not return JSON that fails schema validation.
  • sources or source_groups — the source material against which claims in the output are verified.

What you get back

  • output_json — the generated payload, conforming to output_schema.
  • input_schema_validation — whether the input passed validation (if a schema was supplied).
  • output_schema_validation — whether the output passed validation.
  • confidence_report — the trust report for the values in output_json.
  • output_text — a text representation of the output, useful for logging or human review.

Typical patterns

Structured extraction with verification

An upstream system gives you a PDF or a block of text. You ask JSON API mode to extract a specific structured record (for example, a purchase order). The output_schema enforces the shape. The trust report tells you which fields were grounded in the source and which were not.

Enriching a record with verified values

Your CRM has an incomplete record. You call JSON API mode with the current record as input_payload and a schema that includes the fields you want filled. VeraFrame consults your source material (policies, pricing, contract terms), produces the enriched record, and tags every new value with its verification status.

Backend audit-before-write

Your AI assistant produces a JSON proposal. Before writing it to your database, you route it through JSON API mode with strict schemas and the relevant source groups. Records where the trust report shows any mismatch are routed to human review instead of being written directly.

Step by step (from the UI)

The JSON API mode is also available in the main tool UI for testing and debugging:

  1. Open the main tool and select the JSON API button (violet).
  2. Paste your request description, input payload, input schema, and output schema into the corresponding fields.
  3. Select source material.
  4. Click Run.
  5. Inspect the response. Each output_json field has a status indicator in the trust report.

For production use, call the REST endpoint directly from your backend. See REST API.