logo
Powered by Redocly

CLEAR1 API (1.2)

Download OpenAPI specification:Download

Everything you need to get started with CLEAR1.

API Keys

Login Sessions

Verification Sessions

Create Verification Session

SecurityAuthorization_Bearer
Request
header Parameters
content-type
string (Content-Type)

Must be application/json

Authorization (string) or Authorization (null) (Authorization)
host
string (Host)
Request Body schema: application/json
redirect_url
string (Redirect URL)

If present, users will be redirected to this url upon successful verification.

Phone (string) or Phone (null) (Phone)

User phone number to be prefilled on phone entry screen. User may edit.

Email (string) or Email (null) (Email)

User email to be prefilled on email entry screen. User may edit.

Locale (null) or Locale (string) (Locale)

Locale to use for the user interface and any communication with the end-user. This will override any locale supplied by the user.

project_id
string (Project Id)

[Required] The project ID to use for this session.

custom_fields
object (Custom Fields)

Custom fields specified by you as key-value pairs.

Responses
200

Returns a Verification Session object.

400

Bad Request

401

Unauthorized

412

Precondition Failed

429

Too Many Requests

500

Internal Server Error

post/verification_sessions
Request samples
application/json
{
  • "auth_type": "sms",
  • "send_creator_email": true,
  • "sandbox": false
}
Response samples
application/json
{
  • "id": "string",
  • "object_name": "verification_session",
  • "authenticated": true,
  • "authentication_methods": [
    ],
  • "activated_authentication_methods": [ ],
  • "checks": [
    ],
  • "completed_at": 0,
  • "created_at": 0,
  • "email": "string",
  • "expires_at": 0,
  • "fields_to_collect": [ ],
  • "ip": [ ],
  • "phone": "string",
  • "redirect_url": "string",
  • "status": "success",
  • "token": "string",
  • "updated_at": 0,
  • "user_agent": [ ],
  • "user_created": false,
  • "user_id": "string",
  • "traits": {
    },
  • "project_id": "string",
  • "user_profile_information": {
    },
  • "custom_fields": { },
  • "user_profile_match_status": "string",
  • "idv_status": "string",
  • "sessions": [
    ]
}

List Verification Sessions

SecurityAuthorization_Bearer
Request
query Parameters
page_size
integer (Page Size)
Default: 25

Number of records per page.

page
integer (Page)
Default: 1

Page number of the current page.

sort_descending
boolean (Sort Descending)
Default: true

Whether to sort in descending (True) or ascending (False) order. By default, sorts descending.

sort_by
string (Sort By)
Default: "created_at"

Property to sort by. "created_at" by default.

Enum: "user_id" "status" "created_at" "updated_at" "completed_at" "expires_at" "creator_email" "first_name" "middle_name" "last_name" "second_family_name" "email" "phone" "user_created"
search_term
string (Search Term)
Default: ""

Search term for filtering results. Supports searching by a trait the user has consented to share (email, phone, name, etc.). Examples: 'my.email@example.com', '+15551234567', 'Alex Taylor'.

header Parameters
content-type
string (Content-Type)

Must be application/json

host
string (Host)
Authorization (string) or Authorization (null) (Authorization)
Responses
200

Returns a list of Verification Session objects.

400

Bad Request

401

Unauthorized

412

Precondition Failed

429

Too Many Requests

500

Internal Server Error

get/verification_sessions
Request samples 
Response samples 
application/json
{
  • "verifications": [
    ],
  • "links": {}
}
Get Verification Session
Retrieve verification session details.


Sensitive Data Handling:


    

  • By default, SPII such as SSNs and government ID images are not revealed in the response
    • 

  • To reveal this data, set the reveal_sensitive_data query parameter to true
    • 



⚠️ Deprecation Notice:
The previous approach of using https://secure.verified.clearme.com
to reveal sensitive PII is being deprecated. Please migrate to using the reveal_sensitive_data
query parameter instead.


SecurityAuthorization_Bearer 
Request 
path Parameters
id
required
string (ID) 
Verification Session ID


 
query Parameters
reveal_sensitive_data
boolean (Reveal Sensitive Data) 
Set to true to reveal sensitive data such as SSNs and government ID images.


 
header Parameters
content-type
string (Content-Type) 
Must be application/json


 
Authorization (string) or Authorization (null) (Authorization) 
 
Responses 
200
Returns a Verification Session object.


400
Bad Request


401
Unauthorized


412
Precondition Failed


429
Too Many Requests


500
Internal Server Error


get/verification_sessions/{id}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "object_name": "verification_session",
  • "authenticated": true,
  • "authentication_methods": [
    ],
  • "activated_authentication_methods": [ ],
  • "checks": [
    ],
  • "completed_at": 0,
  • "created_at": 0,
  • "email": "string",
  • "expires_at": 0,
  • "fields_to_collect": [ ],
  • "ip": [ ],
  • "phone": "string",
  • "redirect_url": "string",
  • "status": "success",
  • "token": "string",
  • "updated_at": 0,
  • "user_agent": [ ],
  • "user_created": false,
  • "user_id": "string",
  • "traits": {
    },
  • "project_id": "string",
  • "user_profile_information": {
    },
  • "custom_fields": { },
  • "user_profile_match_status": "string",
  • "idv_status": "string",
  • "sessions": [
    ]
}
Add Custom Fields to Verification Session
SecurityAuthorization_Bearer 
Request 
path Parameters
id
required
string (ID) 
Verification Session ID


 
header Parameters
content-type
string (Content-Type) 
Must be application/json


 
Authorization (string) or Authorization (null) (Authorization) 
 
Request Body schema: application/json
required
required
object (Custom Fields) 
Custom fields specified by you as key-value pairs.


 
Responses 
200
Successful Response


400
Bad Request


401
Unauthorized


412
Precondition Failed


429
Too Many Requests


500
Internal Server Error


post/verification_sessions/{id}/custom_fields
Request samples 
application/json
{
  • "custom_fields": {
    }
}
Response samples 
application/json
{
  • "id": "string",
  • "object_name": "verification_session",
  • "authenticated": true,
  • "authentication_methods": [
    ],
  • "activated_authentication_methods": [ ],
  • "checks": [
    ],
  • "completed_at": 0,
  • "created_at": 0,
  • "email": "string",
  • "expires_at": 0,
  • "fields_to_collect": [ ],
  • "ip": [ ],
  • "phone": "string",
  • "redirect_url": "string",
  • "status": "success",
  • "token": "string",
  • "updated_at": 0,
  • "user_agent": [ ],
  • "user_created": false,
  • "user_id": "string",
  • "traits": {
    },
  • "project_id": "string",
  • "user_profile_information": {
    },
  • "custom_fields": { },
  • "user_profile_match_status": "string",
  • "idv_status": "string",
  • "sessions": [
    ]
}
Biographic Information Matching
Create Biometric Information Matching Session
SecurityAuthorization_Bearer 
Request 
path Parameters
id
required
string (ID) 
Verification Session ID


 
header Parameters
content-type
string (Content-Type) 
Must be application/json


 
Authorization (string) or Authorization (null) (Authorization) 
 
Request Body schema: application/json
required
required
object (UserProfileMatchingRequestDetails) 
Details object for user profile matching session.


 
Responses 
200
Returns the result(s) of a Biographic Information Matching Session.


400
Bad Request


401
Unauthorized


412
Precondition Failed


429
Too Many Requests


500
Internal Server Error


post/biographic_match/{id}
Request samples 
application/json
{
  • "biographic_information": {
    }
}
Response samples 
application/json
{
  • "biographic_information": {
    },
  • "user_id": "string"
}
Reports (beta)
SCIM
System for Cross-domain Identity Management (SCIM) is a standard for automating the exchange of user identity information between identity domains or IT systems. The SCIM API is used to create, read, update, and delete users in the CLEAR1 system.


Verification Status Descriptions
Session Status Descriptions
User Profile Match Status Descriptions
Supported Identity Checks
Supported Document Types
Supported Watchlists
Supported National Identification Number Types