Moov.OnboardingLinks (Moov v1.0.0)

Hosted, co-branded onboarding forms you can send merchants instead of building your own UI.

See https://docs.moov.io/api/moov-accounts/onboarding/.

Summary

Functions

create(client, params)

Creates an onboarding invite. params typically includes things like :account_type, requested :capabilities, and where to redirect afterward (:redirect_uri or similar) - see the Moov dashboard for the exact fields your onboarding flow supports.

get(client, code)

Retrieves a single onboarding invite by its code.

list(client, opts \\ [])

Lists onboarding invites.

revoke(client, code)

Revokes an onboarding invite so its link can no longer be used.

Functions

create(client, params)

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

Creates an onboarding invite. params typically includes things like :account_type, requested :capabilities, and where to redirect afterward (:redirect_uri or similar) - see the Moov dashboard for the exact fields your onboarding flow supports.

get(client, code)

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

Retrieves a single onboarding invite by its code.

list(client, opts \\ [])

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

Lists onboarding invites.

revoke(client, code)

@spec revoke(Moov.Client.t(), String.t()) :: {:ok, term()} | {:error, Moov.Error.t()}

Revokes an onboarding invite so its link can no longer be used.