recover
abstract suspend fun recover(request: IB2BRecoveryCodesRecoverParameters): B2BRecoveryCodesRecoverResponse
Authenticates the member using a recovery code as an MFA fallback, establishing a member session. Calls the POST /sdk/v1/b2b/recovery_codes/recover endpoint. Automatically includes the intermediate session token if one is present. Each recovery code can only be used once.
Kotlin:
StytchB2B.recoveryCodes.recover(
B2BRecoveryCodesRecoverParameters(
organizationId = "org-test-d5a3b680-e8a3-40c0-b815-ab79986666d0",
memberId = "member-test-d5a3b680-e8a3-40c0-b815-ab79986666d0",
recoveryCode = "recovery-code",
sessionDurationMinutes = 30,
)
)Content copied to clipboard
iOS:
let params = B2BRecoveryCodesRecoverParameters(
organizationId: "org-test-d5a3b680-e8a3-40c0-b815-ab79986666d0",
memberId: "member-test-d5a3b680-e8a3-40c0-b815-ab79986666d0",
recoveryCode: "recovery-code",
sessionDurationMinutes: 30
)
let response = try await StytchB2B.recoveryCodes.recover(params)Content copied to clipboard
React Native:
StytchB2B.recoveryCodes.recover({
organizationId: "org-test-d5a3b680-e8a3-40c0-b815-ab79986666d0",
memberId: "member-test-d5a3b680-e8a3-40c0-b815-ab79986666d0",
recoveryCode: "recovery-code",
sessionDurationMinutes: 30,
})Content copied to clipboard
Return
B2BRecoveryCodesRecoverResponse containing the authenticated member session.
Parameters
request
IB2BRecoveryCodesRecoverParameters
organizationId— The ID of the organization.memberId— The ID of the member using the recovery code.recoveryCode— A one-time-use recovery code issued during MFA enrollment.sessionDurationMinutes— Duration of the session to create, in minutes.
Throws
StytchError
if the recovery code is invalid or has already been used.
if the coroutine is cancelled.