id as {incorporationId} for participant, document, intake, status, issue, and submit endpoints.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Field reference for the top-level Partner Incorporation API record.
id as {incorporationId} for participant, document, intake, status, issue, and submit endpoints.
| Attribute | Type | Description |
|---|---|---|
id | string | Unique incorporation identifier. Use this value as {incorporationId}. |
customerId | integer | Customer that owns the incorporation. This is not the legal entity being incorporated. |
country | string | ISO 3166-1 alpha-2 jurisdiction code for the incorporation. |
countryOptions | object | Country-specific incorporation selections. The shape depends on country; use the jurisdiction catalog to discover supported keys and values. |
incorporationStatus | string | Top-level lifecycle status for the incorporation. |
businessEntityId | integer or null | Target Commenda OS business entity id for the entity being incorporated. Corporate shareholder business entity ids are separate participant resource ids. |
createdAt | string | ISO timestamp for when the incorporation was created. |
updatedAt | string | ISO timestamp for when the incorporation was last updated. |
| Value | Meaning |
|---|---|
AWAITING_CUSTOMER_INPUT | Required intake information, participant roles, or documents are missing or invalid, or the current state is complete but has not been submitted for review. |
SUBMITTED | The incorporation was explicitly submitted and currently validates against the incorporation requirements, but workflow work has not started yet. |
IN_PROGRESS | Commenda is actively processing the incorporation through the dedicated workflow. |
BLOCKED | The incorporation has active partner-visible issues or workflow start/runtime failures. |
COMPLETED | The incorporation has been completed. |
| Field | Description |
|---|---|
requirements | Current incorporation requirements for the selected jurisdiction and options. |
incorporationValidation | Current validation result for the full incorporation. |
intakeState | Current submitted incorporation-level intake values. Always returned; an empty intake state is initialized automatically when one does not yet exist. |
participants | Participants registered to this incorporation, when requested or available. |
| Action | Endpoint |
|---|---|
| Create | Create an incorporation |
| List | List incorporations |
| Retrieve | Get an incorporation |
| Submit | Submit an incorporation |
| Read status | Get incorporation status |
| Read issues | List incorporation issues |
Was this page helpful?