getstarted.ae

Update a participant

PATCHhttps://api.getstarted.ae/v1/incorporations/{incorporationId}/participants/{participantId}

Replaces the participant's roles.

  • roles is replaced whole. Send every role the participant should hold.

Path parameters

  • incorporationIdstringrequired

    ID of the incorporation, e.g. inc_01J9ZK7C3VYB5N.

  • participantIdstringrequired

    ID of the participant, e.g. par_01J9ZKE7LB2H6J.

Body parameters

  • rolesarrayrequired

    The full set of roles the participant should hold.

    • roles[].roleenumrequired

      DIRECTOR, SHAREHOLDER, SECRETARY, MANAGER, UBO or AUTHORISED_SIGNATORY.

    • roles[].ownershipPercentagenumber

      Required for SHAREHOLDER and UBO. 0–100, up to two decimals.

Responses

  • 200OK. Returns the object shown in the example.
  • 400unknown_field The body contains a key the endpoint does not accept.
  • 404resource_not_found No participant with that ID exists in this environment.
  • 409incorporation_locked The incorporation has been submitted.
  • Every endpoint can also return 401 for a missing or invalid key. See Errors.
curl -X PATCH "https://api.getstarted.ae/v1/incorporations/inc_01J9ZK7C3VYB5N/participants/par_01J9ZKE7LB2H6J" \
  -H "Authorization: Bearer $GETSTARTED_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "roles": [
    {
      "role": "DIRECTOR"
    },
    {
      "role": "SHAREHOLDER",
      "ownershipPercentage": 60
    }
  ]
}'
Response · 200
{
  "id": "par_01J9ZKE7LB2H6J",
  "object": "participant",
  "incorporationId": "inc_01J9ZK7C3VYB5N",
  "participantType": "INDIVIDUAL",
  "resource": {
    "resourceType": "PERSON",
    "resourceId": "per_01J9ZKA1M4HD2T"
  },
  "roles": [
    {
      "role": "DIRECTOR"
    },
    {
      "role": "SHAREHOLDER",
      "ownershipPercentage": 60
    }
  ],
  "documents": [
    {
      "documentKind": "PASSPORT_SCAN",
      "fileId": "file_01J9ZKG1DV4K8N",
      "attachedAt": "2026-09-20T08:52:30Z"
    }
  ],
  "createdAt": "2026-09-20T08:45:18Z",
  "updatedAt": "2026-09-20T08:52:30Z"
}