CLEAR ID Verification node

Use the CLEAR ID Verification node to integrate CLEAR verification in your authentication journey.

Compatibility

Product	Compatible?
Advanced Identity Cloud	Yes
PingAM (self-managed)	Yes
Ping Identity Platform (self-managed)	Yes

Product

Compatible?

Advanced Identity Cloud

Yes

PingAM (self-managed)

Yes

Ping Identity Platform (self-managed)

Yes

None. This node doesn’t read shared state data.

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

Property	Usage
CLEAR API Key	Environment API Key for CLEAR.
CLEAR Project ID	Google Cloud administrator’s private key.
Key ID	The tenant ID for the CLEAR project used for integration.
Redirect URL	The target URL for redirection after verification.
Use Secure Endpoint	If this toggle is enabled, the node uses the secure endpoint to retrieve user verification results; otherwise, the node uses the standard endpoint.

Property

Usage

CLEAR API Key

Environment API Key for CLEAR.

CLEAR Project ID

Google Cloud administrator’s private key.

Key ID

The tenant ID for the CLEAR project used for integration.

Redirect URL

The target URL for redirection after verification.

Use Secure Endpoint

If this toggle is enabled, the node uses the secure endpoint to retrieve user verification results; otherwise, the node uses the standard endpoint.

The ID Verification results are stored in the verificationResults shared state attribute. An example of data is provided here.

If this node logged an error, review the log messages for the transaction and contact CLEAR support for further troubleshooting.

The example journey shows the following:

The journey starts with user registration.
CLEAR ID Verification node verifies the user credentials.
The Scripted Decision node is a scripted decision node extracts the document number from the CLEAR verification response stored in shared state and stores it on the user object.