TreasuryPrime.AdditionalPersonApplication (TreasuryPrime v1.0.0)

Adds a new owner, signer, or authorized user to an already open account (as opposed to person_applications passed at TreasuryPrime.AccountApplication.create/3 time, which is for people added during initial account opening).

Creating one

{:ok, additional_person_app} =
  TreasuryPrime.AdditionalPersonApplication.create(client, %{
    person_application_id: "apsn_01d5w7mvmwvy",
    role: "owner"
  })

Summary

Types

t()

Functions

create(client, params, opts \\ [])

Adds a person (already represented by a TreasuryPrime.PersonApplication) to an existing account. Required: person_application_id, role ("owner" | "signer" | "authorized_user", etc., per your bank partner's configuration), and an account_id to attach to (or the account is inferred for some flows — check your specific integration).

create!(client, params, opts \\ [])

get(client, id)

Fetches a single additional person application by id.

get!(client, id)

list(client, params \\ %{})

Lists additional person applications.

list!(client, params \\ %{})

Types

t()

@type t() :: %TreasuryPrime.AdditionalPersonApplication{
  account_id: String.t() | nil,
  bankdata: map() | nil,
  created_at: String.t() | nil,
  id: String.t() | nil,
  person_application_id: String.t() | nil,
  role: String.t() | nil,
  status: String.t() | nil,
  updated_at: String.t() | nil,
  userdata: map() | nil
}

Functions

create(client, params, opts \\ [])

@spec create(TreasuryPrime.Client.t(), map(), keyword()) ::
  {:ok, t()} | {:error, TreasuryPrime.Error.t()}

Adds a person (already represented by a TreasuryPrime.PersonApplication) to an existing account. Required: person_application_id, role ("owner" | "signer" | "authorized_user", etc., per your bank partner's configuration), and an account_id to attach to (or the account is inferred for some flows — check your specific integration).

create!(client, params, opts \\ [])

@spec create!(TreasuryPrime.Client.t(), map(), keyword()) :: t()

get(client, id)

@spec get(TreasuryPrime.Client.t(), String.t()) ::
  {:ok, t()} | {:error, TreasuryPrime.Error.t()}

Fetches a single additional person application by id.

get!(client, id)

@spec get!(TreasuryPrime.Client.t(), String.t()) :: t()

list(client, params \\ %{})

@spec list(TreasuryPrime.Client.t(), map()) ::
  {:ok, TreasuryPrime.Page.t()} | {:error, TreasuryPrime.Error.t()}

Lists additional person applications.

Filterable params

account_id, role, status.

list!(client, params \\ %{})

@spec list!(TreasuryPrime.Client.t(), map()) :: TreasuryPrime.Page.t()