> ## Documentation Index
> Fetch the complete documentation index at: https://docs.klara-ai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Overview

> Technical overview of the Klara Partner API

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:

| Environment    | Base URL                                    | Purpose                 |
| -------------- | ------------------------------------------- | ----------------------- |
| **Sandbox**    | `https://sandbox.klara-ai.com/api/external` | Testing and development |
| **Production** | `https://app.klara-ai.com/api/external`     | Live integrations       |

<Tip>
  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](https://sandbox.klara-ai.com).
</Tip>

<Note>
  Sandbox data may be periodically reset. Do not use sandbox for production workloads.
</Note>

## Authentication

Include your API key in the `Authorization` header:

```bash theme={null}
Authorization: Bearer klara_{client_id}.{secret}
```

See [Authentication](/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:

```json theme={null}
{
  "error": "primary_contact.email is required"
}
```

Retryable errors (e.g., a temporary registry outage) additionally include `"retryable": true`.

## Available endpoints

<Card icon="plus" href="/api-reference/create-application" title="POST /applications">
  Create a new application and receive a submission link.
</Card>

<Card icon="rotate" href="/api-reference/refresh-pre-auth" title="POST /applications/{id}/pre-auth">
  Refresh the pre-auth code for an existing application.
</Card>

<Card icon="list" href="/api-reference/list-applications" title="GET /applications">
  List applications for your organization with pagination.
</Card>

<Card icon="file" href="/api-reference/get-application" title="GET /applications/{id}">
  Get full application detail including all collected data.
</Card>

<Card icon="pen" href="/api-reference/update-application" title="PATCH /applications/{id}">
  Update form field values on an application from your own system.
</Card>

<Card icon="download" href="/api-reference/download-document" title="GET /applications/{id}/documents/{docId}">
  Get a presigned download URL for a specific document.
</Card>

<Card icon="gavel" href="/api-reference/record-decision" title="POST /applications/{id}/decision">
  Record a provider's approval, rejection, or referral decision.
</Card>

<Card icon="table-list" href="/api-reference/field-catalog" title="GET /applications/{id}/fields">
  Discover the field IDs, types, and allowed option values for an application.
</Card>

<Card icon="book" href="/api-reference/types" title="Types & Enums">
  Reference for all enum values and nested types in API responses.
</Card>

<Card icon="bell" href="/webhooks" title="Webhooks">
  Receive real-time notifications when events occur in your applications.
</Card>