Update Entity

patch

https://bo-api.drivewealth.io/back-office/entities/{entityId}

Updates a Entity.

Path Params

entityId

string

required

Unique ID of the Entity to update.

Body Params

Request body for a partial update (PATCH) of an entity. All fields are optional — include only the top-level fields you want to change, and each is applied independently of the others. When a top-level object (for example attributes or contact) is provided, its own required sub-fields still apply.

ibID

string

The unique identifier of the firm.

type

string

enum

The type of the entity.

Allowed:

subType

string

enum

The subtype of the entity. Required for 'CORPORATION', 'LLC', and 'PARTNERSHIP'; optional for 'TRUST'. Valid values by type — CORPORATION: S_CORPORATION, C_CORPORATION; LLC: LLC_SINGLE_MEMBER, LLC_C_CORPORATION, LLC_S_CORPORATION, LLC_PARTNERSHIP; PARTNERSHIP: PARTNERSHIP_GENERAL, PARTNERSHIP_LIMITED; TRUST: SMSF.

attributes

object

identifications

object

contact

object

metadata

object

Additional metadata for the entity.

kyb

object

disclosures

object

investorProfile

object

financialAffiliations

array of strings

List of financial affiliations.

financialAffiliations

industryClassification

object

Industry classification details.

Responses

400

Bad Request - Invalid input.

401

Unauthorized - Authentication failed.

403

Forbidden - You do not have permission to access this resource.

404

Not Found - The requested resource was not found.

500

Internal Server Error - An unexpected error occurred.

200Updating a Entity was Successful.