FrameSDK/com.framepayments.framesdk.onboardingsessions/OnboardingSessionsAPI

OnboardingSessionsAPI

Creates onboarding sessions via the Frame API.

Note: POST /v1/onboarding_sessions accepts a publishable key (pk_), so the onboarding flow can mint its own account-scoped session on-device without a secret key — see createOnboardingSessionWithPublishableKey. The deprecated createOnboardingSession methods below default to the configured key (typically sk_ in the example app) and remain for backward compatibility; production integrations that mint from their own backend hand the resulting onb_sess_… to the onboarding flow as its clientSecret.

Functions

createOnboardingSession

suspend fun ~~createOnboardingSession~~(request: OnboardingSessionRequests.CreateOnboardingSessionRequest): Pair<OnboardingSessionResponses.OnboardingSession?, NetworkingError?>

Creates an onboarding session and returns its onb_sess_… client secret.

fun ~~createOnboardingSession~~(request: OnboardingSessionRequests.CreateOnboardingSessionRequest, completionHandler: (OnboardingSessionResponses.OnboardingSession?, NetworkingError?) -> Unit)

Callback variant of createOnboardingSession.

createOnboardingSessionWithPublishableKey

suspend fun createOnboardingSessionWithPublishableKey(request: OnboardingSessionRequests.CreateOnboardingSessionRequest): Pair<OnboardingSessionResponses.OnboardingSession?, NetworkingError?>

Mints an onboarding session using the SDK's publishable key (pk_), the client-safe credential accepted by POST /v1/onboarding_sessions. The onboarding flow calls this to bind itself to a freshly-created account so subsequent requests (e.g. IDV) authenticate as the session rather than falling back to the configured key. Not deprecated — unlike createOnboardingSession, this never sends a secret key.