Standalone Capture
- Get Started
This guide will take you through the process of setting up the Standalone Capture Module.
For a guide on setting up the full Sensibill SDK see Spend Manager SDK .
Before you begin
To arrange access to our SDK repositories please contact your Account Manager.
Installation
Adding Sensibill SDK to a Project
The Sensibill SDK for iOS is distributed in two formats: a binary package format (XCFramework), and a universal archive (legacy format). Both formats can be installed using CocoaPods dependency manager (a preferred method), or by adding the dependency manually to your project.
- Installation options
Overview
The iOS SDK is provided in two formats:
- a Binary Framework format (extension
xcframework
) - a legacy Universal Framework format (extension
framework
)
and can be installed in one of two ways:
- Using Cocoapods - a quick and convenient way to download external dependencies for an iOS project.
- Via Direct Download (where the SDK is copied to the project)
Note that Binary Framework and Universal Framework are stored in different repositories.
- Branding
What can be customized?
An integrator can configure and pass into the Capture during build/runtime:
Colors, fonts and images.
Follow the Global Theme page to provide a global customization for Capture screens.
Strings / Localization
You can replace strings used for any of the supported languages, or add additional localizations. See Localization page for more information.
Customize Tips, if required, as explained in Capture Tips Customization section.
- Feature Switching
You can customize the experience and features available in the Capture through the use of feature toggles.
Available Feature Toggles
Description Default value iOS Property Android Property Enables the auto-capture feature true enableAutoCapture
enableAutoCapture
Starts the capture screen with auto-capture mode
Note: auto-capture feature must be enabledtrue defaultToAutoCapture
initialAutoCaptureState
Enables the ability to toggle the phone’s flash on/off to help capture in low-light situations true enableFlash
allowFlashToggling
(Android only) Sets the flash mode that will be set by default when the capture flow begins
Note: flash feature must be enabledFlashMode.FLASH_MODE_AUTO
N/A defaultFlashMode
Enables the tips feature true enableCaptureTips
enableCaptureTips
Enables the visibility of feedback while capturing document. true enableCaptureProgressFeedback
enableCaptureProgressFeedback
Enables the user to select an image from their phone’s image gallery true enableImageGallery
enableGalleryImport
Enables the long document capture feature - capturing a longer document composed from a top and bottom image true enableLongCapture
enableLongCapture
Enables toast on the long document capture screen.
Note: Long document capture must be enabled.true enableLongReceiptPageToast
enableLongReceiptPageToast
Enables the ability to crop captured images true enableCrop
enableCrop
Determines the maximum number of documents a user can capture in a single capture session. The number must be in 1-10 range. 1 maxImages
maxImages
Enables the ability to attach the device’s current location to the image being captured. Requires location permission to have been granted by the user before launching capture. Ensure your app has appropriate location permission false attachLocationData
attachLocationData
Ensures that the images returned as a result of capture comply with the size and quality requirements of Sensibill API.Note: this flag can only be changed if using standalone capture. true compressForSensibillApi
compressForSensibillApi
(Android only) Will cause the capture flow to set the WindowManager.LayoutParams.FLAG_SECURE
flag in order to prevent users from taking screenshots from within the flowfalse N/A enableSecureWindow
(Android only) Informs capture what type of document is being captured. Currently, this changes some configuration restrictions and what types of strings are displayed to the user CaptureDocumentType.RECEIPT
N/A documentType
(Android only) A bundle of string resource references defining what string resources will be used in some document type specific locations (eg. “top of receipt” vs “top of invoice”) DocumentTypeStrings.defaultReceiptStrings
N/A documentTypeStrings
(iOS only) Enables a blur warning on the preview screen after capturing true enableBlurDetection
(Note: this feature is only available on the iPhone 6s and newer)N/A Reference
- Installation options