Configuration¶
The SDK can be configured by providing a Map to the SDK. This map may contain or not the following keys/values, sorted alphabetically:
- activate : The text to show of the alert indicating the user that NFC is needed and its going to be redirected to activate it.
- activatetitle : The title of the alert that indicates the user that NFC is needed and its going to be redirected to activate it.
- askpinspass : The text that indicates the user to introduce the data of the passport.
- askpinstitlepass : The title of the alert that asks for the pins of the chip of the passport.
- canalertdetail : The text of the alert that asks for the CAN.
- canalerttitle : The title of the alert that asks for the CAN.
- canerror : The error shown in the CAN field, indicating that it is a necessary field.
- cardiderror : The error shown when the card id introduced does not fulfill the format needed.
- cardidpinpass : The label of the textfield to introduce the ID of the passport.
- closebutton : Whether the SDK may have a close button or not. ("YES"/"NO")
- datedaypin : The label of the textfield to introduce the day of the dates.
- dateerror : The error shown in the dates, indicating that it is a necessary field.
- datemonthpin : The label of the textfield to introduce the month of the dates.
- dateofbirthpin : The label of the textfield to introduce the date of birth.
- dateofexppin : The label of the textfield to introduce the date of expiry of the document.
- dateyearpin : The label of the textfield to introduce the year of the dates.
- error : The text to show when the device is pulled apart from the chip while reading.
- errortitle : The title of the error shown when the device is pulled apart from the chip while reading.
- finalerror : The text of the error shown after a few retries to read. (The SDK will stop trying to read)
- finalerrornotreadalldata : The text of the error shown when it has not been possible to read all the requested keys.
- finalerrornotreadalldatatitle : The title of the error shown when it has not been possible to read all the requested keys.
- finalerrortitle : The title of the error shown after a few retries to read. (The SDK will stop trying to read)
- gif : Whether the SDK must show the gif to help the user or not. ("YES"/"NO")
- image : Whether the SDK must show the NFC icon or not. ("YES"/"NO")
- positivebuttontitle : The text of the all positive buttons.
- readingtext : The text to show while the SDK is reading the data from the chip.
- readingtext1 : The text to show in the first step while reading the NFC chip.
- readingtext2 : The text to show in the second step while reading the NFC chip.
- readingtext3 : The text to show in the third step while reading the NFC chip.
- tagwaitingindication : The text to show when SDK is ready to read but does not have a NFC chip near.
- tagwaitingindicationpass : The text to show when SDK is ready to read but does not have a NFC chip near when passport is going to be read.
- tutorialgifpathid : The path of the passport tutorial gif.
- tutorialgifpathpassport : The path of the DNI 3.0 tutorial gif.
- waitingkeystext : The text to show while the SDK waits for the NFC keys to unlock the data inside the chip.
The default values for these keys are:
| KEY | Default Value (en/es) |
|---|---|
| "activate" | "NFC activation is necessary in order to validate your document with the NFC chip. The settings of your device will be opened. Once you have activated the NFC, press Back to come back to the app." "Se necesita activar NFC para validar su documento con el chip NFC. Se va a abrir la configuración del dispositivo.Una vez activado el NFC pulse en volver para regresar a la app." |
| "activatetitle" | "Activate NFC" "Activar NFC" |
| "askpinspass" | "Complete the following data." "Complete los siguientes datos." |
| "askpinstitlepass" | "" |
| "canalertdetail" | "It is in the lower right corner of the front of your document." "Aparece en la esquina inferior derecha del frontal de su documento." |
| "canalerttitle" | "Enter your identification\'s CAN number" "Introduzca el CAN de su documento de identidad" |
| "canerror" | "The CAN number must have 6 digits" "El número CAN debe tener 6 dígitos" |
| "cardiderror" | "The document number shall have between 4 and 9 alphanumeric characters" "El número de documento debe tener entre 4 y 9 carácteres alfanuméricos" |
| "cardidpinpass" | "Passport number" "Número de pasaporte" |
| "closebutton" | "NO" |
| "datedaypin" | "Day" "Día" |
| "dateerror" | "Necessary field" "Campo necesario" |
| "datemonthpin" | "Month" "Mes" |
| "dateofbirthpin" | "Date of birth" "Fecha de nacimiento" |
| "dateofexppin" | "Expiration date" "Fecha de caducidad" |
| "dateyearpin" | "Year" "Año" |
| "error" | "Reposition the device" "Recoloque el móvil" |
| "errortitle" | "NFC error" "Fallo NFC" |
| "finalerror" | "It was impossible to connect with the NFC" "No se ha podido conectar con el NFC" |
| "finalerrornotreadalldata" | "We could not extract all the data from the NFC chip" "No se ha podido obtener todos los datos del chip NFC" |
| "finalerrornotreadalldatatitle" | "NFC error" "Fallo NFC" |
| "finalerrortitle" | "NFC error" "Fallo NFC" |
| "gif" | "YES" |
| "image" | "YES" |
| "positivebuttontitle" | "Continue" "Continuar" |
| "readingtext" | "The NFC is being read.\nDo not move the document or the device.\nThis process can take a few seconds" "Leyendo NFC.\nNo despegue el documento del dispositivo.\nEste proceso puede tardar unos segundos." |
| "readingtext1" | "Accessing the chip..." "Accediendo al chip..." |
| "readingtext2" | "Reading personal data..." "Leyendo datos personales..." |
| "readingtext3" | "Reading images..." "Leyendo imágenes..." |
| "tagwaitingindication" | "Slowly slide your device over the DNI until the NFC chip is detected." "Deslice lentamente su dispositivo por encima del DNI hasta que se detecte el chip NFC." |
| "tagwaitingindicationpass" | "Slowly slide your device over the backside of the PASSPORT until the NFC chip is detected." "Deslice lentamente su dispositivo por la parte de atrás del PASAPORTE hasta que se detecte el chip NFC." |
| "tutorialgifpathid" | "" |
| "tutorialgifpathpassport" | "" |
| "waitingkeystext" | "We are configuring the secure gateway to read your document" "Configurando pasarela segura para leer su documento" |