Skip to main content
POST
Prepare add auth method

Authorizations

Authorization
string
header
required

User bearer credential: either a Cognito JWT or an ak_ user API key. Backend integrators using HMAC must include the user API key alongside the three HMAC headers on user-scoped endpoints.

Body

Prepare request for adding an auth method. Discriminated by kind. Email requires a prior call to the email-start flow to obtain otpId.

Prepare request for adding an auth method. Discriminated by kind. Email requires a prior call to the email-start flow to obtain otpId.

kind
enum<string>
required
Available options:
passkey
challenge
string
required

Passkey/WebAuthn challenge produced by the client SDK.

Minimum string length: 1
label
string

Optional nickname for this passkey.

Minimum string length: 1

Response

Prepare response. Branch on status: intent_required requires stamping + commit; already_exists returns the existing method directly.

Prepare response. Branch on status: intent_required requires stamping + commit; already_exists returns the existing method directly.

status
enum<string>
required
Available options:
intent_required
intent
object
required

Prepared activity that the embedded wallet must stamp before commit.