Skip to main content
The Klara API is a RESTful API that allows partners to programmatically create and manage onboarding applications.

​
Environments

Klara provides two environments for API access:
Use the sandbox environment to test your integration before going live. Sandbox and production use separate API keys—generate sandbox keys from the sandbox dashboard.
Sandbox data may be periodically reset. Do not use sandbox for production workloads.

​
Authentication

Include your API key in the Authorization header:
See Authentication for details on obtaining and managing API keys.

​
Request format

  • All request bodies must be JSON
  • Set the Content-Type: application/json header

​
Response format

Successful responses return JSON with the requested data. Error responses include an error field with details:
Retryable errors (e.g., a temporary registry outage) additionally include "retryable": true.

​
Available endpoints

POST /applications

Create a new application and receive a submission link.

POST /applications/{id}/pre-auth

Refresh the pre-auth code for an existing application.

GET /applications

List applications for your organization with pagination.

GET /applications/{id}

Get full application detail including all collected data.

PATCH /applications/{id}

Update form field values on an application from your own system.

GET /applications/{id}/documents/{docId}

Get a presigned download URL for a specific document.

POST /applications/{id}/decision

Record a provider’s approval, rejection, or referral decision.

GET /applications/{id}/fields

Discover the field IDs, types, and allowed option values for an application.

Types & Enums

Reference for all enum values and nested types in API responses.

Webhooks

Receive real-time notifications when events occur in your applications.