Introduction

IBAN Verification API Services ensure the accuracy and validity of IBANs by performing syntax checks, checksum verification, and other validations to confirm that the provided IBANs are correctly formatted and correspond to the correct country and financial institution. This helps prevent errors and fraud in cross-border payments and ensures the integrity of international banking transactions.

The IBAN Verification API service lets you fetch account information for multiple bank accounts in a Consent ID or a single account using the Account ID.

Consent

User consent is the primary requirement to access any services in Open Banking. The user or account holder grants explicit consent to a Third-Party to access their financial data. This consent is given through a secure, multi-factor authentication process to verify the user's identity.

The consent request must include the following details:

Endpoint	`useCaseType` Value	`permissions` Value
`/v1/api/observice/connect`	`IBANVALIDATIONS`	`ReadAccountsBasic` `ReadAccountsDetail`

Endpoint

useCaseType

Value

permissions

Value

/v1/api/observice/connect

IBANVALIDATIONS

ReadAccountsBasic
ReadAccountsDetail

Check Consent Management for more details to create, view, and revoke consents.

Get All Accounts IBAN Verification Services

Try in API Reference ➜

Endpoint details

Endpoint URL	Method	Authentication requirements
`/v1/api/observice/accounts`	POST	1. `clientId` 2. `clientCode` 3. `signature` 4. `Authorization Bearer: Token`

Sample request

{
  "dateTimeStamp": "2024-12-31T10:40:00+02:00",
  "requestID": "df797efb-b588-4234-8ae1-5cb748559830",
  "merchantId": "APIS-300505",
  "fromDate": "2016-01-01T10:40:00+02:00",
  "toDate": "2025-12-31T10:40:00+02:00",
  "ibanValidation" : true,
  "banks": [
    {
      "code": "SAMA",
      "consentId":"urn:SAMA:kac-5a166b7d-8cdb-443a-a67a-80ad7a5b95b3",
      "iban":"SA0000000000000580000001"
    }
  ]
}

Request description

JSON Tag	Description	Data type
DateTimeStamp Mandatory	Stamp denoting the date and time of the request ISO 8601 format - YYYY-MM-DDTHH:MM:SS	Date
RequestID Mandatory	Unique request identification	Alphanumeric
merchantId Mandatory	Unique merchant identification	Alphanumeric
fromDate Mandatory	Initial date of transaction period ISO 8601 format - YYYY-MM-DDTHH:MM:SS	Date
toDate Mandatory	Final date of transaction period ISO 8601 format - YYYY-MM-DDTHH:MM:SS	Date
ibanValidation Mandatory	IBAN Validation service tag to be denoted as `true`	Boolean
banks Mandatory	Array of banks and consents	Object
code Mandatory	Unique bank identification code	Alphanumeric
consentId Mandatory	Unique consent identification	String
iban Mandatory	Unique IBAN identification details with `XX` Country Code and `0000000000000000000000` as account number	String

Sample response

{
  "success": true,
  "payload": [
    {
      "code": "SAMA",
      "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",
            "ibanCheck": "failed"
          },
          {
            "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",
            "ibanCheck": "failed"
          }
        ]
      },
      "links": {
        "self": "https://rs1.lab.openbanking.sa/open-banking/account-information/2022.11.01-final-errata2/accounts"
      },
      "meta": {
        "totalPages": 1
      }
    }
  ]
}

Response description

JSON Tag	Description
success	Process success status represented as `true` or `false`
payload	Tag carrying the response information
code	Unique bank identification code
data	Tag carrying the response data of the accounts
account	Tag carrying accounts information in the response
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 `active` or `inactive`
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
ibanValidation	Status/result of IBAN Validation process for the account
links	Redirect link
self	Own link/URL details
meta	Meta tag
totalPages	Information displayed in terms of pages

Get IBAN Verification Services by Account ID