Submitting Captured Data
Applies to: Direct
After you receive a response from the /start
endpoint, the next step is to submit captured data to another endpoint. Captured data might be in the form of a barcode, a front image, or a back image from the identification document. You must submit different types of captured data based on the combination of document_type
and signals
in the /start
request.
For example, suppose you submitted na_dl
as the document_type
along with idcheck
in the signals
array. This is a common combination used to verify a North American driver license. The /start
endpoint returned a transaction_id
value. You could next use the /submit-back
endpoint to submit transaction_id
along with back
, which is a base64-encoded string of image data from the backside of the driver license.
Our Direct customers must capture and encode the document images separately.
The following table shows the capture data requirements for common document_type
and signals
combinations.
Document Type | Signals | Barcode | Frontside of ID | Backside of ID | Selfie |
---|---|---|---|---|---|
na_dl | idcheck | Yes or Backside of ID | No | Yes or Barcode | No |
na_dl | idcheck with ocr_scan | Yes or Backside of ID | Yes | Yes or Barcode | No |
na_dl | idcheck with kyc | Yes or Backside of ID | No | Yes or Barcode | No |
na_dl | idcheck with criminal_background | Yes or Backside of ID | No | Yes or Barcode | No |
na_dl | idcheck with ocr_match and ocr_scan | Yes | Yes | Yes | No |
na_dl | selfie with ocr_scan | No | Yes | No | Yes |
passport | ocr_scan | No | Yes | No | No |
passport | kyc with ocr_scan | No | Yes | No | No |
passport | ocr_scan with criminal_background | No | Yes | No | No |
passport | ocr_match with ocr_scan | No | Yes | No | No |
other | ocr_scan | No | Yes | Yes | No |
other | kyc with ocr_scan | No | Yes | Yes | No |
other | ocr_scan with criminal_background | No | Yes | Yes | No |
other | ocr_match with ocr_scan | No | Yes | Yes | No |
Updated 10 months ago