Validate IBAN details

IBAN Validation service enables you to verify whether a provided IBAN matches an account associated with the customer's authorized banking data. The service can be used to validate a specific account or verify an IBAN across all accounts linked to a consent.

This capability helps organizations confirm account ownership, validate beneficiary information, reduce payment errors, and support onboarding and compliance workflows.

IBAN Validation service compares a supplied IBAN against customer account information available through an authorized consent.

Using this service, you can:

Validate a specific IBAN.
Verify whether an IBAN belongs to a customer.
Confirm beneficiary account information.
Reduce failed payments and transfer errors.
Support account verification and onboarding processes.
Validate IBAN ownership before initiating payouts or transfers.

The service can be used across all customer accounts associated with a consent or to validate a specific account when account-level information is available.

Important information

The consentId must refer to an active and authorized consent
A valid access token must be included in the Authorization: Bearer header

This API can only be accessed using a valid and active consent. Before accessing this service, ensure that a consent has been created and authorized with the required useCaseType and permissions.

The consent must include the appropriate useCaseType and permission values that allow access to the corresponding financial data services.

If you do not already have a consent with the required configuration, you must first create one using the Create Consent API and ensure that it is successfully authorized. Once the consent becomes active, the generated consentId can be used to access this API service.

Scope	useCaseType	Permissions
To access IBAN Validation service under Data Use Case APIs	`IBANVALIDATIONS`	`"ReadAccountsBasic",` `"ReadAccountsDetail",`

Scope

useCaseType

Permissions

To access IBAN Validation service under Data Use Case APIs

IBANVALIDATIONS

"ReadAccountsBasic",

"ReadAccountsDetail",

Validate All IBANs

This service requires consentId and returns all accounts information associated with that consent for IBAN validation.

Endpoint

Endpoint URL	Method
`/v2/api/observice/ibanValidation`	GET

Header

The following headers must be included when calling the accounts API.

Header parameter	Description
`Authorization: Bearer`	Access token used to authenticate the API request

Sample request

Example to initiate request to retrieve all accounts information for IBAN validation

curl --request GET \
     --url 'https://obsandbox.onesingleview.com/v2/api/observice/ibanValidation?dateTimeStamp=2023-06-14T17%3A51%3A03&requestID=db35902b-806a-4141-b1e2-e93f60c82f62&merchantId=APIU-300356&ibanCheck=true&bankCode=SVMOB1&consentId=urn%3ASVMOB%3Akac-cd3b9a37-eb97-4a70-b268-38af9f2950b1&iban=SA0000000000000580000001' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjoiTDNyMmpxV29JS2I4MTNodDBNYVR4WGpBZU5qU1FWaTFad3B5QnlkOVpHelZXR2ZwUmFQNUZ1TTJ6NmIzbi9WVE1aK1FucERJMEZXWWN6VGJsOEc5cXhaY0VLUTZZWEFsYmZnejdkdlFpTTRXeVBNalQ2WG1NUDh5YXI4RDVWZTUwUGhYbDcwYkYxRENJeEpDaU5TVkhBKytXYnRUZkhDblVBPT0iLCJpYXQiOjE3ODE1OTAwMDksImV4cCI6MTc4MTU5MzYwOX0.MO69uVzXyHqN2UBxvxCn3sBZcOpNWYP7bsQPe-qdGsQ'

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 YYYY-MM-DDTHH:MM:SS
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 request	String
ibanCheck	Mandatory	Specification of data use case API	Enum	`true` or `false`
bankCode	Mandatory	Unique bank identifier code	Enum
consentId	Mandatory	Unique identifier of the consent	String
iban	Optional	Unique international bank account number	String

Sample response

Example response for a successfully retrieved all accounts information for IBAN validation

{
  "success": true,
  "payload": [
    {
      "code": "SVMOB1",
      "data": {
        "account": [
          {
            "accountId": "100004000000000000000001",
            "accountHolderName": "Mohammad Alhajri",
            "accountHolderShortName": "Alhajri",
            "status": "Active",
            "currency": "SAR",
            "nickname": "Mohammad",
            "accountType": "KSAOB.Corporate",
            "accountSubType": "Business Current Account",
            "accountIdentifiers": [
              {
                "identificationType": "KSAOB.IBAN",
                "identification": "SA5678907654334454445601",
                "name": "Mohammad Alhajri"
              }
            ],
            "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"
          }
        ]
      },
      "links": {
        "self": ""
      },
      "meta": {
        "totalPages": 1
      }
    }
  ]
}

