UAE PASS

UAE PASS API

UAE PASS API as documented publicly: 7 operations. Contract generated from the documentation by API Evangelist (2026-10-26); not the provider's own document.

Documentation GitHub OpenAPI

Operations 7

POST / POST / #

POST /api/v1/consent/transaction/callback Callback API - Send Consent Response #

POST /api/v1/consent/transaction/send Send Consent Request #

POST /idshub/introspect POST /idshub/introspect #

POST /idshub/token POST /idshub/token #

GET /idshub/userinfo GET /idshub/userinfo #

GET /oauth2/token GET /oauth2/token #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/uae-pass:uae-pass-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.1.0
info:
  title: UAE PASS API
  version: '2026-10-26'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-26: 7 operation(s) read from 8 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; UAE PASS has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 5
    documentation: 2
    pages-with-code: 8
    pages-read: 8
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-26'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.uaepass.ae/web-registration/endpoints/2.-access-token.md
  - https://docs.uaepass.ae/web-registration/endpoints/3.-user-information.md
  - https://docs.uaepass.ae/feature-guides/data-processing-consent/endpoints/api-security.md
  - https://docs.uaepass.ae/feature-guides/data-processing-consent/endpoints/send-consent-request.md
  - https://docs.uaepass.ae/feature-guides/data-processing-consent/endpoints/callback-api-send-consent-response.md
  - https://docs.uaepass.ae/feature-guides/authentication/token-validation-api/integration-steps/1.-obtaining-resource-server-or-sp-access-token.md
  - https://docs.uaepass.ae/feature-guides/authentication/token-validation-api/integration-steps/2.-verifying-access-token-api.md
  - https://docs.uaepass.ae/quick-start-guide-uae-pass-staging-environment/conduct-a-poc-with-uae-pass-authentication.md
servers:
- url: https://stg-id.uaepass.ae
paths:
  /:
    post:
      operationId: post
      tags:
      - Api
      summary: POST /
      x-source: https://docs.uaepass.ae/feature-guides/data-processing-consent/endpoints/send-consent-request.md
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl --location --request POST '/v1/consent/transaction/send'  --header 'X-Timestamp: 1700000000'  --header 'X-UAEPASS-Signature:\
          \ {{X-UAEPASS-Signature}}'  --header 'X-UP-AccessToken: {{datasharing_ccg_access_token}}'  --header 'Authorization: JWS {{datasharing_ccg_jwt_token}}'\
          \  --header 'User-Agent: Apidog/1.0.0 (https://apidog.com)'  --header 'Content-Type: application/json'  --data-raw '{\n    \""
  /api/v1/consent/transaction/callback:
    post:
      operationId: post_api_v1_consent_transaction_callback
      tags:
      - Api
      summary: Callback API - Send Consent Response
      x-source: https://docs.uaepass.ae/feature-guides/data-processing-consent/endpoints/callback-api-send-consent-response.md
      parameters:
      - name: X-API-Key
        in: header
        required: true
        schema:
          type: string
        description: refer to API Authentication – UAEPASS to SP
      - name: X-Timestamp
        in: header
        required: true
        schema:
          type: string
        description: time this request was generated, used in HMAC token generation
      - name: X-UAEPASS-Signature
        in: header
        required: true
        schema:
          type: string
        description: HMAC token for non‑repudiation
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1ConsentTransactionCallbackRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/consent/transaction/send:
    post:
      operationId: post_api_v1_consent_transaction_send
      tags:
      - Api
      summary: Send Consent Request
      x-source: https://docs.uaepass.ae/feature-guides/data-processing-consent/endpoints/send-consent-request.md
      parameters:
      - name: X-Timestamp
        in: header
        required: true
        schema:
          type: string
        description: time this request was generated, used in HMAC token generation
      - name: X-UAEPASS-Signature
        in: header
        required: true
        schema:
          type: string
        description: Refer section API nonrepudiation – HMAC
      - name: X-UP-AccessToken
        in: header
        required: true
        schema:
          type: string
        description: Refer section Generating client credential tokens
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Refer section Generating client credential tokens
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1ConsentTransactionSendRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1ConsentTransactionSendResponse'
      x-evidence:
        kind: documentation
  /idshub/introspect:
    post:
      operationId: post_idshub_introspect
      tags:
      - Idshub
      summary: POST /idshub/introspect
      x-source: https://docs.uaepass.ae/feature-guides/authentication/token-validation-api/integration-steps/1.-obtaining-resource-server-or-sp-access-token.md
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostIdshubIntrospectResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl --location --request POST ''https://stg-id.uaepass.ae/idshub/introspect''  --header ''Content-Type: application/x-www-form-urlencoded;
          charset=UTF-8''  --header ''Authorization: Basic <<Basic auth credentials>>''  --header ''Cookie: NSC_EJE_TUBH_USVTUY_MC_8082=ffffffffaf1a571d45525d5f4f58455e445a4a4229a2''  --data-urlencode
          ''token=<<Token to introspect>>

          ```'
  /idshub/token:
    post:
      operationId: post_idshub_token
      tags:
      - Idshub
      summary: POST /idshub/token
      x-source: https://docs.uaepass.ae/web-registration/endpoints/2.-access-token.md
      parameters:
      - name: code
        in: query
        required: false
        schema:
          type: string
      - name: grant_type
        in: query
        required: false
        schema:
          type: string
      - name: redirect_uri
        in: query
        required: false
        schema:
          type: string
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostIdshubTokenResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl --location --request POST ''https://stg-id.uaepass.ae/idshub/token?grant_type=authorization_code&redirect_uri=https://stg-selfcare.uaepass.ae&code=bfe96299-83f4-3ee9-80e4-56c24f5265d3''  --header
          ''Content-Type: multipart/form-data''  --header ''Authorization: Basic c2FuZGJveF9zdGFnZTpzYW5kYm94X3N0YWdl''

          ```'
  /idshub/userinfo:
    get:
      operationId: get_idshub_userinfo
      tags:
      - Idshub
      summary: GET /idshub/userinfo
      x-source: https://docs.uaepass.ae/web-registration/endpoints/3.-user-information.md
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetIdshubUserinfoResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl --location --request GET ''https://stg-id.uaepass.ae/idshub/userinfo''` `--header ''Authorization: Bearer {Access Token}''`'
  /oauth2/token:
    get:
      operationId: get_oauth2_token
      tags:
      - Oauth2
      summary: GET /oauth2/token
      x-source: https://docs.uaepass.ae/feature-guides/data-processing-consent/endpoints/api-security.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl | <p>curl --location ''<https://stg-ids.uaepass.ae/oauth2/token>'' \ </p><p>--header ''Authorization: Basic \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*''
          \ </p><p>--header ''Content-Type: application/x-www-form-urlencoded'' \ </p><p>--data-urlencode ''scope=urn:uae:digitalid:backend\_api:manage\_user\_consent
          openid '' \ </p><p>--data-urlencode ''grant\_type=client\_credentials'' </p> |

          | Method      | '
