PlaidEx.API.Income (plaid_ex v1.0.0)

Copy Markdown View Source

Plaid Income API — employment and income verification.

Summary

Functions

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

Creates an income verification for a user.

get_payroll(config, income_verification_id, opts \\ [])

Returns payroll income data.

get_summary(config, income_verification_id, opts \\ [])

Returns income verification summary.

Functions

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

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

Creates an income verification for a user.

get_payroll(config, income_verification_id, opts \\ [])

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

Returns payroll income data.

get_summary(config, income_verification_id, opts \\ [])

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

Returns income verification summary.