Configurations

This section describes the available NFC configurations.

The NFC feature is customizable and allows configuring the activity texts and colors.

The configurations can be defined as exemplified below:

// NFC configurations
val nfcTexts = NFC()
nfcTexts.nfcTitle = "Ready to Scan"
nfcTexts.nfcDescription = "Hold the passport close to the phone"

val ctaTexts = CTA()
ctaTexts.settings = "Settings"
ctaTexts.skip = "Skip"

val translations = Translations()
translations.nfc = nfcTexts
translations.cta = ctaTexts

val colors = Colors()
colors.primary = "#4880FF"
colors.secondary = "#F2F6FF"

val nfcCustomization = NFCustomization()
nfcCustomization.translations = translations
nfcCustomization.colors = colors

// Scanner configurations
val style = CaptureStyleOptions(
    textColor = R.color.black,
    textBackground = R.color.white,
    overlayColor = R.color.black,
    overlaySuccessColor = R.color.white,
)
val texts = CaptureTextOptions(title = "Insert a card", text = "inside the frame")
val photoOptions = ManualPhotoOptions(active = false)
val scannerCustomization = CaptureOptions(takePhoto = photoOptions, i18n = texts, style = style)

For more information about each possible configuration see the corresponding data model below:

Models

NFCustomization	Description
Translations translations	Defines the texts used for the NFC activity.
Colors colors	Defines the colors used in the activity.

---

Translations	Description
CTA cta	Defines the texts for the main action buttons.
NFC nfc	Defines the texts shown during the NFC scanning process.

---

CTA	Description
String proceed	Defines the proceed action button text.
String skip	Defines the skip action button text.
String settings	Defines the settings action button text.
String cancel	Defines the cancel action button text.
String allow	Defines the allow action button text.

---

NFC	Description
String instructionsTitle	Defines the NFC instructions title text.
String instructionsSlide1Description	Defines the NFC instructions first slide text.
String instructionsSlide2Description	Defines the NFC instructions second slide text.
String instructionsSlide3Description	Defines the NFC instructions third slide text.
String instructionsSlide4Description	Defines the NFC instructions fourth slide text.
String nfcTitle	Defines the NFC scan title text.
String nfcDescription	Defines the NFC scan description text.
String nfcHold	Defines the NFC scan hold still text.
String nfcCompleted	Defines the NFC scan completed text.
String errorTitle	Defines the error title text.
String errorDescription	Defines the error description text.
String success	Defines the success text.
String close	Defines the close action text.
String permissionTitle	Defines the permission title text.
String permissionDescription	Defines the permission description text.

---

Colors	Description
String primary	Defines the hex value for the primary color of the activity.
String secondary	Defines the hex value for the secondary color of the activity.
String error	Defines the hex value for the error color of the activity.
String base	Defines the hex value for the base color of the activity.

---

For detailed scanner configurations, please visit the following page:

Configurations