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

OpenAPI client for @ory/kratos-client

# UpdateRecoveryFlowWithCodeMethod

Update Recovery Flow with Code Method

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | **string** | Code from the recovery email  If you want to submit a code, use this field, but make sure to _not_ include the email field, as well. | [optional] [default to undefined]
**csrf_token** | **string** | Sending the anti-csrf token is only required for browser login flows. | [optional] [default to undefined]
**email** | **string** | The email address of the account to recover  If the email belongs to a valid account, a recovery email will be sent.  If you want to notify the email address if the account does not exist, see the [notify_unknown_recipients flag](https://www.ory.sh/docs/kratos/self-service/flows/account-recovery-password-reset#attempted-recovery-notifications)  If a code was already sent, including this field in the payload will invalidate the sent code and re-send a new code.  format: email | [optional] [default to undefined]
**method** | **string** | Method is the method that should be used for this recovery flow  Allowed values are `link` and `code`. link RecoveryStrategyLink code RecoveryStrategyCode | [default to undefined]
**recovery_address** | **string** | A recovery address that is registered for the user. It can be an email, a phone number (to receive the code via SMS), etc. Used in RecoveryV2. | [optional] [default to undefined]
**recovery_confirm_address** | **string** | If there are multiple recovery addresses registered for the user, and the initially provided address is different from the address chosen when the choice (of masked addresses) is presented, then we need to make sure that the user actually knows the full address to avoid information exfiltration, so we ask for the full address. Used in RecoveryV2. | [optional] [default to undefined]
**recovery_select_address** | **string** | If there are multiple addresses registered for the user, a choice is presented and this field stores the result of this choice. Addresses are \'masked\' (never sent in full to the client and shown partially in the UI) since at this point in the recovery flow, the user has not yet proven that it knows the full address and we want to avoid information exfiltration. So for all intents and purposes, the value of this field should be treated as an opaque identifier. Used in RecoveryV2. | [optional] [default to undefined]
**screen** | **string** | Set to \"previous\" to go back in the flow, meaningfully. Used in RecoveryV2. | [optional] [default to undefined]
**transient_payload** | **object** | Transient data to pass along to any webhooks | [optional] [default to undefined]

## Example

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

const instance: UpdateRecoveryFlowWithCodeMethod = {
    code,
    csrf_token,
    email,
    method,
    recovery_address,
    recovery_confirm_address,
    recovery_select_address,
    screen,
    transient_payload,
};
```

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