Skip to main content
GET
/
partner
/
incorporation
/
{incorporationId}
/
status
Get incorporation status
curl --request GET \
  --url https://api.prod.commenda.io/api/v1/partner/incorporation/{incorporationId}/status \
  --header 'x-api-key: <api-key>'
{
  "incorporationStatus": "AWAITING_CUSTOMER_INPUT",
  "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": "kyc",
      "label": "KYC",
      "description": "Review required identity, ownership, and compliance materials.",
      "owner": "PARTNER",
      "position": 2,
      "status": "NOT_STARTED",
      "startedAt": "2026-04-26T19:05:00.000Z",
      "completedAt": null,
      "blockedByIssueIds": [
        "issue_123"
      ]
    }
  ],
  "updatedAt": "2026-04-26T19:15:00.000Z"
}

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.

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:
FieldTypeMeaning
idstringStable stage identifier. Use this as the React key for a stage row/card.
labelstringHuman-readable stage label.
descriptionstringHuman-readable explanation of the stage.
ownerstringParty expected to own the work: PARTNER, CUSTOMER, or COMMENDA.
positionintegerOne-based display order.
statusstringCurrent stage progress.
startedAtstring or nullWhen work in this stage first started.
completedAtstring or nullWhen this stage completed, or null if it is not complete.
blockedByIssueIdsstring[]Active issue ids blocking this stage.

​
Example

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>'

{
  "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

StatusMeaning
AWAITING_CUSTOMER_INPUTRequired intake information, participant roles, or documents are missing or invalid, or the complete intake has not been submitted yet.
SUBMITTEDThe incorporation was submitted and still validates, but Commenda review has not started yet.
IN_PROGRESSCommenda review is in progress.
BLOCKEDThe incorporation has active partner-visible issues or review start/runtime failures.
COMPLETEDThe incorporation is complete.

​
Stage status

StatusMeaning
NOT_STARTEDThe stage has not started.
IN_PROGRESSAt least one task in the stage has started and the stage is not complete.
BLOCKEDThe stage is blocked by active issue ids or failed review work.
COMPLETEDThe 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.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
incorporationId
string
required

Incorporation identifier returned by create or list endpoints.

Response

Incorporation status retrieved successfully

​
incorporationStatus
enum<string>
required

Current top-level lifecycle status for the incorporation.

Available options:
AWAITING_CUSTOMER_INPUT,
SUBMITTED,
IN_PROGRESS,
BLOCKED,
COMPLETED
​
incorporationId
string
required
Example:

"0f9a8f5e-7f7c-4c1b-a60a-b1022f9d8c91"

​
customerId
integer
required
Example:

77

​
country
enum<string>
required

ISO 3166-1 alpha-2 country code for the incorporation jurisdiction.

Available options:
AE,
CA,
GB,
IE,
IN,
KY,
NZ,
SG,
US
Example:

"SG"

​
countryOptions
object
required

Country-specific incorporation options. Use the jurisdiction catalog for the currently supported fields and values.

Example:
{
  "corporationType": "PRIVATE_LIMITED_COMPANY"
}
​
statusWorkflow
object
required
​
blockingIssueIds
string[]
required

Active partner-visible issue ids currently blocking the incorporation.

Example:
["issue_123"]
​
blockingIssueCount
integer
required
Example:

1

​
stages
object[]
required
​
updatedAt
string<date-time>
required
Example:

"2026-04-26T19:15:00.000Z"