Update entity customer

Update an entity customer affiliated with your platform. Your platform must be configured for this endpoint before use.

This is a partial update — send only the fields you want to change. All fields are optional except submitter_email, which identifies the caller.

💡 Use the Examples dropdown on the request body below to see common update scenarios (tax info, mailing address, adding people, W-8BEN-E / W-9 certification, and more).

Adding vs. updating associated persons

  • Sending control_persons or beneficial_owners here adds new persons to the entity — it does not modify existing ones.
  • To update a person already attached to the entity (Control Person, Beneficial Owner, or Board Member), call PATCH /participants/entity/{participant_code}/users/USER_CODE (PatchUserBody) with that person’s user_code.
  • Board members cannot be added or changed here — they are only accepted at creation time via POST /participants/entity/new.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^[A-Z0-9]{6}$

Unique participant identifier. Always 6 uppercase alphanumeric characters.

Body Params

Entity fields to update. All fields are optional except submitter_email; send only what you want to change.

Sending control_persons / beneficial_owners adds new associated persons — use PATCH /participants/entity/{participant_code}/users/USER_CODE (PatchUserBody) to update existing ones.

Headers
string
required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

string
required

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json