X-Timestamp: \[time this request was generated, used in HMAC token generation]
X-UAEPASS-Signature: Refer section API nonrepudiation – HMAC in SECURITY.
X-UP-AccessToken: Refer section Generating client credential tokens in Security
Authorization: Refer section Generating client credential tokens in Security.
| #### Request Parameters | Name | Type | Mandatory/Optional | Description | | ------------------------------------------------------------- | ------ | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Identifier | String | M | Emirates id or passport number based on document id type | | idDocType | String | M | Expected Values: \[EMIRATES\_ID, PASSPORT, GCC\_NATIONAL\_ID\_CARDS] | | requestedById | String | O |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 | M | Configured Service Provider’s (Data Owner) client id in the UAE Pass backend | | spTransactionID | String | M | Transaction id generated by the service provider | | purpose | String | O | Requestor’s Reason for requesting authorization from UAE Pass User in english. | | purposeAr | String | O | Requestor’s Reason for requesting authorization from UAEPass User in arabic. | | requestType | String | O |Expected Values \[peerToPeer, spToSp].
spToSp is a default value.
| | Requestor | Object | O |These Fields are mandatory for request type \[peerToPeer].
idType : Expected Values: \[EMIRATES\_ID, PASSPORT, GCC\_NATIONAL\_ID\_CARDS]
| | requestor.name | String | O |These Fields are mandatory for request type \[peerToPeer].
idType : Expected Values: \[EMIRATES\_ID, PASSPORT, GCC\_NATIONAL\_ID\_CARDS]
| | requestor.nameAr | String | O |These Fields are mandatory for request type \[peerToPeer].
idType : Expected Values: \[EMIRATES\_ID, PASSPORT, GCC\_NATIONAL\_ID\_CARDS]
| | requestor.identifier | String | O |These Fields are mandatory for request type \[peerToPeer].
idType : Expected Values: \[EMIRATES\_ID, PASSPORT, GCC\_NATIONAL\_ID\_CARDS]
| | requestor.idType | String | O |These Fields are mandatory for request type \[peerToPeer].
idType : Expected Values: \[EMIRATES\_ID, PASSPORT, GCC\_NATIONAL\_ID\_CARDS]
| | requestor.additionalInfo | Object | O | It is map object with extra info and won’t be shown in screen. | | Content | Object | M | Content of the request | |content
.documents
| List | M | List of documents | | content.documents name | String | M | document Name | |content
.documents.nameAr
| String | M | document Name in arabic | |content
.documents\[0].type
| String | M | Document type | |ct
.ypeAr
| String | M | Document type in arabic | |content
.documents\[0].metadata
| List | M | List of meta data | |content
.documents\[0].metadata.displayName
| String | M | Name of each point meta data | |content
.documents\[0].metadata.displayNameAr
| String | M | Name in arabic of each point meta data | #### Sample Request ``` { "identifier": "7841995659945349000", "idDocType": "EMIRATES_ID", "requestedById": "requester_sp_client_id", "spId": "owner_sp_client_id", "spTransactionID": "spTransactionID-208", "purpose": "Dicsdetek contract", "purposeAr": "عقد ديسيتيك", "requestType": "spToSp", "requestor": { "name": "mohamed", "nameAr": "محمد", "identifier": "7841984319372919", "idType": "EMIRATES_ID", "additionalInfo": { "address": "dubai", "mobile": "0555566556" } }, "content": { "documents": [ { "name": "Salary Certifcate", "nameAr": "المرتب", "type": "Document", "typeAr": "الوثيقة", "metaData": [ { "displayName": "Salary", "displayNameAr": "الراتب" }, { "displayName": "Allowance", "displayNameAr": "البدل" }, { "displayName": "Job Title", "displayNameAr": "المسمى وظيفي" }, { "displayName": "Date of Birth", "displayNameAr": "التاريخ الميلاد" } ] } ] } } ``` #### Curl Command ``` 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 '{ "identifier": "784190000000000", "idDocType": "EMIRATES_ID", "requestedById": "abcdef_mob_prod", "spId": "dataowner_client_id", "spTransactionID": "XXX-12520", "requestType": "peerToPeer", "requestor": { "name": "ahmed", "nameAr": "احمد", "identifier": "7841900000000", "idType": "EMIRATES_ID", "additionalInfo": { "address": "dubai", "mobile": "05500000000" } }, "content": { "documents": [ { "name": "ABCD contract 2024.pdf", "nameAr": 2024.pdf", "type": "Salary document", "typeAr": "وثيقة الراتب", "metaData": [ { "displayName": "Salary", "displayNameAr": "الراتب" }, { "displayName": "Allowance", "displayNameAr": "البدل" }, { "displayName": "Job Title", "displayNameAr": "المسمى وظيفي" }, { "displayName": "Date of Birth", "displayNameAr": "التاريخ الميلاد" } ] } ] } }' ``` ### Response #### Response Parameters | Name | Type | Mandatory/Optional | Description | | -------------------- | ------ | ------------------ | ---------------------------------------------- | | uaePassTransactionID | String | M | Generated uaepass id | | transactionStatus | String | M | Status will be for initial status as TRIGGERED | | spTransactionID | String | O | Request transaction | #### Sample Success Reponse ``` { "code": "0", "desc": { "ar": "تم تشغيل الإخطار بنجاح.", "en": "Notification has been triggered successfully." }, "data": { "uaePassTransactionID": "08c03fd4-1a99-4e6e-bb9c-793b1a4bb7b6", "spTransactionID": "spTransactionID-212", "transactionStatus": "TRIGGERED" } } ``` #### Error Response Codes | Description | Error Message | Http Status Code | | ------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | | Transaction Id Already Exist |{
"code": "CONS\_1000001",
"desc": {
"ar": "المعاملة موجودة بالفعل.",
"en": "Transaction already exists."
}
}
| 409 | | Missing headers: \[X-UAEPASS-Signature - X-Timestamp] |{
"code": "401",
"desc": {
"ar": "UNAUTHORIZED",
"en": "UNAUTHORIZED"
}
}
| 401 | | User Profile does not exist |{
"code": "0001",
"desc": {
"ar": "ملف تعريف المستخدم غير موجود",
"en": "User Profile does not exist with provided details"
}
}
| 404 | | Mismatch Document Id type with user profile |{
"code": "CONS\_1000002",
"desc": {
"ar": "نوع مستند الهوية خاطئ.",
"en": "Wrong Id document type."
}
}
| 409 | | Account is not verified |{
"code": "CONS\_1000003",
"desc": {
"ar": "لم يتم التحقق من الحساب.",
"en": "Account is not verified"
}
}
| 094 | | Missing Configuration in Backend |{
"code": "CONS\_1000004",
"desc": {
"ar": "الاعدادات المطلوبة مفقودة.",
"en": "Required configuration is missing"
}
}
| 500 | | X-UAEPASS-Signature is mismatch with generated signature in backend |{
"code": "CONS\_1000005",
"desc": {
"ar": "التوقيع غير صحيح.",
"en": "Invalid signature."
}
}
| 401 | | Invalid Document Type |{
"code": "CONS\_1000006",
"desc": {
"ar": "idDocType is missing or invalid value, allowed values \[EMIRATES\_ID, PASSPORT, GCC\_NATIONAL\_ID\_CARDS]",
"en": "idDocType is missing or invalid value, allowed values \[EMIRATES\_ID, PASSPORT, GCC\_NATIONAL\_ID\_CARDS]"
}
}
| 400 | | Consent Already done |{
"code": "CONS\_1000011",
"desc": {
"ar": "تمت الموافقة على المعاملة رقم \[spTransactionID-apidog-494]، وحالتها الحالية هي \[ACCEPTED].",
"en": "Consent for transaction ID \[spTransactionID -494] has been done. Its current status is \[ACCEPTED]."
}
}
| 409 | | Service Provider \[owner\_sp\_client\_id] is not found. |{
"code": "CONS\_1000012",
"desc": {
"ar": "مقدم الخدمة \[owner\_sp \_client\_id] غير موجودة.",
"en": "Service Provider \[owner\_sp \_client\_id] is not found."
}
}
| 404 | |invalid identifier | | |
|
ex: "identifier": "X"
{
"code": "UMS\_VAL\_025",
"desc": {
"ar": " الهوية غير صحيحة",
"en": "invalid identifier"
}
}
| 400 |