Skip to content

Start passkey registration for the current session

POST
/v1/mfa/passkeys/register/start
curl --request POST \
--url https://api.aetherpush.com/v1/mfa/passkeys/register/start \
--header 'Authorization: Bearer <token>'

Session-only; API keys and named access keys receive a plain 403. Returns WebAuthn registration options excluding already-registered credentials. The challenge expires after five minutes, and starting again invalidates any prior unconsumed registration challenge.

WebAuthn registration options to pass to the browser.

Media typeapplication/json
object
options
required

WebAuthn PublicKeyCredentialCreationOptionsJSON, as produced by SimpleWebAuthn’s generateRegistrationOptions(). Pass it to startRegistration() from @simplewebauthn/browser.

object
key
additional properties
any
Examplegenerated
{
"options": {}
}

Authentication required.

Media typeapplication/json
object
error
required

Human-readable error message.

string
requestId

Unique identifier for the request, also exposed as the X-Request-Id response header.

string
Example
{
"error": "The requested resource was not found.",
"requestId": "req_abc123"
}

API keys and named access keys receive a plain 403. A login session that is not a dashboard login session receives code dashboard_session_required.

Media typeapplication/json
One of:
object
error
required

Human-readable error message.

string
requestId

Unique identifier for the request, also exposed as the X-Request-Id response header.

string
Example
{
"error": "The requested resource was not found.",
"requestId": "req_abc123"
}

Passkeys are not configured on this server.

Media typeapplication/json
object
error
required

Human-readable error message.

string
requestId

Unique identifier for the request, also exposed as the X-Request-Id response header.

string
Example
{
"error": "The requested resource was not found.",
"requestId": "req_abc123"
}