LexisNexis OTP Sender node
The LexisNexis One-Time Password (OTP) Sender node displays a list of available methods to send an OTP code. This supports sending OTP over email, SMS, and voice. The choice of OTP delivery method depends upon:
-
Whether the capability is activated in the node
-
If the necessary attribute is available in the user directory for the user
Compatibility
Product | Compatible? |
---|---|
Advanced Identity Cloud |
Yes |
PingAM (self-managed) |
Yes |
Ping Identity Platform (self-managed) |
Yes |
Inputs
The LexisNexis OTP Sender node reads the username
from shared state.
To provide the username
in shared state for LexisNexis OTP Sender node earlier in the journey configure a node, such as the Platform Username node.
During the journey, the node queries the user directory with the username to fetch the attributes required by subsequent nodes in the journey.
Dependencies
To use this node, you should have already set up Advanced Identity Cloud integration with the LexisNexis service.
Configuration
Property | Usage |
---|---|
Org ID |
A unique ID associated with your organization in the Dynamic Decision Platform (DDP). |
API Key |
The unique API key generated in the DDP portal to associate with the organization. |
OTP URL |
The URL for the DDP authentication hub API endpoint. The default URL is the worldwide endpoint. This should be modified for specific regions such as EU, US, or IN (India). |
Policy |
The DDP portal policy for associating the DDP authentication hub with the OTP. |
OTP Length |
Length of the OTP |
OTP Expire |
OTP validity time in minutes. |
Send Email |
Toggle to enable or disable OTP delivery over email. |
Email Title |
The title of the email sent to the user when OTP over email is triggered. |
Email Message |
The message body of the email sent to the user when email is triggered. |
Email Attribute |
The attribute in the user directory to get the email address for sending the OTP code at runtime. If the value is present, then this OTP delivery method is displayed; otherwise, this method is not displayed. |
Send SMS Text |
Toggle to enable or disable OTP delivery over SMS. |
SMS Message |
The message body of the SMS text message sent to the user when SMS/OTP is triggered. |
SMS Attribute |
The attribute to get the mobile phone number for sending the OTP over SMS. If the value is present, then this OTP delivery method is displayed; otherwise, this method is not displayed. |
Send Voice |
Toggle to enable or disable OTP delivery over voice. |
Voice Attribute |
The attribute in the user directory to get the user’s phone number to convey the OTP code over automated voice. If the value is present, then this OTP delivery method is displayed; otherwise, this method is not displayed. |
Outcomes
Success
-
The OTP code was successfully generated for the user. OTP generation does not guarantee delivery to the user’s device. The LexisNexis OTP Collector node allows for retry if the user does not receive the OTP.
None Available
-
No OTP delivery methods are available because the required attributes required are not configured for that user.
API Error
-
There is an issue with the API request, such as a network timeout, or the service is unavailable.
OTP Fail
-
The API request is rejected by the LexisNexis DDP authentication hub. The actual error code is logged in the debug log for the node.
Error
-
There is an integration error or a new bug is discovered. Check the debug log files for any integration issues.
Troubleshooting
If this node logs an error, review the log messages to find the reason for the error. If the configuration looks accurate, then open a support case with LexisNexis.
Example
Refer to Example LexisNexis OTP journey.