Skip to main content
GET
/
api
/
export
curl -X GET "https://api.example.com/api/export?scan_id=abc123&format=json" \
  -H "Authorization: Bearer YOUR_TOKEN"

{
  "report": {
    "generated_at": "2026-02-28T10:30:00.000Z",
    "policy": {
      "id": "policy_123",
      "name": "AML Standard Policy"
    },
    "scan": {
      "id": "abc123",
      "score": 85,
      "violation_count": 42,
      "scan_date": "2026-02-27T15:00:00.000Z"
    },
    "violations": [
      {
        "id": "viol_001",
        "rule_id": "AML_HIGH_RISK_COUNTRY",
        "severity": "HIGH",
        "record_id": "rec_456",
        "status": "open",
        "description": "Transaction with high-risk country"
      }
    ],
    "reviews": [
      {
        "violation_id": "viol_002",
        "status": "false_positive",
        "reviewer": "user_789",
        "note": "Verified legitimate transaction",
        "timestamp": "2026-02-28T09:15:00.000Z"
      }
    ],
    "summary": {
      "total_violations": 42,
      "critical_severity": 5,
      "high_severity": 15,
      "medium_severity": 22
    }
  }
}
Exports a comprehensive compliance report for a specific scan or the latest scan. The report includes complete scan metadata, all violations with details, review history, policy information, and summary statistics.

​
Query Parameters

​
scan_id
string
The unique identifier of the scan to export. If not provided, exports the latest scan for the authenticated user.
​
format
string
default:"json"
Export format. Currently only json is supported.

​
Response

​
report
object
The complete compliance report object
​
generated_at
string
ISO 8601 timestamp of when the report was generated
​
policy
object
Policy information associated with the scan
​
id
string
Policy unique identifier
​
name
string
Policy name
​
scan
object
Scan metadata
​
id
string
Scan unique identifier
​
score
number
Compliance score (0-100)
​
violation_count
number
Total number of violations detected
​
scan_date
string
ISO 8601 timestamp of when the scan was created
​
violations
array
Array of all violation objects with complete details including severity, rule_id, record_id, status, and review information
​
reviews
array
Array of review history objects
​
violation_id
string
ID of the reviewed violation
​
status
string
Review status (e.g., approved, false_positive)
​
reviewer
string
ID of the user who reviewed the violation
​
note
string
Optional review note
​
timestamp
string
ISO 8601 timestamp of the review
​
summary
object
Summary statistics for the report
​
total_violations
number
Total number of violations
​
critical_severity
number
Number of critical severity violations
​
high_severity
number
Number of high severity violations
​
medium_severity
number
Number of medium severity violations

​
Error Responses

​
error
string
Error code: NOT_FOUND, UNAUTHORIZED, or INTERNAL_ERROR
​
message
string
Human-readable error message
curl -X GET "https://api.example.com/api/export?scan_id=abc123&format=json" \
  -H "Authorization: Bearer YOUR_TOKEN"

{
  "report": {
    "generated_at": "2026-02-28T10:30:00.000Z",
    "policy": {
      "id": "policy_123",
      "name": "AML Standard Policy"
    },
    "scan": {
      "id": "abc123",
      "score": 85,
      "violation_count": 42,
      "scan_date": "2026-02-27T15:00:00.000Z"
    },
    "violations": [
      {
        "id": "viol_001",
        "rule_id": "AML_HIGH_RISK_COUNTRY",
        "severity": "HIGH",
        "record_id": "rec_456",
        "status": "open",
        "description": "Transaction with high-risk country"
      }
    ],
    "reviews": [
      {
        "violation_id": "viol_002",
        "status": "false_positive",
        "reviewer": "user_789",
        "note": "Verified legitimate transaction",
        "timestamp": "2026-02-28T09:15:00.000Z"
      }
    ],
    "summary": {
      "total_violations": 42,
      "critical_severity": 5,
      "high_severity": 15,
      "medium_severity": 22
    }
  }
}

Build docs developers (and LLMs) love

Get started for freeTalk to us