Overview

This guide covers what is required to build and host CLEAR within your platform.

Layer 1: Admin UI

The Admin UI layer is a critical component when building a platform integrations. It ensures the following

1. Customer data flows into their CLEAR tenant so they own and control the data. This ensures they can track a user across all of their deployed use cases. Customers want to track which use cases their end users have verified through. It is critical that each platform deployment allows for customers to input their CLEAR credentials (ProjectIDs and API keys)
2. Customer data flows into their tenant within your software platform. The customer likely has data flowing through

CLEAR Credential Input

• Credential Input - Within your platform please provide a UI that enables customers to plug in their CLEAR projectIDs and API key
• Security - Ensure API keys, secrets, and other sensitive values are stored and managed using the organization’s standard secrets management and key rotation policies

Credential Validation

• Once a customer adds their CLEAR credentials, please allow the users to test their credentials by adding "test credentials" functionality. To test, please use the credentials and call out create_verification_session API: Link to create verification session API here
  • This ensures the CLEAR credentials are formatted correctly and that the credentials will work when passing them through during through for the end user experience.

Layer 2: End User Experience

Summary

Customers will use CLEAR to verify their end users. They will expect that after verification the end user will complete the use case your platform provides.

Example: if your platform is used for self service password reset, CLEAR is not the verification layer in front of that. Your platform will use the verification decision to determine whether or not the user should reset their password.

Layer 2 is what is needed to trigger CLEAR natively within your platform using customer CLEAR credentials. As the software platform, you hosts the infrastructure, and the data flows into the customer tenant within your platform. The customer owns the data and it is stored in the customer tenant.

Layer 2 will use CLEAR standard integration which ensures a that customer's end users are verified, and that the user CLEAR returns matches to the original user who initiated the verification.

The key difference between our standard integration and our platform integration is that the customers input CLEAR credentials from step 1, and they must be used during the end user experience so that the customer owns and controls their data, and that it flows back into the CLEAR console

How To Build

For guidance on how to build the end user experience please refer to our Standard Integration

Key Takeaways

• The difference between platform integrations and customer integrations is that an admin UI is required that allows customers to input their own CLEAR credentials
• The end user experience development follows the same pattern as the standard integration, it just uses customer specific credentials from layer 1.