Plugin Response

Response States

SUCCESS: Process finished successfully

EXIT: Process terminated by the user with no errors

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

ERROR : Process terminated due to an error in the builder

Note: Check your configurations

Primary Response Object

nameValuePairs

Note: All SDK responses are returned in JSON format

Note: This is the first-level object

nameValuePairs Object Body

• state <string>

• errorCode <string>

• errorMessage <string>

• livenessResult <sub-object>

• capturedImages list<sub-object>

Note: These are the second-level objects

CapturedImages <list>

• id <int>

• action <string>

• faceSample <base64-string>

• status <boolean>

Note: CapturedImages is a list of objects that contain the images captured of the user's face during the SDK experience

livenessResult <sub-object>

• 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

State Responses

SUCCESS

• nameValuePairs <object>

  • state <string>

  • livenessResult <sub-object>

  • capturedImages <sub-object>

EXIT

• nameValuePairs <object>

  • state <string>

  • livenessResult <sub-object>

  • capturedImages <sub-object>

  • step <string>

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

FAILURE

• nameValuePairs <object>

  • state <string>

  • errorCode <int>

  • errorMessage <string>

  • livenessResult <sub-object>

  • capturedImages <sub-object>

ERROR

• nameValuePairs <object>

  • state <string>

  • errorCode <int>

  • errorMessage <string>