Solaris.Lending.AccountSnapshots (Solaris v1.0.0)

Copy Markdown View Source

Account snapshots for credit scoring in loan applications.

Account snapshots provide Solaris with a 90-day view of a customer's account history from their primary bank, enabling automated credit scoring decisions.

Flow

  1. Initiate a snapshot session → get a redirect URL
  2. Customer connects their bank via the redirect URL
  3. Receive ACCOUNT_SNAPSHOT_COMPLETED webhook
  4. Link the snapshot to a loan application

Summary

Functions

create(person_id, attrs, opts \\ [])

Creates an account snapshot session.

get(person_id, snapshot_id, opts \\ [])

Retrieves an account snapshot.

list(person_id, opts \\ [])

Lists account snapshots for a person.

Functions

create(person_id, attrs, opts \\ [])

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

Creates an account snapshot session.

Returns a URL to redirect the customer to connect their bank account.

Examples

{:ok, snapshot} = Solaris.Lending.AccountSnapshots.create("cper_123", %{
  redirect_url: "https://yourapp.com/snapshot/callback"
})

redirect_to(snapshot["url"])

get(person_id, snapshot_id, opts \\ [])

@spec get(String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, Solaris.Error.t()}

Retrieves an account snapshot.

list(person_id, opts \\ [])

@spec list(
  String.t(),
  keyword()
) :: {:ok, [map()]} | {:error, Solaris.Error.t()}

Lists account snapshots for a person.