@spec create_subscription(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Subscribe a customer or business to monitoring — This endpoint is rarely needed. Since August 2022, watchlist monitoring is automatically enabled for all businesses and customers who are verified (KYC/KYB) through Synctera's platform.

Options

• :body — request body (map), required.
• :idempotency_key — see Synctera.Idempotency.
• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec create_subscription!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like create_subscription/2 but returns the value directly and raises on error.

@spec delete_subscription(Synctera.Client.t(), String.t(), keyword()) ::
  {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Delete monitoring subscription

Options

• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec delete_subscription!(Synctera.Client.t(), String.t(), keyword()) ::
  Synctera.JSON.json()

Like delete_subscription/3 but returns the value directly and raises on error.

@spec get_alert(Synctera.Client.t(), String.t(), keyword()) ::
  {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Retrieve a monitoring alert

Options

• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec get_alert!(Synctera.Client.t(), String.t(), keyword()) :: Synctera.JSON.json()

Like get_alert/3 but returns the value directly and raises on error.

@spec get_subscription(Synctera.Client.t(), String.t(), keyword()) ::
  {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Retrieve monitoring subscription

Options

• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec get_subscription!(Synctera.Client.t(), String.t(), keyword()) ::
  Synctera.JSON.json()

Like get_subscription/3 but returns the value directly and raises on error.

@spec list_alerts(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

List monitoring alerts

Options

Query options: :id, :person_id, :business_id, :limit, :page_token

• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec list_alerts!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like list_alerts/2 but returns the value directly and raises on error.

@spec list_subscriptions(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

List monitoring subscriptions

Options

Query options: :id, :person_id, :business_id, :limit, :page_token

• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec list_subscriptions!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like list_subscriptions/2 but returns the value directly and raises on error.

@spec update_alert(Synctera.Client.t(), String.t(), keyword()) ::
  {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Update a monitoring alert

Options

• :body — request body (map), required.
• :idempotency_key — see Synctera.Idempotency.
• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec update_alert!(Synctera.Client.t(), String.t(), keyword()) ::
  Synctera.JSON.json()

Like update_alert/3 but returns the value directly and raises on error.