Authentication nodes

CLEAR ID Verification node

The CLEAR ID Verification node integrates CLEAR identity verification into your authentication journey.

Example

The following example journey verifies a user’s identity with CLEAR during registration:

Journey using the CLEAR ID Verification node

  • The journey starts with user registration.

  • The CLEAR ID Verification node verifies the user’s credentials.

  • The Set Document Number node, a Scripted Decision node, extracts the document number from the CLEAR verification response stored in node state and saves it to the user profile.

  • The Create Object node creates a new user object in the identity store with the verified information.

Availability

Product Available?

PingOne Advanced Identity Cloud

Yes

PingAM (self-managed)

Yes (1)

Ping Advanced Identity Software (self-managed)

Yes (1)

(1) For self-managed products, download the node from the Ping Identity Marketplace.

Inputs

The node reads the following from the node state, if available:

  • sessionId: the CLEAR verification session ID the node created earlier in the journey.

  • nonce: the nonce value the node generated earlier in the journey.

The node also reads the nonce query parameter from the request CLEAR sends back to Advanced Identity Cloud when it redirects the user to the journey.

Dependencies

To use this node, you must have access to a CLEAR Verified tenant. Learn more in Set up a CLEAR tenant.

Configuration

Property Usage

API Key

The API key for CLEAR.

Project ID

The project ID for the CLEAR project used for the integration.

Redirect URL

The target URL for the redirect after verification.

Use Secure Endpoint

If enabled, the node retrieves the user’s verification results from the secure endpoint; otherwise, the node uses the standard endpoint.

Default: Enabled

Outputs

This node writes the following to the node state:

  • sessionId: the CLEAR verification session ID.

  • nonce: the generated nonce value.

  • verificationResults: the user’s verification results from CLEAR. Learn more about the response format in the CLEAR documentation.

Callbacks

The node sends a RedirectCallback, which redirects the user’s browser to the CLEAR hosted verification UI.

Outcomes

Continue

The node retrieved the user’s verification results successfully.

Error

The node couldn’t complete the verification; for example, the nonce values didn’t match, or the verification results request failed.

Errors

The node can log the following errors:

  • [ClearNode][Version: <version>][Marketplace]Exception occurred

    An exception occurred while the node processed the verification. The node stores the exception message and stack trace in the node state.

  • Mismatched nonce value exiting out of journey.

    The nonce request parameter returned by CLEAR doesn’t match the nonce value stored in the node state.