Skip to main content
POST
/
v1
/
self
/
mfa
/
enroll
/
start
Start MFA enrollment
curl --request POST \
  --url https://api.arklow.io/v1/self/mfa/enroll/start \
  --header 'Content-Type: application/json' \
  --header 'x-arklow-auth: <api-key>' \
  --data '
{
  "name": "<string>",
  "device_type": "totp"
}
'
{
  "data": {
    "device": {
      "id": "<string>",
      "user_id": "<string>",
      "name": "<string>",
      "device_type": "totp",
      "confirmed_at": "2023-11-07T05:31:56Z",
      "last_used_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    },
    "provisioning_uri": "<string>",
    "qr_code": "<string>",
    "backup_codes": [
      "<string>"
    ]
  },
  "errors": [
    {
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

x-arklow-auth
string
header
required

Body

application/json
name
string
required
Required string length: 1 - 64
device_type
enum<string>
Available options:
totp

Response

200 - application/json

Default Response

data
object
required
errors
object[] | null
required