Guides

Testing Known User Key Flow (Sandbox)

This guide demonstrates how to test the known user key flow in the CLEAR sandbox environment using synthetic test identities.

📘

You must trigger an establish identity workflow in your CLEAR tenant and complete a verification session prior to triggering a known user key flow.

Please complete a session with one of the identites listed below before triggering the known user key flow

Overview

The known user key flow allows you to create verification sessions for users who have already been verified by CLEAR. This is useful for re-verification scenarios or when you need to validate an existing user's identity.

⚠️

Sandbox Environment

All examples in this document are for the sandbox environment only. The synthetic test identities will always return a mock api response



How to Use the User ID

To trigger the sandbox userID verification session creation, the user_id to pass in follows the format: first-last-user-id

For example, for "Ellen Doe", you would use "ellen-doe-user-id" in your API request.

Sample Request Format

curl --request POST \
  --url 'https://verified.clearme.com/v1/verification_sessions' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <SANDBOX_API_KEY>' \
  --header 'content-type: application/json' \
  --data '{
    "user_id": "ellen-doe-user-id",
    "project_id": "<REVERIFICATION_PROJECT_ID>"
  }'

Simply replace "ellen-doe-user-id" with the appropriate user ID from the table below.

📝

Note: For re-verification flows, use your re-verification project ID in the project_id field.

Available Synthetic Test Identities

NamePhone NumberEmailDOBGenderAddressRecordsSSNUser ID
Allison Hackett608-555-1243[email protected]01/15/1987Female1325 Main St, Madison, WI, US 57303Epic, MedAllies-allison-hackett-user-id
Damon Mychart608-211-3314[email protected]07/26/1979Male308 Oak St, Madison, WI, US 53711Epic, MedAllies-damon-mychart-user-id
Dog Beaker410-707-2690[email protected]11/24/1985Male124 Lake Street, Vernon, CT, US 06066MedAllies-dog-beaker-user-id
Barbara Testa831-600-3769[email protected]05/24/1947Female8855 Orchid Blvd, Reading, PA, US 19602MedAllies-barbara-testa-user-id
Tracy CraneTest222-360-1564[email protected]12/26/1936Female458 Streich Street, Lunenburg, MA, US 01462Commonwell-tracy-cranetest-user-id
Camila Maria Lopez469-469-4321[email protected]09/12/1987Female3268 West Johnson St. Apt 117, Garland, TX, US 75043Epic, Commonwell, MedAllies-camila-maria-lopez-user-id
Derrick Lin785-785-4321[email protected]06/03/1973Male7324 Roosevelt Ave, Indianapolis, IN, US 46201Epic, Commonwell, MedAllies-derrick-lin-user-id
Homer J Simpson217-123-3608[email protected]02/09/1975Male742 Evergreen Terrace, Madison, WI, US 53711Commonwell-homer-j-simpson-user-id
Margaret Smith706-123-4567[email protected]01/02/1960Female123 Peachtree Road Augusta, GA, US 30909Kno2-margaret-smith-user-id
Ellen Doe401-555-1940[email protected]03/07/1940Female110 Westminster St Providence, RI, US 02903CMS900090009ellen-doe-user-id

Test Examples

Example 1: Allison Hackett - Re-verification

curl --request POST \
  --url 'https://verified.clearme.com/v1/verification_sessions' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <SANDBOX_API_KEY>' \
  --header 'content-type: application/json' \
  --data '{
    "user_id": "allison-hackett-user-id",
    "project_id": "<REVERIFICATION_PROJECT_ID>"
  }'

Example 2: Damon Mychart - Re-verification

curl --request POST \
  --url 'https://verified.clearme.com/v1/verification_sessions' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <SANDBOX_API_KEY>' \
  --header 'content-type: application/json' \
  --data '{
    "user_id": "damon-mychart-user-id",
    "project_id": "<REVERIFICATION_PROJECT_ID>",
    "verification_type": "re_verification"
  }'

Example 3: Dog Beaker - Re-verification

curl --request POST \
  --url 'https://verified.clearme.com/v1/verification_sessions' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <SANDBOX_API_KEY>' \
  --header 'content-type: application/json' \
  --data '{
    "user_id": "dog-beaker-user-id",
    "project_id": "<REVERIFICATION_PROJECT_ID>"
  }'

Example 4: Barbara Testa - Re-verification

curl --request POST \
  --url 'https://verified.clearme.com/v1/verification_sessions' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <SANDBOX_API_KEY>' \
  --header 'content-type: application/json' \
  --data '{
    "user_id": "barbara-testa-user-id",
    "project_id": "<REVERIFICATION_PROJECT_ID>",
    "verification_type": "re_verification"
  }'

Example 5: Tracy CraneTest - Re-verification

curl --request POST \
  --url 'https://verified.clearme.com/v1/verification_sessions' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <SANDBOX_API_KEY>' \
  --header 'content-type: application/json' \
  --data '{
    "user_id": "tracy-cranetest-user-id",
    "project_id": "<REVERIFICATION_PROJECT_ID>"
  }'

Example 6: Camila Maria Lopez - Re-verification

curl --request POST \
  --url 'https://verified.clearme.com/v1/verification_sessions' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <SANDBOX_API_KEY>' \
  --header 'content-type: application/json' \
  --data '{
    "user_id": "camila-maria-lopez-user-id",
    "project_id": "<REVERIFICATION_PROJECT_ID>",
    "verification_type": "re_verification"
  }'

Example 7: Derrick Lin - Initial Verification

curl --request POST \
  --url 'https://verified.clearme.com/v1/verification_sessions' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <SANDBOX_API_KEY>' \
  --header 'content-type: application/json' \
  --data '{
    "user_id": "derrick-lin-user-id",
    "project_id": "<REVERIFICATION_PROJECT_ID>"
  }'

Example 8: Homer J Simpson - Re-verification

curl --request POST \
  --url 'https://verified.clearme.com/v1/verification_sessions' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <SANDBOX_API_KEY>' \
  --header 'content-type: application/json' \
  --data '{
    "user_id": "homer-j-simpson-user-id",
    "project_id": "<REVERIFICATION_PROJECT_ID>",
    "verification_type": "re_verification"
  }'

Example 9: Margaret Smith - Initial Verification

curl --request POST \
  --url 'https://verified.clearme.com/v1/verification_sessions' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <SANDBOX_API_KEY>' \
  --header 'content-type: application/json' \
  --data '{
    "user_id": "margaret-smith-user-id",
    "project_id": "<REVERIFICATION_PROJECT_ID>"
  }'

Example 10: Ellen Doe - Re-verification

curl --request POST \
  --url 'https://verified.clearme.com/v1/verification_sessions' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <SANDBOX_API_KEY>' \
  --header 'content-type: application/json' \
  --data '{
    "user_id": "ellen-doe-user-id",
    "project_id": "<REVERIFICATION_PROJECT_ID>",
    "verification_type": "re_verification"
  }'

Important Notes

  • ✅ Synthetic identities will always return successful verification in sandbox
  • ❌ To simulate a failed verification, use fail this check
  • 🔑 Replace <sandbox_api_key> with your actual sandbox API key
  • 📋 Replace <project_id> with your actual project identifier
  • 🌐 All requests should be made to the sandbox environment: https://verified.clearme.com

Next Steps

After successful verification, you can:

  1. Retrieve verification session details
  2. Integration with your application workflow

Updated about 11 hours ago

Did this page help you?