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

# Get incorporation status

> Retrieve the current public status projection for an incorporation, including top-level status, ordered stages, and active blocking issue ids.

Retrieves the current public status projection for an incorporation.

Use this endpoint for progress views after an incorporation is created. It returns the top-level `incorporationStatus`, the workflow version used for the incorporation, ordered stages, and any active issues blocking the incorporation.

## Stage fields

Each item in `stages` has these fields:

| Field               | Type           | Meaning                                                                  |
| ------------------- | -------------- | ------------------------------------------------------------------------ |
| `id`                | string         | Stable stage identifier. Use this as the React key for a stage row/card. |
| `label`             | string         | Human-readable stage label.                                              |
| `description`       | string         | Human-readable explanation of the stage.                                 |
| `owner`             | string         | Party expected to own the work: `PARTNER`, `CUSTOMER`, or `COMMENDA`.    |
| `position`          | integer        | One-based display order.                                                 |
| `status`            | string         | Current stage progress.                                                  |
| `startedAt`         | string or null | When work in this stage first started.                                   |
| `completedAt`       | string or null | When this stage completed, or `null` if it is not complete.              |
| `blockedByIssueIds` | string\[]      | Active issue ids blocking this stage.                                    |

## Example

```bash theme={null}
curl --request GET \
  --url 'https://api.prod.commenda.io/api/v1/partner/incorporation/0f9a8f5e-7f7c-4c1b-a60a-b1022f9d8c91/status' \
  --header 'x-api-key: <partner_api_key>'
```

```json theme={null}
{
  "incorporationStatus": "BLOCKED",
  "incorporationId": "0f9a8f5e-7f7c-4c1b-a60a-b1022f9d8c91",
  "customerId": 77,
  "country": "SG",
  "countryOptions": {
    "corporationType": "PRIVATE_LIMITED_COMPANY"
  },
  "statusWorkflow": {
    "schemaVersion": "2026-04-26",
    "definitionVersion": "1.0.0",
    "key": "singapore-incorporation-partner-api"
  },
  "blockingIssueIds": ["issue_123"],
  "blockingIssueCount": 1,
  "stages": [
    {
      "id": "intake",
      "label": "Intake",
      "description": "Collect required incorporation information and documents.",
      "owner": "PARTNER",
      "position": 1,
      "status": "COMPLETED",
      "startedAt": "2026-04-26T18:10:00.000Z",
      "completedAt": "2026-04-26T18:30:00.000Z",
      "blockedByIssueIds": []
    },
    {
      "id": "kyc",
      "label": "KYC",
      "description": "Review required identity, ownership, and compliance materials.",
      "owner": "COMMENDA",
      "position": 2,
      "status": "BLOCKED",
      "startedAt": "2026-04-26T19:05:00.000Z",
      "completedAt": null,
      "blockedByIssueIds": ["issue_123"]
    }
  ],
  "updatedAt": "2026-04-26T19:15:00.000Z"
}
```

## Top-level status

| Status                    | Meaning                                                                                                                                 |
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `AWAITING_CUSTOMER_INPUT` | Required intake information, participant roles, or documents are missing or invalid, or the complete intake has not been submitted yet. |
| `SUBMITTED`               | The incorporation was submitted and still validates, but Commenda review has not started yet.                                           |
| `IN_PROGRESS`             | Commenda review is in progress.                                                                                                         |
| `BLOCKED`                 | The incorporation has active partner-visible issues or review start/runtime failures.                                                   |
| `COMPLETED`               | The incorporation is complete.                                                                                                          |

## Stage status

| Status        | Meaning                                                                   |
| ------------- | ------------------------------------------------------------------------- |
| `NOT_STARTED` | The stage has not started.                                                |
| `IN_PROGRESS` | At least one task in the stage has started and the stage is not complete. |
| `BLOCKED`     | The stage is blocked by active issue ids or failed review work.           |
| `COMPLETED`   | The stage is complete.                                                    |

Active issues are listed in `blockingIssueIds`. If an issue has a `scope.stageId`, that issue appears on the matching stage's `blockedByIssueIds`; otherwise it blocks the first non-completed stage.


## OpenAPI

````yaml GET /partner/incorporation/{incorporationId}/status
openapi: 3.0.1
info:
  title: Commenda Public APIs
  description: >-
    APIs for Commenda entity management, partner incorporation, indirect tax,
    compliance, and corporate operations.
  license:
    name: NONE
    url: NONE
  version: 1.0.0
servers:
  - url: https://api.prod.commenda.io/api/v1
    description: Commenda platform APIs, including Partner Incorporation and Commenda OS.
  - url: https://transaction-tax.api.in.commenda.io/api/v1
    description: Global Indirect Tax API.
security:
  - bearerAuth: []
