Get incorporation status

curl --request GET \
  --url https://api.prod.commenda.io/api/v1/partner/incorporation/{incorporationId}/status \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.prod.commenda.io/api/v1/partner/incorporation/{incorporationId}/status"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.prod.commenda.io/api/v1/partner/incorporation/{incorporationId}/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.prod.commenda.io/api/v1/partner/incorporation/{incorporationId}/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prod.commenda.io/api/v1/partner/incorporation/{incorporationId}/status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.prod.commenda.io/api/v1/partner/incorporation/{incorporationId}/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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.",
      "position": 2,
      "startedAt": "2026-04-26T19:05:00.000Z",
      "completedAt": null,
      "blockedByIssueIds": [
        "issue_123"
      ]
    }
  ],
  "updatedAt": "2026-04-26T19:15:00.000Z"
}

{
  "statusCode": 403,
  "message": "Company does not belong to this affiliate firm",
  "error": "Forbidden"
}

{
  "statusCode": 403,
  "message": "Company does not belong to this affiliate firm",
  "error": "Forbidden"
}

{
  "statusCode": 403,
  "message": "Company does not belong to this affiliate firm",
  "error": "Forbidden"
}

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

import requests

url = "https://api.prod.commenda.io/api/v1/partner/incorporation/{incorporationId}/status"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.prod.commenda.io/api/v1/partner/incorporation/{incorporationId}/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.prod.commenda.io/api/v1/partner/incorporation/{incorporationId}/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prod.commenda.io/api/v1/partner/incorporation/{incorporationId}/status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.prod.commenda.io/api/v1/partner/incorporation/{incorporationId}/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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.",
      "position": 2,
      "startedAt": "2026-04-26T19:05:00.000Z",
      "completedAt": null,
      "blockedByIssueIds": [
        "issue_123"
      ]
    }
  ],
  "updatedAt": "2026-04-26T19:15:00.000Z"
}

{
  "statusCode": 403,
  "message": "Company does not belong to this affiliate firm",
  "error": "Forbidden"
}

{
  "statusCode": 403,
  "message": "Company does not belong to this affiliate firm",
  "error": "Forbidden"
}

{
  "statusCode": 403,
  "message": "Company does not belong to this affiliate firm",
  "error": "Forbidden"
}

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

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

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.

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

Show child attributes

blockingIssueIds

string[]

required

Active partner-visible issue ids currently blocking the incorporation.

Example:

["issue_123"]

blockingIssueCount

integer

required

Example:

1

stages

object[]

required

Show child attributes

updatedAt

string<date-time>

required

Example:

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

Get status workflow Incorporation object

Overview

Customer setup

Partner Incorporation API

Commenda OS Partner API

Webhooks

Stage fields

Example

Top-level status

Stage status

Authorizations

Path Parameters

Response

​Stage fields

​Example

​Top-level status

​Stage status

Authorizations

Path Parameters

Response

Stage fields

Example

Top-level status

Stage status