Plaid.Identity (elixir_plaid v0.1.4) View Source

Plaid Identity API calls and schema.

Link to this section Summary

Types

t()

Functions

get(access_token, options \\ %{}, config)

Get information about all available accounts.

Link to this section Types

t()

Specs

t() :: %Plaid.Identity{
  addresses: [Plaid.Identity.Address.t()],
  emails: [Plaid.Identity.Email.t()],
  names: [String.t()],
  phone_numbers: [Plaid.Identity.PhoneNumber.t()]
}

Link to this section Functions

get(access_token, options \\ %{}, config)

Specs

get(String.t(), options, Plaid.config()) ::
  {:ok, Plaid.Accounts.GetResponse.t()} | {:error, Plaid.Error.t()}
when options: %{optional(:account_ids) => [String.t()]}

Get information about all available accounts.

Does a POST /identity/get call to retrieve account information, along with the owners info for each account associated with an access_token's item.

Params:

access_token - Token to fetch identity for.

Options:

account_ids - Specific account ids to fetch identity for.

Examples

get("access-sandbox-123xxx", client_id: "123", secret: "abc")
{:ok, %Plaid.Accounts.GetResponse{}}