CLEAR Verification Sessions API

The Verification Sessions API from CLEAR — 4 operation(s) for verification sessions.

Documentation Provider Profile APIs.io OpenAPI GitHub

CLEAR Verification Sessions API is published by CLEAR on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Verification Sessions. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 6 operations across 4 paths, and defines 49 schemas. It is described by OpenAPI 3.1.0, at version 1.1.

Requests are made against a single base URL, https://verified.clearme.com/v1.

6 operations 4 paths 49 schemas 3 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.1.0

API Version

1.1

Base URL

https://verified.clearme.com/v1

Authentication

HTTP Bearer

Resource Areas

Authentication & Security 1

CLEAR Verification Sessions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Authorization_Bearer). By default, every request must be authenticated.

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 3 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Verification Sessions 6

POST

/verification_sessions

Create Verification Session

create_verification_session body → 200400401412429500

GET

/verification_sessionsdeprecated

List Verification Sessions

list_verifications 5 params → 200400401412429500

POST

/verification_sessions/{id}/custom_fields

Add Custom Fields to Verification Session

add_custom_fields_verification_vendor_backend 1 param body → 200400401412429500

GET

/verification_sessions/{id}

Get Verification Session

get_verification 2 params → 200400401412429500

PUT

/verification_sessions/{id}

Submit User Profile Information for Verification Session

update_verification_session 1 param body → 200400401412429500

GET

/verification_sessions/search

Search Verification Sessions with Advanced Filters

search_verification_sessions 14 params → 200400401412429500

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are VerificationSessionOut (28 properties), TraitsOut (20 properties), WatchlistHitDetails (16 properties), DocumentOut (14 properties). Each schema is shown below with its type and property counts.

SessionInfoOut

object

Information gathered from the user's frontend session.

6 properties

VerificationStatus

string

The statuses that a verification can be in.

APIError401Out

object

3 properties

APIError412Out

object

3 properties

NameMatchingModel

object

Parameters for creating a name for matching

3 properties

APIError429Out

object

3 properties

UserProfileMatchingRequestDetailsV2

object

User profile matching details for verification session.

5 properties

KeysetPaginatedVerificationSessionsOut

object

3 properties

WatchlistHitEntityType

string

VerificationSessionsOut

object

2 properties

AddressOut

object

Verified address object returned to the vendor.

6 properties

VerificationSearchSortField

string

UserProfileMatchingResponseDetailsV2

object

Response object for user profile matching in verification sessions.

5 properties

SoraExternalCheckExport

object

7 properties 1 required

WatchlistHits

object

2 properties 1 required

ErrorType412

string

ErrorType401

string

FieldErrors

object

3 properties 3 required

SoraExternalCheckAdditionalDetails

object

Additional details returned for some checks.

1 property

NameMatchingModelV2

object

Parameters for creating a name for matching, excluding middle name.

2 properties

CustomFieldsIn

object

1 property 1 required

APIError500Out

object

3 properties

DocumentOut

object

Verified document object returned to the vendor.

14 properties

TraitsOut

object

Information collected from the user returned to the vendor.

20 properties

SoraDocumentTypeEnum

string

WatchlistHitDetails

object

Details about the watchlist hit person

16 properties

WatchlistSource

object

Information regarding the source of the watchlist hit

3 properties 3 required

VerificationOptions

object

Options for verification session creation.

8 properties

SortByOptions

string

AddressMatchingModel

object

Parameters for creating an address for matching

6 properties

LocationInfo

object

Information about where a request came from parsed from its IP or other request-level information.

7 properties

VerificationUpdateOptions

object

1 property

VerifiedEmailOut

object

Verified email object returned to the vendor.

3 properties

APIError400Out

object

3 properties

HealthInsuranceOut

object

Verified health insurance object returned to the vendor.

8 properties

ErrorType500

string

PaginationLinks

object

Links to other response pages for paginated responses

6 properties

Date

object

A date object.

3 properties

ErrorType400

string

WatchlistDate

object

3 properties 1 required

WatchlistHit

object

4 properties 3 required

WatchlistHitTypes

string

Types of watchlist hits.

VerificationSessionOut

object

We return data in the following schema for our Verification Session routes.

28 properties

HistoricalNameOut

object

10 properties

VerificationSearchSortDirection

string

VerificationSessionStatus

string

The statuses that a a verification session can be in.

HistoricalDataOut

object

2 properties

ErrorType429

string

HistoricalAddressOut

object

14 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

#Verification Sessions

← Back to C APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

CLEAR Verification Sessions API

Metadata

Authentication & Security 1

Paths & Operations 6

Schemas 49

Specification

Source

API Details

Provider

Explore more