SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
customer auth

Confirm TOTP enrolment with a 6-digit code. Returns one-time recovery codes (shown once).

Confirm TOTP enrolment with a 6-digit code. Returns one-time recovery codes (shown once).

POSThttps://staging.softsolz.uk/api/v1/services/customer-auth/users/{id}/mfa/enrol/confirm

Recent Requests

Log in to see full request history
TimeStatusUser Agent
Make a request to see history.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Body Params

codestring

6-digit TOTP code from the authenticator app.

Response

Response Body

mfa_enabledbooleanTrue once enrolment is confirmed.
recovery_codesarray of stringsTen single-use recovery codes; only hashes are persisted.

Request

import { SoftSolz } from '@softsolz/sdk';
const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });
const result = await client.customerAuth.confirmUserMfaEnrol('<id>', {});
console.log(result);

Credentials

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
"data": {
"mfa_enabled": true,
"recovery_codes": []
}
}