mobile-android-cri-orchestrator

About

The Credential Issuer (CRI) Orchestrator coordinates identity proofing capability for the GOV.UK One Login app. It builds on the ID Check SDK used in the GOV.UK ID Check app with additional functionality including REST API based web-to-app handoff and document selection.

Currently the only CRI supported within the SDK is the Document Checking CRI (DCMAW), but this component could be extended in the future to allow for additional app-based CRI‍s. In particular, adding support for the Address-Check and Fraud CRI‍s into the app would enable a complete end-to-end identity proofing journey within the GOV.UK One Login app.

See the Mobile App Integration ADR for more details.

Getting Started

Clone the repository, including the Android pipelines submodule:

git clone --recurse-submodules [email protected]:govuk-one-login/mobile-android-cri-orchestrator.git

Learn more about working with Git submodules.

Usage

You can trigger the identity proofing journey in two ways. If there is no active session, both of these components are hidden.

See the Orchestration of ID Check SDK in One Login app tech design for more details.

Start an ID Check immediately

This displays the full-screen "You can now continue your identity check" page, providing the user has a current active session.

// Code snippet TBC

Allow users to start an ID Check

This displays a card-view component designed to appear on an app home-screen, providing the user has a current active session.

// Code snippet TBC