Customer onboarding — used by registered Third-Party Providers (TPPs) with
the customer-onboarding:write scope to onboard new customers on
Starling's behalf via the Onboarding API.
This requires elevated, individually-approved access and is not available to standard developer/sandbox accounts without a partnership agreement.
Summary
Functions
Submits a new customer onboarding application. attrs mirrors Starling's onboarding payload schema.
Fetches the status of a previously submitted onboarding application.
Functions
@spec create(map(), StarlingBank.Client.t() | keyword() | nil) :: {:ok, map()} | {:error, StarlingBank.Error.t()}
Submits a new customer onboarding application. attrs mirrors Starling's onboarding payload schema.
@spec status(String.t(), StarlingBank.Client.t() | keyword() | nil) :: {:ok, map()} | {:error, StarlingBank.Error.t()}
Fetches the status of a previously submitted onboarding application.