Text & Language

Default configuration:

SDK version 4.x

{
  startingCamera: "Starting Camera...",
  validating: "Validating...",
  processing: "Processing...",
  closingSession: "Closing session...",
  exit: {
    title: "Confirm leave session",
    description: "Do you want to leave the session?",
    yesButtonText: "yes",
    noButtonText: "no",
  },
  upload: [
    {
      title: "Upload your %s",
      front: {
        description: "Drag and drop the front page of your document here",
        buttonText: "Select File",
      },
      back: {
        description: "Drag and drop the back page of your document here",
        buttonText: "Select File",
      },
      acceptedFilesDescription: "Accepted file types: JPG, PNG, PDF / max. size 5MB per file",
      buttonText: "Upload",
      tipDescription:
        "Upload two images, one containing the front side and the one the back side of your document If you have a PDF containing both images (first image is considered the front side) you can just upload the single file as the front side.",
    },
  ],
  backgroundCheck: {
    title: "Background Check",
    description: `TBD: A text that explains what is a background check and what are the checks that will be performed.`,
    declineButtonText: "decline",
    consentButtonText: "consent",
    continueButtonText: "continue",
    declineConfirmation: {
      title: "Are you sure you want to decline?",
      description: "",
      noButtonText: "no",
      yesButtonText: "yes",
    },
  },
  facialRecognition: {
    title: "Facial Recognition",
    description: "Position head inside oval, then start recording",
    livenessDetectionMessages: {
      OK: "Hold your position",
      MULTIPLE_PERSON_DETECTED: "Too many faces detected",
      MOVE_CLOSER: "Move closer to the oval",
      GO_BACK: "Move further from the oval",
      MOVE_TO_CENTER: "Center your face in the oval",
      DARK_ENVIRONMENT_DETECTED: "Make sure your environment is not too dark",
      BLUR_DETECTED: "Ensure good lighting conditions to capture a good quality selfie",
      MOUTH_COVER_DETECTED: "Remove anything that covers your face, e.g. mask",
      EYE_CLOSED: "Look straight to the camera",
      EYE_COVER: "Remove anything that can cover your eyes, e.g. sun glasses",
      SPOTLIGHT_DETECTED:
        "Change lighting conditions to avoid strong light reflections on your face",
      SHADOW_DETECTED: "Change lighting conditions to avoid the shadow effect on your face",
      ERROR: "Unknown Error, Refresh",
    },
  },

  scan: [
    {
      titleFrontSide: "Scan the front side of your %s",
      titleBackSide: "Scan the back side of your %s",
      titlePhotoPage: "Scan the photo page in your %s",
      frontLabel: "front",
      backLabel: "back",
      photoPageLabel: "photo page",
      turnDocumentDescription: "Flip to the back side",

      rescanButtonText: "rescan",
      continueButtonText: "continue",
      tipDescription: "Ensure all data is clearly readable",
      tipDescription2: "Ensure your face is clearly visible<br>and no hologram is covering it",
      description: "Position the document inside the frame and press the shutter button below",

      cameraSelection: {
        title: "Camera Selection",
        description:
          "If the default camera struggles to focus and you frequently receive a message about an unclear image, try switching to a different camera.",
        button: "Okay, Got It!",
      },

      messages: {
        OK: "Scanning complete",
        LOW_LIGHT: "Low light conditions detected, please ensure good lighting while scanning",
        MOVE_CLOSER: "Please move the camera closer to the document",
        UNCLEAR_IMAGE: "Unclear image. Don't move during the scan and ensure good lighting",
        WRONG_DOCUMENT_TYPE: "Please provide the document %s",
        WRONG_DOCUMENT_SIDE: "Please provide the %s side of the document",
        AVOID_GLARE: "Avoid light reflections on the document",
        REMOVE_FINGER: "Please do not cover the document with your fingers",
        BAD_QUALITY: "Photo not clear. Please move to better lighting",
        MOVE_TO_CENTER: "Position the document in the center of the frame",
        ERROR: "Unknown Error, Refresh",
      },
    },
  ],
  documentTypes: {
    BHR_ID: "Bahrain ID",
    GENERIC_ID: "National ID",
    KWT_ID: "Kuwait ID",
    OMN_ID: "Oman ID",
    PAK_ID: "Pakistan ID",
    PASSPORT: "Passport",
    SAU_ID: "Saudi ID",
    UAE_ID: "Emirates ID",
    UAE_DL: "Driving License",
    NLD_DL: "Driving License",
    UAE_VISA: "Resident Visa",
    UAE_VL: "Vehicle License",
    QAT_ID: "Qatar ID",
    DEU_ID: "German ID",
    DZA_ID: "Algerian ID",
    SDN_ID: "Sudan ID",
    SDN_DL: "Driving License",
    SDN_VL: "Vehicle License",
    GHA_ID: "Ghana ID",
    NGA_DL: "Driving License",
    NGA_VOTER_ID: "Voter ID",
    NGA_NIN: "NIN",
    GBR_DL: "Driving License",
    SAU_DL: "Driving License",
    ZAF_ID: "South African ID",
    ZAF_DL: "Driving License",
    EGY_ID: "Egyptian ID",
    RWA_ID: "Rwandan ID",
    KEN_ID: "Kenyan ID",
    GHA_DL: "Driving License",
    GHA_VOTER_ID: "Voter ID",
    GHA_SSNIT: "SSNIT",
    UGA_ID: "Ugandan ID",
    IND_ID: "Indian Aadhaar ID",
    SEN_ID: "Senegal ID",
    TUR_ID: "Turkish ID",
    UGA_VOTER_ID: "Ugandan Voter ID",
    COD_DL: "Driving License",
    GBR_ID: "Resident ID",
    COD_VOTER_ID: "Voter ID",
    OMN_VL: "Vehicle License",
    OMN_DL: "Driving License",
    USA_DL: "Driving License",
    QAT_DL: "Driving License",
    BHR_DL: "Driving License",
    PHL_DL: "Driving License",
    RSL_ID: "National ID",
    IND_PAN: "PAN card",
    LBN_ID: "Lebanese ID",
    LBN_DL: "Lebanese Driving License",
    IRQ_ID: "Iraqi ID",
    MRZ: "MRZ",
    UAE_ID_DIGITAL: "Digital Emirates ID",
    QAT_VL: "Vehicle License",
    UAE_PASSPORT_DIGITAL: "Digital Emirates Passport",
    TUN_ID: "Tunisian ID",
    SOM_ID: "Somali ID",
    BHR_VL: "Vehicle License",
    JOR_VL: "Vehicle License",
    SAU_VL: "Vehicle License",
  },
  errors: {
    SCAN_DOCUMENT_NOT_RECOGNIZED: {
      title: "Scanning Failed",
      description:
        "<b>Ensure:<br/>1. </b> Good lighting conditions<br/><b>2.</b> Camera lens is clean<br/><b>3.</b> No reflections on document<br/><b>4.</b> Remove any stickers on the document",
      button: "Try Again",
    },
    SCAN_DOCUMENT_EXPIRED: {
      title: "Document is expired",
      description: "Please make sure to use a valid document",
      button: "Try Again",
    },
    SCAN_DOCUMENT_FRONT_BACK_MISMATCH: {
      title: "Scanning Failed",
      description: "Front and back page don't belong to the same document",
      button: "Try Again",
    },
    FACE_LIVENESS_FAILED: {
      title: "Facial recognition failed",
      description:
        "Here are some hints:<br/><b>1.</b> Fit face inside oval and look straight to the camera<br/><b>2.</b> Remove anything that can cover your face, e.g. mask<br/><b>3.</b> Take off your sun glasses or eye glasses with dark lens<br/><b>4.</b> Make sure your environment is not too dark or too bright<br/><b>5.</b> Make sure the lens of your front camera are clean",
      button: "Try Again",
    },
    FACE_NO_MATCH: {
      title: "Face didn't match",
      description:
        "Here are some hints:<br/><b>1.</b> Fit face inside oval and look straight to the camera<br/><b>2.</b> Remove anything that can cover your face, e.g. mask<br/><b>3.</b> Take off your sun glasses or eye glasses with dark lens<br/><b>4.</b> Make sure your environment is not too dark or too bright<br/><b>5.</b> Make sure the lens of your front camera are clean",
      button: "Try Again",
    },
    UNEXPECTED_ERROR: {
      title: "Unexpected error",
      description: "The service encountered an internal error",
      button: "Try Again",
    },
    PAYLOAD_TOO_LARGE: {
      title: "File is too large",
      description: "Only JPG, PNG, PDF with a max size of 5MB are accepted",
      button: "Try Again",
    },
    SCAN_DOCUMENT_AGE_VERIFICATION_FAILED: {
      title: "Age Verification Failed",
      description: `Document not accepted, minimum age required %d`,
      button: "Try Again",
    },
    LANDSCAPE_NOT_SUPPORTED: {
      title: "Landscape not supported",
      description: "Switch to portrait mode",
    },
    UNSUPPORTED_DOCUMENT_TYPE: {
      title: "Document type not supported",
      description: "Only JPG, PNG and PDF are accepted",
      button: "Try Again",
    },
  },
}

