Authentication

Start 2FA enrolment

post/auth/totp/setup

Generate a TOTP secret and QR code to scan with an authenticator app.

Authorization

Bearer token in the Authorization header.

Body required

passwordstringrequired

Response

qrCodestringrequired

Data URL of a QR code to scan

manualKeystringrequired

Base32 secret for manual entry

otpauthUristringrequired

otpauth:// URI encoded in the QR

Request

curl -X POST 'https://api.lira.com/api/v1/auth/totp/setup' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "password": "your-password"
}'

const response = await fetch('https://api.lira.com/api/v1/auth/totp/setup', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "password": "your-password"
  }),
});

const data = await response.json();

import requests

response = requests.post(
    "https://api.lira.com/api/v1/auth/totp/setup",
    headers={"Authorization": "Bearer YOUR_ACCESS_TOKEN"},
    json={
  "password": "your-password"
},
)

data = response.json()

Response

{
  "qrCode": "string",
  "manualKey": "string",
  "otpauthUri": "string"
}

{
  "message": "NG Account Number verification is not enabled for your organisation.",
  "code": "SERVICE_NOT_ENABLED",
  "action": {
    "type": "CONTACT_ADMIN",
    "hint": "Ask your administrator to enable NG Account Number verification in the Lira dashboard."
  }
}