Response parameters

Parameter	Description	Data type	Data validation
success	Indicates whether the request was successfully processed	Enum	`true` or `false`
payload	Contains account information grouped by bank	Array of objects
code	Bank identifier associated with the account data	Enum
data	Contains account details returned from the bank	Object
account	List of accounts associated with the consent	Array of objects
accountId	Unique identifier of the account	String
accountHolderName	Full name of the account holder	String
accountHolderShortName	Short or display name of the account holder	String
status	Current status of the account	Enum	`Active` or `Inactive`
currency	Currency in which the account operates	String
nickname	Nickname assigned to the account	String
accountType	Specifies the type of accounts that can be accessed	Enum	`retail` or `corporate`
accountSubType	Specifies the type of accounts that can be accessed	Enum	`Savings` or `CurrentAccount` or `CreditCard` or `EMoney`
accountIdentifiers	Each account may contain one or more identifiers that uniquely identify the account	Object
identificationType	Type of identifier used	String
identification	Identifier value associated with the account	String
name	Name associated with the identifier	String
servicer	This contains information about the financial institution servicing the account	Object
identificationType	Type of bank identifier used	String
identification	Identifier value of the servicing institution	String
statusUpdateDateTime	Date and time when the account status was last updated by the servicing bank	Date	ISO 8601 format YYYY-MM-DDTHH:MM:SS
description	Additional information or description associated with the account subtype or account characteristics	String
openingDate	Date and time when the account was originally opened at the bank	Date	ISO 8601 format YYYY-MM-DDTHH:MM:SS
maturityDate	Date when the account reaches maturity. This field is typically applicable for term-based accounts.	Date	ISO 8601 format YYYY-MM-DDTHH:MM:SS
ibanCheck	Details on the validation status of the IBAN		`passed` or `failed`
links	Contains reference links related to the API response or resource	Object
self	Link referencing the current API resource or endpoint that returned the response	String
meta	Provides additional metadata related to the API response, such as pagination information	Object
totalPages	Indicates the total number of pages available in the response when pagination is applied	Integer

Validate a Specific IBAN

This service requires accountId along with consentId and returns details for the specified account for IBAN validation.

Endpoint

Endpoint URL	Method
`/v2/api/observice/ibanValidationByAccountId`	GET

Header

The following headers must be included when calling the IBAN Validation API.

Header parameter	Description
`Authorization: Bearer`	Access token used to authenticate the API request

Sample request

Example to initiate request to retrieve a specific account information for IBAN validation

curl --request GET \
     --url 'https://obsandbox.onesingleview.com/v2/api/observice/ibanValidationByAccountId?dateTimeStamp=2023-06-14T17%3A51%3A03&requestID=db35902b-806a-4141-b1e2-e93f60c82f62&merchantId=APIU-300356&ibanCheck=true&bankCode=SVMOB1&consentId=urn%3ASVMOB%3Akac-cd3b9a37-eb97-4a70-b268-38af9f2950b1&accountId=100004000000000000000001&iban=SA0000000000000580000001' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjoiTDNyMmpxV29JS2I4MTNodDBNYVR4WGpBZU5qU1FWaTFad3B5QnlkOVpHelZXR2ZwUmFQNUZ1TTJ6NmIzbi9WVE1aK1FucERJMEZXWWN6VGJsOEc5cXhaY0VLUTZZWEFsYmZnejdkdlFpTTRXeVBNalQ2WG1NUDh5YXI4RDVWZTUwUGhYbDcwYkYxRENJeEpDaU5TVkhBKytXYnRUZkhDblVBPT0iLCJpYXQiOjE3ODE1OTAwMDksImV4cCI6MTc4MTU5MzYwOX0.MO69uVzXyHqN2UBxvxCn3sBZcOpNWYP7bsQPe-qdGsQ'

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 YYYY-MM-DDTHH:MM:SS
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 request	String
ibanCheck	Mandatory	Specification of data use case API	Enum	`true` or `false`
bankCode	Mandatory	Unique bank identifier code	Enum
consentId	Mandatory	Unique identifier of the consent	String
accountId	Mandatory	Unique identifier of the account	String
iban	Optional	Unique international bank account number	String

