Read guest registration eligibility and retention deadline.

GET

/api/account/guest-upgrade

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/account/guest-upgrade \
  --cookie authrim_session=<authrim_session>

Reads current settings without extending retention. Browser guest sessions use a client-bound contract. Only methods with available prerequisites are advertised (OTP secret and tenant email delivery configuration for email, a secure browser origin for passkeys). The deadline remains visible when registration is disabled. After a durable upgrade completes, this request repairs guest flags only on the session that initiated the verified upgrade. Machine and agent accounts are excluded.

Authorizations

• accountSessionCookie

Responses

200

Current account registration state. All timestamps are Unix seconds.

Media type application/json

object

status

required

Operational account status, independent of registration state.

string

registration_state

required

string

Allowed values: guest registered

deletion_due_at

required

integer | null

upgrade_hold_until

required

integer | null

upgrade_eligible

required

boolean

allowed_methods

required

Array<string>

Allowed values: email passkey

upgrade_in_progress

required

boolean

profile_complete

required

boolean

Example

{
  "registration_state": "guest",
  "allowed_methods": [
    "email"
  ]
}

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"
}

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"
}