ORory
frontend

Create Verification Flow for Browser Clients

This endpoint initializes a browser-based account verification flow. Once initialized, the browser will be redirected to selfservice.flows.verification.ui_url with the flow ID set as the query parameter ?flow=.

If this endpoint is called via an AJAX request, the response contains the recovery flow without any redirects.

This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...).

More information can be found at Ory Kratos Email and Phone Verification Documentation.

get/self-service/verification/browser

Request

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

Query parameters

return_tostring

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

Response

verificationFlow

activestring

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

expires_atstring date-time

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

idstring uuid required

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

type: string format: uuid

issued_atstring date-time

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

request_urlstring

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 verification flow to hooks and email templates

typestring required

The flow type can either be api or browser.

Changes

No recorded changes to this operation across all 65 revisions of this API.