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

Was this helpful?

  1. Facial Biometric Transactions Confirmation
  2. Web Integration
  3. Integration Steps

Obtain Authorization Code

Invoke authorization request in order to initiate face authentication flow with UAE PASS from the SP application.

The user shall be presented with UAE PASS confirmation screen on the UAE PASS app followed by face verification to confirm the request.

On success/failure the control will return back to the SP portal callback URL with appropriate status. In case of success the SP web portal will receive the “authorization code” to the callback URL of SP (which is pre-configured in UAE PASS). (Just change the "redirect_uri" and "client_id" appropriately as per your environment and other parameters as applicable).

Request

https://stg-id.uaepass.ae/idshub/authorize?response_type=code&client_id=client_id&scope=urn:uae:digitalid:profile:general&state=HnlHOJTkTb66Y5H&redirect_uri=[redirect url]&acr_values=urn:safelayer:tws:policies:authentication:level:low&username=[EID]

Request Parameters

Name
Type
Usage

response_type

Query

Required

Must take the value, code which indicates that an authorization code is requested.

redirect_uri

Query

Required

Redirect URI to the application. The application waits to receive at this URI the response with the authorization code.

client_id

Query

Required

Identifier of the client application. .(To be shared by UAE PASS team specific to face verification flow)

state

Query

Recommended

We recommend using this parameter to safeguard against CSRF attacks.

scope

Query

Required

List of values, separated by spaces, that represent the scope of the authorization that the application wants to obtain. It queries the scopes required for accessing the resources or services in question.(To be shared by UAE PASS team if its value other than as specified in sample above)

acr_values

Query

Optional

Defines conditions for authenticating the user (minimum levels or specific flows) who must authorize the access. (To be used as specified in sample or check with UAE PASS team for more details)

username

Query

Required

Emirates ID of the already logged in user

ui_locales

Query

Optional

Language parameter to be sent in order to render English or Arabic login pages of UAE PASS and below are the possible values: • English page : en • Arabic pages : ar

Response

Once the face verification request is complete, and the user has granted authorization, the application receives an HTTP GET response. The application receives this response at the redirect URL specified in the authorization request (the redirect_uri parameter).

GET {redirection_uri_path}?code={code}&state={state} HTTP/1.1 Host: {redirection_uri_host}
https://stg-ids.uaepass.ae/authenticationendpoint/oauth2_error.do?oauthErrorCode=invalid_callback&oauthErrorMsg=callback.not.match&crId=71460d07-55f9-49ac-8489-04541cbe2a09

Application will receive the error invalid call back (callback not match) when the call back URL used in the authorization request does not match with the call back URL configured in the UAE PASS (Authorization server) servers.

Response Parameters

Name
Description

code

Authorization code. Denotes the authorization that the user granted to the application. The application must use this code to obtain the access token in access token API.

state

The same value that the application includes in the authorization request will be returned from the authorization server (UAE PASS Server). Application should validate the received value when processing the response.

PreviousIntegration StepsNextObtain Access Token

Last updated 1 month ago

Was this helpful?