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.
The incorporationValidation object represents validation for the full incorporation: incorporation-level intake fields, participants, ownership totals, participant resources, and participant documents.
Use incorporationValidation to decide whether the incorporation is ready to submit. It is returned by incorporation read/write endpoints and can be refreshed directly with Get incorporation validation.
Attributes
| Attribute | Type | Description |
|---|
isComplete | boolean | true when the current incorporation state satisfies the current requirements and is eligible to submit for review. This does not submit the incorporation by itself. |
missingRequirements | array | Required fields, participants, ownership totals, participant resource fields, or participant documents that have not been provided yet. |
invalidRequirements | array | Submitted values that do not satisfy the current requirements. |
incorporationValidation.isComplete is true, call Submit an incorporation to hand the incorporation to Commenda for review.
Validation issues
Each item in missingRequirements and invalidRequirements has the same shape.
| Attribute | Type | Description |
|---|
code | string | Stable machine-readable validation issue code. |
path | string | Dot/bracket path for the missing or invalid requirement. Values depend on the current requirements and participant ids, such as companyNames.companyNameOptions or participants.participant_123.documents.PASSPORT_SCAN. |
message | string | Human-readable explanation of what is missing or invalid. |
participantId | string | Present when the issue belongs to a participant. |
documentKind | string | Present when the issue belongs to a participant document. |
displayName | string | Present when Commenda can provide a useful label for the affected person, business entity, or field. |
Endpoints
| Action | Endpoint |
|---|
| Read current validation | Get incorporation validation |
| Update intake and validate | Update incorporation intake |
| Register participant and validate | Register an incorporation participant |
| Update participant and validate | Update an incorporation participant |
| Upsert document and validate | Upsert a participant document |
| Retrieve incorporation with validation | Get an incorporation |
