Moov.Representatives (Moov v1.0.0)

Copy Markdown View Source

Manage the controllers and owners of a business account, required for KYB on LLCs, partnerships, and private corporations.

At least one representative must be a controller (has significant management responsibility); every individual with a 25%+ ownership stake must be added as an owner. A single representative can be both.

See https://docs.moov.io/api/moov-accounts/representatives/.

Summary

Functions

Adds a representative to a business account.

Removes a representative from a business account.

Retrieves a single representative.

Lists representatives for a business account.

Functions

create(client, account_id, params)

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

Adds a representative to a business account.

params: :name (:first_name, :last_name, ...), :email, :phone, :address, :birth_date, :government_id, :responsibilities - %{is_controller: true, is_owner: true, ownership_percentage: 40, job_title: "CEO"}.

delete(client, account_id, representative_id)

@spec delete(Moov.Client.t(), String.t(), String.t()) ::
  {:ok, term()} | {:error, Moov.Error.t()}

Removes a representative from a business account.

get(client, account_id, representative_id)

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

Retrieves a single representative.

list(client, account_id, opts \\ [])

@spec list(Moov.Client.t(), String.t(), keyword()) ::
  {:ok, [map()]} | {:error, Moov.Error.t()}

Lists representatives for a business account.

update(client, account_id, representative_id, params)

@spec update(Moov.Client.t(), String.t(), String.t(), map()) ::
  {:ok, map()} | {:error, Moov.Error.t()}

Updates a representative.