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

    DescriptionDefault valueiOS PropertyAndroid Property
    Enables the auto-capture featuretrueenableAutoCaptureenableAutoCapture
    Starts the capture screen with auto-capture mode
    Note: auto-capture feature must be enabled
    truedefaultToAutoCaptureinitialAutoCaptureState
    Enables the ability to toggle the phone’s flash on/off to help capture in low-light situationstrueenableFlashallowFlashToggling
    (Android only) Sets the flash mode that will be set by default when the capture flow begins
    Note: flash feature must be enabled
    FlashMode.FLASH_MODE_AUTON/AdefaultFlashMode
    Enables the tips featuretrueenableCaptureTipsenableCaptureTips
    Enables the visibility of feedback while capturing document.trueenableCaptureProgressFeedbackenableCaptureProgressFeedback
    Enables the user to select an image from their phone’s image gallerytrueenableImageGalleryenableGalleryImport
    Enables the long document capture feature - capturing a longer document composed from a top and bottom imagetrueenableLongCaptureenableLongCapture
    Enables toast on the long document capture screen.
    Note: Long document capture must be enabled.
    trueenableLongReceiptPageToastenableLongReceiptPageToast
    Enables the ability to crop captured imagestrueenableCropenableCrop
    Determines the maximum number of documents a user can capture in a single capture session. The number must be in 1-10 range.1maxImagesmaxImages
    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 permissionfalseattachLocationDataattachLocationData
    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.
    truecompressForSensibillApicompressForSensibillApi
    (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 flowfalseN/AenableSecureWindow
    (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 userCaptureDocumentType.RECEIPTN/AdocumentType
    (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.defaultReceiptStringsN/AdocumentTypeStrings
    (iOS only) Enables a blur warning on the preview screen after capturingtrueenableBlurDetection
    (Note: this feature is only available on the iPhone 6s and newer)
    N/A

    Reference