The canonical, current record for an individual associated with one or
more accounts (as an owner, signer, or authorized user) — created
automatically when their TreasuryPrime.PersonApplication is approved.
Unlike TreasuryPrime.PersonApplication (a point-in-time snapshot taken
at application time), Person reflects current information and can be
updated as it changes (e.g. a new address or phone number).
There is no list/2 for this resource — fetch a person by the
person_id/primary_person_id found on a TreasuryPrime.Account, or by
the id in person_ids.
Summary
Functions
Fetches a single person by id.
Updates a person's current information (e.g. phone_number, physical_address, mailing_address, email).
Types
@type t() :: %TreasuryPrime.Person{ account_ids: [String.t()] | nil, address: map() | nil, bankdata: map() | nil, created_at: String.t() | nil, email: String.t() | nil, first_name: String.t() | nil, id: String.t() | nil, last_name: String.t() | nil, mailing_address: map() | nil, middle_name: String.t() | nil, phone_number: String.t() | nil, physical_address: map() | nil, updated_at: String.t() | nil, userdata: map() | nil }
Functions
@spec get(TreasuryPrime.Client.t(), String.t()) :: {:ok, t()} | {:error, TreasuryPrime.Error.t()}
Fetches a single person by id.
@spec get!(TreasuryPrime.Client.t(), String.t()) :: t()
@spec update(TreasuryPrime.Client.t(), String.t(), map()) :: {:ok, t()} | {:error, TreasuryPrime.Error.t()}
Updates a person's current information (e.g. phone_number, physical_address, mailing_address, email).
@spec update!(TreasuryPrime.Client.t(), String.t(), map()) :: t()