Skip to main content

API Reference

Base URL: https://api.korastratum.com/api/v1

All endpoints require Authorization and X-Tenant-ID headers. See Authentication.

Endpoints

Screening

MethodPathDescription
POST/v1/screeningsCreate a screening (sync or async)
GET/v1/screeningsList screenings
GET/v1/screenings/{screening_id}Get screening result
POST/v1/screenings/batchCreate batch screening
GET/v1/screenings/batch/{batch_id}Get batch screening status
POST/v1/screenings/rescheduleSchedule a rescreen (Coming Soon)

Subjects

MethodPathDescription
POST/v1/subjectsCreate a subject
GET/v1/subjectsList subjects
GET/v1/subjects/{subject_id}Get subject details
PATCH/v1/subjects/{subject_id}Update a subject
GET/v1/subjects/{subject_id}/screeningsGet subject's screenings
GET/v1/subjects/{subject_id}/riskGet subject's risk profile
POST/v1/subjects/{subject_id}/relationshipsAdd a relationship
GET/v1/subjects/{subject_id}/relationshipsList relationships

Case Management

MethodPathDescription
POST/v1/casesCreate a case
GET/v1/casesList cases
GET/v1/cases/{case_id}Get case details
PUT/v1/cases/{case_id}/assignAssign a case
PUT/v1/cases/{case_id}/escalateEscalate a case
POST/v1/cases/{case_id}/activitiesAdd case event
GET/v1/cases/{case_id}/activitiesList case events
POST/v1/cases/{case_id}/attachmentsAdd attachment
GET/v1/cases/{case_id}/attachmentsList attachments
PUT/v1/cases/{case_id}/dispositionSet case disposition
POST/v1/cases/{case_id}/overrideRecord decision override

Transaction Monitoring

MethodPathDescription
POST/v1/monitoring/evaluateEvaluate a transaction
GET/v1/monitoring/alertsList alerts
GET/v1/monitoring/alerts/{alert_id}Get alert details
PUT/v1/monitoring/alerts/{alert_id}/dispositionDispose an alert
GET/v1/monitoring/rulesList monitoring rules
POST/v1/monitoring/rulesCreate a monitoring rule
PUT/v1/monitoring/rules/{rule_id}Update a rule
DELETE/v1/monitoring/rules/{rule_id}Delete a rule

Datasets

MethodPathDescription
GET/v1/datasetsList datasets
GET/v1/datasets/{source}Get dataset details
GET/v1/datasets/{source}/versionsList dataset versions
POST/v1/datasets/{source}/ingestTrigger data ingestion
GET/v1/datasets/entriesSearch entries

Rules & Configuration

MethodPathDescription
GET/v1/rulesetsList rulesets
POST/v1/rulesetsCreate a ruleset
GET/v1/rulesets/{ruleset_id}Get ruleset
GET/v1/rulesets/{ruleset_id}/versionsList ruleset versions
POST/v1/rulesets/{ruleset_id}/versionsCreate ruleset version
PUT/v1/rulesets/{ruleset_id}/versions/{version_id}/activateActivate version
GET/v1/risk-factorsGet risk factors
PUT/v1/risk-factorsUpdate risk factors
GET/v1/risk-bandsGet risk bands
PUT/v1/risk-bandsUpdate risk bands

Reporting

MethodPathDescription
POST/v1/reports/regulatoryGenerate regulatory report
GET/v1/reports/regulatoryList regulatory reports
GET/v1/reports/regulatory/{report_id}Get report
PUT/v1/reports/regulatory/{report_id}/submitSubmit report
GET/v1/reports/screening-summaryGet screening summary
GET/v1/reports/case-summaryGet case summary

Webhooks

MethodPathDescription
POST/v1/webhooks/subscriptionsCreate subscription
GET/v1/webhooks/subscriptionsList subscriptions
GET/v1/webhooks/subscriptions/{subscription_id}Get subscription
PUT/v1/webhooks/subscriptions/{subscription_id}Update subscription
DELETE/v1/webhooks/subscriptions/{subscription_id}Delete subscription
POST/v1/webhooks/subscriptions/{subscription_id}/testSend test event
GET/v1/webhooks/deliveriesList deliveries
POST/v1/webhooks/deliveries/{delivery_id}/retryRetry delivery

Audit

MethodPathDescription
GET/v1/audit/logsQuery audit logs
POST/v1/audit/exportExport audit trail
GET/v1/audit/export/{export_id}Get export status

Health

MethodPathDescription
GET/healthHealth check
GET/readyReadiness check