Password Reset Step 1 . Request email

Description

This service initiates the password reset process for a party (e.g., a person, company, or physical location) that has forgotten their password.

When called, Thalamus sends an email to the party containing a unique link. This link includes a token that must be used in the subsequent "Reset Password" service to complete the process.

---

Request

Restrictions

This service can only be called when the party is not logged in.

Endpoint

This service can be called on a Person, Physical Location, or Company entity.

POST https://<server-url>/api/v4/person/password/requestreset
POST https://<server-url>/api/v4/physicallocation/password/requestreset
POST https://<server-url>/api/v4/company/password/requestreset

Parameters

Parameter	Location	Description
touchpoint	Query / Header	The identifier for the touchpoint making the request. If sent as a header, the name must be Thalamus-Touchpoint.
token	Query / Header	The authentication token for the API. If sent as a header, the name must be Thalamus-Token.
activity	Query / Header	Optional. The activity to be used. If sent as a header, the name must be Thalamus-Activity.
Content-Type	Header	Specifies the content type of the request body. Must be application/json.

Full URL Example

https://<server-url>/api/v4/person/password/requestreset?touchpoint=test&token=testtesttesttesttesttesttesttesttesttesttesttesttesttesttesttest

Request Body

The body of the request must be a JSON object containing the party's principal identifier.

Field	Type	Description
principal	String	The primary identifier for the party.

JSON

{
  "principal": "1:27658923"
}

---

Response

✅ Successful Response: 200 OK

The request was successful and the password reset email has been sent. The token in the response body is the password reset token.

JSON

{
  "context": {
    "links": [
      {
        "ref": "home",
        "href": "http://localhost:8080/thalamus/api/v4/people/home"
      },
      {
        "ref": "profile",
        "href": "http://localhost:8080/thalamus/api/v4/people/profile"
      },
      {
        "ref": "consumer",
        "href": "http://localhost:8080/thalamus/api/v4/people/consumer"
      }
    ],
    "activities": [],
    "simpleProfile": null
  },
  "token-development": {
    "credentialId": 1,
    "configurationId": 1,
    "expiredDate": 1362840510000,
    "token": "8d9e09346e50b4400ebdfeb33bd10da7"
  }
}

❌ Unsuccessful Response: 400 Bad Request

Returned if the party is already logged in.

JSON

{
  "errors": {
    "execution": "PartyAlreadyLoggedin"
  }
}

❌ Unsuccessful Response: 404 Not Found

Returned when no party can be found with a principal that matches the one provided in the request.

JSON

{
  "errors": {
    "execution": "InvalidPrincipal"
  }
}