Get a single or multiple accounts information
SingleView AIS API enables the retrieval of account information from banks using the Consent ID and account ID. The API allows the users to access the account information for the Bank accounts with active user consent. Once consent is expired or deleted, that specific bank account information shall be inaccessible.
For all the consented bank accounts, a unique account ID can be used to retrieve the corresponding account information and data.
The account information can be obtained in the following methods:
This method uses the Consent ID and fetches all the bank accounts included in the specified consent. Below are examples of requests and responses to this method.
Endpoint URL | Method | Authentication requirements |
|---|---|---|
| POST |
|
{
"dateTimeStamp": "2024-12-31T10:40:00+02:00",
"requestID": "df797efb-b588-4234-8ae1-5cb748559830",
"merchantId": "APIS-300505",
"banks": [
{
"code": "SVMB01",
"consentId":"urn:SVMB01:kac-5a166b7d-8cdb-443a-a67a-80ad7a5b95b3"
}
]
}JSON Tag | Requirement | Description | Data type |
|---|---|---|---|
DateTimeStamp | Mandatory | Stamp denoting the date and time of the request | Date |
RequestID | Mandatory | Unique request identification | Alphanumeric |
merchantId | Mandatory | Unique merchant identification | Alphanumeric |
banks | Mandatory | Array of banks and consents | Object |
code | Mandatory | Unique bank identification code | Alphanumeric |
consentId | Mandatory | Unique consent identification | String |
{
"success": true,
"payload": [
{
"code": "SVMB01",
"data": {
"account": [
{
"accountId": "100004000000000000000002",
"accountHolderName": "Mitsuhirato",
"accountHolderShortName": "Mitsuhirato",
"status": "Active",
"currency": "SAR",
"nickname": "Mitsuhirato",
"accountType": "KSAOB.Retail",
"accountSubType": "CurrentAccount",
"accountIdentifiers": [
{
"identificationType": "KSAOB.IBAN",
"identification": "10000109010102",
"name": "Luigi International"
},
{
"identificationType": "KSAOB.IBAN",
"identification": "10000109010102",
"name": "Luigi International"
}
],
"servicer": {
"identificationType": "KSAOB.BICFI",
"identification": "10000109010101"
},
"statusUpdateDateTime": "2023-02-01T16:37:00.980Z",
"description": "Account sub-type description",
"openingDate": "2022-04-08T16:37:00.980Z",
"maturityDate": "2023-11-29T16:37:00.980Z"
},
{
"accountId": "100004000000000000000003",
"accountHolderName": "Mitsuhirato",
"accountHolderShortName": "Mitsuhirato",
"status": "Active",
"currency": "SAR",
"nickname": "Mitsuhirato",
"accountType": "KSAOB.Retail",
"accountSubType": "CurrentAccount",
"accountIdentifiers": [
{
"identificationType": "KSAOB.IBAN",
"identification": "10000109010103",
"name": "Mario International"
},
{
"identificationType": "KSAOB.IBAN",
"identification": "10000109010103",
"name": "Mario International"
}
],
"servicer": {
"identificationType": "KSAOB.BICFI",
"identification": "10000109010101"
},
"statusUpdateDateTime": "2023-02-01T16:37:00.981Z",
"description": "Account sub-type description",
"openingDate": "2022-04-08T16:37:00.981Z",
"maturityDate": "2023-11-29T16:37:00.981Z"
},
{
"accountId": "100004000000000000000005",
"accountHolderName": "Mitsuhirato",
"accountHolderShortName": "Mitsuhirato",
"status": "Active",
"currency": "SAR",
"nickname": "Mitsuhirato",
"accountType": "KSAOB.Retail",
"accountSubType": "CurrentAccount",
"accountIdentifiers": [
{
"identificationType": "KSAOB.IBAN",
"identification": "10000109010105",
"name": "Spectrum"
}
],
"servicer": {
"identificationType": "KSAOB.BICFI",
"identification": "10000109010101"
},
"statusUpdateDateTime": "2023-02-01T16:37:00.985Z",
"description": "Account sub-type description",
"openingDate": "2022-04-08T16:37:00.985Z",
"maturityDate": "2023-11-29T16:37:00.985Z"
}
]
},
"links": {
"self": "https://rs1.lab.openbanking.sa/open-banking/account-information/2022.11.01-final-errata2/accounts"
},
"meta": {
"totalPages": 1
}
}
]
}JSON Tag | Description |
|---|---|
success | Process success status represented as |
payload | Tag carrying the response information |
code | Unique bank identification code |
data | Tag carrying the response data of the accounts |
account | Tag carrying a specific account information |
accountId | Unique bank account identification code |
accountHolderName | Full name of the account holder |
accountHolderShortName | Short name of the account holder |
status | Current status of the account as |
currency | Default currency of the account |
nickname | Nickname of the account holder |
accountType | Type of the account |
accountSubType | Sub-type of the account |
accountIdentifiers | Account identifiers information tag |
identificationType | Type of account identification |
identification | Unique identification details |
name | Name of the account as per identification |
servicer | Account servicer details tag |
identificationType | Type of servicer account identification |
identification | Unique servicer identification details |
statusUpdateDateTime | Effective date and time of the last update of account information |
description | Description of the account information |
openingDate | Date of opening of the bank account |
maturityDate | Date of maturity of the bank account |
links | Redirect links tag |
self | Own links/URL details |
meta | Meta tag |
totalPages | Information included in the response in terms of page length |
This method uses the Consent ID and Account ID to fetch the account information of the specified account.
Endpoint URL | Method | Authentication requirements |
|---|---|---|
| POST |
|
{
"dateTimeStamp": "2024-12-31T10:40:00+02:00",
"requestID": "df797efb-b588-4234-8ae1-5cb748559830",
"merchantId": "APIS-300505",
"banks": [
{
"code": "SVMB01",
"consentId":"urn:SVMB01:kac-5a166b7d-8cdb-443a-a67a-80ad7a5b95b3",
"accountId": "100004000000000000000002"
}
]
}JSON Tag | Requirement | Description | Data type |
|---|---|---|---|
DateTimeStamp | Mandatory | Stamp denoting the date and time of the request | Date |
RequestID | Mandatory | Unique request identification | Alphanumeric |
merchantId | Mandatory | Unique merchant identification | Alphanumeric |
banks | Mandatory | Array of banks and consents | Object |
code | Mandatory | Unique bank identification code | Alphanumeric |
consentId | Mandatory | Unique consent identification | String |
accountId | Mandatory | Unique bank account identification included in the corresponding consent | String |
{
"payload": {
"success": true,
"payload": [
{
"code": "SVMB01",
"data": {
"accountId": "100004000000000000000002",
"account": {
"accountHolderName": "Mitsuhirato",
"accountHolderShortName": "Mitsuhirato",
"status": "Active",
"currency": "SAR",
"nickname": "Mitsuhirato",
"accountType": "KSAOB.Retail",
"accountSubType": "CurrentAccount",
"accountIdentifiers": [
{
"identificationType": "KSAOB.IBAN",
"identification": "10000109010102",
"name": "Luigi International"
},
{
"identificationType": "KSAOB.IBAN",
"identification": "10000109010102",
"name": "Luigi International"
}
],
"servicer": {
"identificationType": "KSAOB.BICFI",
"identification": "10000109010101"
},
"statusUpdateDateTime": "2023-02-01T16:37:00.980Z",
"description": "Account sub-type description",
"openingDate": "2022-04-08T16:37:00.980Z",
"maturityDate": "2023-11-29T16:37:00.980Z"
}
},
"links": {
"self": "https://rs1.lab.openbanking.sa/open-banking/account-information/2022.11.01-final-errata2/accounts/100004000000000000000002"
},
"meta": {
"totalPages": 1
}
}
]
}
}JSON Tag | Description |
|---|---|
success | Process success status represented as |
payload | Tag carrying the response information |
code | Unique bank identification code |
data | Tag carrying the response data of the accounts |
accountId | Unique bank account identification as per the consent |
account | Tag carrying a specific account information |
accountHolderName | Full name of the account holder |
accountHolderShortName | Short name of the account holder |
status | Current status of the account as |
currency | Default currency of the account |
nickname | Nickname of the account holder |
accountType | Type of the account |
accountSubType | Sub-type of the account |
accountIdentifiers | Account identifiers information tag |
identificationType | Type of account identification |
identification | Unique identification details |
name | Name of the account as per identification |
servicer | Account servicer details tag |
identificationType | Type of servicer account identification |
identification | Unique servicer identification details |
statusUpdateDateTime | Effective date and time of the last update of account information |
description | Description of the account information |
openingDate | Date of opening of the bank account |
maturityDate | Date of maturity of the bank account |
links | Redirect links tag |
self | Own links/url details |
meta | Meta tag |
totalPages | Information included in the response in terms of page length |