Request a password-reset code

Sends a reset code to the number if it has an account; returns the same shape regardless (no account enumeration). Subject to the same rate, allowlist and per-IP guards as sign-up.

POST /api/v1/account/password-reset/otp

Request a password-reset code

cURL

curl --request POST \
  --url https://sandbox.api.nkama.ga/api/v1/account/password-reset/otp \
  --header 'Content-Type: application/json' \
  --data '
{
  "phoneNumber": "<string>"
}
'

201

{
  "challengeId": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "maskedDestination": "<string>"
}

Body

application/json

phoneNumber · string · required

Minimum string length: 1

Pattern: ^\+[1-9]\d{6,14}$

Response

201 - */*

Created

challengeId · string

channel · enum<string>

Available options: WHATSAPP, SMS, EMAIL

expiresAt · string<date-time>

maskedDestination · string