Biometric
Table of Contents
- $config : mixed
- $throwError : mixed
- __construct() : void
- Initialize Face API
- setCustomData() : void
- Set an arbitrary string you wish to save with the transaction. e.g Internal customer reference number
- setParameter() : void
- Set an API parameter and its value, this function allows you to set any API parameter without using the built-in functions
- setProfile() : void
- Set KYC Profile
- throwAPIException() : void
- Whether an exception should be thrown if API response contains an error message
- verifyFace() : array<string|int, mixed>
- Perform 1:1 face verification using selfie photo or selfie video, against a reference face image.
- verifyLiveness() : array<string|int, mixed>
- Perform standalone liveness check on a selfie photo or video.
Properties
$config
private
mixed
$config
= array("profile" => "", "profileOverride" => array(), "customData" => "", "client" => "php-sdk")
$throwError
private
mixed
$throwError
= false
Methods
__construct()
Initialize Face API
public
__construct() : void
Tags
Return values
void —setCustomData()
Set an arbitrary string you wish to save with the transaction. e.g Internal customer reference number
public
setCustomData(string $customData) : void
Parameters
- $customData : string
Return values
void —setParameter()
Set an API parameter and its value, this function allows you to set any API parameter without using the built-in functions
public
setParameter(string $parameterKey, string $parameterValue) : void
Parameters
- $parameterKey : string
-
Parameter key
- $parameterValue : string
-
Parameter value
Return values
void —setProfile()
Set KYC Profile
public
setProfile(Profile $profile) : void
Parameters
- $profile : Profile
-
KYCProfile object
Tags
Return values
void —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
Return values
void —verifyFace()
Perform 1:1 face verification using selfie photo or selfie video, against a reference face image.
public
verifyFace(string $referenceFaceImage[, string $facePhoto = "" ][, string $faceVideo = "" ]) : array<string|int, mixed>
Parameters
- $referenceFaceImage : string
-
Front of Document (file path, base64 content, url, or cache reference)
- $facePhoto : string = ""
-
Face Photo (file path, base64 content or URL, or cache reference)
- $faceVideo : string = ""
-
Face Video (file path, base64 content or URL)
Tags
Return values
array<string|int, mixed> —verifyLiveness()
Perform standalone liveness check on a selfie photo or video.
public
verifyLiveness([string $facePhoto = "" ][, string $faceVideo = "" ]) : array<string|int, mixed>
Parameters
- $facePhoto : string = ""
-
Face Photo (file path, base64 content or URL, or cache reference)
- $faceVideo : string = ""
-
Face Video (file path, base64 content or URL)