[MS-1383] Non-credential fields (name, dob, etc.) can now be returned in the MFID

[alexandr-simprints]

JIRA ticket
Will be released in: 2026.2.0

Notable changes

The majority of the changes is related to refactoring of ScannedCredential usage in favor of ExternalCredentialSearchResult. See the details below

1. Non-credential fields can now be scanned

This requires isCapturingAllFields flag to be set to true in MultiFactorIdConfiguration for the specific document type. We haven't agreed on the specific card fields yet, so currently there are only two options: capture everything or nothing. The credential capture is not affected by that flag.

• If enabled, the OCR reader will try to find the values for the labels printed on cards. See GhanaNhisCardOcrReaderUseCase and GhanaIdCardOcrReaderUseCase for examples.
• The return type is updated in LibSimprintsResponseMapper. If enabled, the response can look like this:

"scannedCredential" : {
  "NHISCard": "12345678",
  "documentFields": {
    "name": "Name",
    "dateOfBirth": "01/01/2000",
    "dateOfIssue": "12/06/2028"
  }
}

2. OCR result set expanded into a model.

The OCR scan results are now structured as an MfidDocument sealed class (GhanaNhisCard, GhanaIdCard, GhanaQrCode), with each carrying a credential + document-specific non-credential fields (name, date of birth, nationality, etc.).

3. ScannedCredential is renamed to ScannedCredentialResult

This helps to better represent ScannedCredentialResult as a part of the step result.

4. ExternalCredentialSearchResult replaces ScannedCredential across the flow.

This allows downstream steps to receive a complete data of the credential scan, search and its matches. ExternalCredentialSearchResult carries:

• ScannedCredentialResult, that contains the entire MfidDocument with all OCR-extracted fields
• confirmedCredential: what the user actually confirmed as correct after scanning
• matchResults: biometric matches against credentials linked to credential (if any)

This way the entire outcome of the MFID flow is accessible from a single object through the orchestrator steps cache.

Additional work checklist

• Effect on other features and security has been considered
• Design document marked as "In development" (if applicable)
• External (Gitbook) and internal (Confluence) Documentation is up to date (or ticket created)
• Test cases in Testiny are up to date (or ticket created)
• Other teams notified about the changes (if applicable)

[Copilot]

Pull request overview

Copilot reviewed 100 out of 100 changed files in this pull request and generated 7 comments.

[sonarqubecloud]

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
82.6% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud