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:
- bringcloserfacetext: Text to show when the face is detected but extremely far.
- capturebackgroundcolor : The background color of the capture view.
- centerfacetext : Text to show when the face is detected but it is not centered.
- challengebottomtext : The text indication for bottom movement.
- challengecentertext : The text indication for center movement.
- challengeerrortext : The text indication for when an error happened.
- challengelefttext : The text indication for left movement.
- challengerighttext : The text indication for right movement.
- challengetoptext : The text indication for top movement.
- checkselfietext : The text that is shown to inform the user in the revision of the selfie photo.
- checkselfietextcolor : The color of the text that is shown to inform the user in the revision of the selfie photo.
- closebutton : Whether the SDK may have a close button or not. ("YES"/"NO")
- closebuttonimage : Image for the close button.
- continuebuttonbackgroundcolor : The background color of the continue button in the document photo verification.
- continuebuttonicon : Image to be displayed alongside the continue button.
- continuebuttontext : The text of the continue button in the document photo verification.
- continuebuttontextcolor : The color of the text of the continue button in the document photo verification.
- countdownposition : The position of the countdown animation.
- deviceincorrectposition : The text indication when the device is in an incorrect position.
- facedetectednotcenteredcolor: Fixed oval color when the face is detected but it is not centered or extremely far.
- facedetectedokcolor: Template and text color when face is detected in the correct position.
- faceshapeoval : Whether the SDK may have a fixed oval or faced shape. ("YES"/"NO")
- facetightness: The distance in which the face is detected. ("tight"/"loose")
- facing : Camera to be used to take the picture. ("back"/"front").
- familyName : Name of the fond to be used in the whole SDK but the countdown.
- finaltutorialalertshow: Whether the final alert should be shown or not. ("YES"/"NO")
- fixedoval : Whether the fixed oval or faced shape must shown or not. ("YES"/"NO")
- infoalert : The text to show at the beginning of the capture 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 showed at the beginning of the capture.
- informativebackgroundcolor : The color of the background of the informative label shown to the user.
- informativetextcolor : The color of the text of the informative label shown to the user.
- jwstoken : The token that defines the challenge in a Selfie Alive Pro process.
- livephoto : Whether live photos capabilities are activated or not. ("YES"/"NO")
- livephotoimage : Whether live photos suggestion (happy/neutral) are shown or not. ("YES"/"NO")
- mobileoval : Whether the following face surrounding oval must be shown or not. ("YES"/"NO")
- mobileovalcolor : The color of the face surrounding oval.
- orientationbackgroundcolor : The background color of the opacity screen shown when orientation is incorrect.
- orientationopacity : Whether the SDK may change the opacity of the screen when orientation incorrect or not. ("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.
- popupvalidationbackgroundcolor : The background color of the text to show when the user hits the help button in the photo selfie verification.
- popupvalidationtextcolor : The color of the text to show when the user hits the help button in the photo selfie verification.
- positivebuttontext : The text of the all positive buttons.
- repeatbuttonbackgroundcolor : The background color of the repeat button in the photo selfie verification.
- repeatbuttonicon : Image to be shown alongside the repeat button text.
- repeatbuttontext : The text of the repeat button in the photo selfie verification.
- repeatbuttontextcolor : The color of the text of the repeat button in the photo selfie verification.
- searchingfacestepinstruction : The text to guide the user to take a selfie.
- selfiealivearrowcolor : The color of the arrow shown during the Selfie Alive Pro process.
- selfiengaserroralertbuttontext : The text to accept the error alert in a Selfie Alive Pro and Selfie Alive process.
- selfiengaserroralertdescription : The description of the alert in a Selfie Alive Pro process.
- selfiengaserroralertstep1 : The first step description of Selfie Alive Pro process in the error alert.
- selfiengaserroralertstep2 : The second step description of Selfie Alive Pro process in the error alert.
- selfiengaserroralertstep3 : The third step description of Selfie Alive Pro process in the error alert.
- selfiengaserroralerttitle : The title of the error alert in a Selfie Alive and Selfie Alive Pro process.
- selfiengaserroralerttitlecolor : The title color of the error alert in a Selfie Alive and Selfie Alive Pro process.
- selfiengasshowarrows : Whether the arrows shown in the Selfie Alive Pro process process should be shown or not. ("YES"/"NO)
- selfiengastutorialdescription3 : The third step description of Selfie Alive Pro process in the tutorial.
- selfiengastutorialstep3title : The third step title of Selfie Alive Pro process in the tutorial.
- selfiesmiletutorialdescription3 : The third step description of Selfie Alive with smile process in the tutorial.
- selfiesmiletutorialstep3title : The third step title of Selfie Alive with smile process in the tutorial.
- selfietutorialbackgroundcolor : The background color of the tutorial view.
- selfietutorialcontinuebuttonfirstgradientcolor : The first gradient color of the continue button in the tutorial of Selfie Alive Pro process.
- selfietutorialcontinuebuttonsecondgradientcolor : The second gradient color of the continue button in the tutorial of Selfie Alive Pro process.
- selfietutorialcontinuebuttontext : The text shown in the continue button of the tutorial.
- selfietutorialcontinuebuttontextcolor" : The color of the text shown in the continue button of the tutorial.
- selfietutorialcurrentpointcolor : The color of the current slide point in the tutorial.
- selfietutorialdescription1 : The first step description of Selfie process in the tutorial.
- selfietutorialdescription2 : The second step description of Selfie process in the tutorial.
- selfietutorialdescriptioncolor : The color of the tutorial descriptions in the tutorial slides.
- selfietutorialgeneraltitle : The title of the tutorial.
- selfietutorialgeneraltitlecolor : The title color of the tutorial.
- selfietutorialstep1title : The first step title of Selfie in the tutorial.
- selfietutorialstep2title : The second step title of Selfie in the tutorial.
- selfietutorialstepbuttonnexttext : The text of the next button in the tutorial slides.
- selfietutorialstepbuttonnexttextcolor : The color of the next button in the tutorial slides.
- selfietutorialstepbuttonprevioustext : The text of the previous button in the tutorial slides.
- selfietutorialstepbuttonprevioustextcolor : The color of the previous button in the tutorial slides.
- selfietutorialsteptitlecolor : The color of the tutorial titles in the tutorial slides.
- showselfie : Whether photo selfie verification section must be shown or not.("YES","NO")
- showtutorial : Whether the SDK tutorial section must be shown or not. ("YES"/"NO")
- smartselfie: Whether the photo selfie will show a level to make the user take a correct selfie or not. ("YES"/"NO")
- smilerequestserious: The text to be shown when the user has to be more serious.
- smilerequestseriousimage: The image to be shown when the user has to be more serious.
- smilerequestsmile: The text to be shown when the user has to be smile more.
- smilerequestsmileimage: The image to be shown when the user has to be smile more.
- smiletimeout: Whether the photo selfie should have a timeout for the smile request. ("YES"/"NO")
- smiletimeoutmessage: The text to be shown when the user has reached the timeout of the smile.
- smiletimeoutseconds: Seconds to reach the smile timeout.
- tickcirclecolor : Color of the circle of the tick image.
- tickcolor : Color of the tick of the tick image.
- tickshow : Whether the final tick must be shown or not. ("YES" / "NO")
- tutorialtitle : The title of the tutorial section.
- tutorialtitlecolor : The title color of the tutorial section.
- userinfo : The text to show when the user hits the help button in the document photo verification section.
- validationviewbackgroundcolor : The background color of the document photo verification section.
- veridaslogoshow : Whether the veridas logo must be shown or not. ("YES" / "NO")
The default values for these keys are:
| Key | Default Value (en/es) |
|---|---|
| "bringcloserfacetext" | "Get closer to the camera Acérquese a la cámara" |
| "capturebackgroundcolor" | red = "125", green = "125", blue = "125", alpha = "1" |
| "centerfacetext" | "Center your face in the oval Centre su cara en el óvalo" |
| "challengebottomtext" | "Turn your face down" "Gira la cara hacia abajo" |
| "challengecentertext" | "¡Great! Look back to the center" "¡Bien! Vuelve al centro" |
| "challengeerrortext" | "The process could not be completed. Try again. " "No se ha podido completar el proceso. Inténtelo de nuevo." |
| "challengelefttext" | "Turn your face to your left" "Gira la cara hacia tu izquierda" |
| "challengerighttext" | "Turn your face to your right" "Gira la cara hacia tu derecha" |
| "challengetoptext" | "Turn your face up" "Gira la cara hacia arriba" |
| "checkselfietext" | "If the photo is clear, press CONTINUE" "Si la foto se ve bien, pulsa CONTINUAR" |
| "checkselfietextcolor" | red = "255", green = "255", blue = "255", alpha = "1" |
| "closebutton" | "NO" |
| "closebuttonimage" | "ic_closebutton.png" |
| "continuebuttonbackgroundcolor" | red = "17", green = "100", blue = "102", alpha = "1" |
| "continuebuttonicon" | "" |
| "continuebuttontext" | "CONTINUE" "CONTINUAR" |
| "continuebuttontextcolor" | red = "255", green = "255", blue = "255", alpha = "1" |
| "countdownposition" | "center" |
| "deviceincorrectposition" | "Hold the phone vertically in front of you" "Pon el teléfono en vertical frente a ti" |
| "facedetectednotcenteredcolor" | red = "255", green = "0", blue = "0", alpha = "1" |
| "facedetectedokcolor" | red = "26", green = "94", blue = "176", alpha = "1" |
| "faceshapeoval" | "YES" |
| "facetightness" | "tight" |
| "facing" | "front" |
| "familyName" | "Helvetica" |
| "fixedoval" | "YES" |
| "finaltutorialalertshow" | "YES" |
| "infoalert" | "Automatic selfie: center your face in the oval frame." "Selfie automático: centre su cara en el óvalo." |
| "infoalertshow" | "YES" |
| "infoalerttitle" | "" |
| "informativebackgroundcolor" | red = "0", green = "0", blue = "0", alpha = "0" |
| "informativetextcolor" | red = "26", green = "94", blue = "176", alpha = "1" |
| "informativetextposition" | "center" |
| "jwstoken" | "" |
| "livephoto" | "NO" |
| "livephotoimage" | "YES" |
| "mobileoval" | "NO" |
| "mobileovalcolor" | red = "26", green = "94", blue = "176", alpha = "1" |
| "orientationbackgroundcolor" | red = "127", green = "127", blue = "127", alpha = "1" |
| "orientationopacity" | "YES" |
| "permissionrefused" | "The permission was rejected. You need to activate it manually: Settings > Application > Activate Permission" "Ha rechazado el permiso. Tiene que activarlo manualmente en: Ajustes > Aplicación > Activar Permiso" |
| "permissionrefusedbutton" | "Open settings" "Abrir ajustes" |
| "permissionrefusedtitle" | "Required permission" "Permiso requerido" |
| "popupvalidationbackgroundcolor" | red = "0", green = "0", blue = "0", alpha = "0.7" |
| "popupvalidationtextcolor" | red = "255", green = "255", blue = "255", alpha = "1" |
| "positivebuttontext" | "Continue" "Continuar" |
| "repeatbuttonbackgroundcolor" | red = "17", green = "100", blue = "102", alpha = "1" |
| "repeatbuttonicon" | "" |
| "repeatbuttontext" | "REPEAT" "REPETIR" |
| "repeatbuttontextcolor" | red = "255", green = "255", blue = "255", alpha = "1" |
| "searchingfacestepinstruction" | "Now, place your face inside the frame and hold steady while we take a photo" "Ahora, encaja tu cara en el marco y mantente estable mientras tomamos una foto" |
| "selfiealivearrowcolor" | red = "26", green = "94", blue = "176", alpha = "1" |
| "selfiengaserroralertbuttontext" | "I GOT IT, CONTINUE" "ENTENDIDO, CONTINUAR" |
| "selfiengaserroralertdescription" | "Let's start the process again. After taking the photo, follow these instructions to validate. Make sure to be in a well lit environment without elements that cover your face." "Vamos a empezar de nuevo el proceso. Después de sacar la foto, sigue estas instrucciones para hacer la validación. Asegúrate de estar en un entorno con luz y sin elementos que tapen tu cara." |
| "selfiengaserroralertstep1" | "1- Turn your head in the direction indicated" "1- Gira la cabeza en la dirección indicada" |
| "selfiengaserroralertstep2" | "2- You will hear a sound when you do it correctly" "2- Escucharás un sonido al hacer el giro correctamente" |
| "selfiengaserroralertstep3" | "3- Look back at the center to continue" "3- Vuelve a mirar al centro para continuar" |
| "selfiengaserroralerttitle" | "Have any doubts?" "¿No sabes qué hacer?" |
| "selfiengaserroralerttitlecolor" | red = "26", green = "94", blue = "176", alpha = "1" |
| "selfiengasshowarrows" | "YES" |
| "selfiengastutorialdescription3" | "1. Fit your face into the frame and wait for the countdown. 2. Turn your face slightly in one direction. 3. When the screen tells you that you have done it correctly, look back at the center. 4. The process will be repeated 3 times" "1. Encaja la cara en el marco y espera a la cuenta atrás. 2. Gira la cara ligeramente en la dirección que te indiquen las flechas. 3. Cuando la pantalla te indique que lo has hecho correctamente, vuelve a mirar al centro. 4. Repite el proceso 3 veces." |
| "selfiengastutorialstep3title" | "Follow the instructions" "Sigue las instrucciones" |
| "selfiesmiletutorialdescription3" | "1. Turn your face slightly in one direction. 2. When the screen tells you that you have done it correctly, look back at the center. 3. We will repeat the process several times." "1. Gira la cara ligeramente en la dirección que te indiquen las flechas. 2. Cuando la pantalla te indique que lo has hecho correctamente, vuelve a mirar al centro. 3. Repetiremos el proceso varias veces." |
| "selfiesmiletutorialstep3title" | "Hold steady and smile when prompted" "Mantén la mirada y sonríe cuando se indique" |
| "selfietutorialbackgroundcolor" | red = "236", green = "236", blue = "236", alpha = "1" |
| "selfietutorialcontinuebuttonfirstgradientcolor" | red = "0", green = "93", blue = "180", alpha = "1" |
| "selfietutorialcontinuebuttonsecondgradientcolor" | red = "0", green = "158", blue = "221", alpha = "1" |
| "selfietutorialcontinuebuttontext" | "START THE PROCESS" "COMENZAR EL PROCESO" |
| "selfietutorialcontinuebuttontextcolor" | red = "255", green = "255", blue = "255", alpha = "1" |
| "selfietutorialcurrentpointcolor" | red = "26", green = "94", blue = "176", alpha = "1" |
| "selfietutorialdescription1" | "Make sure you have good lighting (natural lighting would be ideal)." "Asegúrate tener una buena iluminación (si es natural, mejor aún)." |
| "selfietutorialdescription2" | "Try to hold the phone as vertical as possible and look at it from the front.Avoid any element that covers your face (hair, mask, etc.)" "Procura que el teléfono esté lo más en vertical posible y míralo de frente. Evita elementos que te cubran la cara (el pelo, la mascarilla, etc.)" |
| "selfietutorialdescriptioncolor" | red = "134", green = "134", blue = "134", alpha = "1" |
| "selfietutorialgeneraltitle" | "Before starting the process, read these quick instructions" "Antes de comenzar el proceso, lee estas sencillas instrucciones" |
| "selfietutorialgeneraltitlecolor" | red = "26", green = "94", blue = "176", alpha = "1" |
| "selfietutorialstep1title" | "Find the right place" "Busca el lugar adecuado" |
| "selfietutorialstep2title" | "Hold the phone vertically" "Sujeta el telefono en vertical" |
| "selfietutorialstepbuttonnexttext" | "Next" "Siguiente" |
| "selfietutorialstepbuttonnexttextcolor" | red = "26", green = "94", blue = "176", alpha = "1" |
| "selfietutorialstepbuttonprevioustext" | "Previous" "Anterior" |
| "selfietutorialstepbuttonprevioustextcolor" | red = "26", green = "94", blue = "176", alpha = "1" |
| "selfietutorialsteptitlecolor" | red = "26", green = "94", blue = "176", alpha = "1" |
| "showselfie" | "YES" |
| "showtutorial" | "YES" |
| "smartselfie" | "YES" |
| "smilerequestserious" | "And now...Serious" "Y ahora... Serio" |
| "smilerequestseriousimage" | "" |
| "smilerequestsmile" | "And now...Smile" "Y ahora... Sonría" |
| "smilerequestsmileimage" | "" |
| "smiletimeout" | "YES" |
| "smiletimeoutmessage" | "Your smile has not been detected. Please try again." "No se ha detectado su sonrisa. Por favor, pruebe otra vez." |
| "smiletimeoutseconds" | "10" |
| "tickcirclecolor" | red = "26", green = "94", blue = "176", alpha = "1" |
| "tickcolor" | red = "255", green = "255", blue = "255", alpha = "1" |
| "tickshow" | "YES" |
| "tutorialtitle" | "Photo Selfie" "Foto Selfie" |
| "tutorialtitlecolor" | red = "255", green = "255", blue = "255", alpha = "1" |
| "tutorialbackgroundcolor" | red = "18", green = "38", blue = "78", alpha = "1" |
| "tutorialcontinuebuttontext" | "Continue" "Continuar" |
| "tutorialcontinuebuttontextcolor" | red = "255", green = "255", blue = "255", alpha = "1" |
| "tutorialgif" | "" |
| "tutorialphotolivetext" | "When started: • Fit your face in the oval and wait. • When required smile or get serious." "Cuando comience:• Ponga su cara en el ovalo y espere.• Cuando se le requiera sonría o pongase serio." |
| "tutorialphotolivetitle" | "Selfie Alive" "Foto viva" |
| "tutorialtext" | "Photo Selfie" "Foto Selfie" |
| "tutorialtextcolor" | red = "255", green = "255", blue = "255", alpha = "1" |
| "userinfo" | "Check that your face is shown complete, with a natural expression and without any shine or shadow." "Compruebe que su cara se muestra completa, con una expresión natural y sin ningún tipo de brillo o sombra." |
| "validationviewbackgroundcolor" | red = "66", green = "66", blue = "66", alpha = "1" |
| "veridaslogoshow" | "YES" |