DIZME SDK

Document Capture Documentation for Android and iOS


Android Document Capture

This document describes integration specifications of DocCapture library for the Android version.
In this section we will describe how to customize the SDK text component.
All customizations are in accordance with the Android standard.
For example, if you want to configure the strings for your language, insert the strings in the strings.xml file.

Selection View

This is the view where you need to select the type of document to be captured.

The text components in the strings.xml file are:

  • "doc_capture_selection_title" for the Title.
  • "doc_capture_selection_title_nations" for the Nationality Document Label.
  • "doc_capture_selection_title_documents" for the Type of Document Label.
  • "assisted_selfie_start_button_width" for the Button's width.
  • "doc_capture_selection_button_accept" for the accept Button.
  • Instructions View

    This view is shown if the option to show instructions is enabled.

    The text components in the strings.xml file are:

  • "doc_capture_instructions_button_accept" for accept Button.
  • "doc_capture_instructions_button_accept_width" for accept Button's width.

  • For the Title item there are more options:
  • "doc_capture_instructions_title_eidc_front" for Front Document of Electronic ID Card.
  • "doc_capture_instructions_title_eidc_back" for Back Document of Electronic ID Card.
  • "doc_capture_instructions_title_pidc_front" for Internal Document of Paper ID Card.
  • "doc_capture_instructions_title_pidc_back" for Cover Document of Paper ID Card.
  • "doc_capture_instructions_passport_inside" for Internal Document of Passport.
  • "doc_capture_instructions_title_dlc_front" for Front Document of Driving License.
  • "doc_capture_instructions_title_dlc_back" for Back Document of Driving License.
  • "doc_capture_instructions_title_hic_front" for Front Document of Health Insurance Card.
  • "doc_capture_instructions_title_hic_back" for Back Document of Health Insurance Card.
  • "doc_capture_instructions_title_rpc_front" for Front Document of Residence Permit Card.
  • "doc_capture_instructions_title_rpc_back" for Back Document of Residence Permit Card.
  • Camera View

    This is the view where the photo of the document will be acquired.

    The text components in the strings.xml file are:

  • "doc_capture_camera_button_shutter_width" for Alternative Shutter Button's width.
  • "doc_capture_camera_alternative_layout_heigth" for the the layout heigth.
  • "doc_capture_camera_toast_unsupported_flash" when the flash is not supported, a warning message will be shown.

  • For the Title item there are more options:
  • "doc_capture_camera_title_eidc_front" for Front Document of Electronic ID Card.
  • "doc_capture_camera_title_eidc_back" for Back Document of Electronic ID Card.
  • "doc_capture_camera_title_pidc_inside" for Internal Document of Paper ID Card.
  • "doc_capture_camera_title_pidc_cover" for Cover Document of Paper ID Card.
  • "doc_capture_camera_title_passport_inside" for Internal Document of Passport.
  • "doc_capture_camera_title_dlc_front" for Front Document of Driving License.
  • "doc_capture_camera_title_dlc_back" for Back Document of Driving License.
  • "doc_capture_camera_title_hic_front" for Front Document of Health Insurance Card.
  • "doc_capture_camera_title_hic_back" for Back Document of Health Insurance Card.
  • "doc_capture_camera_title_rpc_front" for Front Document of Residence Permit Card.
  • "doc_capture_camera_title_rpc_back" for Back Document of Residence Permit Card.

  • For the Subtitle item there are more options:
  • "doc_capture_camera_subtitle_eidc_front" for Front Document of Electronic ID Card.
  • "doc_capture_camera_subtitle_eidc_back" for Back Document of Electronic ID Card.
  • "doc_capture_camera_subtitle_pidc_inside" for Internal Document of Paper ID Card.
  • "doc_capture_camera_subtitle_pidc_cover" for Cover Document of Paper ID Card.
  • "doc_capture_camera_subtitle_passport_inside" for Internal Document of Passport.
  • "doc_capture_camera_subtitle_dlc_front" for Front Document of Driving License.
  • "doc_capture_camera_subtitle_dlc_back" for Back Document of Driving License.
  • "doc_capture_camera_subtitle_hic_front" for Front Document of Health Insurance Card.
  • "doc_capture_camera_subtitle_hic_back" for Back Document of Health Insurance Card.
  • "doc_capture_camera_subtitle_rpc_front" for Front Document of Residence Permit Card.
  • "doc_capture_camera_subtitle_rpc_back" for Back Document of Residence Permit Card.
  • Check View - image quality

    In this view you can check the image quality. You can confirm or discard by clicking on related Accept and Reject buttons.

    The text components in the strings.xml file are:

  • "doc_capture_check_title" for the Title text.
  • "doc_capture_check_title" for the Title size.
  • "doc_capture_check_subtitle" for the Subtitle text.
  • "doc_capture_check_subtitle" for the Subtitle size.
  • "doc_capture_check_button_accept" for the accept Button text.
  • "doc_capture_check_button_accept_width" for the accept Button's width.
  • "doc_capture_check_button_discard" for discard Button text.
  • "doc_capture_check_button_discard_width" for discard Button's width.

  • If an error is detected in the photo taken then, only the title (with the error message) and the button to retake the photo will be shown.
    For the Title error messages there are more options:
  • "doc_capture_check_title_blurry" for the Blur detection.
  • "doc_capture_check_title_glare" for the Glare detection.

  • For the Subtitle error messages there are more options:
  • "doc_capture_check_subtitle_blurry" to smile.
  • "doc_capture_check_subtitle_glare" for the Subtitle.
  • Dialog Customization View

    The following image refers to the new dialog, but the same customizations apply to the old dialog.

    The text components in the strings.xml file are:

  • "doc_capture_dialog_exit_title" for the Title text.
  • "doc_capture_dialog_exit_message" for the Message text.
  • "doc_capture_dialog_exit_yes" for the accept Button text.
  • "doc_capture_dialog_exit_no" for the discard Button text.

  • Starting with version 2.1.6, we have added a more modern look to the dialog:
  • "dialog_button_width" for the Buttons width.
  • iOS Document Capture

    This document describes integration specifications of DocCapture library for the iOS version.
    In this section we will describe how to customize the SDK component text.
    For example, if you want to configure the strings for your language, insert the strings in the Localizable.strings file.

    Selection View

    This is the view where you need to select the type of document to be captured.

    The text components in the Localizable.strings file are:

  • "doc_capture_selection_title" for the Title.
  • "doc_capture_selection_button_exit" for the Exit Button.
  • "doc_capture_selection_button_accept" for the Accept Button.

  • For the Labels item inside PickerView there are more options:
  • "doc_capture_selection_eidc" for Electronic ID Card.
  • "doc_capture_selection_pidc" for Paper ID Card.
  • "doc_capture_selection_passport" for Passport.
  • "doc_capture_selection_dlc" for Driving License.
  • "doc_capture_selection_hic" for Health Insurance.
  • "doc_capture_selection_rpc" for Residence Permit.
  • Instructions View

    This view is shown if the option to show instructions is enabled.

    The text components in the Localizable.strings file are:

  • "doc_capture_instructions_button_accept" for Accept Button text.
  • "doc_capture_instructions_button_reject" for Reject Button text.

  • For the Title item there are more options:
  • "doc_capture_instructions_title_eidc_front" for Front Document of Electronic ID Card.
  • "doc_capture_instructions_title_eidc_back" for Back Document of Electronic ID Card.
  • "doc_capture_instructions_title_pidc_front" for Front Document of Paper ID Card.
  • "doc_capture_instructions_title_pidc_back" for Back Document of Paper ID Card.
  • "doc_capture_instructions_title_passport_inside" for Internal Document of Passport.
  • "doc_capture_instructions_title_dlc_front" for Front Document of Driving License.
  • "doc_capture_instructions_title_dlc_back" for Back Document of Driving License.
  • "doc_capture_instructions_title_hic_front" for Front Document of Health Insurance Card.
  • "doc_capture_instructions_title_hic_back" for Back Document of Health Insurance Card.
  • "doc_capture_instructions_title_rpc_front" for Front Document of Residence Permit Card.
  • "doc_capture_instructions_title_rpc_back" for Back Document of Residence Permit Card.

  • Camera View

    This is the view where the photo of the document will be acquired.

    The text components in the Localizable.strings file are:
    For the Title item there are more options:

  • "doc_capture_camera_title_eidc_front" for Front Document of Electronic ID Card.
  • "doc_capture_camera_title_eidc_back" for Back Document of Electronic ID Card.
  • "doc_capture_camera_title_pidc_inside" for Internal Document of Paper ID Card.
  • "doc_capture_camera_title_pidc_cover" for Cover Document of Paper ID Card.
  • "doc_capture_camera_title_passport_inside" for Internal Document of Passport.
  • "doc_capture_camera_title_dlc_front" for Front Document of Driving License.
  • "doc_capture_camera_title_dlc_back" for Back Document of Driving License.
  • "doc_capture_camera_title_hic_front" for Front Document of Health Insurance Card.
  • "doc_capture_camera_title_hic_back" for Back Document of Health Insurance Card.
  • "doc_capture_camera_title_rpc_front" for Front Document of Residence Permit Card.
  • "doc_capture_camera_title_rpc_back" for Back Document of Residence Permit Card.

  • For the Subtitle item there are more options:
  • "doc_capture_camera_subtitle_eidc_front" for Front Document of Electronic ID Card.
  • "doc_capture_camera_subtitle_eidc_back" for Back Document of Electronic ID Card.
  • "doc_capture_camera_subtitle_pidc_inside" for Internal Document of Paper ID Card.
  • "doc_capture_camera_subtitle_pidc_cover" for Cover Document of Paper ID Card.
  • "doc_capture_camera_subtitle_passport_inside" for Internal Document of Passport.
  • "doc_capture_camera_subtitle_dlc_front" for Front Document of Driving License.
  • "doc_capture_camera_subtitle_dlc_back" for Back Document of Driving License.
  • "doc_capture_camera_subtitle_hic_front" for Front Document of Health Insurance Card.
  • "doc_capture_camera_subtitle_hic_back" for Back Document of Health Insurance Card.
  • "doc_capture_camera_subtitle_rpc_front" for Front Document of Residence Permit Card.
  • "doc_capture_camera_subtitle_rpc_back" for Back Document of Residence Permit Card.
  • Check View - image quality

    In this view you can check the image quality. You can confirm or discard by clicking on related Accept and Reject buttons.

    The text components in the Localizable.strings file are:

  • "doc_capture_check_title" for the Title.
  • "doc_capture_check_subtitle" for the Subtitle.
  • "doc_capture_check_button_accept_text" for the Accept Button.
  • "doc_capture_check_button_discard_text" for the Reject Button

  • If an error is detected in the photo taken then, only the title (with the error message) and the button to retake the photo will be shown.
    For the Title item there are more options:
  • "doc_capture_check_title_blurry" for Blur detection.
  • "doc_capture_check_title_glare" for Glare detection.

  • For the Subtitle item there are more options:
  • "doc_capture_check_subtitle_blurry" for Blur detection.
  • "doc_capture_check_subtitle_glare" for Glare detection.
  • Dialog Customization View

    If you click on the exit button then a dialog message will appear which will have a text and two buttons to confirm or to cancel the exit.

    The text components in the Localizable.strings file are:

  • "doc_capture_dialog_exit_title" for the Title text.
  • "doc_capture_dialog_exit_message" for the Message text.
  • "doc_capture_dialog_exit_ok" for the confirm Button text.
  • "doc_capture_dialog_exit_cancel" for the text of the Button for cancel the exit.