Scanner

4. Scanner

This category supports all scanning-related functions specifically used to initiate a new identity document scan & ID face verification transaction by uploading based64-encoded images.

4.1. scan

This function Initiate a new identity document scan & ID face verification transaction by providing input images.

Declaration

(async) scan(documentFront, documentBack, facePhoto, faceVideo) → {Promise.<*>}

Here are the input and output parameters defined against this function.

Type (In/Out)	Name	Description
String - [In]	documentFront	Front of Document (file path, base64 content, URL, or cache reference). The function will use BLANK value if the parameter is left out during execution. The function will throw an exception if BLANK value is passed in this parameter.
String - [In]	documentBack	Back of Document (file path, base64 content, URL, or cache reference). The function will use BLANK value if the parameter is left out during execution.
String - [In]	facePhoto	Face Photo (file path, base64 content, URL, or cache reference). The function will use BLANK value if the parameter is left out during execution.
String - [In]	faceVideo	Face Video (file path, base64 content, or URL). The function will use BLANK value if the parameter is left out during execution.
Object - [Out]	N/A	The scan result object streamed into `$payload` named parameter and returned.

4.2. quickScan

This function lets the developer initiate a quick identity document OCR scan by providing input images.

Declaration

(async) quickScan(documentFront, documentBack, cacheImage) → {Promise.<*>}

Here are the input and output parameters defined against this function.

Type (In/Out)	Name	Description
String - [In]	documentFront	Front of Document (file path, base64 content, URL, or cache reference). The function will use BLANK value if the parameter is left out during execution. The function will throw an exception if BLANK value is passed in this parameter.
String - [In]	documentBack	Back of Document (file path, base64 content, URL, or cache reference). The function will use BLANK value if the parameter is left out during execution.
Boolean - [In]	cacheImage	Cache uploaded image(s) for 24 hours and obtain a cache reference for each image; the reference hash can be used to start a standard scan transaction without re-uploading the file. The function will use false value in case the parameter is left out during execution.
Object - [Out]	N/A	The scan result object streamed into `$payload` named parameter and returned back.