Poll Request Status

Request

This endpoint allows SP to fetch the status of the consent transaction triggered by the SP. This can be used as a fallback mechanism in case SP is not notified on the callback endpoint hosted by the SP.

Method

POST

Source

Service Provider (Data Owner)

Target

UAEPASS

Security

Client credential grant

Headers

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

spTransactionID

String

M

spId

String

M

Sample Request

{ 

    "spTransactionID": "m9mhsb1iy0rqeru53e", 

    "spId": "owner_sp_client_id" 

} 

Response

Response Parameters

Name
Type
Mandatory/Optional
Description

uaePassTransactionID

String

M

Generated uaepass id

spTransactionID

String

M

status

String

M

Expected Values: [TRIGGERED – ACCEPTED – REJECTED – INIT_FAILED – EXPIRED]

Sample Success Response

Error Response

Error Description
Error Message
Http Status Code

Missing headers: [X-UAEPASS-Signature - X-Timestamp]

{

"code": "401",

"desc": {

"ar": "UNAUTHORIZED",

"en": "UNAUTHORIZED"

}

}

401

Invalid spId

{

"code": "CONS_1000012",

"desc": {

"ar": "مقدم الخدمة [owner_sp_client_ids] غير موجودة.",

"en": "Service Provider [owner_sp_client_ids] is not found."

}

}

404

Invalid spTransactionID

{

"code": "CONS_1000010",

"desc": {

"ar": "المعاملة رقم [thh95681-d24b-4b14-a5de-837b7e60c287-19] غير موجودة.",

"en": "Transaction id [thh95681-d24b-4b14-a5de-837b7e60c287-19] is not found."

}

}

404

Last updated

Was this helpful?