Capture Flow

In order to launch Gini Capture SDK, follow these steps:

Request camera access via configuring Info.plist in your project.
Configure GiniConfiguration.shared. Here is an implementation example.
Present the UIViewController. Here is an example.
Handle the extraction results by implementing GiniCaptureResultsDelegate. There are more details about the delegate methods later and here is an implementation example.
Send the final transfer summary values to Gini by calling GiniConfiguration.shared.sendTransferSummary()method which will be used to improve the future extraction accuracy
Clean up the SDK by calling GiniConfiguration.shared.cleanup() which will release the resources used by SDK.

Follow these recommendations:

Provide values for all necessary fields, including those that were not extracted.
Provide the final data approved by the user (and not the initially extracted only).
Send transfer summary only after TAN verification.

You don’t need to implement any extra steps.

  GiniConfiguration.shared.sendTransferSummary(paymentRecipient: "Payment Recipient",
                                   paymentReference: "Payment Reference",
                                   paymentPurpose: "Payment Purpose",
                                   iban: "IBAN",
                                   bic: "BIC",
                                   amountToPay: ExtractionAmount(value: 10.242, currency: .EUR))
                                   
   GiniConfiguration.shared.cleanup()

Check out an example app to see what an integration can look like.

The diagram shows the interaction between your app and the SDK:

Gini Capture SDK returns one of results by invoking the following GiniCaptureResultsDelegate methods:

GiniCaptureResultsDelegate.giniCaptureAnalysisDidFinishWith(result: AnalysisResult)
A document was analyzed and the extractions are available in the properties of the AnalysisResult object.
GiniCaptureResultsDelegate.giniCaptureDidCancelAnalysis()
The user has canceled Gini Capture SDK.
GiniCaptureResultsDelegate.giniCaptureDidEnterManually()
The document analysis finished with no results/an error and the user clicked the Enter manually button on either the No Results Screen or the Error Screen. To enable manual entry of payment information, you should close Gini Capture SDK, letting your app prompt users for manual input.