Skip to content

Document template · generic.it.vulnerability_assessment

Vulnerability Assessment

  • Render-verified
  • Informational
  • Version 1.0.0

Quarterly or monthly external/internal vulnerability scan summary. Counts by severity plus a prioritised remediation table for the top findings.

JSON Schema

Fields in this template

Data sent to the API is validated against the template’s JSON Schema before anything is rendered. This template defines 30 fields:

Field Required Type Description
entity Required string
scan_period Required object
scan_period.start Required date
scan_period.end Required date
scope Required object
scope.assets_in_scope Required array of string
methodology Required object
methodology.tool_used Required string
methodology.authenticated_scan Required boolean
methodology.frequency Required string
summary_counts Required object
summary_counts.critical Required integer
summary_counts.high Required integer
summary_counts.medium Required integer
summary_counts.low Required integer
top_findings Required array of object
top_findings[].cve_or_id Required string
top_findings[].title Required string
top_findings[].severity Required enum
top_findings[].affected_assets Required array of string
top_findings[].cvss_score Optional number
top_findings[].recommended_fix Required string
top_findings[].owner Required string
top_findings[].target_date Required date
top_findings[].status Required enum
remediation_trend Optional string
next_scan_date Optional date
author Required object
author.name Required string
author.title Required string

POST /render

Generate it

One POST /render call: send your JSON, get the finished PDF back. Or skip the JSON entirely and describe the document in plain language on chut.app.

curl
curl -X POST https://api.papii.eu/render \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "template": "generic.it.vulnerability_assessment",
    "data": { ... },
    "options": {"language": "en"}
  }' -o vulnerability-assessment.pdf

Frequently asked questions

What is “Vulnerability Assessment”?

Quarterly or monthly external/internal vulnerability scan summary. Counts by severity plus a prioritised remediation table for the top findings. On papii this document is available as template generic.it.vulnerability_assessment: a JSON Schema plus a deterministic PDF renderer, so the same data always produces the same document.

Can I generate a Vulnerability Assessment with AI?

Yes. chut.app — the AI back office papii powers — fills this template from a plain-language description: you describe the document in one sentence, the AI structures the data, papii validates it against the schema and renders the PDF. Developers can also call the papii API directly with structured JSON.

Is the Vulnerability Assessment template legally compliant?

This template is render-verified: its schema, sample data and PDF output are automatically tested on every release. It is published with status “ready”, meaning it has not yet been through papii’s final legal review. Where it references specific legislation, that is stated in the template description — always have a professional check documents with legal effect before relying on them.