Developer Portal

Build on Vouli IQ

A read-only REST API over your org data — scorecards, roadmaps, risks, compliance and signals — plus signed outbound webhooks. OpenAPI 3.1, an official TypeScript SDK, and per-key rate limits.

Quickstart (TypeScript SDK)

npm install @vouli-iq/sdk

import { VouliIQ } from '@vouli-iq/sdk';
const vouli = new VouliIQ({ apiKey: process.env.VOULI_API_KEY! });

const { scorecard } = await vouli.scorecard();
const risks = await vouli.risks({ severity: 'HIGH' });

Generate a key in Dashboard → API keys (admin only). Most endpoints use Authorization: Bearer; scores/signals use x-api-key (the SDK handles both).

Quickstart (Python SDK)

pip install vouli-iq

from vouli_iq import VouliIQ
vouli = VouliIQ(api_key=os.environ["VOULI_API_KEY"])

scorecard = vouli.scorecard()
risks = vouli.risks(severity="HIGH")

Stdlib-only (no third-party dependencies). Same endpoint coverage as the TypeScript SDK, kept in lock-step with the OpenAPI spec by a CI ratchet.

Endpoints

Live OpenAPI 3.1 spec: GET /api/v1

Method	Path	Description
GET	/api/v1/scorecard	Get the most recent completed SOVEREIGN scorecard.
GET	/api/v1/roadmap	Get the active phased roadmap with milestones.
GET	/api/v1/risks	Get the risk register.
GET	/api/v1/compliance	Get the active compliance assessment + obligations.
GET	/api/v1/vendor	Get the active vendor portfolio + inventory.
GET	/api/v1/talent	Get the active talent assessment + gaps.
GET	/api/v1/scores	Get assessment score history (up to 24 most recent).
GET	/api/v1/signals	Get the current deterministic signal set (cockpit tiles).

Webhooks

Subscribe an endpoint to receive signed events (X-Vouli-Signature, HMAC-SHA256). Deliveries retry with backoff and dead-letter; replay from the dashboard.

Event	When	Stability
assessment.completed	A maturity assessment finished and a new SOVEREIGN scorecard is available.	stable
verdict.changed	The org’s headline verdict band changed versus the previous assessment.	stable
roadmap.updated	The active roadmap or one of its milestones changed.	stable
risk.created	A new risk was added to the register.	stable
risk.severity_changed	An existing risk’s severity was re-rated.	stable
compliance.posture_changed	The org’s overall compliance posture changed for a regime.	beta
evidence.pack_filed	A compliance evidence pack was assembled and filed with a fresh manifest hash.	beta

Resources

OpenAPI 3.1 spec (JSON)
Postman collection: /vouli-iq.postman_collection.json
Terms · Trust & security