Upsert investment entity

Create an Investment Entity if none exists with the given Tracking ID, or update the existing one otherwise.

This is an idempotent operation: calling it twice with the same payload results in the same end state. Safe to retry on network failure, or to replay as part of a scheduled sync from your CRM or source system.

Matching rule

The Investment Entity is matched by the trackingId you supply in the request body. trackingId is required — requests without a trackingId are rejected with a 400 Bad Request. Use the regular Create Investment Entity endpoint if you want to create an entity without a Tracking ID.

Response

The response always includes the full Investment Entity object plus a result field:

  • "result": "created" — no match was found, a new Investment Entity was created under the supplied clientId.
  • "result": "updated" — an existing Investment Entity was found and its fields were updated.

Field semantics

FieldCreateUpdate
trackingIdRequired (match key).Required (match key).
nameRequired.Replace if present; omit = unchanged.
clientIdRequired.Ignored — use the dedicated move endpoint to reassign the entity to a different client.
type, jurisdiction, amlKycStatusOptional.Replace if present (empty string clears); omit = unchanged.
riskLevelOptional.Replace if present (empty string is ignored — riskLevel cannot be cleared via this endpoint; use the dedicated update endpoint). Setting a new value auto-creates a risk-assessment record (audit trail), same as the regular update endpoint.
noteOptional.Replace if present; omit = unchanged.

Validation errors return 400 Bad Request with the offending field name.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of the Firm object

Body Params
string

Anduin ID or Tracking ID of the parent client.
Required when creating a new investment entity. Ignored when updating an existing entity — use the move endpoint to reassign an entity to a different client.

string
required

Customer-supplied Tracking ID used to match an existing Investment Entity.
If an entity with this Tracking ID already exists in the firm, it will be updated.
Otherwise, a new entity will be created with this Tracking ID. Required.

string

Required when creating a new Investment Entity. On update, omit to leave the name unchanged.

string
string
string
string
string
Responses

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