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).

username parameter can have the value EID, MOBILE or EMAIL.

For Residents you can use EID, MOBILE or EMAIL while for verified visitors you can use MOBILE or EMAIL as username parameter value.

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, Mobile or Email 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).

200

GET {redirection_uri_path}?code={code}&state={state} HTTP/1.1 Host: {redirection_uri_host}

Error scenario

Application will observe the error invalid call back (callback does 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.