Intellicheck Capture API
The /start
API allows you to choose Signals for ID verification. For example, you may subscribe to selfie
, idcheck
, and kyc
. However, you may not want to use all of these signals for every circumstance. In that case, you can specify just one or two in the /start
signals
parameter.
The following table describes each of the available signals.
Signal | Description |
---|---|
idcheck | Barcode analysis on North American driver licenses, including real IDs, and extended IDs. |
kyc | Watchlists background check. This provides watchlists and sanctions screening based on a tiered approach. Watchlists include Office of Foreign Asset Control (OFAC), sanctions, regulatory, criminal, politically exposed person (PEP), head of international organization (HIO), and high-risk business (HRB). |
ocr_match | Compare OCR scan to barcode or MRZ data. |
ocr_scan | OCR scan on passport books, passport cards, and other forms of identification. |
selfie | Facial matching and liveness. |
criminal_background | Criminal background check. |
Your company must subscribe to signals. Contact Intellicheck Support for subscription assistance.
Signal Selection
To selectively apply signals in the /start
endpoint, you use the signals
parameter in the request body. If you do not provide these parameters, all data for signals to which your company account is subscribed will be returned.
For example, the following /start
private_data
request body could be used to obtain watchlists (kyc
) and (ocr_scan
) results for a passport:
{
"private_data": {
"document_type": "passport",
"signals": [
"kyc",
"ocr_scan"
],
}
}
To additionally obtain the results of a criminal background check, (criminal_background
), the /start
private_data
request body might look like this:
{
"private_data": {
"document_type": "passport",
"signals": [
"kyc",
"ocr_scan",
"criminal_background"
],
}
}