PApaymongo
Password Reminder

Issue an OTP for the password reminder flow

Unauthenticated. Validates email + current password (which must already be expired), optionally validates a candidate new password, and issues an email OTP. When new_password is empty the response is bound to the waive branch; when populated, to the update branch. Returns 201 with data.type = "challenge" carrying expiration_at/resend_at/factor.

post/v1/password_reminder/challenge

Request

  • Base URL
    https://identity-api.paymongo.com
  • URL
    https://identity-api.paymongo.com/v1/password_reminder/challenge
  • Auth
    none required

Request body

Example request

{
  "data": {
    "attributes": {
      "email": "user@example.com",
      "factor": "email",
      "new_password": "NewStr0ng!Pass",
      "new_password_confirmation": "NewStr0ng!Pass",
      "password": "OldStr0ng!Pass"
    }
  }
}

Response

Created

has_moreboolean

Example response

{
  "data": {
    "attributes": {
      "expiration_at": 1735689600,
      "factor": "email",
      "resend_at": 1735689120
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.