KodexakodéxaShieldAPI Reference
https://shield.kodexa.systems/apiPortal →
Reporting Layer

SAR-AI

Coming soon

Automatically draft Suspicious Activity Reports from flagged cases. Pre-fills all required fields per jurisdiction format — FINTRAC STR, goAML STR, or SAMA SAR.

This plugin is in development. The API schema below is planned and subject to change. You can design your integration now using this reference.

Endpoint

POST/api/sar/draft

Request parameters

ParameterTypeRequiredDescription
case_idstringYesReview queue case ID from Shield dashboard.
jurisdictionstringYesOne of: CA, AE, SA. Determines report format.
reporter_namestringYesName of the reporting compliance officer.
additional_notesstringNoAdditional context to include in the report.

Response fields

ParameterTypeRequiredDescription
data.report_idstringYesUnique report reference.
data.report_formatstringYesfintrac_str, goaml_str, or sama_sar.
data.report_contentobjectYesPre-filled report fields ready for submission.
data.pdf_urlstringNoURL to download the formatted PDF report.

cURL

# Coming soon
curl -X POST \
  https://shield.kodexa.systems/api/sar/draft \
  -H "Content-Type: application/json" \
  -d '{...}'

Code examples available when plugin launches