Skip to content

General Considerations

The NFC SDK follows the same structure as the rest of the Veridas iOS SDKs (Document, Selfie and Video). If you already integrate any of them, the integration of the NFC SDK will be familiar: a static facade (NfcRead), a delegate for the results and lifecycle callbacks (NfcReadDelegate), an optional delegate for the events (NfcReadEventsDelegate), and a Codable configuration. Below are the key considerations for developers and integration teams.

Modular JSON Configuration Structure

The configuration structure is modularized into four distinct sections, each managed either through a separate file or as a root-level key within the JSON structure.

  • Medias (medias)
    • All references to images and media resources (for example, logos or illustrations) can be placed in a separate file, or under the root-level medias key in the JSON.
    • Each value can be an asset catalog image name ("tutorial_screen"), a file of the app bundle with its extension ("tutorial_screen.gif"), or an https URL. See Where each image is loaded from.
  • Setup (setup)
    • All SDK configuration (for example, the maximum number of reading attempts) can be placed in a separate file, or under the root-level setup key in JSON.
    • This includes all configurable parts of the SDK, and the document data used to open the chip (prefill), which is usually set at runtime.
  • Styles (styles)
    • All UI customization parameters (for example, color palette, typography, component styles) can be declared in a separate file, or under the root-level styles key in the JSON.
    • The styles are shared with the rest of the Veridas iOS SDKs, so the same definition can be reused across all of them.
  • Texts (texts)
    • All text-related content can be placed in a separate file, or under the root-level texts key in the JSON.
    • This includes interface messages, titles, instructions and the messages of the system NFC sheet.

Migration Summary and Best Practices

To ensure a successful integration, organize your JSON configurations following the modular model. This structure offers greater flexibility and scalability, making it especially effective for clients who need dynamic, localized, or branded experiences.

When the NFC reading follows a document capture, pass the MRZ data obtained from the document as prefill, so the user does not have to type it.