Understanding Multi-Signal Requests

Applies to: Direct | Capture

To understand whether a private_data object is correct, first consider the document_type. Then make sure the required signal is included. Then evaluate the remaining signals.

Consider the following private_data object.

{  
  "private_data": {  
    "document_type": "na_dl",
    "signals": [
      "idcheck",
      "ocr_scan",
      "ocr_match",
      "selfie",
      "email_validation"
    ]
  }
}
  • There is one document type, na_dl. You can only include one document type per request.
  • The required signal for that document type is included, idcheck.
  • Since ocr_match is requested, ocr_scan is also requested.
  • selfie and email_validation are both valid signals for na_dl.

The following illustration shows this request in the API explorer.

You can understand if a private_data object is correct by:

  • Requesting only one document type
  • Including the required signal
  • Considering each remaining member of the signals array