Implement iOS callbacks
Last updated: October 28, 2024
To create a streamlined and successful user journey, implement the iProov callbacks. For details see: https://github.com/iProov/ios#launch-the-sdk
SDK claim lifecycle
The diagram below maps the possible callbacks during an iProov iOS SDK claim transaction..
Statuses
Status | Description | Implementation guidance | Suggested user experience |
---|---|---|---|
.connecting |
The SDK is connecting to the iProov server. |
Optional debug logging. | Depending on the journey, display a loading or progress indicator. |
.connected |
The SDK is connected and the iProov UI launches. |
Optional debug logging. |
Hide the progress indicators. The iProov UI is displayed automatically. |
.processing |
The claim is being processed and video streamed to complete the user authentication. |
This callback event may be called multiple times. iProov recommends adding the calls to the debug logs. |
Display a progress indicator. Descriptive messages are provided by iProov. |
.success |
The iProov claim was completed successfully. |
You must call the validate endpoint to validate this token. See Verify enrolled users API. |
|
.failure |
The claim was processed resulting in a failure code. May indicate a fraudulent attempt. |
Review the failure codes. Some codes will indicate a valid retry attempt with appropriate user guidance. Others will indicate that the GPA or LA claim has been rejected. |
Depending on the failure code:
|
.error |
iProov was unable to process the claim. There was a system failure establishing a connection or capture, or during the processing. The error reason is provided by iProov. |
Log as an error. If the error occurred in the allowed number of retry attempts:
|
|
.cancelled |
The user canceled the process by tapping Home or Close.
|
Log the incomplete user journey including the retry attempt number. |
Offer a retry attempt and provide guidance for completing a claim. See: Unhappy path |
Next step