Guides
Create an Intake Session
Create a hosted intake session and hand the applicant a signed Klarefi intake URL
Overview
An intake session is the applicant-facing entry point for one case. Create a session when your system knows which workflow should run and who needs to submit answers or documents.
Inputs
A session creation request should include:
- Workflow identifier
- Applicant or case reference from your system
- Optional branding context
- Required callback or return destination
- Metadata your operators need during review
Example Request
POST /api/v1/intake/sessions
Authorization: Bearer sk_live_your_api_key
Content-Type: application/json{
"workflow_id": "wf_claims_motor",
"external_case_id": "claim_48392",
"applicant": {
"email": "applicant@example.com"
},
"metadata": {
"policy_number": "POL-123",
"source_system": "claims_core"
}
}The response contains a hosted URL that can be opened by the applicant. Store the Klarefi session ID alongside your own case identifier.
Operational Guidance
Create sessions from trusted server-side code. Do not build session URLs in the browser. Treat session links as scoped applicant access, and expire or revoke them when the case no longer needs applicant input.