Sign in
Beneficial Owners

Create beneficial owner

Changed on

Creates a new beneficial owner linking a corporate AccountHolder to a LegalEntity.

The account_holder_id must reference an existing AccountHolder in the same tenant. The legal_entity_id must reference an existing LegalEntity in the same tenant. Each (account_holder_id, legal_entity_id) pair must be unique.

post/api/beneficial-owners

Request

  • Base URL: http://localhost:4100
  • URL: http://localhost:4100/api/beneficial-owners
  • Auth: none required

Request body

account_holder_idstring uuid required
beneficial_owner_numberstring nullable
chain_screeningboolean

When true (default), enqueues a compliance screening job after creation. Set to false to skip.

control_type'shareholder' | 'director' | 'officer' | 'trustee' required
external_idstring nullable
ownership_pctnumber nullable
tenant_idstring uuid
verification_status'pending' | 'verified' | 'failed' nullable

Example request

{
  "account_holder_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "beneficial_owner_number": "",
  "chain_screening": false,
  "control_type": "shareholder",
  "external_id": "",
  "legal_entity": null,
  "ownership_pct": 0,
  "tenant_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "verification_status": "pending"
}

Changes

  • e99ccd17df53Revision changes
    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the new optional request property