Start two-factor enrolment

POST/api/v1/mailbox/security/2fa/begin

Requires amailbox token— it acts as one mailbox holder, not as the organization.

Generates a secret and recovery codes. Enrolment is NOT active until /confirm succeeds with a working code -- otherwise a mis-scanned QR would lock the holder out of their own mailbox.

Request

POST/api/v1/mailbox/security/2fa/begin

curl -X POST 'https://app.mailyte.com/api/v1/mailbox/security/2fa/begin' \
  -H 'Authorization: Bearer MAILBOX_TOKEN'

const response = await fetch('https://app.mailyte.com/api/v1/mailbox/security/2fa/begin', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer MAILBOX_TOKEN',
  },
});
const { data } = await response.json();

import requests
response = requests.post(
    "https://app.mailyte.com/api/v1/mailbox/security/2fa/begin",
    headers={"Authorization": "Bearer MAILBOX_TOKEN"},
)
data = response.json()["data"]

<?php

$response = Http::withToken('MAILBOX_TOKEN')
    ->post('https://app.mailyte.com/api/v1/mailbox/security/2fa/begin');

$data = $response->json('data');

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/mailbox/security/2fa/begin")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer MAILBOX_TOKEN"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

The key names its own organization, so no X-Organization-ID header is needed.

Response

Successful Response

Returned inside the standard envelope.

Errors

Every status, with what causes it and what to do, is on the error reference.