PlaidEx.API.Assets (plaid_ex v1.0.0)

Copy Markdown View Source

Plaid Assets API — generate Asset Reports for income verification.

Summary

Functions

create(config, access_tokens, days_requested, opts \\ [])

Creates an Asset Report asynchronously.

create_audit_copy(config, asset_report_token, auditor_id, opts \\ [])

Creates an Audit Copy of an Asset Report for sharing with a third party.

filter(config, asset_report_token, account_ids_to_exclude, opts \\ [])

Filters an Asset Report to include only specified account IDs.

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

Retrieves a completed Asset Report.

get_pdf(config, asset_report_token, opts \\ [])

Retrieves an Asset Report in PDF format.

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

Removes an Asset Report.

Functions

create(config, access_tokens, days_requested, opts \\ [])

@spec create(PlaidEx.Config.t(), [String.t()], integer(), keyword()) ::
  {:ok, %{asset_report_token: String.t()}} | {:error, PlaidEx.Error.t()}

Creates an Asset Report asynchronously.

create_audit_copy(config, asset_report_token, auditor_id, opts \\ [])

@spec create_audit_copy(PlaidEx.Config.t(), String.t(), String.t(), keyword()) ::
  {:ok, %{audit_copy_token: String.t()}} | {:error, PlaidEx.Error.t()}

Creates an Audit Copy of an Asset Report for sharing with a third party.

filter(config, asset_report_token, account_ids_to_exclude, opts \\ [])

@spec filter(PlaidEx.Config.t(), String.t(), [String.t()], keyword()) ::
  {:ok, %{asset_report_token: String.t()}} | {:error, PlaidEx.Error.t()}

Filters an Asset Report to include only specified account IDs.

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

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

Retrieves a completed Asset Report.

get_pdf(config, asset_report_token, opts \\ [])

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

Retrieves an Asset Report in PDF format.

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

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

Removes an Asset Report.