Session Configurations

Create a session configuration

post/api/v1/session-configurations

Request

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

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.

Request body

namestring required
slugstring required
descriptionstring
workflowSlugsstring[]

Ordered array of workflow slugs

subjectKind'individual' | 'business'
isVerificationboolean

Enable resolution (approved/rejected)

autoResolveboolean

Auto-resolve based on validation results

finalManualReviewRequiredboolean

Require explicit partner approval or decline after workflow completion

defaultExpiresInMinutesnumber

Default session expiration in minutes

resubmissionMinimumWindowMinutesinteger

Minutes the person has at least, before the session expires, whenever their work resumes: every resubmission (automatic or requested, a reopen included) and every release of a session from pending_review back to in_progress (a review approval, or an async check that finishes, with workflows still to run) moves expiresAt to now plus this window when that is later, never earlier. Read each time, so a change applies to sessions already under way. 0 never extends: with expiresAt already passed, a resubmit, reopen or review approval that would resume the session is refused with 409 (reason: session_expired). A session with no expiry, or that has expired, is unchanged.

defaultRedirectUrlstring

Default redirect URL after session completion

Example request

{
  "name": "KYC Standard",
  "slug": "kyc-standard",
  "description": "Identity document + proof of address",
  "workflowSlugs": [
    "id-document",
    "proof-of-address"
  ]
}

Response

sandboxboolean required

Persisted execution mode: true for test data

idstring required
organizationIdstring required
namestring required
slugstring required
descriptionstring nullable
workflowSlugsstring[] required
subjectKind'individual' | 'business' required
isVerificationboolean required
autoResolveboolean required
finalManualReviewRequiredboolean required
defaultExpiresInMinutesnumber nullable
resubmissionMinimumWindowMinutesinteger required

Minutes the person has at least, before the session expires, whenever their work resumes: every resubmission (automatic or requested, a reopen included) and every release of a session from pending_review back to in_progress (a review approval, or an async check that finishes, with workflows still to run) moves expiresAt to now plus this window when that is later, never earlier. Read each time, so a change applies to sessions already under way. 0 never extends: with expiresAt already passed, a resubmit, reopen or review approval that would resume the session is refused with 409 (reason: session_expired). A session with no expiry, or that has expired, is unchanged.

defaultRedirectUrlstring nullable
isActiveboolean required
createdAtstring date-time required
updatedAtstring date-time required

Changes

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