Create Recovery Flow

Endpoint

GET /v1/flows/recovery

Base URL: https://api-id.avnology.net

Authentication: None required

Creates a recovery flow that allows users to regain access to their account by verifying their identity through email or SMS.

Request

Query Parameters

Parameter	Type	Required	Description
`return_to`	string	No	URL to redirect after successful recovery
`email`	string	No	Pre-fill the email field

Example Request

curl "https://api-id.avnology.net/v1/flows/recovery" \
  -H "Accept: application/json"

Response

Success (200 OK)

{
  "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "type": "recovery",
  "state": "show_form",
  "expires_at": "2026-04-08T13:00:00Z",
  "issued_at": "2026-04-08T12:00:00Z",
  "ui": {
    "action": "https://api-id.avnology.net/v1/flows/recovery/c3d4e5f6-a7b8-9012-cdef-123456789012:submit",
    "method": "POST",
    "nodes"

Code Examples

JavaScript (fetch)

async function createRecoveryFlow() {
  const response = await fetch('https://api-id.avnology.net/v1/flows/recovery');
  return response.json();
}

Python (httpx)

import httpx

def create_recovery_flow() -> dict:
    return httpx.get("https://api-id.avnology.net/v1/flows/recovery").json()

Go (net/http)

func createRecoveryFlow(ctx context.Context) (*AuthFlow, error) {
	req, _ := http.NewRequestWithContext(ctx, "GET", "https://api-id.avnology.net/v1/flows/recovery"

Submit Recovery -- submit recovery email and code
SDK: client.auth.requestRecovery(email) (TypeScript)

On this page