Docupass

6. Docupass

This category supports all rapid user verification based on the ids and the face images provided.

6.1. listDocupass

This function retrieves a list of all available Docupass based on the parameters provided.

Declaration

public function listDocupass($order = -1, $limit = 10, $offset = 0)

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

Type (In/Out)	Name	Description
Integer - [In]	$order	Sort results by newest(-1) or oldest(1). The function will use the -1 value the parameter is left out during execution. The value cannot be 1 or -1. The function will throw an exception if any one of these value is used.
Integer - [In]	$limit	Number of items to be returned per call. The function will use the -1 value if the parameter is left out during execution. The 'limit' should be a positive integer greater than 0 and less than or equal to 100.
Integer - [In]	$offset	Start the list from a particular entry index.
Object- [Out]	N/A	The list of Docupass object result objects streamed into `$payload` named parameter and returned.

6.2. createDocupass

This function creates a new Docupass link for rapid identity verification and/or e-signature.

Declaration

public function createDocupass( $profile = null, $contractFormat = 'pdf', $contractGenerate='', $contractPrefill='', $contractSign = '', $customData = '', $language = '', $mode = 0, $referenceDocument = null, $referenceDocumentBack=null, $referenceFace=null, $reusable=false, $userPhone='', $verifyAddress='', $verifyAge='', $verifyDOB='', $verifyDocumentNumber='', $verifyName='', $verifyPostcode='')

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

Type (In/Out)	Name	Description
Object - [In]	$profile	Custom KYC Profile details. The function will use NULL value in case the parameter is left out during execution. The function will throw an exception if NULL value is passed in this parameter.
String - [In]	$contractFormat	Available contract formats are PDF, DOCX or HTML. The function will use PDF value in case the parameter is left out during execution.
String - [In]	$contractGenerate	Generate up to 5 documents using information from the uploaded ID without the user reviewing or signing the document. The function will use the BLANK value if the parameter is left out during execution.
String - [In]	$reusable	Whether the generated link can be used to verify multiple persons. The function will use false value in case the parameter is left out during execution.
String - [In]	contractPrefill	JSON data in key-value pairs to autofill dynamic fields, data from user ID will be used first in case of a conflict. E.g. passing {"myparameter":"abc"} would fill %{myparameter} in contract template with "abc". The function will use BLANK value if the parameter is left out during execution.
String - [In]	$contractSign	Generate a document using information from the uploaded ID, and have the user review and sign the document after identity verification. Required for mode=3. The function will use the BLANK value if the parameter is left out during execution.
String - [In]	$customData	Custom data to create Docupass. The function will use BLANK value if the parameter is left out during execution.
String - [In]	$language	Override auto language detection. The function will use BLANK value if the parameter is left out during execution.
String - [In]	$mode	Docupass modes can be 0=Document+Face, 1=Document Only, 2=Face Only, 3=e-Signature Only. The function will use 0 value in case the parameter is left out during execution.
String - [In]	$referenceDocument	Base64 encoded document image; if supplied, no document front image will be captured. The function will use BLANK value if the parameter is left out during execution.
String - [In]	$referenceDocumentBack	Base64 encoded document back image; if supplied, no document back image will be captured. The function will use BLANK value if the parameter is left out during execution.
String - [In]	$referenceFace	Base64 encoded face image; if supplied, no face image will be captured. Required if mode=2. - Function will use BLANK value if the parameter is left out during execution.
String - [In]	$userPhone	Supply user phone number for verification. This enables phoneVerification in profile settings. Function will use BLANK value if the parameter is left out during execution.
String - [In]	$verifyAddress	Verification address. The function will use BLANK value if the parameter is left out during execution.
String - [In]	$verifyAge	Verification age. The function will use BLANK value if the parameter is left out during execution.
String - [In]	$verifyDOB	Verification date of birth. The function will use BLANK value if the parameter is left out during execution.
String - [In]	$verifyDocumentNumber	- Verification document number. - Function will use BLANK value if the parameter is left out during execution.
String - [In]	$verifyName	- Verification name. - Function will use BLANK value if the parameter is left out during execution.
String - [In]	$verifyPostcode	- Verification postcode. - Function will use BLANK value if the parameter is left out during execution.
Object- [Out]	N/A	The saved Docupass object streamed into `$payload` named parameter and returned.

6.3. deleteDocupass

This function deletes Docupass Link by reference code.

Declaration

public function  deleteDocupass($reference = null)

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

Type (In/Out)	Name	Description
System.string - [In]	$reference	Docupass reference id that is to be deleted. The function will use NULL value in case the parameter is left out during execution. The function will throw an exception if NULL value is passed in this parameter.
JObject - [Out]	N/A	The deleted Docupass object streamed into `$payload` named parameter and returned.