Start email or passkey registration for the current guest.

POST

/api/account/guest-upgrade/start

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/account/guest-upgrade/start \
  --header 'Content-Type: application/json' \
  --cookie authrim_session=<authrim_session> \
  --data '{ "method": "email", "email": "[email protected]", "preserve_sub": true }'

Requires an authenticated browser guest session and CSRF protection. Tenant, method and originating-client registration permissions must allow the method. Method prerequisites are rechecked before acquiring a hold; unavailable methods return 403 without consuming it. Starting a valid attempt acquires the guest’s one-time deletion hold; retries never renew it. Proof expires independently: an emailed code after the tenant’s email code lifetime (credentials.email_code_ttl, five minutes by default), a passkey registration after ten minutes. Disabling guest login does not disable registration.

Authorizations

• accountSessionCookie

Request Body ^required

Media type application/json

object

method

required

string

Allowed values: email passkey

email

Required for email verification.

string format: email

<= 320 characters

preserve_sub

boolean

default: true

Responses

200

A session-bound registration operation. Store the opaque token only for this attempt. Email confirmation may be delivered asynchronously.

Media type application/json

object

operation_id

required

string

upgrade_token

required

string

/^[a-f0-9]{64}$/

method

required

string

Allowed values: email passkey

expires_at

required

integer

options

WebAuthn PublicKeyCredentialCreationOptionsJSON for passkey registration.

object

Example

{
  "method": "email"
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

error_code

Stable Authrim error category that can be provided to support.

string

/^AR[0-9]{6}$/

error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

error_code

Stable Authrim error category that can be provided to support.

string

/^AR[0-9]{6}$/

error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

error_code

Stable Authrim error category that can be provided to support.

string

/^AR[0-9]{6}$/

error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

409

Error response.

Media type application/json

object

error

string

message

string

error_description

string

error_code

Stable Authrim error category that can be provided to support.

string

/^AR[0-9]{6}$/

error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

429

Error response.

Media type application/json

object

error

string

message

string

error_description

string

error_code

Stable Authrim error category that can be provided to support.

string

/^AR[0-9]{6}$/

error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

503

Error response.

Media type application/json

object

error

string

message

string

error_description

string

error_code

Stable Authrim error category that can be provided to support.

string

/^AR[0-9]{6}$/

error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}