Check Validation Code (Step 2)

Description

This service is used to validate a pre-registered person.

---

Request

Restrictions

For the registered person to obtain a code, an automatic communication must be configured using the replacement variables ${partyValidatorCode.sms} or ${partyValidatorCode.email}. Additionally, a "register" or "opt_in" interaction must be configured as the trigger.

Endpoint

This service can be called using either of the following endpoints:

PUT https://<server-url>/api/v4/person/validationcode
PUT https://<server-url>/api/v4/physicallocation/validationcode

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.
Content-Type	Header	Specifies the content type of the request body. Must be application/json.

Full URL Example

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

Request Body

The body of the request must be a JSON object containing the user's principal and the validation code.

Field	Type	Description
principal	String	The primary identifier for the user, such as [email protected].
validationCode	String	The validation code received by the user.
validIdentity	Boolean	Optional. Defaults to true. Set to false when you do not want to validate the identity of the person.

JSON

{
  "principal": "[email protected]",
  "validationCode": "12345"
}

{
  "principal": "[email protected]",
  "validationCode": "12345",
  "validIdentity": false
}