> ## 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.

# Types & Enums

> Reference for all enum values and nested types used in Klara API responses

This page documents all enum values and nested types returned by the Klara API. Use this as a reference when parsing API responses.

## Application status

Returned on the `status` field of applications.

| Value         | Description                                     |
| ------------- | ----------------------------------------------- |
| `created`     | Application created but invite not yet sent     |
| `sent`        | Invite email sent to primary contact            |
| `in_progress` | End user has started filling in the application |
| `submitted`   | End user has submitted all requested items      |
| `review`      | Application is under manual review              |
| `approved`    | Application approved by admin                   |
| `rejected`    | Application rejected by admin                   |

## Document status

Returned on the `status` field of documents.

| Value                  | Description                                      |
| ---------------------- | ------------------------------------------------ |
| `pending`              | Document uploaded, awaiting validation           |
| `validating`           | AI validation in progress                        |
| `accepted`             | Document passed validation                       |
| `rejected`             | Document failed validation                       |
| `clarification_needed` | Additional information requested from the user   |
| `forced`               | Document manually accepted by an admin           |
| `skipped`              | Document requirement manually waived by an admin |

## Person source

Returned on the `source` field of people in `data.people`.

| Value              | Description                                                                              |
| ------------------ | ---------------------------------------------------------------------------------------- |
| `registry`         | Person was auto-populated from a company registry (e.g., Companies House)                |
| `user_added`       | Person was manually added by the end user                                                |
| `contact_fallback` | Person was created from the primary contact when no directors were found in the registry |

## Person roles

Returned on the `roles` array of people in `data.people`. A person can have multiple roles.

| Value         | Description                                          |
| ------------- | ---------------------------------------------------- |
| `director`    | Company director                                     |
| `ubo`         | Ultimate beneficial owner (typically 25%+ ownership) |
| `shareholder` | Shareholder of the company                           |

## Entity type

Returned on the `type` field of entities in `data.entities`.

| Value             | Description                                  |
| ----------------- | -------------------------------------------- |
| `holding_company` | A holding company in the ownership structure |
| `subsidiary`      | A subsidiary entity                          |
| `parent`          | A parent entity                              |
| `other`           | Other related entity                         |

## Entity source

Returned on the `source` field of entities in `data.entities`.

| Value        | Description                                       |
| ------------ | ------------------------------------------------- |
| `registry`   | Entity was auto-populated from a company registry |
| `user_added` | Entity was manually added by the end user         |

## Participant role

Returned on the `role` field of participants.

| Value          | Description                                                                 |
| -------------- | --------------------------------------------------------------------------- |
| `primary`      | The main contact responsible for the application                            |
| `collaborator` | An additional participant invited to help complete parts of the application |

## Acceptance reason

Returned on the `acceptance_reason` field of documents.

| Value                     | Description                                        |
| ------------------------- | -------------------------------------------------- |
| `validation_passed`       | The document passed AI validation                  |
| `no_validator_configured` | No validation is configured for this document type |
| `baseline_passed`         | The document passed baseline checks                |

## Registry document type \[#registry-document-type]

Returned on the `document_type` field of `registry_documents` (see [Get Application](/api-reference/get-application)). These are Companies House filing types.

| Value    | Description                                               |
| -------- | --------------------------------------------------------- |
| `NEWINC` | Certificate of incorporation                              |
| `AA`     | Annual accounts                                           |
| `CS01`   | Confirmation statement                                    |
| `CERTNM` | Certificate of change of name (one entry per name change) |
| `MA`     | Memorandum & articles of association                      |

## Registry documents status

Returned on the top-level `registry_documents_status` field of an application.

| Value      | Description                                      |
| ---------- | ------------------------------------------------ |
| `pending`  | Retrieval from the registry is still in progress |
| `complete` | All available filings were retrieved             |
| `partial`  | Some filings could not be retrieved              |
| `failed`   | Retrieval failed                                 |

## Ownership relationship \[#ownership-relationship]

Returned in the `data.ownership` array.

| Field                 | Type                                  | Description                                                       |
| --------------------- | ------------------------------------- | ----------------------------------------------------------------- |
| `id`                  | `string`                              | Unique identifier                                                 |
| `owner_type`          | `"person"` \| `"entity"` \| `"other"` | What type of entity is the owner                                  |
| `owner_id`            | `string \| undefined`                 | ID of the person or entity. Absent when `owner_type` is `"other"` |
| `other_description`   | `string \| undefined`                 | Description when owner is "other" (e.g., "Public shareholders")   |
| `country`             | `string \| undefined`                 | Country/jurisdiction for entity owners (ISO 3166-1 alpha-2)       |
| `registration_number` | `string \| undefined`                 | Company registration number for entity owners                     |
| `owned_type`          | `"target"` \| `"entity"`              | Whether this is ownership of the target company or another entity |
| `owned_id`            | `string \| undefined`                 | ID of the owned entity. Absent when owning the target company     |
| `percentage`          | `number`                              | Ownership percentage                                              |
| `is_direct`           | `boolean`                             | Whether this is direct or indirect ownership                      |
| `is_nominee`          | `boolean`                             | Whether this is a nominee arrangement                             |
| `beneficial_owner_id` | `string \| undefined`                 | If nominee, the ID of the actual beneficial owner                 |

## Webhook event types

See [Webhooks](/webhooks) for full payload examples.

| Event                   | Description                                   |
| ----------------------- | --------------------------------------------- |
| `application.opened`    | End user opened the portal for the first time |
| `application.submitted` | End user submitted the application            |
| `webhook.test`          | Manual test ping from the dashboard           |