API Keys

To access the Identity API, you'll need an API key. There are two types of API keys: sandbox and production.

Sandbox

• Sandbox API keys are for evaluating and testing the Identity API. You can generate sandbox API keys in the console. To test with CLEAR's Sandbox environment, just use your sandbox API key.

  🚧

  Verification sessions created in the Sandbox environment don't send OTPs or check data with live data sources.

• To control the user interface, you can enter the magic OTP code 123456 to verify your email or phone number. The default behavior in the Sandbox environment is to successfully verify all identity data. To reject a user's identity information, you can check the "Reject verification" checkbox.

Production

• Once you're ready to go live, contact your CLEAR support team to get an API key for live data.

The Identity API uses HTTP Bearer Auth to authenticate requests. All API requests need the header Authorization: Bearer <API_KEY>. Requests should be made over HTTPS only; requests made over plain HTTP will fail.