Skip to main content

​
Overview

Generate and manage compliance reports in various formats (PDF, Word, Excel).

​
List Reports

curl -X GET "https://api.conformly.ai/api/v1/reports?workspace_id=uuid&cursor=&limit=20" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

{
  "items": [
    {
      "id": "uuid",
      "name": "Compliance Snapshot - 2025-09-17",
      "generated_at": "2025-09-17T12:00:00Z",
      "status": "completed",
      "format": "pdf",
      "size_mb": 2.1,
      "standards": ["ISO 26262", "ISO 21434", "ASPICE"],
      "work_products": 12,
      "compliance_score": 85,
      "gaps": 5
    }
  ],
  "next_cursor": null
}

​
Create Report

curl -X POST "https://api.conformly.ai/api/v1/reports?name=Report&format=pdf&standards=uuid1&standards=uuid2&workspace_id=uuid&scope={\"type\":\"all\"}" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

{
  "job_id": "uuid",
  "status": "queued"
}

​
Get Report Details

curl -X GET "https://api.conformly.ai/api/v1/reports/{id}" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

{
  "id": "uuid",
  "name": "Compliance Snapshot - 2025-09-17",
  "generated_at": "2025-09-17T12:00:00Z",
  "status": "completed",
  "format": "pdf",
  "size_mb": 2.1,
  "download_url": "https://signed-url",
  "standards": ["ISO 26262", "ISO 21434"],
  "compliance_score": 85,
  "gaps": 5
}

​
Download Report

curl -X GET "https://api.conformly.ai/api/v1/reports/{id}/download" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -o report.pdf

​
Export Gap Analysis (HTML/PDF/JSON/CSV)

Exports persisted gaps with severity counts and summary. Filter by analysis_id to export a single run. 
curl -X GET "https://api.conformly.ai/api/v1/export/{workspace_id}/gaps?format=html&analysis_id=analysis-uuid" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

{
  "export_type": "gap_analysis",
  "workspace_id": "uuid",
  "severity_counts": { "critical": 0, "high": 3, "medium": 5, "low": 2 },
  "gaps": []
}
Tip: HTML export is optimized for browser “Print to PDF”. The generated document includes section breaks and a “Prioritized Action Plan” table to drive remediation.

​
Export Traceability (HTML/PDF/JSON/CSV)

Exports traceability artifacts, links, and detected gaps. 
curl -X GET "https://api.conformly.ai/api/v1/export/{workspace_id}/traceability?format=html" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"