Guideline No. | AC001 |
Purpose | To clarify the definition of an “AA Client” |
Description | ReBIT guidelines define an “AA Client” as possessing the following characteristics:
The term “library” is interchangeable with the term “SDK”. Further, as mentioned in the first characteristic, the “library” (or “SDK”) includes the customer-facing interface (such as a “Screen”). A “set of APIs” or a “headless library” (i.e. without screens) does not qualify to be called an AA Client. These are internal engineering assets of an AA, which may be provided to their partner FIUs on the basis of bilateral agreements, for the purpose of co-development of an AA client. |
Stage | Finalised |
Guideline No. | AC002 |
Purpose | To clarify ownership vs co-development aspects between an FIU and an AA, of an AA Client |
Description | An AA Client is necessarily owned by an AA.However, the interfaces (e.g. screens) that are part of the AA Client design may be customised or co-designed by FIUs, in partnership with AAs, to suit their user interface and user experience requirements.The co-development scope may include any or all of the following:
As long as the interaction is bound by common guidelines derived from Master Directions and/or technical specifications, FIUs and AAs are free to redesign AA Client interfaces as per their requirements. Such common guidelines are codified in a community-driven “Customer Experience Guidelines Checklist”. Further, any redesigned interface screens are also “owned” by the AA, with respect to all aspects of development and devops. As part of a joint design and development effort with respect to the interface screens, AAs may provide access to internal APIs as they deem fit, while retaining complete control over all aspects of development, testing and distribution. FIUs and AAs are, however, free to enter into any bilateral legal agreements to restrict usage of such co-designed interfaces to named parties mutually agreed to. |
Stage | Finalised |
Guideline No. | AC005 |
Purpose | To clarify if an embedded Web Library is an acceptable form of an AA client |
Description | Embedded Web libraries (e.g. those built using Javascript) pose a serious data privacy risk.Applications that embed such web libraries, in their web applications, are likely to gain control over data that flows to-and-fro between the library and the backend service.Such risks can be mitigated technically for mobile libraries (e.g. built using Android, iOS) embedded within host mobile applications. They cannot be mitigated for web libraries.It is therefore recommended that no AA offers an embedded web library to FIUs as an AA client. |
Stage | Finalised |
Guideline No. | AC006 |
Purpose | To clarify what “ownership” of an AA Client implies |
Description | An AA Client is necessarily “owned” by an AA.This implies the following:For AA clients of type = web application:
For AA clients of type = mobile application OR mobile library:
The accountability of all aspects pertaining to the AA client rests solely with the AA. |
Stage | Finalised |
Guideline No. | AC007 |
Purpose | To clarify what metadata, if any, can be communicated between an AA client and the FIU app |
Description | The technical guidelines for Redirection and Mobile library invocation/ app-to-app integration provide clarity around what parameters can be passed back-and-forth between the FIU app and the AA client.In addition to parameters that help an AA authenticate the app user (e.g. mobile number) and the FIU determine user experience post-AA-interaction (e.g. whether the user approved a consent request or not), it may be useful for an FIU to determine the termination stage in a user’s AA journey.This is useful for the FIU to provide appropriate support for repeat tries / grievance redressal to the citizen.
In addition to such information pertinent to an individual citizen’s AA journey, it would also be useful for the FIU to get anonymized, aggregated metadata about its customers’ AA journey. Such metadata may include all information necessary for the FIU and the AA to jointly construct a “drop-off funnel” and use the same to improve user experience. The parameters that constitute such “metadata” are as defined here: https://sahamati.gitbook.io/aa-redirection-guidelines/v/1.2.1/specification/response-specification |
Stage | Finalised |
Guideline No. | AC008 |
Purpose | To clarify branding guidelines for co-designed AA Client screens |
Description | All AA Client screens that are co-designed with FIUs ought to include a “Powered by <AA Name>” in a clearly visible area of the screen. The AA Logo may be optionally added, next to the AA Name.The FIU name and logo may also be optionally added to such co-designed screens, to ensure there is contextual continuity to users while switching between the FIU and the AA interfaces. |
Stage | Finalised |
Guideline No. | AC009 |
Purpose | To clarify if the FIU name and logo can be displayed on AA Client screens in a redirection type of integration |
Description | AA Client screens may, optionally, show the FIU name and/or logo, from-and-to which the citizen will be redirected.This is to enable contextual continuity to users while switching between the FIU and AA interfaces. |
Stage | Finalised |