components:
  schemas:
    PostApiV1ConsentTransactionCallbackRequest:
      type: object
      properties:
        spTransactionID:
          type: string
          description: Transaction id
        status:
          type: string
          description: 'Expected Values: [ACCEPTED – REJECTED]'
        uaePassTransactionID:
          type: string
      required:
      - spTransactionID
      - status
    PostApiV1ConsentTransactionSendRequest:
      type: object
      properties:
        identifier:
          type: string
          description: Emirates id or passport number based on document id type
        idDocType:
          type: string
          description: 'Expected Values: [EMIRATES_ID, PASSPORT, GCC_NATIONAL_ID_CARDS]'
        requestedById:
          type: string
          description: Client id for the requesting SP in the UAE Pass backend. Mandatory in case of SP-to-SP data sharing flow. Not applicable
            in case of Peer-to-Peer flow
        spId:
          type: string
          description: Configured Service Provider’s (Data Owner) client id in the UAE Pass backend
        spTransactionID:
          type: string
          description: Transaction id generated by the service provider
        purpose:
          type: string
          description: Requestor’s Reason for requesting authorization from UAE Pass User in english.
        purposeAr:
          type: string
          description: Requestor’s Reason for requesting authorization from UAEPass User in arabic.
        requestType:
          type: string
          description: Expected Values [peerToPeer, spToSp]. spToSp is a default value.
        requestor:
          type: object
          description: These Fields are mandatory for request type [peerToPeer].
        requestor.name:
          type: string
        requestor.nameAr:
          type: string
        requestor.identifier:
          type: string
        requestor.idType:
          type: string
          description: 'Expected Values: [EMIRATES_ID, PASSPORT, GCC_NATIONAL_ID_CARDS]'
        requestor.additionalInfo:
          type: object
        content:
          type: object
          description: Content of the request
        content.documents:
          type: array
          description: List of documents
        content.documents.name:
          type: string
          description: document Name
        content.documents.nameAr:
          type: string
          description: document Name in arabic
        content.documents.type:
          type: string
          description: Document type
        content.documents.typeAr:
          type: string
          description: Document type in arabic
        content.documents.metadata:
          type: array
          description: List of meta data
        content.documents.metadata.displayName:
          type: string
          description: Name of each point meta data
        content.documents.metadata.displayNameAr:
          type: string
          description: Name in arabic of each point meta data
      required:
      - identifier
      - idDocType
      - spId
      - spTransactionID
      - content
      - content.documents
      - content.documents.name
      - content.documents.nameAr
      - content.documents.type
      - content.documents.typeAr
      - content.documents.metadata
      - content.documents.metadata.displayName
      - content.documents.metadata.displayNameAr
    PostApiV1ConsentTransactionSendResponse:
      type: object
      properties:
        uaePassTransactionID:
          type: string
          description: Generated uaepass id
        transactionStatus:
          type: string
          description: Status will be for initial status as TRIGGERED
        spTransactionID:
          type: string
          description: Request transaction
    PostIdshubIntrospectResponse:
      type: object
      properties:
        sub:
          type: string
        nbf:
          type: integer
        scope:
          type: string
        iss:
          type: string
        client_claims:
          type: object
          properties:
            sub:
              type: string
            acr:
              type: string
            domain:
              type: string
            amr:
              type: string
            distinguished_name:
              type: string
            name:
              type: string
        active:
          type: boolean
        token_type:
          type: string
        exp:
          type: integer
        iat:
          type: integer
        client_id:
          type: string
        username:
          type: string
    PostIdshubTokenResponse:
      type: object
      properties:
        access_token:
          type: string
        refresh_token:
          type: string
        token_type:
          type: string
        expires_in:
          type: integer
    GetIdshubUserinfoResponse:
      type: object
      properties:
        sub:
          type: string
        gender:
          type: string
        firstnameEN:
          type: string
        mobile:
          type: string
        lastnameEN:
          type: string
        fullnameEN:
          type: string
        userType:
          type: string
        uuid:
          type: string
        email:
          type: string
  securitySchemes:
    basic:
      type: http
      scheme: basic
security:
- basic: []
tags:
- name: Api
- name: Idshub
- name: Oauth2