ForgotPasswordResponse

Package: @nauth-toolkit/client Type: Response

Response payload for a forgot-password request. Designed to be non-enumerating.

import { ForgotPasswordResponse } from '@nauth-toolkit/client';

Properties

Property	Type	Required	Description
`success`	`boolean`	Yes	Always `true` when request accepted (even if account does not exist).
`destination`	`string \| undefined`	No	Masked destination (for example `j*@example.com` or `+1*1234`).
`deliveryMedium`	`'email' \| 'sms' \| undefined`	No	Delivery medium when known.
`expiresIn`	`number \| undefined`	No	Code expiry in seconds when known.

{
  "success": true,
  "destination": "j***@example.com",
  "deliveryMedium": "email",
  "expiresIn": 900
}