PingOne Credentials Verification node
The PingOne Credentials Verification node initiates verification of PingOne credentials. The actual task of verification is performed by the PingOne Credentials service and not by this node.
Compatibility
| Product | Compatible? |
|---|---|
Advanced Identity Cloud |
Yes |
PingAM (self-managed) |
Yes |
Ping Identity Platform (self-managed) |
Yes |
Inputs
If the Push delivery method is selected, this node retrieves
pingOneApplicationInstanceId from the journey state.
If Custom Requested Credentials is selected, this node retrieves requestedCredentials from journey state.
Dependencies
This node requires that the PingOne Worker Service is configured so that it can connect to your PingOne instance and initiate PingOne credentials verification.
Configuration
| Property | Usage | ||
|---|---|---|---|
PingOne Worker service ID |
The ID of the PingOne Worker service for connecting to PingOne. |
||
Credential Type |
Type of credential to verify. Must be the name of a PingOne credential type issued by the credential issuer. |
||
Disclosure Attribute Keys |
Attribute key names for selective disclosure to return from the credential. |
||
Digital Wallet Application ID |
Digital Wallet Application ID from PingOne Credentials required for the Push delivery method. |
||
Verification URL Delivery Method |
The delivery method (QR code or Push) for delivering the verification URL. |
||
Allow user to choose the URL delivery method |
To prompt the user to select the URL delivery method. |
||
Delivery method message |
The message to display to the user allowing them to select the delivery method
(QR Code or |
||
QR code message |
The message with instructions to scan the QR code and begin credential verification. |
||
Waiting Message |
Localization overrides for the waiting message. This is a map of locale to message. |
||
Push Message |
A custom message for the user when requesting the credential. |
||
Store Credential Verification Response |
Store the list of verified data submitted by the user in the shared state
under the
|
||
Verification Timeout |
The period of time (in seconds) to wait for a response to the verification request. If no response is received within this time, the node times out and the verification process fails. |
||
Custom Requested Credentials |
If selected, a custom requested credentials payload is retrieved from the |
Outputs
-
pingOneCredentialVerification: The new PingOne Credential Verification request status and full response. -
pingOneApplicationInstanceId: The identifier of the application running the Wallet SDK on the user’s device and registered with the service.
Outcomes
Success-
The credential verification was successful.
Error-
There was an error during the verification process.
Time Out-
The verification process reached the configured timeout value.
Troubleshooting
If this node logs an error, review the log messages to find the reason for the error and address the issue appropriately.
If any of the API calls to PingOne Credentials fail, the following errors may be logged:
-
Error: PingOne Credentials Create Verification session- Status Code - Response Body. -
Error: PingOne Credentials Create Push Verification session- Status Code - Response Body. -
Error: PingOne Credentials Read a Verification session- Status Code - Response Body.
Example
Learn more in an example journey using PingOne Credentials nodes.