Account and sign-in

Start two-step setup

POSThttps://voxa.abhinavyadav.in/api/v1/account/2fa/setup

Returns a secret and an otpauth:// URL for an authenticator app. Confirm with Turn on two-step verification.

Needs a signed-in user session (Authorization: Bearer <token> from Sign in); API keys get 403.

Authorization

A signed-in user’s session token (Authorization: Bearer). API keys are refused.

Authorization: Bearer

Query parameters

timezonestringdefault: "Asia/Kolkata"

IANA time zone for every timestamp in the response (at, date, timestamp and *_at fields), as ISO 8601 with the offset. The X-Timezone header works too; the zone used comes back in the X-Timezone response header. An unknown zone is a 400.

Response

200Success.

See the 200 example next to the code samples.

401No credentials, or they are invalid or revoked.

detailstring

What went wrong, in plain words.

403Your role (or an API key) lacks the permission.

detailstring

What went wrong, in plain words.

curl --request POST \
  --url 'https://voxa.abhinavyadav.in/api/v1/account/2fa/setup?timezone=Asia/Kolkata' \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://voxa.abhinavyadav.in/api/v1/account/2fa/setup"
params = {
    "timezone": "Asia/Kolkata",
}
headers = {
    "Authorization": "Bearer <token>",
}

response = requests.post(url, params=params, headers=headers)
print(response.status_code, response.json())

const response = await fetch("https://voxa.abhinavyadav.in/api/v1/account/2fa/setup?timezone=Asia/Kolkata", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
  },
})
const data = await response.json()
console.log(response.status, data)

Response

{
  "secret": "JBSWY3DPEHPK3PXP",
  "otpauth_url": "otpauth://totp/Voxa:rohan%40example.com?secret=JBSWY3DPEHPK3PXP&issuer=Voxa"
}

{
  "detail": "sign in required"
}

{
  "detail": "API keys have no account"
}