@ory/kratos-client/docs/RecoveryFlow.md

OpenAPI client for @ory/kratos-client

# RecoveryFlow

This request is used when an identity wants to recover their account.  We recommend reading the [Account Recovery Documentation](../self-service/flows/password-reset-account-recovery)

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**active** | **string** | Active, if set, contains the recovery method that is being used. It is initially not set. | [optional] [default to undefined]
**continue_with** | [**Array<ContinueWith>**](ContinueWith.md) | Contains possible actions that could follow this flow | [optional] [default to undefined]
**expires_at** | **string** | 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. | [default to undefined]
**id** | **string** | 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> | [default to undefined]
**issued_at** | **string** | IssuedAt is the time (UTC) when the request occurred. | [default to undefined]
**request_url** | **string** | 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. | [default to undefined]
**return_to** | **string** | ReturnTo contains the requested return_to URL. | [optional] [default to undefined]
**state** | **any** | State represents the state of this request:  choose_method: ask the user to choose a method (e.g. recover account via email) sent_email: the email has been sent to the user passed_challenge: the request was successful and the recovery challenge was passed. | [default to undefined]
**transient_payload** | **object** | TransientPayload is used to pass data from the recovery flow to hooks and email templates | [optional] [default to undefined]
**type** | **string** | The flow type can either be `api` or `browser`. | [default to undefined]
**ui** | [**UiContainer**](UiContainer.md) |  | [default to undefined]

## Example

```typescript
import { RecoveryFlow } from '@ory/kratos-client';

const instance: RecoveryFlow = {
    active,
    continue_with,
    expires_at,
    id,
    issued_at,
    request_url,
    return_to,
    state,
    transient_payload,
    type,
    ui,
};
```

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)