Register Person

Description

This service registers a new person and, upon successful registration, may also log them in. This documentation covers direct registration with Thalamus.

---

Request

Restrictions

This service can only be called when a consumer is not already logged in.

Endpoint

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

Parameters

Parameter	Location	Description
touchpoint	Query / Header	The identifier for the touchpoint. Use Thalamus-Touchpoint for the header.
token	Query / Header	The authentication token for the API. Use Thalamus-Token for the header.
activity	Query / Header	Optional. The activity to be used. Use Thalamus-Activity for the header.
validation	Query	Optional. Defines the validation strategy for the new user. See options below.

Validation Strategies

The validation query parameter accepts one of the following values:

Value	Description
automatic	(Default) Thalamus attempts to validate the person immediately using the strategy defined for the touchpoint.
manual	The person is created with an UNDER_VALIDATION status. A case is created for manual review (e.g., by a call center).
temporary	The person is created with a TEMPORARY_VALID status and can interact with the system for a limited time. A case is also created for manual review.
pre-validated	Assumes the person was validated externally. They are created with a VALID status.
pre-registration	Creates the person with a PREREGISTERED status. The registration must be completed later via an update or validation call.

Request Body

The request body must contain the profile information, credentials, and any communication opt-ins for the new person.

Field	Type	Description
consumers	Array	An array of consumer objects containing data like brand preferences.
profile	Object	An object containing the person's profile data (e.g., name, email, address). For a full list of available fields, see the Get Profile Fields document.
optIns	Array	An array of opt-in objects for communication channels.
ownerPartnerPrincipal	String	Optional. The principal of an existing partner to associate this person with.
credential	Object	An object containing the login principal and password for the new person.

Note: The required, editable, and visible attributes for each profile field can be configured per touchpoint. Always consult the Profile Fields Reference for the definitive structure.

Full URL Example

https://<server-url>/api/v4/person?touchpoint=test&token=...
https://<server-url>/api/v4/person?validation=manual&touchpoint=test&token=...

Request Body Example

JSON

{
  "consumers": [
    {
      "activeConsumer": true,
      "consumptionFrecuency": 4,
      "preferedBrandId": 1,
      "alternativeBrandId": 1,
      "competitiveMarketId": 1
    }
  ],
  "profile": {
    "firstname": "Malkovich",
    "lastname": "John",
    "birthday": 1353380400000,
    "gender": "Male",
    "email": "[email protected]",
    "address": {
      "countryId": 1,
      "stateId": 2,
      "street1": "Catulo Castillo 5420",
      "postalCode": "4203",
      "city": "Buenos Aires"
    },
    "document": {
      "type": 1,
      "number": "171717"
    },
    "policy_agreement": true
  },
  "optIns": [
    {
      "brandFamilyId": 1,
      "channel": 6001,
      "accepted": true
    }
  ],
  "credential": {
    "principal": "1:171717",
    "password": "user_password"
  }
}

---

Response

✅ Successful Response: 201 Created

The response varies based on the chosen validation strategy.

With Automatic Validation

If registration is successful, the person is created and logged in automatically. The response returns the new session context.

JSON

{
  "context": {
    "links": [
      {
        "ref": "home",
        "href": "http://localhost:8080/thalamus/api/v1/people/home"
      }
    ],
    "activities": [
      {
        "code": "EMileage",
        "name": "E Mileage"
      }
    ],
    "simpleProfile": {
      "firstName": "Malkovich",
      "lastName": "John",
      "email": "[email protected]"
    }
  }
}

With Manual Validation

The person is created but not logged in. The response confirms that the manual validation process has been initiated.

JSON

{
  "context": {
    "links": [],
    "simpleProfile": null
  },
  "validationStatus": "The manual validation request is getting processed"
}

❌ Unsuccessful Response: 400 Bad Request

Returned if the request fails validation. The errors object will contain key-value pairs where the key is the field name and the value is the error code.

Common Error Scenarios

• Mandatory or Invalid Data: A required field is missing or a value is malformed (e.g., InvalidName, InvalidMail, Required).

• Principal Field Errors: The chosen principal (e.g., email, document) already exists in the system.

• Identity Validation Errors: The provided identity data (name, document, etc.) does not match external validation records (e.g., Mismatch, Minor).

• Unexpected Errors: A server-side error occurred (execution.unexpected).

JSON

{
  "errors": {
    "person.profile.firstname": "Required",
    "profile.email": "InvalidMail",
    "error.invalid.credentials": "The following credential already exists: email",
    "credential": "NotMatchAnyPrincipal"
  }
}