Request to Change a Forgotten Password

Use the /Authentication/Password/Forgot endpoint to request a password reset when you have forgotten your current password. You must provide your username. Upon successful validation, a password reset email containing a unique link to reset their password will be sent to your email address or phone by SMS. The response is a generic message indicating that if an account with the provided email address exists, a password reset link will be sent. This helps maintain user privacy and security. In case of errors, appropriate error codes and messages are provided.

SecurityApiKeyAuth

Request

header Parameters

required

string

Initialization Vector for database encryption.

Request Body schema:
application/UNENCRYPTED—DO_NOT_SEND+json

object or object

One of:

username required	string (Username) An string containing the user's login credential, which is either the user's primary `emailAddress` or primary `phoneNumber`.
deviceId	string (DeviceId) The unique identifier for the device.

Responses

200

400

Bad Request

401

Unauthorized access

403

Access forbidden

404

Resource was not found

409

Conflict.

429

Too Many Requests

post/authentication/Password/Forgot

Request samples

{"userCredentials": {"username": "joeblow@acme.com",
"deviceId": "A-10000"
}
}

Response samples

{"cryptoKeys": {"deviceEncryptionKey": "7625e224dc0f0ec91ad28c1ee67b1eb96d1a5459533c5c950f44aae1e32f2da3",
"transactionEncryptionKey": "aafeeba6959ebeeb96519d5dcf0bcc069f81e4bb56c246d04872db92666e6d4b"
}
}