Skip to content
VERITAS CYBER

API reference

The Veritas Cyber v1 API lets you score an Essential Eight self-assessment and generate the document pack from your own systems — for broker platforms, MSP tools, and integrations. It returns an indicative, self-assessed maturity result and documents that carry the standard self-assessment disclaimer; it is not a certification, audit, or insurance-outcome service.

Authentication

Create an API key on your Developer page and send it as a bearer token. Keep it secret — treat it like a password.

Authorization: Bearer vk_live_your_key_here

POST /api/v1/score

Scores a set of answers against a framework (default essential-eight). Stateless — nothing is stored. Rate limited to 60 requests/minute per key.

curl -X POST https://veritas-cyber.com/api/v1/score \
  -H "Authorization: Bearer $VK_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "framework": "essential-eight",
    "answers": [
      { "questionId": "mfa-org-online-services", "value": "yes" },
      { "questionId": "backups-performed", "value": "no" }
    ]
  }'

Returns the scored result:

{
  "result": {
    "frameworkId": "essential-eight",
    "overall": 0,
    "targetLevel": 2,
    "maxLevel": 3,
    "perControl": [ { "control": "mfa", "level": 1, "applicable": true, ... } ]
  }
}

POST /api/v1/documents

Generates one document as a PDF from the answers + an organisation profile. Requires an active subscription on your account (the Privacy Act and AI documents require the Pro plan); calls without one return 402. Rate limited to 20 requests/minute per key. Pass org.brand to white-label the header — the Veritas Cyber attribution and self-assessment disclaimer are always retained.

curl -X POST https://veritas-cyber.com/api/v1/documents \
  -H "Authorization: Bearer $VK_KEY" \
  -H "Content-Type: application/json" \
  -o evidence-pack.pdf \
  -d '{
    "kind": "evidence_pack",
    "org": { "name": "Blue Gum Dental", "industry": "Healthcare", "hasMsOffice": true, "brand": "Acme Brokers" },
    "answers": [ { "questionId": "mfa-org-online-services", "value": "yes" } ]
  }'

Document kinds: evidence_pack, roadmap, information_security_policy, access_control_policy, patch_management_policy, backup_recovery_policy, acceptable_use_policy, incident_response_plan, privacy_reasonable_steps, data_breach_response_plan, data_inventory_starter, ai_use_policy.

Errors

  • 401 — invalid or missing API key.
  • 402 — document generation requires an active subscription (Pro for the Privacy Act / AI documents).
  • 400 — invalid payload (details in the response body).
  • 429 — rate limit exceeded (see the Retry-After header).

Questions

Building an integration? Email hello@veritas-cyber.com.