Get Person

Description

This service returns all available information for the authenticated consumer. The response includes the validation status for each profile field, indicated by a corresponding fieldCode.valueState property (e.g., email.valueState).

---

Request

Restrictions

This service requires an authenticated user and can only be called after a successful consumer login.

Endpoint

GET https://<server-url>/api/v4/person

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 session. 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.
mode	Query	Optional. Controls attribute visibility. simple (default) shows configured attributes; expanded shows all possible attributes.
date_format	Query	Optional. Sets the format for date fields. timestamp (default) returns a Unix timestamp; readable returns in yyyy-MM-dd format.
fill_referencers	Query	Optional. on (default) fills the referencers element in the response; off leaves it empty to speed up the response.
Content-Type	Header	Specifies the content type of the request body. Must be application/json.

Full URL Example

https://<server-url>/api/v4/person?mode=simple&touchpoint=test&token=...
https://<server-url>/api/v4/person?date_format=readable&touchpoint=test&token=...
https://<server-url>/api/v4/person?fill_referencers=off&touchpoint=test&token=...

Request Body

This request does not have a body.

---

Response

✅ Successful Response: 200 OK

The full profile information for the consumer is returned in the person object.

JSON

{
  "context": {
    "links": [
      {
        "ref": "home",
        "href": "http://localhost:8080/thalamus/api/v1/people/home"
      },
      {
        "ref": "profile",
        "href": "http://localhost:8080/thalamus/api/v1/people/profile"
      },
      {
        "ref": "consumer",
        "href": "http://localhost:8080/thalamus/api/v1/people/consumer"
      }
    ],
    "activities": [
      {
        "links": [],
        "code": "EMileage",
        "name": "E Mileage",
        "message": "E Mileage. You can accumulate points by introducing the codes printed on E packs. Then you can trade those points for items in our catalogue. You will participate in raffle at the end of the activity. You can up-load your codes using your smartphone, our web page, SMS or iPad.",
        "type": "GENERIC"
      }
    ],
    "simpleProfile": {
      "firstname": "Malkovich",
      "lastname": "John",
      "email": "[email protected]"
    }
  },
  "person": {
    "links": [],
    "consumer": {
      "links": [],
      "activeConsumer": true,
      "consumptionFrecuency": 4,
      "preferedBrandId": 5,
      "preferedProductId": null,
      "alternativeProductdId": null,
      "alternativeBrandId": 5
    },
    "profile": {
      "links": [],
      "birthday": 1353380400000,
      "phone": {
        "areaCode": "11",
        "number": "47964444",
        "type": "cellphone",
        "intCode": "54"
      },
      "document": {
        "number": "32438213",
        "type": 1
      },
      "email": "[email protected]",
      "address": {
        "countryId": 1,
        "street2": "",
        "street1": "Catulo Castillo 5420",
        "postalCode": "4203",
        "stateId": 2,
        "type": "home",
        "city": 1
      },
      "lastname": "John",
      "gender": "Male",
      "firstname": "Malkovich",
      "address.valueState": "UNKNOWN",
      "lastname.valueState": "UNKNOWN",
      "firstname.valueState": "UNKNOWN",
      "birthday.valueState": "UNKNOWN",
      "email.valueState": "VERIFIED",
      "gender.valueState": "UNKNOWN",
      "cellphone.valueState": "VALID"
    },
    "optIns": [
      {
        "brandFamilyId": 4,
        "channel": 6001,
        "accepted": false
      }
    ],
    "credential": null
  }
}