SDK version 3.x

{
  startingCamera: "Starting Camera...",
  validating: "Validating...",
  processing: "Processing...",
  closingSession: "Closing session...",
  exit: {
    title: "Confirm leave session",
    description: "Do you want to leave the session?",
    yesButtonText: "yes",
    noButtonText: "no",
  },
  upload: [
    {
      title: "Upload your %s",
      front: {
        description: "Drag and drop the front page of your document here",
        buttonText: "Select File",
      },
      back: {
        description: "Drag and drop the back page of your document here",
        buttonText: "Select File",
      },
      acceptedFilesDescription:
        "Accepted file types: JPG, PNG, PDF / max. size 5MB per file",
      buttonText: "Upload",
      tipDescription:
        "Upload two images, one containing the front side and the one the back side of your document If you have a PDF containing both images (first image is considered the front side) you can just upload the single file as the front side.",
    },
  ],
  backgroundCheck: {
    title: "Background Check",
    description: `TBD: A text that explains what is a background check and what are the checks that will be performed.`,
    declineButtonText: "decline",
    consentButtonText: "consent",
    continueButtonText: "continue",
    declineConfirmation: {
      title: "Are you sure you want to decline?",
      description: "",
      noButtonText: "no",
      yesButtonText: "yes",
    },
  },
  facialRecognition: {
    title: "Facial Recognition",
    description: "Position head inside oval, then start recording",
    livenessDetectionMessages: {
      OK: "Hold your position",
      MOVE_CLOSER: "Move closer to the oval",
      GO_BACK: "Move further from the oval",
      LOOK_STRAIGHT: "Look straight at the camera",
      EYE_CLOSED: "Look straight at the camera",
      MOVE_TO_CENTER: "Center your face in the oval",
      NO_PERSON_DETECTED: "No face detected",
      MULTIPLE_PERSON_DETECTED: "Multiple faces detected",
      ERROR: "Unknown Error, Refresh",
    },
  },

  scan: [
    {
      titleFrontSide: "Take a picture<br>of the front page %s",
      titleBackSide: "Take a picture<br>of the back page %s",
      rescanButtonText: "rescan",
      continueButtonText: "continue",
      turnDocumentDescription: "Turn document over",
      tipDescription: "Ensure all data is clearly readable",
      tipDescription2:
        "Ensure your face is clearly visible<br>and no hologram is covering it",
      description:
        "Position the document inside the frame and press the shutter button below",
    },
  ],
  documentTypes: {
    BHR_ID: "Bahrain ID",
    GENERIC_ID: "National ID",
    KWT_ID: "Kuwait ID",
    OMN_ID: "Oman ID",
    PAK_ID: "Pakistan ID",
    PASSPORT: "Passport",
    SAU_ID: "Saudi ID",
    UAE_ID: "Emirates ID",
    UAE_DL: "Driving License",
    NLD_DL: "Driving License",
    UAE_VISA: "Resident Visa",
    UAE_VL: "Vehicle License",
    QAT_ID: "Qatar ID",
    DEU_ID: "German ID",
    DZA_ID: "Algerian ID",
    SDN_ID: "Sudan ID",
    SDN_DL: "Driving License",
    SDN_VL: "Vehicle License",
    GHA_ID: "Ghana ID",
    NGA_DL: "Driving License",
    NGA_VOTER_ID: "Voter ID",
    NGA_NIN: "NIN",
    UAE_VL_PDF: "Vehicle License (Electronic Version)",
    GBR_DL: "Driving License",
    SAU_DL: "Driving License",
    ZAF_ID: "South African ID",
    ZAF_DL: "Driving License",
    EGY_ID: "Egyptian ID",
    RWA_ID: "Rwandan ID",
    KEN_ID: "Kenyan ID",
    GHA_DL: "Driving License",
    GHA_VOTER_ID: "Voter ID",
    GHA_SSNIT: "SSNIT",
    UGA_ID: "Ugandan ID",
    IND_ID: "Indian Aadhaar ID",
    SEN_ID: "Senegal ID",
    TUR_ID: "Turkish ID",
    UGA_VOTER_ID: "Ugandan Voter ID",
    COD_DL: "Driving License",
    GBR_ID: "Resident ID",
    COD_VOTER_ID: "Voter ID",
    OMN_VL: "Vehicle License",
    OMN_DL: "Driving License",
    USA_DL: "Driving License",
    QAT_DL: "Driving License",
    BHR_DL: "Driving License",
    PHL_DL: "Driving License",
    RSL_ID: "National ID",
    IND_PAN: "PAN card",
    LBN_ID: "Lebanese ID",
    LBN_DL: "Lebanese Driving License",
    IRQ_ID: "Iraqi ID",
    MRZ: "MRZ",
    UAE_ID_DIGITAL: "Digital Emirates ID",
    QAT_VL: "Vehicle License",
    UAE_PASSPORT_DIGITAL: "Digital Emirates Passport",
  },
  errors: {
    SCAN_DOCUMENT_NOT_RECOGNIZED: {
      title: "Scanning Failed",
      description:
        "<b>Ensure:<br/>1. </b> Good lighting conditions<br/><b>2.</b> Camera lens is clean<br/><b>3.</b> No reflections on document<br/><b>4.</b> Remove any stickers on the document",
      button: "Try Again",
    },
    SCAN_DOCUMENT_EXPIRED: {
      title: "Document is expired",
      description: "Please make sure to use a valid document",
      button: "Try Again",
    },
    SCAN_DOCUMENT_FRONT_BACK_MISMATCH: {
      title: "Scanning Failed",
      description: "Front and back page don't belong to the same document",
      button: "Try Again",
    },
    FACE_LIVENESS_FAILED: {
      title: "Facial recognition failed",
      description:
        "Here are some hints:<br/><b>1.</b> Fit face inside oval and look straight to the camera<br/><b>2.</b> Remove anything that can cover your face, e.g. mask<br/><b>3.</b> Take off your sun glasses or eye glasses with dark lens<br/><b>4.</b> Make sure your environment is not too dark or too bright<br/><b>5.</b> Make sure the lens of your front camera are clean",
      button: "Try Again",
    },
    FACE_NO_MATCH: {
      title: "Face didn't match",
      description:
        "Here are some hints:<br/><b>1.</b> Fit face inside oval and look straight to the camera<br/><b>2.</b> Remove anything that can cover your face, e.g. mask<br/><b>3.</b> Take off your sun glasses or eye glasses with dark lens<br/><b>4.</b> Make sure your environment is not too dark or too bright<br/><b>5.</b> Make sure the lens of your front camera are clean",
      button: "Try Again",
    },
    UNEXPECTED_ERROR: {
      title: "Unexpected error",
      description: "The service encountered an internal error",
      button: "Try Again",
    },
    PAYLOAD_TOO_LARGE: {
      title: "File is too large",
      description: "Only JPG, PNG, PDF with a max size of 5MB are accepted",
      button: "Try Again",
    },
    SCAN_DOCUMENT_AGE_VERIFICATION_FAILED: {
      title: "Age Verification Failed",
      description: `Document not accepted, minimum age required %d`,
      button: "Try Again",
    },
  },
}

Last updated

Was this helpful?