PlaidEx.API.IdentityVerification (plaid_ex v1.0.0)

Copy Markdown View Source

Plaid Identity Verification (IDV) API — KYC/AML identity verification.

Summary

Functions

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

Creates an Identity Verification session.

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

Retrieves an Identity Verification session.

list(config, opts \\ [])

Lists Identity Verification sessions for a user.

retry(config, params, opts \\ [])

Retries an Identity Verification session.

Functions

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

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

Creates an Identity Verification session.

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

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

Retrieves an Identity Verification session.

list(config, opts \\ [])

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

Lists Identity Verification sessions for a user.

retry(config, params, opts \\ [])

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

Retries an Identity Verification session.