Update entity user

Update one or more fields of an existing Entity user (Control Person, Beneficial Owner, or Board Member). This is a partial update endpoint - only the fields provided in the request body will be updated.

Important notes:

Platform configuration:

  • Your platform must be properly configured before using this endpoint.

PII changes and document requirements:

  • When users are updated with new identifying information (such as first_name, last_name, date_of_birth, or citizenship_code), these changes must be accompanied by supporting documentation.
  • Use the Submit Documents endpoint with the appropriate document type to provide supporting documents.

Compliance field updates:

  • Updating KYC-related fields (sanction_screening, kyc, id_number_type, etc.) may require re-verification depending on your platform configuration.
  • Changes to identity documents or verification status may trigger additional compliance checks.

Vendor reliance track:

  • For platforms using vendor reliance track, sanction_screening and kyc fields must be provided with vendor verification results.
  • sanction_screening_timestamp and kyc_timestamp should be set to the time when the vendor completed the verification (in milliseconds since Unix epoch).

Conditional requirements:

  • If id_number_type is non_us_other, the non_us_other_type field is required to describe the ID type.
  • For non-US citizens or when tax_id is an ITIN (begins with 9), id_number_type and id_number are required.

Response:
Returns the complete user object with all fields, including unchanged fields and system-generated metadata.

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.

string
required

Unique identifier related to the user

Body Params

Updated entity user fields (all fields optional, only send fields to update). Certain fields must be sent together (e.g. first_name + last_name, id_number_type + id_number, tax_id + citizenship_code, kyc + kyc_timestamp, sanction_screening + sanction_screening_timestamp).

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