Packages

plaid_elixir

2.2.0
3.4.0 3.3.0 3.2.0 3.1.0 3.0.0 2.5.0 2.4.0 2.3.0 2.2.0 2.1.0 2.0.0 1.9.1 1.9.0 1.8.1 1.8.0 1.7.4 1.7.3 1.7.2 1.7.1 1.7.0 1.6.0 1.5.2 1.5.1 1.5.0 1.4.1 1.4.0 1.3.2 1.3.1 1.3.0 1.2.0 1.1.6 1.1.5 1.1.4 1.1.3 1.1.2 1.1.1 1.1.0 1.0.0 0.3.0 0.2.0 0.1.0

An Elixir Library for Plaid's V2 API

HexDocs

Current section

Files

Jump to
Readme
41 Versions
3 Dependencies
Dependants
Files
Activity
plaid_elixir lib plaid identity.ex
Raw

lib/plaid/identity.ex 

defmodule Plaid.Identity do

  @moduledoc """

  Functions for Plaid `identity` endpoint.

  """



  import Plaid, only: [make_request_with_cred: 4, validate_cred: 1]



  alias Plaid.Utils



  @derive Jason.Encoder

  defstruct accounts: [], item: nil, request_id: nil



  @type t :: %__MODULE__{

          accounts: [Plaid.Accounts.Account.t()],

          item: Plaid.Item.t(),

          request_id: String.t()

        }

  @type params :: %{

          required(:access_token) => String.t()

        }

  @type config :: %{required(atom) => String.t()}



  @endpoint :identity



  @doc """

  Gets identity data associated with an Item.



  Parameters

  ```

  %{

    access_token: "access-env-identifier"

  }

  ```

  """

  @spec get(params, config | nil) :: {:ok, Plaid.Identity.t()} | {:error, Plaid.Error.t()}

  def get(params, config \\ %{}) do

    config = validate_cred(config)

    endpoint = "#{@endpoint}/get"



    :post

    |> make_request_with_cred(endpoint, config, params)

    |> Utils.handle_resp(@endpoint)

  end

end