v4.14.0

NEW

IDV support for Digital ID

When creating an IDV session, one can specify that Digital ID are accepted as ID Documents, and can also specify which providers are allowed.
Using either the DocumentRestrictionsFilterBuilder or OrthogonalRestrictionsFilterBuilder, configure the required document like:

const documentRestrictionsFilter = new DocumentRestrictionsFilterBuilder()
  .withDocumentRestriction((new DocumentRestrictionBuilder())
    .withDocumentTypes(['DIGITAL_AADHAAR'])
    .build())
  .forWhitelist()
  .withAllowDigitalIds(true)
  .withAllowedProviders([
    new AllowedProviderBuilder().withName('DIGILOCKER').build(),
  ])
  .build();

const orthogonalRestrictionsFilter = new OrthogonalRestrictionsFilterBuilder()
  .withAllowDigitalIds(true)
  .withAllowedProviders([
    new AllowedProviderBuilder().withName('DIGILOCKER').build(),
  ])
  .build();

const requiredDocument = new RequiredIdDocumentBuilder()
  .withFilter(documentRestrictionsFilter)
  // or .withFilter(orthogonalRestrictionsFilter)
  .build()

// On the session specification builder, add the document
const sessionSpec = new SessionSpecificationBuilder()
  .withRequiredDocument(requiredDocument)
  // .with... other requirements/options for the session
  .build()

When retrieving a session, for any ID Document based on a Digital ID, the provider is available via the idDocumentResource.getProvider() method.
Additionally, if a session uses any Digital ID shares, the list of the share is available via the session.getDigitalIdShares() method.

REMOVED

The old aml API is now removed as no longer available from Yoti.