Change Logs (17/11/2025)

Change Logs (17/11/2025) (v2.0.0)This file is the authoritative, human-readable record of API surface changes in this repository. Use it to document every change that may affect API consumers — including request/response schema updates, header or status-code changes, new or removed endpoints, behaviour changes, and migration guidance. Keep entries concise, include old/new examples for payload changes, mark breaking changes clearly, and reference the OpenAPI/JSON Schema (file path or commit SHA) when available.
Path: /apis/open-banking/application/client-credentials
Method: POST
Version: 2.0.0
Previous version: 2.0.0
Change type: Changed
Breaking: No
Summary: Added the scope in the response payload a string that lists the permissions granted to the issued access token.
Request changes: No Changes
Response changes:
Added scope
Examples:
Example (old response):
{
    "access_token": "eyJhbGciOiJSUzI.....",
    "expires_in": 1800,
    "refresh_expires_in": 0,
    "token_type": "Bearer",
    "not-before-policy": 0,
}
Example (new response):
{
    "access_token": "eyJhbGciOiJSUzI.....",
    "expires_in": 1800,
    "refresh_expires_in": 0,
    "token_type": "Bearer",
    "not-before-policy": 0,
    "scope": "ob:accounts:read_write_api:read ob:accounts:data:read email ob:estatements:read ob:pfm:data:read profile ob:credit:risk:assessment:data:read ob:kyc:data:read"
}


Path: /apis/open-banking/financial-institution/list2
Method: POST
Version: 2.0.0
Previous version: 2.1.0
Change type: Added
Breaking: No
Summary: Added required purpose_code to request body to idenitify the purpose and change the api_set value from AISP to AIS Request changes:
header: change the X-API-Version value from 2.0.0 to 2.1.0
body: new required field purpose_code
body: change required filed enum api_set to AIS Response changes:
no changes to response schema
Path: /apis/aisp/open-banking/account-access-consent/setup
Method: POST
Version: 2.0.0
Previous version: 2.1.0
Change type: Added
Breaking: No
Summary: Added required application_purpose_code to request body to idenitify the purpose and change the application_redirct_url to application_redirect_url Request changes:
header: change the X-API-Version value from 2.0.0 to 2.1.0
body: new required field application_purpose_code
body: change required filed change the application_redirct_url to application_redirect_url Response changes:
no changes to response schema
Path: /apis/aisp/open-banking/read-write-api/accounts1
Method: POST
Version: 2.0.0
Previous version: 2.0.0
Change type: Changed
Breaking: No
Summary: Changed the response root element from json array [object] to {object} and retuned the response Meta and Links
Request changes: No changes
Response changes:
Example (old response):
[
    "ConsentId": "95dd67a7-b....",
    "Account": [
        {
            "AccountId": "100004000.....",
            "AccountHolderName": "....",
            "AccountHolderShortName": "...",
            "Status": "Active",
            "Currency": "SAR",
            "Nickname": "....",
            "AccountType": "KSAOB.Retail",
            "AccountSubType": "CurrentAccount",
            "AccountIdentifiers": [
                {
                    "IdentificationType": "KSAOB.IBAN",
                    "Identification": ".....",
                    "Name": "....."
                },
                {
                    "IdentificationType": "KSAOB.IBAN",
                    "Identification": ".....",
                    "Name": "....."
                }
            ],
            "Servicer": {
                "IdentificationType": "KSAOB.BICFI",
                "Identification": "....."
            },
            "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"
      }, 
      {...}
  ]
]
Example (new response):
{
    "ConsentId": "95dd67a7-ba.....",
    "AccountId": "10000400......",
    "Account": {
        "AccountHolderName": "Mit......",
        "AccountHolderShortName": "Mi.....",
        "Status": "Active",
        "Currency": "SAR",
        "Nickname": "Mi....",
        "AccountType": "KSAOB.Retail",
        "AccountSubType": "CurrentAccount",
        "AccountIdentifiers": [
            {
                "IdentificationType": "KSAOB.IBAN",
                "Identification": "100.....",
                "Name": "Lu...."
            },
            {
                "IdentificationType": "KSAOB.IBAN",
                "Identification": "100.......",
                "Name": "Lui......"
            }
        ],
        "Servicer": {
            "IdentificationType": "KSAOB.BICFI",
            "Identification": "100........"
        },
        "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"
    },
    "Meta": {
        "TotalPages": 1
    },
    "Links": {
        "Self": "https://rs1.lab.openbanking.sa/open-banking/account-information/2022.11.01-final-errata2/accounts/10000400......"
    }
}
Path: /apis/aisp/open-banking/read-write-api/balances1
Method: POST
Version: 2.0.0
Previous version: 2.0.0
Change type: Changed
Breaking: No
Summary: Changed the response root element from json array [object] to {object} and retuned the response Meta and Links
Request changes: No changes
Path: /apis/aisp/open-banking/read-write-api/beneficiaries1
Method: POST
Version: 2.0.0
Previous version: 2.0.0
Change type: Changed
Breaking: No
Summary: Changed the response root element from json array [object] to {object} and retuned the response Meta and Links
Request changes: No changes
Path: /apis/aisp/open-banking/read-write-api/direct-debits1
Method: POST
Version: 2.0.0
Previous version: 2.0.0
Change type: Changed
Breaking: No
Summary: Changed the response root element from json array [object] to {object} and retuned the response Meta and Links
Request changes: No changes
Path: /apis/aisp/open-banking/read-write-api/parties1
Method: POST
Version: 2.0.0
Previous version: 2.0.0
Change type: Changed
Breaking: No
Summary: Changed the response root element from json array [object] to {object} and retuned the response Meta and Links
Request changes: No changes
Path: /apis/aisp/open-banking/read-write-api/account-parties1
Method: POST
Version: 2.0.0
Previous version: 2.0.0
Change type: Changed
Breaking: No
Summary: Changed the response root element from json array [object] to {object} and retuned the response Meta and Links
Request changes: No changes
Path: /apis/aisp/open-banking/read-write-api/scheduled-payments1
Method: POST
Version: 2.0.0
Previous version: 2.0.0
Change type: Changed
Breaking: No
Summary: Changed the response root element from json array [object] to {object} and retuned the response Meta and Links
Request changes: No changes
Path: /apis/aisp/open-banking/read-write-api/standing-orders1
Method: POST
Version: 2.0.0
Previous version: 2.0.0
Change type: Changed
Breaking: No
Summary: Changed the response root element from json array [object] to {object} and retuned the response Meta and Links
Request changes: No changes
Path: /apis/aisp/open-banking/read-write-api/transactions1
Method: POST
Version: 2.0.0
Previous version: 2.0.0
Change type: Changed
Breaking: No
Summary: Changed the response root element from json array [object] to {object} and retuned the response Meta and Links
Request changes: No changes
SupportFor support, please reach out to us at https://datainsightssaudi.atlassian.net/servicedesk/customer/portal/3
FeedbackIf you have any feedback, please reach out to us at https://datainsightssaudi.atlassian.net/servicedesk/customer/portal/3
AuthorsMohammad Albadarneh
Change Logs (17/11/2025) (v2.0.0)

Support

Feedback

Authors

Contact Us

Resources

Social

Legal
