logo
Powered by Redocly

CLEAR Verified API (1.1)

Download OpenAPI specification:Download

Everything you need to get started with CLEAR Verified.

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 (Authorization)

Bearer

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.

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.

is_webview
boolean (Is Webview)
Default: false

Set to true if using the Webview integration method.

project_id
string (Project Id)

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

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",
  • "is_webview": false,
  • "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",
  • "custom_fields": {
    }
}

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 (SortByOptions)
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.

header Parameters
content-type
string (Content-Type)

Must be application/json

host
string (Host)
authorization
string (Authorization)

Bearer

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
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 (Authorization) 
Bearer 


 
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",
  • "custom_fields": {
    }
}
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 (Authorization) 
Bearer 


 
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",
  • "custom_fields": {
    }
}
Reports (beta)
Status Descriptions
Supported Identity Checks
Supported Document Types
Supported Watchlists
Supported National Identification Number Types