Skip to main content
GET
/
partner
/
incorporation
/
status-workflow
Get incorporation status workflow
curl --request GET \
  --url https://api.prod.commenda.io/api/v1/partner/incorporation/status-workflow \
  --header 'x-api-key: <api-key>'
{
  "statusWorkflow": {
    "schemaVersion": "2026-04-26",
    "definitionVersion": "1.0.0",
    "key": "singapore-incorporation-partner-api",
    "country": "SG",
    "countryOptions": {
      "corporationType": "PRIVATE_LIMITED_COMPANY"
    },
    "name": "Singapore Private Limited Company Incorporation",
    "description": "Track the public progress of a Singapore private limited company incorporation.",
    "stages": [
      {
        "id": "kyc",
        "label": "KYC",
        "description": "Review required identity, ownership, and compliance materials.",
        "owner": "partner",
        "position": 2
      }
    ]
  }
}
Retrieves the public status workflow for a selected incorporation jurisdiction and type. Use this endpoint after the customer chooses country and countryOptions if you want to render a progress UI before the incorporation is created. The response is derived from Commenda’s active workflow template for that selection, with a synthetic intake stage added first. The workflow is informational and versioned. Case progress is returned by Get incorporation status.

​
Query shape

Use the same deep-object query syntax as the requirements endpoint. 
curl --request GET \
  --url 'https://api.prod.commenda.io/api/v1/partner/incorporation/status-workflow?country=SG&countryOptions[corporationType]=PRIVATE_LIMITED_COMPANY' \
  --header 'x-api-key: <partner_api_key>'

​
Response

{
  "statusWorkflow": {
    "schemaVersion": "2026-04-26",
    "definitionVersion": "1.0.0",
    "key": "singapore-incorporation-partner-api",
    "country": "SG",
    "countryOptions": {
      "corporationType": "PRIVATE_LIMITED_COMPANY"
    },
    "name": "Singapore Private Limited Company Incorporation",
    "description": "Track the public progress of a Singapore private limited company incorporation.",
    "stages": [
      {
        "id": "intake",
        "label": "Intake",
        "description": "Collect required incorporation information and documents.",
        "owner": "partner",
        "position": 1
      },
      {
        "id": "kyc",
        "label": "KYC",
        "description": "Review required identity, ownership, and compliance materials.",
        "owner": "commenda",
        "position": 2
      }
    ]
  }
}

​
Stage owners

OwnerMeaning
partnerThe partner integration or partner team owns the stage.
customerThe end customer must provide input.
commendaCommenda owns the stage.
If the status workflow is not active for the selected incorporation type, the endpoint returns 404.

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
country
enum<string>
required

Incorporation country. 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 options using deep-object query syntax, for example countryOptions[corporationType]=PRIVATE_LIMITED_COMPANY. Country-specific incorporation options. Use the jurisdiction catalog for the currently supported fields and values.

Example:
{
  "corporationType": "PRIVATE_LIMITED_COMPANY"
}

Response

Status workflow retrieved successfully

​
statusWorkflow
object
required