PlaidEx.API.Beacon (plaid_ex v1.0.0)

Copy Markdown View Source

Plaid Beacon API — fraud and risk intelligence network.

Summary

Functions

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

Creates a Beacon Report (fraud report).

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

Creates a Beacon User.

get_user(config, beacon_user_id, opts \\ [])

Retrieves a Beacon User.

list_reports(config, beacon_user_id, opts \\ [])

Lists all Beacon Reports for a user.

review_user(config, beacon_user_id, status, opts \\ [])

Reviews a Beacon User (approve / reject).

Functions

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

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

Creates a Beacon Report (fraud report).

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

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

Creates a Beacon User.

get_user(config, beacon_user_id, opts \\ [])

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

Retrieves a Beacon User.

list_reports(config, beacon_user_id, opts \\ [])

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

Lists all Beacon Reports for a user.

review_user(config, beacon_user_id, status, opts \\ [])

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

Reviews a Beacon User (approve / reject).