Migration Rest Portal

Build Apps

Go Headless

Client

API Preview

Develop Websites

REST

GraphQL (Alpha)

# Introduction

Use the Recovery API to allow [Wix Headless](https://dev.wix.com/docs/go-headless) site or app members reset their passwords.

To learn more about the password process, see [Handler Members with Custom Login](https://dev.wix.com/docs/go-headless/coding/rest-api/visitors-and-members/handle-members-with-custom-login#send-a-password-reset-email).


Main address line, usually street and number as free text.

addressLine

Free text providing more detailed address info. Usually contains Apt, Suite, and Floor.

addressLine2

city

country

postalCode

Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).

subdivision

Address

CustomValue

dateValue

numValue

strValue

value

ListValue

MapValue

AddressTag

EmailTag

PhoneTag

StringValue

nanos

seconds

Timestamp

UInt64Value

language of the email - if not received will fallback to the identity language

language

Where to redirect after a successful activation process

EmailOptions

clientId

The URL to redirect to after a successful recovery.

Redirect

AddressWrapper

authenticatorConnectionId

reEnrollmentRequired

AuthenticatorConnection

Connection

type

Custom field name. The name must match one of the key properties of the objects returned by
[`List Extended Fields`](https://dev.wix.com/docs/rest/api-reference/contacts/extended-fields/list-extended-fields)
with the `custom.` prefix removed.

name

CustomField

address

isVerified

Email

Identifier

email

userName

The identity configured connections to authenticate with.

connections

createdDate

identifiers

Represents the current state of an item. Each time the item is modified, its `revision` changes.
For an update operation to succeed, you MUST pass the latest revision.

revision

updatedDate

Identity

addresses

birthdate

company

Any number of custom fields. [Custom fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts)
are used to store additional information about your site or app's contacts.

customFields

Deprecated. Use `secondaryEmails` instead.

emails

firstName

labels

lastName

nickname

phones

phonesV2

picture

position

privacyStatus

secondaryEmails

IdentityProfile

idpConnectionId

idpUserId

IdpConnection

Metadata

countryCode

phone

Phone

PrivacyStatus

Reason

SecondaryEmail

reasons

StatusV2

StatusName

TenantType

password

recoveryToken

RecoverRequest

Recovery token proto is the saved data on the recovery token.

Represents the time this SessionToken was created

identityId

tenantId

tenantType

RecoveryToken

SendActivationEmailRequest

SendActivationEmailResponse

Email address associated with the account to recover.

Language of the email to be sent. Defaults to the language specified in the member's profile.

Where to redirect to after a successful recovery.

SendRecoveryEmailRequest

SendRecoveryEmailResponse

additionalData

sessionToken

The current state of the login or registration process.

state

A token representing the current state of the login or registration process.

stateToken

StateMachineResponse

StateType

Sends a member an email containing a customized link to a Wix-managed page
where the member can set a new password for their account.

Send a password recovery email to a member.

SendRecoveryEmail

Sends an activation email with an activation token
making the transition from initial contact to a site member

Recovery