TreasuryPrime.Kyc (TreasuryPrime v1.0.0)

Triggers and tracks a KYC (Know Your Customer) / KYB (Know Your Business) evaluation for a TreasuryPrime.PersonApplication or TreasuryPrime.BusinessApplication, using one of your bank partner's configured TreasuryPrime.KycProducts (i.e. their chosen identity-verification vendor integration).

Most integrations have KYC run automatically as part of account opening rather than needing to call this directly — check with your bank partner about whether explicit KYC evaluation calls are part of your flow.

Creating an evaluation

{:ok, kyc} =
  TreasuryPrime.Kyc.create(client, %{
    person_application_id: "apsn_01d5w7mvmwvy",
    kyc_product_id: "kycp_..."
  })

Summary

Types

t()

Functions

create(client, params, opts \\ [])

Triggers a KYC/KYB evaluation. Required: either person_application_id or business_application_id.

create!(client, params, opts \\ [])

get(client, id)

Fetches a single KYC evaluation by id.

get!(client, id)

list(client, params \\ %{})

Lists KYC evaluations.

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

Types

t()

@type t() :: %TreasuryPrime.Kyc{
  business_application_id: String.t() | nil,
  created_at: String.t() | nil,
  id: String.t() | nil,
  kyc_product_id: String.t() | nil,
  person_application_id: String.t() | nil,
  provider: String.t() | nil,
  provider_full: map() | nil,
  provider_result: map() | nil,
  status: String.t() | nil,
  updated_at: String.t() | nil,
  userdata: map() | nil
}

Functions

create(client, params, opts \\ [])

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

Triggers a KYC/KYB evaluation. Required: either person_application_id or business_application_id.

create!(client, params, opts \\ [])

@spec create!(TreasuryPrime.Client.t(), map(), keyword()) :: t()

get(client, id)

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

Fetches a single KYC evaluation 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 evaluations.

Filterable params

person_application_id, business_application_id, status.

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

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