TreasuryPrime.Document (TreasuryPrime v1.0.0)

Associates an uploaded TreasuryPrime.File with a person, business, or account application as supporting documentation (e.g. a government ID, articles of incorporation, or a proof-of-address letter) — typically used to satisfy a manual KYC/KYB review request.

Uploading supporting documentation

{:ok, file} = TreasuryPrime.File.upload(client, pdf_binary, "application/pdf")

{:ok, document} =
  TreasuryPrime.Document.create(client, %{
    file_id: file.id,
    person_application_id: "apsn_01d5w7mvmwvy",
    type: "government_id"
  })

Summary

Types

t()

Functions

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

Attaches an uploaded file as a document. Required: file_id, type.

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

get(client, id)

Fetches a single document by id.

get!(client, id)

list(client, params \\ %{})

Lists documents.

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

update(client, id, params)

Updates a document.

update!(client, id, params)

Types

t()

@type t() :: %TreasuryPrime.Document{
  business_application_id: String.t() | nil,
  created_at: String.t() | nil,
  file_id: String.t() | nil,
  id: String.t() | nil,
  person_application_id: String.t() | nil,
  status: String.t() | nil,
  type: 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()}

Attaches an uploaded file as a document. Required: file_id, type.

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 document 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 documents.

Filterable params

person_application_id, business_application_id, type.

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

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

update(client, id, params)

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

Updates a document.

update!(client, id, params)

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