CLEAR Verified API (1.1)

Download OpenAPI specification:Download

Everything you need to get started with CLEAR Verified.

API Keys

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.
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

Payload
curl
Python
Node.js

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": ["string"
],
"activated_authentication_methods": [ ],
"checks": [{"name": "string",
"value": true,
"status": "completed",
"additional_details": {"watchlist_hits": {"hits": [{"entity_type": "person",
"details": {"name": [ ],
"alias": [ ],
"country": [ ],
"address": [ ],
"date_of_birth": [ ],
"date_of_death": [ ],
"place_of_birth": [ ],
"gender": [ ],
"nationality": [ ],
"position": [ ],
"passport_number": [ ],
"id_number": [ ],
"notes": [ ],
"created_at": [ ],
"modified_at": [ ],
"source_urls": [ ]
},
"source_lists": [null
],
"hit_types": [null
]
}
],
"updated_at": 0
}
},
"params": { }
}
],
"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": {"address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string"
},
"dob": {"day": 0,
"month": 0,
"year": 0
},
"email": "string",
"first_name": "string",
"last_name": "string",
"middle_name": "string",
"second_family_name": "string",
"full_last_name": "string",
"phone": "string",
"ssn4": "string",
"ssn9": "string",
"identification_number": "string",
"identification_type": "string",
"document": {"nationality": "string",
"document_type": "drivers_license",
"issuing_country": "string",
"issuing_subdivision": "string",
"document_number": "string",
"date_of_expiry": {"day": 0,
"month": 0,
"year": 0
},
"gender": "string",
"address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string"
},
"date_of_birth": {"day": 0,
"month": 0,
"year": 0
},
"first_name": "string",
"last_name": "string",
"middle_name": "string"
},
"document_front": "string",
"document_back": "string",
"face_scan_preview": "string"
},
"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 (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.

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

curl
Python
Node.js

Response samples

application/json

{"verifications": [{"id": "string",
"object_name": "verification_session",
"authenticated": true,
"authentication_methods": ["string"
],
"activated_authentication_methods": [ ],
"checks": [{"name": "string",
"value": true,
"status": "completed",
"additional_details": {"watchlist_hits": {"hits": [null
],
"updated_at": 0
}
},
"params": { }
}
],
"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": {"address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string"
},
"dob": {"day": 0,
"month": 0,
"year": 0
},
"email": "string",
"first_name": "string",
"last_name": "string",
"middle_name": "string",
"second_family_name": "string",
"full_last_name": "string",
"phone": "string",
"ssn4": "string",
"ssn9": "string",
"identification_number": "string",
"identification_type": "string",
"document": {"nationality": "string",
"document_type": "drivers_license",
"issuing_country": "string",
"issuing_subdivision": "string",
"document_number": "string",
"date_of_expiry": {"day": 0,
"month": 0,
"year": 0
},
"gender": "string",
"address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string"
},
"date_of_birth": {"day": 0,
"month": 0,
"year": 0
},
"first_name": "string",
"last_name": "string",
"middle_name": "string"
},
"document_front": "string",
"document_back": "string",
"face_scan_preview": "string"
},
"project_id": "string",
"custom_fields": { }
}
],
"links": {"current": "http://example.com",
"first": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com",
"last": "http://example.com",
"total_results": 0
}
}

Get Verification Session

SecurityAuthorization_Bearer

Request

path Parameters

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

curl
Python
Node.js

Response samples

application/json