Sample response

Example response for a successfully retrieved a specific account information request

{
"success": true,
"payload": [
{
"code": "SABB",
"data": {
"accountId": "100004000000000000000001",
"account": {
"accountId": "100004000000000000000001",
"accountHolderName": "Mohammad Alhajri",
"accountHolderShortName": "Alhajri",
"status": "Active",
"currency": "SAR",
"nickname": "Mohammad",
"accountType": "KSAOB.Corporate",
"accountSubType": "Business Current Account",
"accountIdentifiers": [
{
"identificationType": "KSAOB.IBAN",
"identification": "SA5678907654334454445601",
"name": "Mohammad Alhajri"
},
{
"identificationType": "KSAOB.NationalID",
"identification": "2123456789",
"name": "Mohammad Alhajri"
},
{
"identificationType": "KSAOB.CommercialRegistrationNumber",
"identification": "5566456733",
"name": "Saudi Company"
}
],
"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": "passed"
}
},
"links": {},
"meta": {}
}
]
}

Response parameters

Parameter	Description	Data type	Data validation
success	Indicates whether the request was successfully processed	Enum	`true` or `false`
payload	Contains the requested account information	Array of objects
code	Bank identifier associated with the account data	Enum
data	Contains account details returned from the bank	Object
accountId	Unique identifier of the account	String
accountHolderName	Full name of the account holder	String
accountHolderShortName	Short or display name of the account holder	String
status	Current status of the account	Enum	`Active` or `Inactive`
currency	Currency in which the account operates	String
nickname	Nickname assigned to the account	String
accountType	Specifies the type of accounts that can be accessed	Enum	`retail` or `corporate`
accountSubType	Specifies the type of accounts that can be accessed	Enum	`Savings` or `CurrentAccount` or `CreditCard` or `EMoney`
accountIdentifiers	Each account may contain one or more identifiers that uniquely identify the account	Object
identificationType	Type of identifier used	String
identification	Identifier value associated with the account	String
name	Name associated with the identifier	String
servicer	This contains information about the financial institution servicing the account	Object
identificationType	Type of bank identifier used	String
identification	Identifier value of the servicing institution	String
statusUpdateDateTime	Date and time when the account status was last updated by the servicing bank	Date	ISO 8601 format YYYY-MM-DDTHH:MM:SS
description	Additional information or description associated with the account subtype or account characteristics	String
openingDate	Date and time when the account was originally opened at the bank	Date	ISO 8601 format YYYY-MM-DDTHH:MM:SS
maturityDate	Date when the account reaches maturity. This field is typically applicable for term-based accounts.	Date	ISO 8601 format YYYY-MM-DDTHH:MM:SS
ibanCheck	Details on the validation status of the IBAN		`passed` or `failed`
links	Contains reference links related to the API response or resource	Object
self	Link referencing the current API resource or endpoint that returned the response	String
meta	Provides additional metadata related to the API response, such as pagination information	Object
totalPages	Indicates the total number of pages available in the response when pagination is applied	Integer

Categories

GENERAL INFORMATION

GETTING STARTED

CONSENT MANAGEMENT

Raw Data APIs

DATA USE CASE APIS

Plug-and-Play Integrations

RESOURCES

API Archives

Validate All IBANs

Endpoint

Header

Sample request

Sample response

Validate a Specific IBAN

Endpoint

Header

Sample request

Sample response

Categories

GENERAL INFORMATION

GETTING STARTED

CONSENT MANAGEMENT

Raw Data APIs

DATA USE CASE APIS

Plug-and-Play Integrations

RESOURCES

API Archives

Consent information

Validate All IBANs

Endpoint

Header

Sample request

Sample response

Validate a Specific IBAN

Endpoint

Header

Sample request

Sample response