Skip to content
Authrim

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

Section titled “Request Body required ”
Media type application/json
object
path
required
string
Example 
/account/security?tab=passkeys

Responses

Section titled “ Responses ”

201

Section titled “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

Section titled “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

Section titled “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

Section titled “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"
}