Skip to main content
GET
/
partner
/
incorporation
/
{incorporationId}
Get an incorporation
curl --request GET \
  --url https://api.prod.commenda.io/api/v1/partner/incorporation/{incorporationId} \
  --header 'x-api-key: <api-key>'
{
  "incorporation": {
    "id": "0f9a8f5e-7f7c-4c1b-a60a-b1022f9d8c91",
    "customerId": 77,
    "country": "SG",
    "countryOptions": {
      "corporationType": "PRIVATE_LIMITED_COMPANY"
    },
    "createdAt": "2026-04-21T17:10:00.000Z",
    "updatedAt": "2026-04-21T17:10:00.000Z",
    "businessEntityId": 44
  },
  "incorporationValidation": {
    "isComplete": false,
    "missingRequirements": [
      {
        "code": "PARTICIPANT_DOCUMENT_REQUIRED",
        "path": "participants.participant_123.documents.PASSPORT_SCAN",
        "message": "Participant participant_123 requires a PASSPORT_SCAN document",
        "participantId": "participant_123",
        "displayName": "Jane Founder"
      }
    ],
    "invalidRequirements": [
      {
        "code": "PARTICIPANT_DOCUMENT_REQUIRED",
        "path": "participants.participant_123.documents.PASSPORT_SCAN",
        "message": "Participant participant_123 requires a PASSPORT_SCAN document",
        "participantId": "participant_123",
        "displayName": "Jane Founder"
      }
    ]
  },
  "intakeState": {
    "id": "state_123",
    "incorporationId": "0f9a8f5e-7f7c-4c1b-a60a-b1022f9d8c91",
    "currentState": {
      "companyNameOptions": [
        {
          "name": "Acme SG Pte Ltd"
        },
        {
          "name": "Acme Asia Pte Ltd"
        },
        {
          "name": "Acme Global Pte Ltd"
        }
      ],
      "registeredOfficeAddressSource": "commendaService"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "participants": [
    {
      "id": "participant_123",
      "participantType": "INDIVIDUAL",
      "resource": {
        "resourceType": "KEY_PERSON",
        "resourceId": 12
      },
      "roles": [
        {
          "role": "DIRECTOR"
        },
        {
          "role": "SHAREHOLDER",
          "ownershipPercentage": 100
        }
      ],
      "documents": [
        {
          "documentId": "document_123",
          "participantId": "participant_123",
          "documentKind": "PASSPORT_SCAN",
          "fileId": 456,
          "status": "SUBMITTED"
        },
        {
          "documentId": "document_124",
          "participantId": "participant_123",
          "documentKind": "UTILITY_BILL",
          "fileId": 789,
          "status": "SUBMITTED"
        }
      ]
    }
  ],
  "requirements": {
    "schemaVersion": "2026-04-22",
    "dslVersion": "mvp-2026-04-22",
    "key": "sg.private_limited_company",
    "country": "SG",
    "countryOptions": {
      "corporationType": "PRIVATE_LIMITED_COMPANY"
    },
    "name": "Singapore Private Limited Company Incorporation Requirements",
    "blocks": [
      {
        "key": "companyNames",
        "name": "Company name options"
      }
    ],
    "participantRequirements": [
      {
        "key": "directors",
        "name": "Directors",
        "role": "DIRECTOR",
        "allowedParticipantTypes": [
          "INDIVIDUAL"
        ],
        "allowedResourceTypes": [
          "KEY_PERSON"
        ],
        "resourceFieldsByParticipantType": {
          "INDIVIDUAL": [
            {
              "kind": "resource",
              "key": "residentialAddress",
              "name": "Residential address",
              "description": "The key person's current residential address. Store this on the Commenda OS person as residentialAddress.",
              "required": true,
              "resourceKind": "address",
              "commendaOs": {
                "entity": "keyPerson",
                "field": "residentialAddress"
              },
              "fields": [
                {
                  "kind": "scalar",
                  "key": "addressLine1",
                  "name": "Address line 1",
                  "required": true,
                  "commendaOs": {
                    "entity": "keyPerson",
                    "field": "residentialAddress.addressLine1"
                  }
                },
                {
                  "kind": "scalar",
                  "key": "city",
                  "name": "City",
                  "required": true,
                  "commendaOs": {
                    "entity": "keyPerson",
                    "field": "residentialAddress.city"
                  }
                },
                {
                  "kind": "scalar",
                  "key": "country",
                  "name": "Country",
                  "required": true,
                  "commendaOs": {
                    "entity": "keyPerson",
                    "field": "residentialAddress.country"
                  }
                }
              ]
            }
          ]
        },
        "documentRequirements": [
          {
            "documentKind": "PASSPORT_SCAN",
            "name": "Passport scan"
          },
          {
            "documentKind": "UTILITY_BILL",
            "name": "Utility bill"
          }
        ]
      }
    ]
  }
}
Retrieves an incorporation for one of your customers. Use this endpoint to refresh the latest intakeState, participants, and top-level incorporationStatus for an ongoing incorporation. incorporationValidation.isComplete tells you whether the current state is eligible to submit. SUBMITTED or IN_PROGRESS is returned only after POST /partner/incorporation/{incorporationId}/submit succeeds for a currently complete incorporation. Use Get incorporation status for stage-level progress and blocking issue ids. Use List incorporation issues to track active or resolved correction requests.

​
Incorporation status

incorporationStatus can be one of:
StatusMeaning
AWAITING_CUSTOMER_INPUTRequired intake information, participant roles, or documents are still missing or invalid, or the current state is complete but has not been submitted for review.
SUBMITTEDThe incorporation was explicitly submitted and currently validates against the incorporation requirements, 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 has been completed.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
incorporationId
string
required

Incorporation identifier returned by create or list endpoints.

Response

Incorporation retrieved successfully

​
incorporation
object
required
​
incorporationValidation
object
required
​
intakeState
object
required

Current intake state for the incorporation. Always returned; an empty intake state is initialized automatically when one does not yet exist.

​
participants
object[]
required

Participants registered to this incorporation, when requested or available.

​
requirements
object

Requirements schema for the selected incorporation. Clients can use this to render their own intake UI, but intake updates are always validated against the current server-side incorporation requirements.

Example:
{
  "schemaVersion": "2026-04-22",
  "dslVersion": "mvp-2026-04-22",
  "key": "sg.private_limited_company",
  "country": "SG",
  "countryOptions": {
    "corporationType": "PRIVATE_LIMITED_COMPANY"
  },
  "name": "Singapore Private Limited Company Incorporation Requirements",
  "blocks": [
    {
      "key": "companyNames",
      "name": "Company name options"
    }
  ],
  "participantRequirements": [
    {
      "key": "directors",
      "name": "Directors",
      "role": "DIRECTOR",
      "allowedParticipantTypes": ["INDIVIDUAL"],
      "allowedResourceTypes": ["KEY_PERSON"],
      "resourceFieldsByParticipantType": {
        "INDIVIDUAL": [
          {
            "kind": "resource",
            "key": "residentialAddress",
            "name": "Residential address",
            "description": "The key person's current residential address. Store this on the Commenda OS person as residentialAddress.",
            "required": true,
            "resourceKind": "address",
            "commendaOs": {
              "entity": "keyPerson",
              "field": "residentialAddress"
            },
            "fields": [
              {
                "kind": "scalar",
                "key": "addressLine1",
                "name": "Address line 1",
                "required": true,
                "commendaOs": {
                  "entity": "keyPerson",
                  "field": "residentialAddress.addressLine1"
                }
              },
              {
                "kind": "scalar",
                "key": "city",
                "name": "City",
                "required": true,
                "commendaOs": {
                  "entity": "keyPerson",
                  "field": "residentialAddress.city"
                }
              },
              {
                "kind": "scalar",
                "key": "country",
                "name": "Country",
                "required": true,
                "commendaOs": {
                  "entity": "keyPerson",
                  "field": "residentialAddress.country"
                }
              }
            ]
          }
        ]
      },
      "documentRequirements": [
        {
          "documentKind": "PASSPORT_SCAN",
          "name": "Passport scan"
        },
        {
          "documentKind": "UTILITY_BILL",
          "name": "Utility bill"
        }
      ]
    }
  ]
}