react
Microblink Platform SDK / react
react
Copyright (c) Microblink. All rights reserved. This code is provided for use as-is and may not be copied, modified, or redistributed.
Interfaces
TranslationMessages
Properties
actions
actions:
object
Translation messages related to call to action buttons in the UI.
| Name | Type | Description |
|---|---|---|
back | string | - |
cancel | string | - |
continue | string | Button text for continue action. Default value: "Continue" |
continueAnotherWay | string | - |
done | string | Button text for done action. Default value: "Done". |
exit | string | Button text for exit action. Default value: "exit" |
start | string | Button text for start action. Default value: "Start" |
startOver | string | - |
switchToDesktopToContinue | string | - |
tryAgain | string | Button text for try again action. Default value: "Try again" |
tryScanningAgain | string | - |
yesContinue | string | - |
cardScanning
cardScanning:
CardScanningTranslations
Translation messages related to card scanning process.
d2d
d2d:
object
Translation messages related to the device-to-device (d2d) flow.
| Name | Type | Description |
|---|---|---|
abortCaption | string | Caption displayed when the user is prompted to abort the process. Default value: "You can now complete your verification on desktop." |
abortTitle | string | Title displayed when the user is prompted to abort the process. Default value: "Continue on desktop." |
cancelVerificationCaption | string | Caption displayed when the user is prompted to cancel the verification process. Default value: "Your mobile device is connected, and verification is underway." |
cancelVerificationTitle | string | Title displayed when the user is prompted to cancel the verification process. Default value: "You are about to cancel the verification on the mobile device. Are you sure?" |
caption | string | Caption displayed during the d2d flow. Default value: "Switch to mobile device to continue the verification." |
chooseAlternativeMethod | string | Message prompting the user to choose an alternative method. Default value: "or choose an alternative method" |
connectedCaption | string | Caption displayed when the devices are successfully connected. Default value: "Verification is in progress. Follow the instructions on your phone." |
connectedTitle | string | Title displayed when the devices are successfully connected. Default value: "Connected. Continue on the mobile device." |
connectionLimitReachedCaption | string | Caption displayed when the connection limit is reached. Default value: "Close the existing connections and try again." |
connectionLimitReachedTitle | string | Title displayed when the connection limit is reached. Default value: "Connection limit reached." |
continueOnDesktop | string | Message prompting the user to continue the process on their desktop. Default value: "Continue the flow on the desktop" |
copyLink | string | Button text to copy a link for the d2d flow. Default value: "Copy link" |
deviceDisconnectedCaption | string | Caption displayed when a device is disconnected. Default value: "The device has lost connection. Possible reasons include battery or other connectivity issues." |
deviceDisconnectedTitle | string | Title displayed when a device is disconnected. Default value: "Device disconnected" |
errorCaption | string | Caption displayed when an error occurs during the d2d flow. Default value: "We couldn't connect to your mobile device." |
errorTitle | string | Title displayed when an error occurs during the d2d flow. Default value: "Error: unable to establish connection" |
expiresIn | string | Message indicating the QR code or session expires in a certain amount of time. Default value: "Expires in" |
getNewQrCode | string | Button text to generate a new QR code. Default value: "Get new QR code" |
inactiveConnectionCaption | string | Caption displayed when the connection becomes inactive. Default value: "Please check your mobile device and try again." |
inactiveConnectionTitle | string | Title displayed when the connection becomes inactive. Default value: "Inactive connection" |
instructionsTitle | string | Title for the instructions screen in the d2d flow. Default value: "Instructions on how to do it." |
linkCopied | string | Message displayed when a link is successfully copied to the clipboard. Default value: "Link copied! Open it on your mobile device to continue." |
proceedWithDesktopCamera | string | Button text to proceed using the desktop camera. Default value: "Proceed with Desktop Camera" |
qrCodeExpired | string | Message displayed when the QR code has expired. Default value: QR code has expired" |
returnToThisDeviceSubtitle | string | Subtitle for the screen prompting the user to return to their original device. Default value: "Once verification is complete, go back to this device." |
returnToThisDeviceTitle | string | Title for the screen prompting the user to return to their original device. Default value: "Return to this device" |
scanCodeSubtitle | string | Subtitle for the screen prompting the user to scan a QR code. Default value: "Use your phone's camera to scan the code displayed on your screen." |
scanCodeTitle | string | Title for the screen prompting the user to scan a QR code. Default value: "Scan QR code or copy link." |
title | string | Title displayed during the d2d flow. Default value: "Switch to mobile device to continue the verification." |
transferToMobilePhoneSubtitle | string | Subtitle for the screen prompting the user to transfer the process to their mobile phone. Default value: "Perform the verification of the identity on the mobile device." |
transferToMobilePhoneTitle | string | Title for the screen prompting the user to transfer the process to their mobile phone. Default value: "Transfer to mobile phone." |
verificationCanceledCaption | string | Caption displayed when the verification process is canceled. Default value: "The verification process has been interrupted." |
verificationCanceledTitle | string | Title displayed when the verification process is canceled. Default value: "Verification canceled" |
verificationSuccessfulCaption | string | Caption displayed when the verification process is successful. Default value: "Your verification is complete. Plase return to your desktop to continue." |
verificationSuccessfulTitle | string | Title displayed when the verification process is successful. Default value: "Verification successful!" |
documentScanning
documentScanning:
DocumentScanningTranslations
Translation messages related to document scanning process.
end
end:
object
Translation messages related to the end screen.
| Name | Type | Description |
|---|---|---|
errorCaption | string | Caption for the error message. Default value: "We couldn’t complete the verification. Let’s try the verification again." |
errorTitle | string | Message indicating an error occurred during the verification process. Default value: "Something went wrong" |
identityNotVerifiedCaption | string | Caption for the identity not verified message. Default value: "We couldn't verify your identity this time. Please double-check your information and try again, or contact support for assistance." |
identityNotVerifiedTitle | string | Message indicating the identity is not verified. Default value: "Identity not verified" |
identityVerifiedCaption | string | Caption for the identity verified message. Default value: "Thank you for proving your identity - it was you all along!" |
identityVerifiedTitle | string | Message indicating the identity is verified. Default value: "Identity verified!" |
identityVerifyingCaption | string | Caption for the identity verifying message. Default value: "We've got everything we need. We'll notify you as soon as it's complete." |
identityVerifyingTitle | string | Message indicating the identity is being verified. Default value: Thanks! We're verifying your identity now |
faceCapture
faceCapture:
FaceCaptureTranslations
Translation messages related to face capture process.
home
home:
object
Translation messages related to the home screen.
| Name | Type | Description |
|---|---|---|
additionalActionsCaption | string | Caption for additional actions on the home screen. Default value: "We may ask you to take additional actions to complete your verification." |
caption | string | Caption for the home screen. Default value: "This will only take a couple of minutes." |
cardVerificationAnotherStepTitle | string | - |
cardVerificationStepCaption | string | Caption for the card verification step on the home screen. Default value: "Go grab your credit or debit card" |
cardVerificationStepTitle | string | Title for the card verification step on the home screen. Default value: "Scan your card" |
documentExtractionAnotherStepTitle | string | - |
documentExtractionStepCaption | string | Caption for the document extraction step on the home screen. Default value: "Go grab your ID" |
documentExtractionStepTitle | string | Title for the document extraction step on the home screen. Default value: "Scan your document" |
documentVerificationAnotherStepTitle | string | - |
documentVerificationStepCaption | string | Caption for the document verification step on the home screen. Default value: "Go grab your ID" |
documentVerificationStepTitle | string | Title for the document verification step on the home screen. Default value: "Scan your document" |
faceMatchStepCaption | string | Caption for the face match step on the home screen. Default value: "Make sure your face is well-lit" |
faceMatchStepTitle | string | Title for the face match step on the home screen. Default value: "Take a selfie" |
manualInputStepCaption | string | Caption for the form step on the home screen. Default value: "Enter your details" |
manualInputStepTitle | string | Title for the form step on the home screen. Default value: "Fill in the form" |
title | string | Title for the home screen. Default value: "Let's verify your identity" |
manualInput
manualInput:
ManualInputTranslations
Translation messages related to the manual input process.
statuses
statuses:
object
Translation messages related to status messages on the UI. For example, messages used to display information about the current state of the process to the user ("Camera loading", "Checking camera", etc.)
| Name | Type | Description |
|---|---|---|
cameraLoading | string | Message indicating the camera is loading. Default value: "Camera loading" |
cameraPermissionRequiredCaption | string | Caption indicating that camera permission is required. Default value: "We don't have your permission to use the camera. To continue, please make sure that camera is enabled." |
cameraPermissionRequiredTitle | string | Message indicating camera permission is required. Default value: "Camera permission required" |
checkingCamera | string | Message indicating the camera is being checked. Default value: "Checking camera..." |
completed | string | Message indicating the process is completed. Default value: "Completed" |
documentNotSupportedCaption | string | Caption for the document not supported message. Default value: "Try scanning a different document." |
documentNotSupportedTitle | string | Title for the document not supported message. Default value: "Document not accepted" |
documentScanErrorCaption | string | Caption for the document scan error message. Default value: "Try again, ensuring your document is fully visible and well-lit. Keep the document steady to prevent any blurriness." |
documentScanErrorTitle | string | Title for the document scan error message. Default value: "Scan again" |
nextUp | string | Message indicating the next step. Default value: "Next up" |
noCameraDevices | string | Message indicating there are no camera devices. Default value: "No camera devices found" |
noInternetConnection | string | Message indicating there is no internet connection. Default value: "No internet connection" |
processing | string | Message indicating processing is in progress. Default value: "Processing..." |
retakeSelfieCaption | string | Caption for the retake selfie message. Default value: "Try again, making sure your eyes are open, your face is fully visible and only one in the frame and there's good lighting." |
retakeSelfieTitle | string | Title for the retake selfie message. Default value: "Retake selfie" |
scanTimeoutErrorCaption | string | Caption for the scan timeout error message. Default value: "Ensure you are in a well-lit space with no glare on the document, keep it in focus, fully visible and steady." |
scanTimeoutErrorTitle | string | Title for the scan timeout error message. Default value: "Having trouble scanning?" |
verificationNotAvailable | string | Message indicating verification is not available. Default value: "Verification not available" |
References
IdvFlowProps
Re-exports IdvFlowProps
ProxyConfig
Re-exports ProxyConfig
ThemeOverride
Re-exports ThemeOverride