Step Result

This page describes the step result payload provided as part of the onStepResult callback. The payload object includes the following properties:

Field	Type	Description
stepId	String	The value of the field
stepResult	StepResult?	Described here

Field	Type	Description
recognition	DocumentRecognition	Document recognition information.
extractedFields	Map of String and FieldValue	Information extracted from the document such as Name and Birth Date. All field names can be found here.
hasPassedRules	Boolean	Indicates that the step has successfully passed the initial checks (e.g., document authenticity, validity, expiration status, etc.). The final step's check status can be retrieved from the IDWise backend.
isConcluded	Boolean	Indicates if the step permits another attempt. A step concludes when: (1) it successfully passes all checks (i.e hasPassedRules = True), or (2) it reaches the maximum number of attempts (e.g., 2 attempts). For further information, refer to the retries and error handling guide.
errorUserFeedbackCode	String	A programmatic code used to indicate the user error encountered. All codes are available here . If the step passes all checks and no errors occur, this will return an empty string.
errorUserFeedbackDetails	String	A user-friendly description of the error, intended to help users understand and correct the issue. You can show this message to your users. If the step passes all checks and no errors occur, this will return an empty string.
errorUserFeedbackTitle	String	A user-friendly title summarizing the error, designed to help users quickly identify the issue. You can display this title to your users. If no errors occur, this will return an empty string.
nfcResult	NFCResult	Result from NFC chip reading.

Document Recognition

Type	Description
issuingCountryCode	String	Country of issue as ISO 3166-1 alpha-3 country code
issuingCountryName	String	Name of country of issue
documentType	String	Type of the Document, either a `Identity Card`, `Passport`, `Commercial Licence`, `Driving Licence`, `Practice Permit`, `Residence Permit`, `Utility Bill`, `Vehicle Licence`, `Vaccination Card`, `Work Permit`, `Car Registration`, `Travel Document`, `Car Ownership`, `Visa`, `Vehicle Registration`, `Proof of Address`, `Other Forms`, `Insurance Certificate`, `Birth Certificate`, `Registration Certificate`, `Tax Document`, `National Insurance Document`, `Military ID`, `Voter Card`, `Archive Only`.

Field	Type	Description
value	String	The value of the field

The NFCResult object contains the following data extracted from the Document via reading the NFC chip

Field	Type	Description
facePhoto	Bitmap	Image of the user which is extracted from NFC chip scanning
extractedFields	Map of String and FieldValue	Information extracted from the NFC chip scanning

All extractedFields from the NFC can be found here