paths:
  /partner/incorporation/{incorporationId}/status:
    get:
      summary: Get incorporation status
      description: >-
        Retrieve the current public status projection for an incorporation,
        including top-level status, ordered stages, and active blocking issue
        ids.
      operationId: getPartnerIncorporationStatus
      parameters:
        - name: incorporationId
          in: path
          required: true
          schema:
            type: string
          description: Incorporation identifier returned by create or list endpoints.
      responses:
        '200':
          description: Incorporation status retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerIncorporationStatusResponse'
        '401':
          description: Missing or invalid partner API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AffiliatePublicError'
        '403':
          description: Incorporation is not accessible to the partner
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AffiliatePublicError'
        '404':
          description: Incorporation not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AffiliatePublicError'
      security:
        - xApiKeyAuth: []
      servers:
        - url: https://api.prod.commenda.io/api/v1
components:
  schemas:
    PartnerIncorporationStatusResponse:
      type: object
      required:
        - incorporationStatus
        - incorporationId
        - customerId
        - country
        - countryOptions
        - statusWorkflow
        - blockingIssueIds
        - blockingIssueCount
        - stages
        - updatedAt
      properties:
        incorporationStatus:
          $ref: '#/components/schemas/PartnerIncorporationStatus'
        incorporationId:
          type: string
          example: 0f9a8f5e-7f7c-4c1b-a60a-b1022f9d8c91
        customerId:
          type: integer
          example: 77
        country:
          $ref: '#/components/schemas/PartnerIncorporationCountry'
        countryOptions:
          $ref: '#/components/schemas/PartnerIncorporationCountryOptions'
        statusWorkflow:
          $ref: '#/components/schemas/PartnerIncorporationStatusWorkflowSummary'
        blockingIssueIds:
          type: array
          description: >-
            Active partner-visible issue ids currently blocking the
            incorporation.
          items:
            type: string
          example:
            - issue_123
        blockingIssueCount:
          type: integer
          example: 1
        stages:
          type: array
          items:
            $ref: '#/components/schemas/PartnerIncorporationStatusStage'
        updatedAt:
          type: string
          format: date-time
          example: '2026-04-26T19:15:00.000Z'
    AffiliatePublicError:
      type: object
      required:
        - statusCode
        - message
        - error
      properties:
        statusCode:
          type: integer
          example: 403
        message:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
          example: Company does not belong to this affiliate firm
        error:
          type: string
          example: Forbidden
    PartnerIncorporationStatus:
      type: string
      description: Current top-level lifecycle status for the incorporation.
      enum:
        - AWAITING_CUSTOMER_INPUT
        - SUBMITTED
        - IN_PROGRESS
        - BLOCKED
        - COMPLETED
    PartnerIncorporationCountry:
      type: string
      description: ISO 3166-1 alpha-2 country code for the incorporation jurisdiction.
      example: SG
      enum:
        - AE
        - CA
        - GB
        - IE
        - IN
        - KY
        - NZ
        - SG
        - US
    PartnerIncorporationCountryOptions:
      type: object
      description: >-
        Country-specific incorporation options. Use the jurisdiction catalog for
        the currently supported fields and values.
      additionalProperties: true
      example:
        corporationType: PRIVATE_LIMITED_COMPANY
    PartnerIncorporationStatusWorkflowSummary:
      type: object
      required:
        - schemaVersion
        - definitionVersion
        - key
      properties:
        schemaVersion:
          type: string
          example: '2026-04-26'
        definitionVersion:
          type: string
          example: 1.0.0
        key:
          type: string
          example: singapore-incorporation-partner-api
    PartnerIncorporationStatusStage:
      type: object
      required:
        - id
        - label
        - description
        - owner
        - position
        - status
        - startedAt
        - completedAt
        - blockedByIssueIds
      properties:
        id:
          type: string
          description: >-
            Stable stage identifier. Issue scopes reference this value as
            `scope.stageId`.
          example: kyc
        label:
          type: string
          description: Human-readable stage label.
          example: KYC
        description:
          type: string
          description: Human-readable explanation of the stage.
          example: Review required identity, ownership, and compliance materials.
        owner:
          $ref: '#/components/schemas/PartnerIncorporationStatusStageOwner'
        position:
          type: integer
          description: One-based display order.
          example: 2
        status:
          $ref: '#/components/schemas/PartnerIncorporationStageStatus'
        startedAt:
          type: string
          format: date-time
          nullable: true
          example: '2026-04-26T19:05:00.000Z'
        completedAt:
          type: string
          format: date-time
          nullable: true
          example: null
        blockedByIssueIds:
          type: array
          description: Active issue ids blocking this stage.
          items:
            type: string
          example:
            - issue_123
    PartnerIncorporationStatusStageOwner:
      type: string
      description: Party expected to own work in a public status stage.
      enum:
        - PARTNER
        - CUSTOMER
        - COMMENDA
    PartnerIncorporationStageStatus:
      type: string
      description: Public progress status for one incorporation workflow stage.
      enum:
        - NOT_STARTED
        - IN_PROGRESS
        - BLOCKED
        - COMPLETED
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    xApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````