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

# Intake state object

> Field reference for the current incorporation intake values.

The intake state object represents the latest merged incorporation-level intake data for one incorporation.

The intake state is not a submission history. Each intake update merges new values into `currentState`, and Commenda revalidates the resulting incorporation state against the current requirements.

## Attributes

| Attribute         | Type   | Description                                                                                                                                                |
| ----------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`              | string | Unique identifier for this intake state record.                                                                                                            |
| `incorporationId` | string | Incorporation this intake state belongs to. Same value used as `{incorporationId}` in intake, participant, document, status, issue, and submit endpoints.  |
| `currentState`    | object | Latest partner-submitted incorporation-level requirement values. Keys vary by the current requirements for the selected country and incorporation options. |
| `createdAt`       | string | ISO timestamp for when the intake state record was created.                                                                                                |
| `updatedAt`       | string | ISO timestamp for when the intake state record was last updated.                                                                                           |

## Current state values

`currentState` contains the merged requirement values submitted through [Update incorporation intake](/engine/incorporation/partner-incorporation-intake-PATCH). The top-level `currentState` property is always returned, but the values inside it are requirements-driven.

When writing intake data, send requirement values under the `requirements` request property. When reading intake state, Commenda returns those same requirement keys under `currentState`.

For example, an incorporation type that requires company name options and a registered office address may use these paths:

| Example read path                              | Matching write path                            | Description                                                                                                    |
| ---------------------------------------------- | ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `currentState.companyNameOptions`              | `requirements.companyNameOptions`              | Preferred legal names for the company being incorporated.                                                      |
| `currentState.registeredOfficeAddressSource`   | `requirements.registeredOfficeAddressSource`   | How the registered office address should be satisfied, such as `commendaService` or `partnerProvidedLocation`. |
| `currentState.registeredOfficeAddressLocation` | `requirements.registeredOfficeAddressLocation` | Commenda OS location reference used when the registered office address source is `partnerProvidedLocation`.    |

Fetch [Get incorporation requirements](/engine/incorporation/partner-incorporation-requirements-GET) to see the fields for the selected incorporation type. Because updates are merge-based, `currentState` can contain previously submitted values that are no longer applicable after later choices. Treat `incorporationValidation` as the source of truth for whether the current incorporation can be submitted.

## Endpoints

| Action                     | Endpoint                                                                                   |
| -------------------------- | ------------------------------------------------------------------------------------------ |
| Create with initial intake | [Create an incorporation](/engine/incorporation/partner-incorporation-incorporations-POST) |
| Update intake              | [Update incorporation intake](/engine/incorporation/partner-incorporation-intake-PATCH)    |
| Retrieve current state     | [Get an incorporation](/engine/incorporation/partner-incorporation-incorporations-id-GET)  |
| Read validation            | [Get incorporation validation](/engine/incorporation/partner-incorporation-validation-GET) |
| Submit when complete       | [Submit an incorporation](/engine/incorporation/partner-incorporation-submit-POST)         |