UAE PASS
  • UAE PASS
  • Overview
  • Getting Onboarded with UAE PASS
    • Onboarding Process for UAE PASS Service Providers
      • Initiation Phase
      • Development Phase
      • Assessment Phase
      • Go live Phase
  • Quick Start Guide - UAE PASS Staging Environment
    • User Account Types
    • Create Staging UAE PASS Account
    • Upgrade Staging UAE PASS Account
    • Testing Credentials for POC
    • Conduct a POC with UAE PASS Authentication
  • Feature Guides
    • Authentication
      • Web Integration
        • Introduction
        • Pre-Requisites
        • Endpoints
        • 1. Authorization Code
        • 2. Access Token
        • 3. User Information
        • 4. Logout
        • Login Button
        • Authentication Postman Walkthrough
      • Mobile Integration
        • Introduction
        • Pre-Requisites
        • Requirements
        • Guide
          • SDK
          • API
        • SDK Integration
      • Token Validation API
        • Introduction
        • Pre-Requistes
        • Endpoints
        • Integration Steps
          • 1. Verify access token API using Basic Authentication
          • 2. Obtaining Authenticated User Information from the Access Token
        • Validation Decisions
      • User Linking
        • Automatic Linking
        • Manual Linking
        • Corporate Account
    • Digital Signature
      • Digital Signature (Single Document)
        • Signing Guide
          • Endpoints
          • Document Signing Steps
            • 1. Token
            • 2. Create Signer Process
            • 3. Sign Document
            • 4. Obtaining Document
            • 5. LTV Configuration
              • Integration Web Services
              • Postman Collection for LTV
            • 6. Deleting Document
          • Document Signature verification Process
          • Postman Collection for Digital Signature
            • Digital Signature Postman Walkthrough
        • Verification API Integration
          • Web Service Details
          • Postman Collection for Signature Verification API
      • Digital Signature (Multiple Document)
        • Signing Guide
          • Endpoints
          • Document Signing Steps
            • 1. Token
            • 2.Create Documents
            • 3. Create Signer Process
            • 4. Sign Document
            • 5. Obtaining Document
            • 6. LTV Configuration
              • Integration Web Services
              • Postman Collection for LTV
            • 7. Deleting Document
          • Document Signature verification Process
          • Postman Collection for Multiple Document Signing.
    • e-Seal
      • Introduction
      • DESC Process for Dubai Entities
        • Process overview
        • Detailed DESC process description
      • ICA Process for Non-Dubai Entities
        • Onboarding Process
        • Obtaining Credentials and Certificates
      • Integration Web Service
        • PAdES eSeal Signing
        • CAdES eSeal Signing
        • eSeal verification
        • eSeal error codes
      • Postman Collection
    • Hash Signing
      • Introduction
      • Hash Signing (Single Document)
        • Hash Signing (Java SDK Set Up)
          • Quick Setup
          • Hash Signing Process
            • 1. Start the Process
            • 2. Initiate Signing Process
            • 3. Sign PDF Document
          • Endpoints
          • Postman Collection
          • Utility Files
      • Bulk Hash Signing (Multiple Documents)
        • Quick Setup
        • Hash Signing Process
          • 1. Start Signing Process
          • 2. Initiate Signing Process
          • 3. Sign PDF Document
        • Endpoints
        • Postman Collection
  • Web Registration
    • Introduction
    • Steps to create account
    • Endpoints
      • 1. Access Code
      • 2. Access Token
      • 3. User Information
  • Facial Biometric Transactions Confirmation
    • Web Integration
      • Endpoints
      • Integration Steps
        • Obtain Authorization Code
        • Obtain Access Token
        • Obtain User Info
        • Log out User
    • Mobile Integration
      • Mobile Integration Guidelines
  • Guidelines
    • Use-Case Guidelines
      • Standard Authentication Scenarios for Service Provider Use Cases
      • Standard Digital Signature Scenarios for Service Provider Use Cases
      • Standard Implementation Guidelines
    • Design Guidelines
      • UAEPASS Button Guideline
      • Text Message Guidelines
  • Resources
    • Attributes List
    • Sample Apps
    • Staging Apps
    • Assets
  • FAQ
    • Common Integration Issues
  • Versioning
Powered by GitBook
On this page
  • App installed scenario:
  • App not installed scenario:

Was this helpful?

  1. Feature Guides
  2. Authentication
  3. Mobile Integration
  4. Guide

API

PreviousSDKNextSDK Integration

Last updated 1 year ago

Was this helpful?

Android: check whether UAEPASS app is installed or not by using UAEPASS package id: ae.uaepass.mainapp.stg

iOS: check whether UAEPASS app is installed or not by using UAEPASS scheme: Production: uaepass:// , Staging: uaepassstg://

App installed scenario:

  1. If the app is installed in the mobile, then invoke the Login url with acr values: acr_values=urn:digitalid:authentication:flow:mobileondevice

  2. Invoke the login url in embedded webview

// httpsdfa:Fasdfadsf

4. Monitor the webview for UAEPASS deep linking url as below:

uaepassstg://...? successURL=<url1> & failureURL=<url2> & ...

5. Save the success url and failure url in separate variables.

6. Re-write the deeplinking url by changing the success url and failure url with SP app scheme and host.

uaepassstg://...?successURL=yourapp:///resume_authn?url=<url1>&failureURL=yourapp:///resume_authn?url=<url2> & ...

7. Invoke the above url in the same webView to open the UAEPASS app for authentication. Once the user confirms the authentication, SP will receive the callback from UAEPASS as successURL. if user cancels the authentication, SP will receive failureURL.

8. Once SP receives callback, SP should invoke the successURL which is stored previously within the same webView.

9. SP will then receive the access code.

10. Access token call (copy and paste the same from web integration).

11. Get user info: (copy and paste the same from web integration).

App not installed scenario:

1. if UAE Pass app is not found in the mobile, SP should use the Login url with acr:

values :acr_values=urn:safelayer:tws:policies:authentication:level:low

2. Invoke the login url in embedded webview

3. User has to provide his UAE PASS identifier (email, mobile and emirates ID) and click on login.

4. User will receive push notification on other device which has UAE PASS app installed.

5. Once the user confirms the authentication, SP will receive the access code in webview.

6. Access token call (copy and paste the same from web integration).

7. Get user info (copy and paste the same from web integration).

For visitor integration: SP need to use the below scopes to their first authentication call to retrieve the unifiedID and profileType attribute of the user: 

 scope=urn:uae:digitalid:profile:general urn:uae:digitalid:profile:general:profileType urn:uae:digitalid:profile:general:unifiedId

https://stg-id.uaepass.ae/idshub/authorize?response_type=code&client_id=sandbox_web_stage&scope=urn:uae:digitalid:profile:general&state=HnlHOJTkTb66Y5H&redirect_uri=https://stg-selfcare.uaepass.ae&acr_values=urn:safelayer:tws:policies:authentication:level:low
LogoUAE PASS
LogoUAE PASS