SDK Response

The response of the SDK will return in the following delegate

func onLivenessResult(VIDVLivenessResponse: VIDVLivenessResponse)

It will return an enum result of type VIDVLivenessResponse

VIDVLivenessResponse Cases

success : Process finished successfully

capturedActions: Images captured are returned in real-time

Note: In capturedActions, the returned images are not processed yet

userExit : Process terminated by the user with no errors

serviceFailure : Process finished with the user's failure to pass the service requirements

builderError : Process terminated due to an error in the builder

Example

switch result {
case .success(let data):
    // data of type VIDVLivenessResult
case .builderError(let code, let message):
    // builder error code & error message
case .serviceFailure(let data, let code, let message):
    // service faluire error code & error message & data of type VIDVLivenessResult
case .userExit(let data, let step):
    // last step in the SDK & data of type VIDVLivenessResult
case .capturedImages(capturedActions: let capturedActions):
    // capturedActions of type capturedActions
    
}

Note: Check your configurations

Primary Response Object

VIDVLivenessResult

Note: This is the first-level object that contains all the second-level objects

Object Body

• facematchTransactionID <string>

• facematchSuccess <boolean>

• livenessSuccess <boolean>

• capturedImage <base64-string>

• auditRequired <boolean>

• auditCaseCreated <boolean>

hmacDataList <list>

• serviceID: ocr

• hmacDigest <string>

• rawResponse <string>

The raw response in hmacDataList should be mapped to the result object as per the HMAC Validation Documentation

Instance Responses

Success

• vidvLivenessResult <object>

CapturedActions

capturedActions <object>

• id <int>

• action <string>

• faceSample <base64-string>

• status <boolean>

capturedAction contains the images captured of the user's face during the SDK experience

UserExit

• vidvLivenessResult <sub-object>

• step <string>

Note: step <string> identifies the point where the user chose to exit the SDK

ServiceFailure

• errorCode <int>

• errorMessage <string>

• vidvLivenessResult <object>

BuilderError

• errorCode <int>

• errorMessage <string>