Consume an Account Page return transaction.

POST

/api/account/return/{id}/consume

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/account/return/example/consume

Consumes a short-lived Account Page return transaction and returns the validated relative redirect URL. The transaction is single-use.

Parameters

Path Parameters

id

required

string

Responses

200

Account Page return transaction consume response.

Media type application/json

object

redirect_url

required

string

Example

{
  "redirect_url": "/account/security?tab=passkeys"
}

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

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

404

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