TreasuryPrime.KycProduct (TreasuryPrime v1.0.0)

Copy Markdown View Source

KYC products represent the identity-verification vendor integration(s) your bank partner has configured (e.g. a specific KYC/KYB provider with specific evaluation rules). Read-only — pass a kyc_product_id from here to TreasuryPrime.Kyc.create/3.

Summary

Types

t()

Functions

get(client, id)

Fetches a single KYC product by id.

get!(client, id)
list(client, params \\ %{})

Lists KYC products available to your organization.

list!(client, params \\ %{})

Types

t()

@type t() :: %TreasuryPrime.KycProduct{
  created_at: String.t() | nil,
  id: String.t() | nil,
  name: String.t() | nil,
  provider: String.t() | nil,
  status: String.t() | nil,
  updated_at: String.t() | nil
}

Functions

get(client, id)

@spec get(TreasuryPrime.Client.t(), String.t()) ::
  {:ok, t()} | {:error, TreasuryPrime.Error.t()}

Fetches a single KYC product by id.

get!(client, id)

@spec get!(TreasuryPrime.Client.t(), String.t()) :: t()

list(client, params \\ %{})

@spec list(TreasuryPrime.Client.t(), map()) ::
  {:ok, TreasuryPrime.Page.t()} | {:error, TreasuryPrime.Error.t()}

Lists KYC products available to your organization.

list!(client, params \\ %{})

@spec list!(TreasuryPrime.Client.t(), map()) :: TreasuryPrime.Page.t()