Start TOTP enrolment for an end-user. Returns the secret + otpauth URI. Not active until confirmed.

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

Recent Requests

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.

Response

Response Body

secret_base32stringBase32 TOTP shared secret; render as a QR / manual-entry key, then confirm.

otpauth_uristringotpauth:// URI for QR generation.

Request

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.customerAuth.enrolUserMfa('<id>', {});
console.log(result);

Credentials

Authorization

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

Response · 200

{
  "data": {
    "secret_base32": "string",
    "otpauth_uri": "string"
  }
}