Plugin Response

Response States

SUCCESS: Process finished successfully

CAPTURED_IMAGES: Images captured by SDK are returned during runtime

EXIT: Process terminated by the user with no errors

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

EVENT_LOGS: SDK event logs are returned during runtime

ERROR_LOGS: SDK error logs are returned during runtime

ERROR : Process terminated due to an error in the builder

Note: in the case of ERROR, please review your configurations

Primary Response Object

nameValuePairs

Note: All SDK responses are returned in JSON format

Note: This is the first-level object

ocrResult Object Body

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

• sessionID <string>

ocrResult <sub-object>

• firstName <string>

• fullName <string>

• religion <string>

• gender <string>

• dateOfBirth <string>

• age <int>

• maritalStatus <string>

• husbandName <string>

• street <string>

• birthGovernorate <string>

• policeStation <string>

• governorate <string>

• profession <string>

• releaseDate <string>

• expiryDate <string>

• expired <boolean>

• serialNumber <string>

• frontNid <string>

• backNid <string>

• frontDataValidity <boolean>

• backDataValidity <boolean>

• frontConfidence <int>

• backConfidence <int>

• isRootOfTrustCompatible <boolean>

• transactionIdFront <string>

• transactionIdBack <string>

• combinationID <string>

captures <sub-object>

• nationalIdFront <base64-string>

• nationalIdBack <base64-string>

Note: captures object contains the latest images used for the OCR service

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

capturedImages Object Body

• nationalIDLabel <string>

• nationalIdImage <base64-string>

Note: capturedImages is a list of objects that contains all images captured throughout the experience

log Object Body

• date <string>

• key<string>

• screen <string>

• timestamp <string>

• type <string>

• sessionID <string>

errors Object Body

• code<string>

• message<base64-string>

• date <string>

• screen <string>

• timestamp <string>

• type <string>

• sessionID <string>

Note: events and errors objects are only returned if enable_logging is set to true from the plugin configuration

State Responses

SUCCESS

• nameValuePairs <object>

  • state <string>

  • ocrResult <sub-object>

CAPTURED_IMAGES

• nameValuePairs <object>

  • state <string>

  • capturedImage <object>

EXIT

• nameValuePairs <object>

  • state <string>

  • ocrResult <object>

  • step <string>

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

FAILURE

• nameValuePairs <object>

  • state <string>

  • ocrResult <object>

  • errorCode <int>

  • errorMessage <string>

ERROR

• nameValuePairs <object>

  • state <string>

  • errorCode <int>

  • errorMessage <string>

EVENT_LOGS

• nameValuePairs <object>

  • state <string>

  • log <object>

ERROR_LOGS

• state <string>

• log <object>