UAE PASS · Schema

PostApiV1ConsentTransactionSendRequest

CompanyIdentityAuthenticationUAEDigital

Properties

Name	Type	Description
identifier	string	Emirates id or passport number based on document id type
idDocType	string	Expected Values: [EMIRATES_ID, PASSPORT, GCC_NATIONAL_ID_CARDS]
requestedById	string	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	string	Configured Service Provider’s (Data Owner) client id in the UAE Pass backend
spTransactionID	string	Transaction id generated by the service provider
purpose	string	Requestor’s Reason for requesting authorization from UAE Pass User in english.
purposeAr	string	Requestor’s Reason for requesting authorization from UAEPass User in arabic.
requestType	string	Expected Values [peerToPeer, spToSp]. spToSp is a default value.
requestor	object	These Fields are mandatory for request type [peerToPeer].
requestor.name	string
requestor.nameAr	string
requestor.identifier	string
requestor.idType	string	Expected Values: [EMIRATES_ID, PASSPORT, GCC_NATIONAL_ID_CARDS]
requestor.additionalInfo	object
content	object	Content of the request
content.documents	array	List of documents
content.documents.name	string	document Name
content.documents.nameAr	string	document Name in arabic
content.documents.type	string	Document type
content.documents.typeAr	string	Document type in arabic
content.documents.metadata	array	List of meta data
content.documents.metadata.displayName	string	Name of each point meta data
content.documents.metadata.displayNameAr	string	Name in arabic of each point meta data

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/uae-pass/main/json-schema/uae-pass-post-api-v1-consent-transaction-send-request-schema.json",
  "title": "PostApiV1ConsentTransactionSendRequest",
  "x-generated": "2026-10-26",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_ae-authored/uae-pass-openapi-generated.yml#/components/schemas/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"
  ]
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
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 JSON Schema

curl "https://apis.io/api/v1/json-schemas/uae-pass-post-api-v1-consent-transaction-send-request"

All schemas

curl "https://apis.io/api/v1/json-schemas?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.