PlaidEx.API.User (plaid_ex v1.0.0)

Copy Markdown View Source

Plaid User API — manage Plaid-hosted user identities.

Summary

Functions

create(config, client_user_id, opts \\ [])

Creates a Plaid-hosted user identity.

get(config, value, opts \\ [])

Retrieves a user by user_token.

update(config, user_token, new_client_user_id, opts \\ [])

Updates a user's client_user_id.

Functions

create(config, client_user_id, opts \\ [])

@spec create(PlaidEx.Config.t(), String.t(), keyword()) ::
  {:ok, %{user_token: String.t(), user_id: String.t()}}
  | {:error, PlaidEx.Error.t()}

Creates a Plaid-hosted user identity.

get(config, value, opts \\ [])

@spec get(PlaidEx.Config.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, PlaidEx.Error.t()}

Retrieves a user by user_token.

update(config, user_token, new_client_user_id, opts \\ [])

@spec update(PlaidEx.Config.t(), String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, PlaidEx.Error.t()}

Updates a user's client_user_id.