Reset Password

Request a reset-password OTP or verify it

When code is omitted, issues an email OTP and returns 201 with type "challenge" carrying expiration_at/resend_at/factor. When code is supplied, verifies it and emails the single-use reset link (204).

post/v1/reset_password

Request

Base URL
https://identity-api.paymongo.com
URL
https://identity-api.paymongo.com/v1/reset_password
Auth
none required

Request body

Example request

{
  "data": {
    "attributes": {
      "code": "123456",
      "email": "user@example.com",
      "factor": "email"
    }
  }
}

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.