Docupass
Table of Contents
- $throwError : mixed
- __construct() : void
- Initialize Contract API
- createDocupass() : mixed|void
- deleteDocupass() : mixed|void
- listDocupass() : array<string|int, mixed>
- Retrieve a list of Docupass
- throwAPIException() : void
- Whether an exception should be thrown if API response contains an error message
Properties
$throwError
private
mixed
$throwError
= false
Methods
__construct()
Initialize Contract API
public
__construct() : void
Tags
Return values
void —createDocupass()
public
createDocupass([ $profile = null ][, $contractFormat = 'pdf' ][, $contractGenerate = '' ][, $contractPrefill = '' ][, $contractSign = '' ][, $customData = '' ][, $language = '' ], $mode[, $referenceDocument = null ][, $referenceDocumentBack = null ][, $referenceFace = null ][, $reusable = false ][, $userPhone = '' ][, $verifyAddress = '' ][, $verifyAge = '' ][, $verifyDOB = '' ][, $verifyDocumentNumber = '' ][, $verifyName = '' ][, $verifyPostcode = '' ]) : mixed|void
Parameters
- $profile : = null
- $contractFormat : = 'pdf'
- $contractGenerate : = ''
- $contractPrefill : = ''
- $contractSign : = ''
- $customData : = ''
- $language : = ''
- $mode :
- $referenceDocument : = null
- $referenceDocumentBack : = null
- $referenceFace : = null
- $reusable : = false
- $userPhone : = ''
- $verifyAddress : = ''
- $verifyAge : = ''
- $verifyDOB : = ''
- $verifyDocumentNumber : = ''
- $verifyName : = ''
- $verifyPostcode : = ''
Tags
Return values
mixed|void —deleteDocupass()
public
deleteDocupass([ $reference = '' ]) : mixed|void
Parameters
Tags
Return values
mixed|void —listDocupass()
Retrieve a list of Docupass
public
listDocupass([int $order = -1 ][, int $limit = 10 ], int $offset) : array<string|int, mixed>
Parameters
- $order : int = -1
-
Sort results by newest(-1) or oldest(1)
- $limit : int = 10
-
Number of items to be returned per call
- $offset : int
-
Start the list from a particular entry index
Tags
Return values
array<string|int, mixed> —throwAPIException()
Whether an exception should be thrown if API response contains an error message
public
throwAPIException([bool $throwException = false ]) : void
Parameters
- $throwException : bool = false
-
Throw exception upon API error, defaults to false