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 ofocr_match
.
Development Signal Name | Conversational Equivalent | Description |
---|---|---|
document_liveness_idrnd | Doc Liveness | Document probability checks for on-screen presentation, printed copy, and portrait substitution. |
email_validation | Email Verify | Customer email address check. |
idcheck | Authoritative North America Barcode | Barcode analysis on North American driver licenses, including real IDs, and extended IDs. |
ocr_match | Doc Verify | Compare OCR scan to barcode or MRZ data. |
ocr_scan | International Verify | OCR scan and templating on passport books, passport cards, and other forms of identification. |
selfie | Face Verify | Facial 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"
],
}
}
Updated 2 days ago