Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Page Properties
hiddentrue

Status

Status
colourYellowGreen
titlefor reviewapproved

Approver

Nadzeya Karaban

To use the capture flow, do the followingIn order to launch Gini Capture SDK, follow these steps:

  1. Request camera access via configuring Info.plist in your project.

  2. Configure GiniBankConfigurationGiniConfiguration.shared. The Here is an implementation example can be found here.

  3. Present the UIViewController. You can find the example here Here is an example.

  4. Handle the extraction results .
    For handling the extraction results you need to implement GiniCaptureResultsDelegate. Here you can find the by implementing GiniCaptureResultsDelegate. There are more details about the delegate methods later and here is an implementation example.

  5. Cleanup configuration and resources while also providing the required extraction feedback to improve future extraction accuracy. You don’t need to implement any extra steps, just follow the recommendations below:

...

  1. Send the final transfer summary values to Gini by calling GiniConfiguration.shared.sendTransferSummary()method which will be used to improve the future extraction accuracy

  2. Clean up the SDK by calling GiniConfiguration.shared.cleanup() which will release the resources used by SDK.

Follow these recommendations:

Note
  • 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.

Code Block
languageswift
   GiniBankConfigurationGiniConfiguration.shared.cleanupsendTransferSummary(paymentRecipient: "Payment Recipient",
                                   paymentReference: "Payment Reference",
                                   paymentPurpose: "Payment Purpose",
                                   iban: "IBAN",
                                   bic: "BIC",
                                   amountToPay: ExtractionAmount(value: 10.242, currency: .EUR))
                                   
   GiniConfiguration.shared.cleanup()
Info

Check out

...

an example app to see what an integration

...

can look like.

...

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

Drawio
mVer2
zoom1
simple0
inComment0
custContentId12288218
pageId11796779
lbox1
diagramDisplayNameUntitled Diagram-1683895916012.drawio
contentVer4
revision4
baseUrlhttps://gini.atlassian.net/wiki
diagramNameUntitled Diagram-1683895916012.drawio
pCenter0
width860
links
tbstyle
height379.5

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.