Custom Language and Styling

Copy, assets, and font styling can all be customized in the Document Scan SDK. Depending on your needs, you may need to modify resources directly within the provided framework bundle.

Localizable Strings

String keys used within the SDK can be overridden in your application’s Localizable.strings.

Key	Default Value
dynamic-pipeline-error-label.text.out-of-focus	Out of focus
dynamic-pipeline-error-label.text.no-document-rectangle	ID not detected
dynamic-pipeline-error-label.text.no-mrz	MRZ not visible
dynamic-pipeline-error-label.text.no-barcode	Barcode not visible
dynamic-pipeline-error-label.text.too-close	Too close
dynamic-pipeline-error-label.text.too-far	Too far
dynamic-pipeline-error-label.text.out-of-frame	ID out of frame
dynamic-pipeline-error-label.text.not-level	Not level
dynamic-pipeline-error-label.text.subject-too-dark	Lighting too low
dynamic-pipeline-error-label.text.too-much-glare	Too much glare
dynamic-pipeline-error-label.text.background-too-dark	Use lighter background
dynamic-pipeline-error-label.text.background-too-light	Use darker background
camera.permission.required	Camera permission is required to use the capture SDK. Please request camera permission from the user.
camera.session.could.not.be.initialized	A camera session could not be initialized. Please check camera permissions.
back.of.document	Back of Document
please.hold.still	Please hold still
controller.not.in.view.hierarchy	The scan UIViewController has not been presented, please add the scan controller to your view to your hierarchy before calling start.
invalid.license	License key is expired or invalid!
cancel	Cancel
document_label	Document Capture Screen
document_info.label.back	Back
document_info.label.front	Front
please.wait	Please Wait…
tap.to.capture.again	Tap to Capture Again.
tap.screen.to.capture	Tap Screen To Capture
please.hold.steady	Please Hold Steady
retake	Retake
accept	Accept
review.confirmation	Please check the image and accept if the image is clear

Styles and Assets

Font styles and image assets are mapped in a framework bundle resource, UIConfigurations.json. Starting in version 5.3.1, the SDK is distributed as an XCFramework, which contains multiple framework bundles (one for iOS, one for iOS Simulator). Since the SDK does not launch on a Simulator, you only need to modify the arm64 bundle:

Colors are represented as RGBA, and assets are referenced by image name (without extension).

Default Configuration

{
    "action_icons": {
        "accept_button": {
            "textSizeLarge": 15,
            "textSizeNormal": 15,
            "textFont": "San Francisco",
            "textColor": {"R":255,"G":255,"B":255,"A":1.0},
            "background_color": {"R":0,"G":122,"B":255,"A":1.0},
            "corner_radius": 0
        },
        "retake_button": {
            "textSizeLarge": 15,
            "textSizeNormal": 15,
            "textFont": "San Francisco",
            "textColor": {"R":255,"G":255,"B":255,"A":1.0},
            "background_color": {"R":0,"G":122,"B":255,"A":1.0},
            "corner_radius": 0
        }
    },
    "brackets": {
        "border_color": {"R":255,"G":255,"B":255,"A":1.0}
    },
    "text": {
        "title": {
            "textSizeLarge": 14,
            "textSizeNormal": 14,
            "textFont": "San Francisco",
            "textColor": {"R":0,"G":0,"B":0,"A":1.0},
            "background_color": {"R":255,"G":255,"B":255,"A":1.0}
        },
        "tap_to_capture": {
            "textSizeLarge": 38,
            "textSizeNormal": 32,
            "textFont": "San Francisco",
            "textColor": {"R":170,"G":170,"B":170,"A":1.0}
        },
        "cancel_button": {
            "textSizeLarge": 22,
            "textSizeNormal": 15,
            "textFont": "San Francisco",
            "textColor": {"R":255,"G":255,"B":255,"A":1.0}
        },
        "review_text": {
            "textSizeLarge": 24,
            "textSizeNormal": 17,
            "textFont": "San Francisco",
            "textColor": {"R":0,"G":0,"B":0,"A":1.0}
        }
    },
    "loader_overlay": {
        "gif_image": {
            "image_name": "assetname"
        },
        "loader_text": {
            "textSizeLarge": 32,
            "textSizeNormal": 24,
            "textFont": "San Francisco",
            "textColor": {"R":255,"G":255,"B":255,"A":1.0}
        },
        "background_color": {"R":0,"G":0,"B":0,"A":1.0}
    }
}