Create an Account Page return transaction.

POST

/api/account/return

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/account/return \
  --header 'Content-Type: application/json' \
  --data '{ "path": "/account/security?tab=passkeys" }'

Creates a short-lived return transaction for unauthenticated Account Page deep links. The path must be a relative URL under the configured Account Page path.

Request Body ^required

Media type application/json

object

path

required

string

Example

/account/security?tab=passkeys

Responses

201

Account Page return transaction creation response.

Media type application/json

object

account_return

required

string

expires_in

required

integer

>= 1

Example ^generated

{
  "account_return": "example",
  "expires_in": 1
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}