{
  "$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"
  ]
}