Fetch the status, scope, and validity of an existing consent
Retrieve Consent Details API allows applications to obtain the current status and details of an existing consent created through the Open Banking platform. This API can be used to verify whether a consent has been authorized, rejected, expired, or is still awaiting authorization.
By providing the Consent ID, the system retrieves the consent information from the bank along with metadata such as permissions granted, transaction access range, and consent validity period. This enables applications to confirm whether the consent is active before attempting to access financial data using Data APIs.
This endpoint submits a consentId and to the system and returns consent details along with the authorization status.
Endpoint URL | Method |
|---|---|
| GET |
The following headers must be included when calling the Retrieve Consent API.
Header parameter | Description |
|---|---|
| Access token used to authenticate the API request |
curl --request GET \
--url 'https://obsandbox.onesingleview.com/v2/api/observice/consent/details?dateTimeStamp=2023-06-14T17%3A51%3A03&requestID=db35902b-806a-4141-b1e2-e93f60c82f62&merchantId=APIU-300356&bankCode=SABB&consentId=urn%3ASABBSARI%3Akac-cd3b9a37-eb97-4a70-b268-38af9f2950b1' \
--header 'accept: application/json' \
--header 'authorization: Bearer asdrtyuiokjhgfrtyujhgy'Request parameters
Parameters | Requirement | Description | Data type | Data validation |
|---|---|---|---|---|
dateTimeStamp | Mandatory | Indicates the date and time when the request is created | Date | ISO 8601 format |
requestID | Mandatory | Unique identifier for the request used for tracking and traceability | Alphanumeric | UUID format |
merchantID | Mandatory | Identifier assigned to the merchant or client application | String |
|
bankCode | Mandatory | Unique bank identifier code | Enum |
|
consentId | Mandatory | Unique identifier of the consent whose details need to be retrieved | String |
|
{
"success": true,
"payload": [
{
"code": "SABB",
"data": {
"permissions": [
"ReadAccountsBasic",
"ReadAccountsDetail",
"ReadBalances",
"ReadTransactionsBasic",
"ReadTransactionsDetail",
"ReadTransactionsCredits",
"ReadTransactionsDebits"
],
"transactionFromDateTime": "2016-01-01T08:40:00.000Z",
"transactionToDateTime": "2025-12-31T08:40:00.000Z",
"expirationDateTime": "2025-12-31T08:40:00.000Z",
"consentId": "urn:SVMOB:kac-95bc6544-54ed-42ff-8096-38392f311560",
"status": "Authorised",
"creationDateTime": "2025-12-03T06:32:34.831Z",
"statusUpdateDateTime": "2025-12-03T06:32:34.000Z"
},
"links": {
"self": ""
},
"meta": {
"totalPages": 1,
"totalRecords": 1,
"requestDateTime": "2025-12-03T09:34:04"
},
"scope": {}
}
]
}
Response parameters
Parameter | Description | Data type | Data validation |
|---|---|---|---|
success | Indicates whether the consent retrieval request was successfully processed | Enum |
|
payload | Contains bank-specific consent information returned by the Open Banking provider | Array of objects |
|
code | Unique bank code identifier for which the consent was created | Enum |
|
data | Data tag for specific bank account consent | Object |
|
permissions | Lists the financial data access permissions granted to the consent | Array of strings |
|
transactionFromDateTime | Initial input for transaction history date range to be accessed | Date | ISO 8601 format |
transactionToDateTime | Final input for transaction history date range to be accessed | Date | ISO 8601 format |
expirationDateTime | Specifies when the consent will expire | Date | ISO 8601 format |
consentId | A unique identifier generated for the consent requested | String |
|
status | Indicates the current state of the consent | Enum |
|
creationDateTime | Timestamp when the consent was created | Date | ISO 8601 format |
statusUpdateDateTime | Timestamp of the most recent status update for the consent | Date | ISO 8601 format |
links | Provides the bank’s consent resource endpoint for reference | Object |
|
self | Provides the bank’s consent resource endpoint that represents the created consent. This link can be used to reference or retrieve consent details directly from the bank. | String |
|
meta | Contains metadata related to the response, including information such as pagination or additional response context | Object |
|
totalPages | Total number of pages returned in the response | Integer |
|
totalRecords | Total number of records returned in the response. | Integer |
|
requestDateTime | Timestamp indicating when the request was processed by the system | Date | ISO 8601 format |
scope | Defines the authorization scope associated with the consent | String |
|