Initiate a consent request to obtain customer authorization for accessing financial data
Create Consent API is used to initiate a consent request that allows an application to access a customer’s financial information through Data APIs. Before retrieving account or transaction data, a valid consent must be created and authorized by the customer.
This API enables the application to define the scope of access, including the accounts involved, the type of financial data required, and the validity period of the consent. Once the consent request is created, the customer must authenticate with their bank and approve the request.
After successful authorization, the consent becomes active, and the generated Consent ID can be used to securely call Data APIs to retrieve financial information. If the consent is rejected or expires, it cannot be used for data access.
This endpoint submits a consent request to the system and returns a Consent ID along with the authorization status.
Endpoint URL | Method |
|---|---|
| POST |
The following headers must be included when calling the Create Consent API.
Header parameter | Description |
|---|---|
| Access token used to authenticate the API request |
curl --request POST \
--url https://obsandbox.onesingleview.com/v2/api/observice/connect \
--header 'authorization: Bearer asdfgi' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{
"dateTimeStamp": "2023-06-14T17:51:03",
"requestID": "db35902b-806a-4141-b1e2-e93f60c82f62",
"merchantId": "APIU-300356",
"useCaseType": "AISP",
"redirectUrl": "https://www.example.com/callback",
"banks": [
{
"code": "SABB",
"permissions": [
"ReadAccountsBasic",
"ReadAccountsDetail",
"ReadBalances",
"ReadParty",
"ReadPartyPSU",
"ReadPartyPSUIdentity",
"ReadBeneficiariesBasic",
"ReadBeneficiariesDetail",
"ReadTransactionsBasic",
"ReadTransactionsDetail",
"ReadTransactionsCredits",
"ReadTransactionsDebits",
"ReadScheduledPaymentsBasic",
"ReadScheduledPaymentsDetail",
"ReadDirectDebits",
"ReadStandingOrdersBasic",
"ReadStandingOrdersDetail"
],
"expiryDate": "2025-12-31T10:40:00+02:00",
"txnFromDate": "2016-01-01T10:40:00+02:00",
"txnToDate": "2025-12-31T10:40:00+02:00",
"accountType": "retail"
}
]
}
'
Request parameters
Parameter | 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 initiating the consent request | String |
|
useCaseType | Mandatory | Defines the open banking service or use case | String | Refer Consent Scope and Permissions |
redirectUrl | Mandatory | URL to which the customer is redirected after completing the authorization process with the bank | String |
|
banks | Mandatory | Contains the bank-specific consent details | Array of objects |
|
code | Mandatory | Unique bank identifier code | Enum |
|
permissions | Mandatory | List of financial data permissions requested | Array of strings | Refer Consent Scope and Permissions |
expiryDate | Mandatory | Date and time when the consent will expire | Date | ISO 8601 format |
txnFromDate | Mandatory | Initial input for transaction history date range to be accessed | Date | ISO 8601 format |
txnToDate | Mandatory | Final input for transaction history date range to be accessed | Date | ISO 8601 format |
accountType | Mandatory | Specifies whether the consent is for retail or corporate accounts | Enum |
|
{
"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 creation 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 once the consent is approved | Array of strings |
|
expirationDateTime | Specifies when the consent will expire | Date | ISO 8601 format |
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 |
accountType | Specifies the type of accounts that can be accessed | Enum |
|
accountSubType | Specifies the type of accounts that can be accessed | Enum |
|
onBehalfOf | Identifies the organization requesting the consent on behalf of the customer | Object |
|
tradingName | Commercial or brand name under which the requesting organization operates | String |
|
legalName | Officially registered legal name of the organization requesting access to the customer's financial data. This name may be displayed to the customer during the consent authorization process. | String |
|
identifierType | Specifies the type of identifier used to represent the organization | String |
|
identifier | Unique identifier associated with the organization requesting the consent | String |
|
purpose | Describes the intended use of the financial data | Array of strings |
|
consentId | A unique identifier generated for the consent request. This ID is used in subsequent Data API calls. | 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 |
|
bankRedirectUrl | URL where the customer must authenticate and authorize the consent with the selected bank | String |
|