Specs

get(String.t(), options, Plaid.config()) ::
  {:ok, Plaid.Identity.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

Examples

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

Perform an identity check match.

Does a POST /identity/match call to retrieve match scores and account metadata for each connected account.

params

Params:

• access_token - Plaid access token.

options

Options:

• user - User details for identity check match.

examples

Examples

Identity.match("access-sandbox-123xxx", %{
  user: %Match.User{
    legal_name: "full legal name",
    phone_number: "123-456-7890",
    email_address: "email@address.com",
    address: %Match.User.Address{
      street: "123 Main St",
      city: "New York",
      region: "NY",
      postal_code: "10001",
      country: "US"
    }
  }
}, client_id: "123", secret: "abc")
{:ok, %Identity.MatchResponse{}}