Signal Descriptions

Applies to: Direct | Capture

The /start API allows you to choose Signals for ID verification. Specify them in the /start signals parameter.

The following table describes each of the available signals. In the table:

  • The Development Signal Name column shows the signal name as required in the signals array of the /start request.
  • The Conversational Equivalent column shows the equivalent signal name as it's commonly used in everyday conversation. For example, ocr_match is necessary for coding, while Doc Verify is the equivalent conversational usage of ocr_match.
Development Signal NameConversational EquivalentDescription
document_liveness_idrndDoc LivenessDocument probability checks for on-screen presentation, printed copy, and portrait substitution.
email_validationEmail VerifyCustomer email address check.
idcheckAuthoritative North America BarcodeBarcode analysis on North American driver licenses, including real IDs, and extended IDs.
ocr_matchDoc VerifyCompare OCR scan to barcode or MRZ data.
ocr_scanInternational VerifyOCR scan and templating on passport books, passport cards, and other forms of identification.
selfieFace VerifyFacial matching and static liveness.

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 for the International Verify signal to validate a passport booklet (ocr_scan) and the Doc Verify signal to return OCR match results (ocr_match).

{  
  "private_data": {
    "document_type": "passport",
    "signals": [  
      "ocr_match",  
      "ocr_scan"  
    ],      
  }  
}

To additionally obtain the results of the Face Verify signal (selfie), the /start private_data request body might look like this.

{  
  "private_data": {
    "document_type": "passport",
    "signals": [  
      "ocr_match",  
      "ocr_scan",
      "selfie"
    ],      
  }  
}