Download OpenAPI specification:Download
Everything you need to get started with CLEAR Verified.
Returns a Verification Session object.
Bad Request
Unauthorized
Precondition Failed
Too Many Requests
Internal Server Error
{- "auth_type": "sms",
- "send_creator_email": true,
- "sandbox": false
}
{- "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": { }
}
Returns a list of Verification Session objects.
Bad Request
Unauthorized
Precondition Failed
Too Many Requests
Internal Server Error
{- "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": {
- "total_results": 0
}
}
⚠️ The base URL is different for this endpoint!
Please use 'https://secure.verified.clearme.com' as the base URL for this endpoint to receive sensitive PII such as SSNs and government ID images.
Returns a Verification Session object.
Bad Request
Unauthorized
Precondition Failed
Too Many Requests
Internal Server Error
{- "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": { }
}
required | object (Custom Fields) Custom fields specified by you as key-value pairs. |
Successful Response
Bad Request
Unauthorized
Precondition Failed
Too Many Requests
Internal Server Error
{- "custom_fields": {
- "property1": "string",
- "property2": "string"
}
}
{- "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": { }
}
required | object (BiographicInformationMatchingRequestDetails) Details object for biographic information matching session. |
Returns the result(s) of a Biographic Information Matching Session.
Bad Request
Unauthorized
Precondition Failed
Too Many Requests
Internal Server Error
{- "biographic_information": {
- "name": { }
}
}
{- "biographic_information": {
- "property1": {
- "success": true,
- "confidence_score": 0,
- "error": "string"
}, - "property2": {
- "success": true,
- "confidence_score": 0,
- "error": "string"
}
}, - "user_id": "string"
}
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 CLEAR Verified system.