Skip to content
VELKRON

API REFERENCE · DESIGN PREVIEW

One endpoint does
the work.

This is the planned shape of a unified public API (one POST in front of your publication flow) so your engineers can size the integration before it exists. It is not live yet and its schema will differ from today's dashboard integration; ask us about what's actually callable now if you want to start sooner.

01AUTHENTICATION

Planned as Bearer keys, scoped to your firm and revocable instantly. This part is already real in the dashboard today, just not yet wired to the unified public endpoint below.

Authorization: Bearer vk_live_...
02RUN A CHECK

POST /v1/checks (planned)

Submit an artefact by URL or inline content. The call is synchronous for typical documents. The rulebook version is fixed and the grounding is enforced; the assessment is model-assisted and refusal-first, and every response carries a tamper-evident receipt. The shape below is the target design, not a live contract; treat field names as provisional.

POST /v1/checks
Content-Type: application/json

{
  "artefact_url": "https://firm.com/promo.pdf",
  "rulebook": "uk-fca",            // rulebook id
  "modules": ["COBS4", "CONC3"],   // optional narrowing
  "mode": "pre_publication"        // or "retrospective"
}
200 OK

{
  "id": "chk_01j8...",
  "verdict": "pass" | "fail" | "refused",
  "breach":    { "rule": "COBS 4.12A.34R", "reason": "..." },  // on fail
  "escalation":{ "reason": "insufficient_grounding" },          // on refused
  "citations": ["COBS 4.2.1R", "COBS 4.5.2R"],
  "grounding": "sufficient" | "insufficient",
  "receipt": {
    "sha256": "9f2c41d8...a41e",
    "chained": true,
    "prev": "b31e07c4...52aa"
  },
  "evidence_pack_url": "https://.../packs/chk_01j8.pdf",
  "rulebook_version": "uk-fca@2026.07"
}
03ERRORS & GUARANTEES
400invalid_request: malformed body, unknown rulebook or module
401unauthenticated: missing or revoked key
413artefact_too_large: split the document
422unprocessable_artefact: format not supported for extraction
429rate_limited: retry with backoff; limits sized per pilot

GROUNDING IS DETERMINISTIC (EVERY CITATION IS VERBATIM) · RULEBOOK IS FIXED & VERSIONED · ASSESSMENT IS MODEL-ASSISTED, REFUSAL-FIRST · A REFUSAL IS A FIRST-CLASS RESULT, NOT AN ERROR · EVERY RESPONSE CARRIES ITS RECEIPT · HUMAN SIGN-OFF REQUIRED

Talk to us about what’s callable today, and what’s still on the roadmap.

Request pilot access›Join the waitlist›