Skip to main content
POST
Generate OTP by Relation Reference
Sends an OTP to a member identified by their RelationReference (CID). This is the preferred OTP trigger for member-facing portals where the CID is already established in your session — it avoids an extra lookup compared to the email-based flow. Loyalife routes the OTP to the member’s registered channel based on their program configuration. Follow this call with Verify OTP by Relation Reference to complete verification.

OtpType Values

Responses

Verify the OTP using Verify OTP by Relation Reference.
OTP expiry duration, delivery channel, and maximum attempt limits are configurable at the program level in Loyalife Admin. Confirm these values with your Xoxoday implementation contact.

Authorizations

Authorization
string
header
required

JWT obtained from Generate Auth Token. Pass as Authorization: bearer {token}.

Body

application/json
UniquerefID
string
required

The member's RelationReference (CID)

Example:

"jane.doe@example.com"

SourceCode
enum<integer>
required

1=Web, 2=Mobile, 3=Email, 4=Service

Available options:
1,
2,
3,
4
Example:

1

SourceAddress
string
required

IP address of the requesting system

Example:

"192.168.1.1"

OtpType
enum<string>
required

Purpose of the OTP. Must match between Generate and Verify calls.

Available options:
ACTIVATION,
LOGIN,
FORGOTPWD,
CHANGEPASSWORD,
RESETPASSWORD,
FORGOTUSERNAME,
TwoFA,
UNBLOCKMEMBER,
NONE,
CASHBACKCONFIRM,
POINTTRANSFERCONFIRM,
FAMILYPOOLINGMERGE,
FAMILYPOOLINGUNMERGE,
AIRREVIEWNCONFIRM,
DOMESTICFLIGHTREVIEWNCONFIRM,
HOTELREVIEWNCONFIRM,
CARREVIEWNCONFIRM,
GIFTCARDREVIEWNCONFIRM,
PACKAGEREVIEWNCONFIRM,
SHOPREVIEWNCONFIRM,
SHOPDIGITALREVIEWNCONFIRM,
MERCHANTREVIEWNCONFIRM,
ISPREVIEWNCONFIRM,
INSURANCEREVIEWNCONFIRM
Example:

"LOGIN"

ProgramId
integer
required
Example:

19

RelationType
integer
required

Use 4 for customers

Example:

4

Response

200 - application/json

OTP sent