Users

Password reset request. It sends an email or SMS (depends on login type) with pin code to reset password.

POST request password reset

Endpoint

POST /api/v1/users/password

Parameters

Name Description
user[login] required Email or phone number

Request

Route

POST /api/v1/users/password

Headers

Accept: application/json
Content-Type: application/json
Host: example.org
Cookie:

Body

{
  "user": {
    "login": "toby.dare+operator@example.com"
  }
}

Response

Simulated Response

Status

200

Headers

x-frame-options: SAMEORIGIN
x-xss-protection: 0
x-content-type-options: nosniff
x-permitted-cross-domain-policies: none
referrer-policy: strict-origin-when-cross-origin
content-type: application/json; charset=utf-8
vary: Accept, Origin
etag: W/"c18be5a53b57b8fc4e85f6b79b4b9a0f"
cache-control: max-age=0, private, must-revalidate
x-request-id: 8bce2ca5-bff6-4e7e-ac41-3db9ac185af9
x-runtime: 0.018217
content-length: 289

Body

{
  "user": {
    "id": 1904,
    "company": null,
    "contact_phone_number": null,
    "email": "toby.dare+operator@example.com",
    "financial_company_id": null,
    "first_name": "Toby",
    "job_position": null,
    "last_name": "Dare",
    "phone_number": null,
    "pin_valid_to": "2025-11-20T08:18:34.363Z",
    "profile_id": null,
    "role": "operator"
  }
}