frontend

Create Recovery Flow for Browsers

Changed on Nov 7, 2025

This endpoint initializes a browser-based account recovery flow. Once initialized, the browser will be redirected to selfservice.flows.recovery.ui_url with the flow ID set as the query parameter ?flow=. If a valid user session exists, the browser is returned to the configured return URL.

If this endpoint is called via an AJAX request, the response contains the recovery flow without any redirects or a 400 bad request error if the user is already authenticated.

This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed.

More information can be found at Ory Kratos Account Recovery Documentation.

get/self-service/recovery/browser

Request

Base URL
/ (relative, and the document was published on a file host, not at the API’s origin)
URL
/self-service/recovery/browser
Auth
none declared

Query parameters

return_tostring

The URL to return the browser to after the flow was completed.

Response

recoveryFlow

activestring

Active, if set, contains the recovery method that is being used. It is initially not set.

expires_atstring date-time required

ExpiresAt is the time (UTC) when the request expires. If the user still wishes to update the setting, a new request has to be initiated.

idstring uuid required

ID represents the request's unique ID. When performing the recovery flow, this represents the id in the recovery ui's query parameter: http://<selfservice.flows.recovery.ui_url>?request=<id>

issued_atstring date-time required

IssuedAt is the time (UTC) when the request occurred.

request_urlstring required

RequestURL is the initial URL that was requested from Ory Kratos. It can be used to forward information contained in the URL's path or query for example.

return_tostring

ReturnTo contains the requested return_to URL.

stateunknown required

transient_payloadobject

TransientPayload is used to pass data from the recovery flow to hooks and email templates

typestring required

The flow type can either be api or browser.

Example response

{
  "expires_at": "2000-01-23T04:56:07.000+00:00",
  "transient_payload": "{}",
  "ui": {
    "nodes": [
      {
        "meta": {
          "label": {
            "context": "{}",
            "id": 6,
            "text": "text",
            "type": "info"
          }
        },
        "messages": [
          {
            "context": "{}",
            "id": 6,
            "text": "text",
            "type": "info"
          },
          {
            "context": "{}",
            "id": 6,
            "text": "text",
            "type": "info"
          }
        ],
        "attributes": {
          "autocomplete": "email",
          "maxlength": 1,
          "onclick": "onclick",
          "pattern": "pattern",
          "onclickTrigger": "oryWebAuthnRegistration",
          "label": {
            "context": "{}",
            "id": 6,
            "text": "text",
            "type": "info"
          },
          "type": "text",
          "required": true,
          "onload": "onload",
          "node_type": "input",
          "onloadTrigger": "oryWebAuthnRegistration",
          "name": "name",
          "disabled": true,
          "value": ""
        },
        "type": "text",
        "group": "default"
      },
      {
        "meta": {
          "label": {
            "context": "{}",
            "id": 6,
            "text": "text",
            "type": "info"
          }
        },
        "messages": [
          {
            "context": "{}",
            "id": 6,
            "text": "text",
            "type": "info"
          },
          {
            "context": "{}",
            "id": 6,
            "text": "text",
            "type": "info"
          }
        ],
        "attributes": {
          "autocomplete": "email",
          "maxlength": 1,
          "onclick": "onclick",
          "pattern": "pattern",
          "onclickTrigger": "oryWebAuthnRegistration",
          "label": {
            "context": "{}",
            "id": 6,
            "text": "text",
            "type": "info"
          },
          "type": "text",
          "required": true,
          "onload": "onload",
          "node_type": "input",
          "onloadTrigger": "oryWebAuthnRegistration",
          "name": "name",
          "disabled": true,
          "value": ""
        },
        "type": "text",
        "group": "default"
      }
    ],
    "method": "method",
    "action": "action",
    "messages": [
      {
        "context": "{}",
        "id": 6,
        "text": "text",
        "type": "info"
      },
      {
        "context": "{}",
        "id": 6,
        "text": "text",
        "type": "info"
      }
    ]
  },
  "continue_with": [
    {
      "action": "show_verification_ui",
      "flow": {
        "verifiable_address": "verifiable_address",
        "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "url": "url"
      }
    },
    {
      "action": "show_verification_ui",
      "flow": {
        "verifiable_address": "verifiable_address",
        "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "url": "url"
      }
    }
  ],
  "active": "active",
  "return_to": "return_to",
  "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "state": "",
  "type": "type",
  "issued_at": "2000-01-23T04:56:07.000+00:00",
  "request_url": "request_url"
}

Changes

Nov 7, 20255f08e5827b5e Revision changes
- breaking
  added to the /// response property oneOf list for the response status
- warning
  added the new div enum value to the /// response property for the response status
- warning
  added the new username webauthn enum value to the //////// response property for the response status
- info
  added div discriminator mapping keys to the /// response property for the response status
- info
  removed the a enum value from the //////// response property for the response status
- info
  removed the a enum value from the ///// response property for the response status
- info
  removed the a enum value from the ///// response property for the response status
- info
  removed the a enum value from the ///// response property for the response status
- info
  removed the img enum value from the //////// response property for the response status
- info
  removed the img enum value from the ///// response property for the response status
- info
  removed the img enum value from the ///// response property for the response status
- info
  removed the img enum value from the ///// response property for the response status
- info
  removed the input enum value from the ///// response property for the response status
- info
  removed the input enum value from the ///// response property for the response status
- info
  removed the input enum value from the ///// response property for the response status
- info
  removed the input enum value from the ///// response property for the response status
- info
  removed the script enum value from the //////// response property for the response status
- info
  removed the script enum value from the ///// response property for the response status
- info
  removed the script enum value from the ///// response property for the response status
- info
  removed the script enum value from the ///// response property for the response status
- info
  removed the text enum value from the //////// response property for the response status
- info
  removed the text enum value from the ///// response property for the response status
- info
  removed the text enum value from the ///// response property for the response status
- info
  removed the text enum value from the ///// response property for the response status
Feb 25, 2025df2fe8db7397 Revision changes
- breaking
  added to the / response property oneOf list for the response status
- breaking
  the / response's property type changed from no type to object for status
- warning
  added the new captcha enum value to the /// response property for the response status
- warning
  added the new identifier_first enum value to the /// response property for the response status
- warning
  added the new saml enum value to the /// response property for the response status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added redirect_browser_to discriminator mapping keys to the / response property for the response status

Operation history (11 revisions)