Sessions

Get session detail by ID

get/api/v1/sessions/{id}

Request

  • Base URL: https://api.korala.ai
  • URL: https://api.korala.ai/api/v1/sessions/{id}
  • Auth: one of:
    • API key in header X-API-Key
    • bearer (a scheme the document does not define)

Path parameters

idstring required

Headers

X-Korala-Mode'live' | 'test'

Dashboard JWT: live (default) or test. API keys are pinned to their credential mode. Mode cannot be changed after creation.

Response

originContextIdstring nullable

Registered originating risk context; null when none was linked. This association does not determine evidence applicability.

subjectIdstring nullable

Explicitly linked Korala risk subject ID; null for unlinked sessions.

sandboxboolean required

Persisted execution mode: true for test data

idstring required
organizationIdstring required
externalUserIdstring required
subjectKind'individual' | 'business' required
finalManualReviewRequiredboolean required
accessTokenstring required

Access token for end-user access

status'created' | 'in_progress' | 'pending_review' | 'completed' | 'expired' | 'failed' required
resolution'approved' | 'rejected'
resolutionReasonstring nullable
resolvedAtstring date-time nullable
resolvedBystring nullable
riskScorenumber nullable
riskLevel'low' | 'medium' | 'high'
eventVersionnumber required

Grows with each change announced by a session webhook; compare it with the webhook's data.version. The higher number is the newer state; numbers may skip.

metadataobject nullable
contextobject nullable
accumulatedDataobject nullable
expiresAtstring date-time nullable
redirectUrlstring nullable
startedAtstring date-time nullable
completedAtstring date-time nullable
createdAtstring date-time required
updatedAtstring date-time required

Example response

{
  "decision": {
    "rulesVersion": "korala-decisions-v3",
    "reasonCodesVersion": "korala-reasons-v1"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.