Configuration¶
The SDK can be configured by providing a dictionary to the SDK. All colors are configured with a dictionary with "red", "green", "blue" as keys and values between 0-255 and "alpha" as key and value between 0-1. Remember to set all text parameters as short and concise as possible to better fit the screen. The SDK configuration dictionary may contain or not the following keys/values:
- capturedbackgroundalpha : The color of the background of the layout shown when the obverse is captured.
- capturedlabelicon : The icon to be drawn in the layout shown when the obverse is captured.
- capturedlabelposition : Position of the label in the layout shown when the obverse is captured ("top"/"center"/"bottom").
- capturedlabeltext : Text of the label in the layout shown when the obverse is captured.
- closebutton : Whether the SDK may have a close button or not. ("YES"/"NO")
- closebuttonimage : Image to be shown in the close button.
- countdowntextcolor : The color of the countdown animation.
- documentlabeltextbackgroundcolor : The start background color of the text of the the informative top label shown to the user.
- documentlabeltextbackgroundcolorfinal : The final background color of the text of the the informative top label shown to the user.
- documentlabeltextcolor : The color of the text of the the informative top label shown to the user.
- documentmobileoval : Whether a surrounding oval will be shown at the location of the document if it is found. ("YES","NO")
- documentmobileovalcolor : The color of the document surrounding oval.
- documentobverselabeltext : The text next to the fixed rectangle to show the obverse of the document.
- documentreverselabeltext : The text next to the fixed rectangle to show the reverse of the document.
- facemobileoval : Whether the following face surrounding oval must be shown or not. ("YES"/"NO")
- facemobileovalcolor : The color of the face surrounding oval.
- facenotfounderror : The text of the alert that will be shown if the face is not shown.
- facenotfounderrortitle : The title of the alert that will be shown if the face is not shown.
- faceshapeoval : Whether the face shape should be and oval or not. ("YES"/"NO")
- familyName : The name of the font family that will overwrite the default one, if any.
- finalerror : The text of the alert that will be shown if an error has occurred while the video recording.
- finalerrortitle : The title of the alert that will be shown if an error has occurred while the video recording.
- fixedoval : Whether the fixed face shape (oval or not) at the center of the screen must be shown or not. ("YES"/"NO")
- fixedrectangle : Whether the fixed rectangle at the document must be shown or not. ("YES"/"NO")
- fixedrectangleposition : The position in which the fixed rectangle should appear ("top"/"center"/"bottom")
- infoalert : The text of the alert shown at the beginning of the video in "onboarding" mode to briefly inform the user of the next step of the process.
- infoalerteauthenticatemode : The text of the alert shown at the beginning of the video in "authentication" mode to briefly inform the user of the next step of the process.
- infoalertpass : The text of the alert shown at the beginning of the video in "onboarding" mode if passport document provided to briefly inform the user of the next step of the process.
- infoalertshow: Whether the initial alert must be shown or not.("YES","NO")
- infoalerttitle : The title of the alert shown at the beginning of the video in "onboarding" mode.
- infoalerttitleauthenticatemode : The title of the alert shown at the beginning of the video in "authentication" mode.
- infoalerttitlepass : The title of the alert shown at the beginning of the video in "onboarding" mode if passport document provided.
- lifetype : The type of video is going to be recorded. "onboarding" for a full proof of life as SEPBLAC requires(name and surname, document obverse and document reverse) or "authentication" for only first part of the proof of life (name and surname).
- metadatadate : Whether the video has a date as metadata or not. ("YES"/"NO").
- metadatatoken : Whether the video has a token as metadata or not. ("YES"/"NO").
- obversenotfounderror : The text of the alert that will be shown if the document obverse is not shown.
- obversenotfounderrortitle : The title of the alert that will be shown if the document obverse is not shown.
- onlyobverse : Whether the SDK may have to take only obverse image capture. ("YES"/"NO")
- permissionrefused : The text for the alert when a permission is not allowed.
- permissionrefusedbutton : The text of the button from the alert when a permission is not allowed. This button will lead to the permission settings of the app.
- permissionrefusedtitle : The title for the alert when a permission is not allowed.
- positivebuttontitle : The text of the all positive buttons.
- reversedetection : Whether the reverse should be detected or not. ("YES"/"NO").
- reversenotfounderror : The text of the alert that will be shown if the document reverse is not shown.
- reversenotfounderrortitle : The title of the alert that will be shown if the document reverse is not shown.
- secondsobversenotfounderror : Seconds until obverse not found error.
- secondsreversenotfounderror : Seconds until reverse not found error.
- secondsshowingface : Duration in seconds in which the user must be showing the face.
- secondsshowingobverse : The seconds to show the obverse when the video is not smart.
- secondsshowingreverse : The seconds to show the reverse when the video is not smart.
- secondsvideotimeout : Maximum seconds for video duration.
- secondsvideotimeoutonlyobverse : Maximum seconds for video duration when the document has only obverse.
- showtutorial : Whether the SDK tutorial section must be shown or not. ("YES"/"NO")
- tickcirclecolor : Color of the circle of the tick image.
- tickcolor : Color of the tick of the tick image.
- token : The token to add.
- tutorialbackgroundcolor : The background color of the tutorial section.
- tutorialcontinuebuttoncolor : The background color of the continue button at the tutorial section.
- tutorialcontinuebuttontext : The text of the continue button at the tutorial section.
- tutorialcontinuebuttontextcolor : The text color of the continue button at the tutorial section.
- tutorialgif : The gif shown to the user at the tutorial section.
- tutorialpassporttext : The passport info text shown to the user at the tutorial section.
- tutorialtext : The document info text shown to the user at the tutorial section.
- tutorialtextcolor : The color of the info text shown to the user at the tutorial section.
- tutorialtitle : The title of the tutorial section.
- tutorialtitlecolor : The title color of the tutorial section.
- usernotacommodatedtext : The text presented to the user when the face is lost in the first seconds of the video (accommodation time).
- usernotacommodatedtitle : The title of the accommodation message.
- videoinformativelabel : Whether the top label will be shown or not. ("YES"/"NO")
- videoinformativelabelbackgroundcolor : The start color of the label background shown at the top of the screen.
- videoinformativelabelbackgroundcolorfinal : The final color of the label background shown at the top of the screen.
- videoinformativelabelborder: Whether the informative label border must be shown or not. ("YES","NO")
- videoinformativelabelbordercolor : The start color of the label border shown at the top of the screen.
- videoinformativelabelbordercolorfinal : The final color of the label border shown at the top of the screen.
- videoinformativelabelposition : The position of the informative label. ("top"/"center"/"bottom"/"documentcenter")
- videoinformativelabelradius : The radius of the informative label.
- videoinformativelabeltextcolor : The text color of the top label shown to the user.
- videoinformativetext1 : The text of the label at the top of the screen to say something in the video.
- videoinformativetext2 : The text of the label at the top of the screen to show the obverse of the document.
- videoinformativetext2pass : The text of the label at the top of the screen to show the first page of the passport.
- videoinformativetext3 : The text of the label at the top of the screen to show the reverse of the document.
The default values for these keys are:
| Key | Default Value (en/es) |
|---|---|
| "capturedbackgroundalpha" | "0.85" |
| "capturedlabelicon" | "" |
| "capturedlabelposition" | "bottom" |
| "capturedlabeltext" | "Captured" "Capturado" |
| "closebutton" | "NO" |
| "closebuttonimage" | ic_closebutton.png |
| "countdowntextcolor" | red = "255", green = "255", blue = "255", alpha = "1" |
| "documentlabeltextbackgroundcolor" | red = "64", green = "176", blue = "116", alpha = "1" |
| "documentlabeltextbackgroundcolorfinal" | red = "0", green = "0", blue = "0", alpha = "0.66" |
| "documentlabeltextcolor" | red = "255", green = "255", blue = "255", alpha = "1" |
| "documentmobileoval" | "YES" |
| "documentmobileovalcolor" | red = "0", green = "255", blue = "0", alpha = "1" |
| "documentobverselabeltext" | "FRONT SIDE" "PARTE DELANTERA" |
| "documentreverselabeltext" | "BACK SIDE" "PARTE TRASERA" |
| "facemobileoval" | "YES" |
| "facemobileovalcolor" | red = "0", green = "255", blue = "0", alpha = "1" |
| "facenotfounderror" | "You stopped looking at the camera and the process has come to a halt. Please, start again" "No se pudo grabar el vídeo. Por favor, mire a la cámara y siga las instrucciones" |
| "facenotfounderrortitle" | "Error" "Error" |
| "faceshapeoval" | "NO" |
| "familyName" | "Helvetica" |
| "finalerror" | "You have not shown the document or it was too far away and the process has come to a halt. Please, start again." "No ha mostrado el documento o el documento estaba muy lejos y el proceso se ha detenido. Por favor, empiece de nuevo." |
| "finalerrortitle" | "An error has occurred." "Ha ocurrido un error." |
| "fixedoval" | "YES" |
| "fixedrectangle" | "YES" |
| "fixedrectangleposition" | "top" |
| "infoalert" | ">When required:\n1º Say your NAME and SURNAME.\n2º Show the FRONT SIDE of your document.\n3º Show the BACK SIDE of your document." "Cuando se le solicite:\n• Diga su NOMBRE y APELLIDOS.\n• Muestre la parte DELANTERA de su documento.\n• Muestre la parte TRASERA de su documento." |
| "infoalerteauthenticatemode" | "The application needs to record a video selfie as proof of life." "La aplicación necesita grabar un vídeo selfie como prueba de vida." |
| "infoalertpass" | "When required:\n1º Say your NAME and SURNAME.\n2º Show the PAGE WITH THE DATA of the passport." "Cuando se le solicite:\n• Diga su NOMBRE y APELLIDOS.\n• Muestre la PÁGINA CON LOS DATOS del pasaporte." |
| "infoalertshow" | "NO" |
| "infoalerttitle" | "Video Selfie" "Video Selfie" |
| "infoalerttitleauthenticatemode" | "Video Proof of Life" "Atención" |
| "infoalerttitlepass" | "Attention" "Atención" |
| "lifetype" | "onboarding" |
| "metadatadate" | "YES" |
| "metadatatoken" | "YES" |
| "obversenotfounderror" | "You have to show the FRONT SIDE of your identity document by putting it close to the camera." "Debe mostrar la parte DELANTERA del documento acercándolo a cámara." |
| "obversenotfounderrortitle" | "Error" "Error" |
| "onlyobverse" | "NO" |
| "permissionrefused" | "The permission was rejected.\nYou need to activate it manually:\nSettings > Application > Activate Permission" "Ha rechazado el permiso.\nTiene que activarlo manualmente en:\nAjustes > Aplicación > Activar permiso" |
| "permissionrefusedbutton" | "Open settings" "Abrir ajustes" |
| "permissionrefusedtitle" | "Required permission" "Permiso requerido" |
| "positivebuttontitle" | "Continue" "Continuar" |
| "reversedetection" | "YES" |
| "reversenotfounderror" | "You have to show the BACK SIDE of your identity document by putting it close to the camera." "Debe mostrar a parte TRASERA del documento acercándolo a cámara." |
| "reversenotfounderrortitle" | "Error" "Error" |
| "secondsobversenotfounderror" | "6" |
| "secondsreversenotfounderror" | "12" |
| "secondsshowingface" | "7" |
| "secondsshowingobverse" | "6" |
| "secondsshowingreverse" | "6" |
| "secondsvideotimeout" | "41" |
| "secondsvideotimeoutonlyobverse" | "17" |
| "showtutorial" | "YES" |
| "tickcirclecolor" | red = "72", green = "174", blue = "100", alpha = "1" |
| "tickcolor" | red = "255", green = "255", blue = "255", alpha = "1" |
| "token" | "" |
| "tutorialbackgroundcolor" | red = "18", green = "38", blue = "78", alpha = "1" |
| "tutorialcontinuebuttoncolor" | red = "69", green = "125", blue = "182", alpha = "1" |
| "tutorialcontinuebuttontext" | "Continue" "Continuar" |
| "tutorialcontinuebuttontextcolor" | red = "255", green = "255", blue = "255", alpha = "1" |
| "tutorialgif" | "" |
| "tutorialpassporttext" | "When required:\n1º Say your NAME and SURNAME.\n2º Show the PAGE WITH THE DATA of the passport." "Cuando se le solicite:\n• Diga su NOMBRE y APELLIDOS.\n• Muestre la PÁGINA CON LOS DATOS del pasaporte." |
| "tutorialtext" | "When required:\n1º Say your NAME and SURNAME.\n2º Show the FRONT SIDE of your document.\n3º Show the BACK SIDE of your document." "Cuando se le solicite:\n• Diga su NOMBRE y APELLIDOS.\n• Muestre la parte DELANTERA de su documento.\n• Muestre la parte TRASERA de su documento." |
| "tutorialtextcolor" | red = "255", green = "255", blue = "255", alpha = "1" |
| "tutorialtitle" | "Video Selfie" "Video Selfie" |
| "tutorialtitlecolor" | red = "255", green = "255", blue = "255", alpha = "1" |
| "usernotacommodatedtext" | "You stopped looking at the camera and the process has come to a halt. Please, start again" "No se pudo grabar el vídeo. Por favor, mire a la cámara y siga las instrucciones." |
| "usernotacommodatedtitle" | "Error" "Error" |
| "videoinformativelabel" | "YES" |
| "videoinformativelabelbackgroundcolor" | red = "64", green = "176", blue = "116", alpha = "1" |
| "videoinformativelabelbackgroundcolorfinal" | red = "0", green = "0", blue = "0", alpha = "0.66" |
| "videoinformativelabelborder" | "YES" |
| "videoinformativelabelbordercolor" | red = "64", green = "176", blue = "116", alpha = "1" |
| "videoinformativelabelbordercolorfinal" | red = "0", green = "0", blue = "0", alpha = "0.66" |
| "videoinformativelabelposition" | "top" |
| "videoinformativelabelradius" | "0" |
| "videoinformativelabeltextcolor" | red = "255", green = "255", blue = "255", alpha = "1" |
| "videoinformativetext1" | "Say your NAME and SURNAME." "Diga su NOMBRE y APELLIDOS" |
| "videoinformativetext2" | "Show the FRONT SIDE of the document." "Muestre la parte DELANTERA del documento." |
| "videoinformativetext2pass" | "Show the page that contains the data of the passport." "Muestre la página con los datos del pasaporte." |
| "videoinformativetext3" | "And now the BACK SIDE." "Y ahora muestre la parte TRASERA." |