PlaidEx.API.Monitor (plaid_ex v1.0.0)

Copy Markdown View Source

Plaid Monitor API — watchlist screening and compliance.

Summary

Functions

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

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

Creates an Entity Screening.

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

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

Creates an Individual Screening.

get_individual_screening(config, watchlist_screening_id, opts \\ [])

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

Retrieves an Individual Screening.

list_individual_screenings(config, opts \\ [])

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

Lists Individual Screenings.