{"id": "string",
"object_name": "verification_session",
"authenticated": true,
"authentication_methods": ["string"
],
"activated_authentication_methods": [ ],
"checks": [{"name": "string",
"value": true,
"status": "completed",
"additional_details": {"watchlist_hits": {"hits": [{"entity_type": "person",
"details": {"name": [ ],
"alias": [ ],
"country": [ ],
"address": [ ],
"date_of_birth": [ ],
"date_of_death": [ ],
"place_of_birth": [ ],
"gender": [ ],
"nationality": [ ],
"position": [ ],
"passport_number": [ ],
"id_number": [ ],
"notes": [ ],
"created_at": [ ],
"modified_at": [ ],
"source_urls": [ ]
},
"source_lists": [null
],
"hit_types": [null
]
}
],
"updated_at": 0
}
},
"params": { }
}
],
"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": {"address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string"
},
"dob": {"day": 0,
"month": 0,
"year": 0
},
"email": "string",
"first_name": "string",
"last_name": "string",
"middle_name": "string",
"second_family_name": "string",
"full_last_name": "string",
"phone": "string",
"ssn4": "string",
"ssn9": "string",
"identification_number": "string",
"identification_type": "string",
"document": {"nationality": "string",
"document_type": "drivers_license",
"issuing_country": "string",
"issuing_subdivision": "string",
"document_number": "string",
"date_of_expiry": {"day": 0,
"month": 0,
"year": 0
},
"gender": "string",
"address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string"
},
"date_of_birth": {"day": 0,
"month": 0,
"year": 0
},
"first_name": "string",
"last_name": "string",
"middle_name": "string"
},
"document_front": "string",
"document_back": "string",
"face_scan_preview": "string"
},
"project_id": "string",
"custom_fields": { }
}

Add Custom Fields to Verification Session

SecurityAuthorization_Bearer

Request

path Parameters

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

Payload
curl
Python
Node.js

application/json

{"custom_fields": {"property1": "string",
"property2": "string"
}
}

Response samples

application/json

{"id": "string",
"object_name": "verification_session",
"authenticated": true,
"authentication_methods": ["string"
],
"activated_authentication_methods": [ ],
"checks": [{"name": "string",
"value": true,
"status": "completed",
"additional_details": {"watchlist_hits": {"hits": [{"entity_type": "person",
"details": {"name": [ ],
"alias": [ ],
"country": [ ],
"address": [ ],
"date_of_birth": [ ],
"date_of_death": [ ],
"place_of_birth": [ ],
"gender": [ ],
"nationality": [ ],
"position": [ ],
"passport_number": [ ],
"id_number": [ ],
"notes": [ ],
"created_at": [ ],
"modified_at": [ ],
"source_urls": [ ]
},
"source_lists": [null
],
"hit_types": [null
]
}
],
"updated_at": 0
}
},
"params": { }
}
],
"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": {"address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string"
},
"dob": {"day": 0,
"month": 0,
"year": 0
},
"email": "string",
"first_name": "string",
"last_name": "string",
"middle_name": "string",
"second_family_name": "string",
"full_last_name": "string",
"phone": "string",
"ssn4": "string",
"ssn9": "string",
"identification_number": "string",
"identification_type": "string",
"document": {"nationality": "string",
"document_type": "drivers_license",
"issuing_country": "string",
"issuing_subdivision": "string",
"document_number": "string",
"date_of_expiry": {"day": 0,
"month": 0,
"year": 0
},
"gender": "string",
"address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string"
},
"date_of_birth": {"day": 0,
"month": 0,
"year": 0
},
"first_name": "string",
"last_name": "string",
"middle_name": "string"
},
"document_front": "string",
"document_back": "string",
"face_scan_preview": "string"
},
"project_id": "string",
"custom_fields": { }
}

CLEAR Verified API (1.1)

API Keys

Verification Sessions

Create Verification Session

header Parameters

Request Body schema: application/json

List Verification Sessions

query Parameters

header Parameters

Get Verification Session

path Parameters

header Parameters

Add Custom Fields to Verification Session

path Parameters

header Parameters

Request Body schema: application/json
required

Biographic Information Matching

Hydra Auth

Reports (beta)

Status Descriptions

Supported Identity Checks

Supported Document Types

Supported Watchlists

Supported National Identification Number Types

CLEAR Verified API (1.1)

API Keys

Login Sessions

Verification Sessions

Create Verification Session

header Parameters

Request Body schema: application/json

List Verification Sessions

query Parameters

header Parameters

Get Verification Session

path Parameters

header Parameters

Add Custom Fields to Verification Session

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Biographic Information Matching

Hydra Auth

Reports (beta)

Status Descriptions

Supported Identity Checks

Supported Document Types

Supported Watchlists

Supported National Identification Number Types

Request Body schema: application/json
required