Skip to main content
PATCH
/
partner
/
incorporation
/
{incorporationId}
/
participants
/
{participantId}
Update an incorporation participant
curl --request PATCH \
  --url https://api.prod.commenda.io/api/v1/partner/incorporation/{incorporationId}/participants/{participantId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "roles": [
    {
      "role": "director"
    },
    {
      "role": "shareholder",
      "ownershipPercentage": 40
    }
  ]
}
'
{
  "participant": {
    "participantId": "participant_123",
    "participantType": "individual",
    "resource": {
      "resourceType": "keyPerson",
      "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"
      }
    ]
  }
}
Replaces the roles for an existing incorporation participant. Use this endpoint when a customer needs to correct director/shareholder roles or shareholder percentages after the participant has already been registered. The underlying Commenda OS resource does not change; this endpoint only updates the participant’s incorporation-specific roles array. Send the full desired roles array. Omitted roles are removed. 
{
  "roles": [
    {
      "role": "director"
    },
    {
      "role": "shareholder",
      "ownershipPercentage": 40
    }
  ]
}
The response shape matches participant registration and list responses. 
{
  "participant": {
    "participantId": "participant_123",
    "participantType": "individual",
    "resource": {
      "resourceType": "keyPerson",
      "resourceId": "12"
    },
    "roles": [
      {
        "role": "director"
      },
      {
        "role": "shareholder",
        "ownershipPercentage": 40
      }
    ],
    "documents": []
  }
}
For Singapore private limited companies, shareholder ownership may not exceed 100 across registered shareholder participants. Updates below 100 are accepted, but incorporation validation remains incomplete until the shareholder total equals 100. If the participant references the wrong person or business entity, register the correct Commenda OS resource as a new participant instead.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
incorporationId
string
required

Incorporation identifier returned by create or list endpoints.

​
participantId
string
required

Incorporation-specific participant identifier returned by register, list, or read endpoints.

Body

application/json

Replaces the roles on an existing incorporation participant. Omitted roles are removed.

​
roles
object[]
required
Minimum array length: 1

Response

Participant updated successfully

​
participant
object
required
Example:
{
  "participantId": "participant_123",
  "participantType": "individual",
  "resource": {
    "resourceType": "keyPerson",
    "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"
    }
  ]
}