Skip to main content
GET
/
partner
/
incorporation
/
{incorporationId}
/
participants
List incorporation participants
curl --request GET \
  --url https://api.prod.commenda.io/api/v1/partner/incorporation/{incorporationId}/participants \
  --header 'x-api-key: <api-key>'
{
  "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"
        }
      ]
    }
  ],
  "count": 1
}
Lists participants registered to an incorporation. Use this endpoint to inspect the reusable Commenda OS resources attached to the incorporation, their director/shareholder roles, and any participant documents. The same participant can hold multiple roles. For example, one individual can be both a director and a 100% shareholder.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
incorporationId
string
required

Incorporation identifier returned by create or list endpoints.

Response

Participants retrieved successfully

​
participants
object[]
required
​
count
integer
required

Number of participants returned.

Example:

1