IBAN Verification

Validate IBAN and verify account information

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:

EndpointuseCaseType Valuepermissions Value
/v1/api/observice/connectIBANVALIDATIONSReadAccountsBasic
ReadAccountsDetail

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

Get All Accounts IBAN Verification Services

Endpoint details

Endpoint URLMethodAuthentication requirements
/v1/api/observice/accountsPOST1. clientId 2. clientCode 3. signature 4. Authorization Bearer: Token

Sample request

{
  "dateTimeStamp": "YYYY-MM-DDTHH:MM:SS",
  "requestID": "Enter_Request_Id",
  "merchantId": "Enter_Merchant_Id",
  "fromDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
  "toDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
  "ibanValidation" : true,
  "banks": [
    {
      "code": "Enter_Bank_Code",
      "consentId":"Enter_Consent_Id",
      "iban":"XX0000000000000000000000"
    }
  ]
}

Request description

JSON TagDescriptionData type
DateTimeStamp
Mandatory
Stamp denoting the date and time of the requestString
RequestID
Mandatory
Unique request identificationString
merchantId
Mandatory
Unique merchant identificationString
fromDate
Mandatory
Initial date of transaction periodString
toDate
Mandatory
Final date of transaction periodString
ibanValidation
Mandatory
IBAN Validation service tag to be denoted as trueBoolean
banks
Mandatory
Array of banks and consentsObject
code
Mandatory
Unique bank identification codeString
consentId
Mandatory
Unique consent identificationString
iban
Mandatory
Unique IBAN identification details with
XX Country Code and 0000000000000000000000 as account number
String

Sample response

{
  "success": true,
  "payload": [
    {
      "code": "Bank_Code",
      "data": {
        "account": [
          {
            "accountId": "Account_Id",
            "accountHolderName": "Account_Holder_Name",
            "accountHolderShortName": "Account_Holder_Short_Name",
            "status": "Account_Status",
            "currency": "Currency",
            "nickname": "Account_Nickname",
            "accountType": "Account_Type",
            "accountSubType": "Account_Sub_Type",
            "accountIdentifiers": [
              {
                "identificationType": "Identification_Type",
                "identification": "Identification_Details",
                "name": "Name"
              },
              {
                "identificationType": "Identification_Type",
                "identification": "Identification_Details",
                "name": "Name"
              }
            ],
            "servicer": {
              "identificationType": "Servicer_Identification_Type",
              "identification": "Servicer_Identification"
            },
            "statusUpdateDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
            "description": "Account_Description",
            "openingDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
            "maturityDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
            "ibanValidation": "failed"
          },
          {
            "accountId": "Account_Id",
            "accountHolderName": "Account_Holder_Name",
            "accountHolderShortName": "Account_Holder_Short_Name",
            "status": "Account_Status",
            "currency": "Currency",
            "nickname": "Account_Nickname",
            "accountType": "Account_Type",
            "accountSubType": "Account_Sub_Type",
            "accountIdentifiers": [
              {
                "identificationType": "Identification_Type",
                "identification": "Identification_Details",
                "name": "Name"
              },
              {
                "identificationType": "Identification_Type",
                "identification": "Identification_Details",
                "name": "Name"
              }
            ],
            "servicer": {
              "identificationType": "Servicer_Identification_Type",
              "identification": "Servicer_Identification"
            },
            "statusUpdateDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
            "description": "Account_Description",
            "openingDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
            "maturityDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
            "ibanValidation": "failed"
          }
        ]
      },
      "links": {
        "self": "https://"
      },
      "meta": {
        "totalPages": 0
      }
    }
  ]
}

Response description

JSON TagDescription
successProcess success status represented as true or false
payloadTag carrying the response information
codeUnique bank identification code
dataTag carrying the response data of the accounts
accountTag carrying accounts information in the response
accountIdUnique bank account identification code
accountHolderNameFull name of the account holder
accountHolderShortNameShort name of the account holder
statusCurrent status of the account as active or inactive
currencyDefault currency of the account
nicknameNickname of the account holder
accountTypeType of the account
accountSubTypeSub-type of the account
accountIdentifiersAccount identifiers information tag
identificationTypeType of account identification
identificationUnique identification details
nameName of the account as per identification
servicerAccount servicer details tag
identificationTypeType of servicer account identification
identificationUnique servicer identification details
statusUpdateDateTimeEffective date and time of the last update of account information
descriptionDescription of the account information
openingDateDate of opening of the bank account
maturityDateDate of maturity of the bank account
ibanValidationStatus/result of IBAN Validation process for the account
linksRedirect link
selfOwn link/URL details
metaMeta tag
totalPagesInformation displayed in terms of pages

Get IBAN Verification Services by Account ID

Endpoint details

Endpoint URLMethodAuthentication requirements
/v1/api/observice/accountsByIdPOST1. clientId 2. clientCode 3. signature 4. Authorization Bearer: Token

Sample request

{
  "dateTimeStamp": "YYYY-MM-DDTHH:MM:SS",
  "requestID": "Enter_Request_Id",
  "merchantId": "Enter_Merchant_Id",
  "fromDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
  "toDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
  "ibanValidation" : true,
  "banks": [
    {
      "code": "Enter_Bank_Code",
      "consentId":"Enter_Consent_Id",
      "accountId": "Enter_Account_Id",
      "iban":"XX0000000000000000000000"
    }
  ]
}

Request description

JSON TagDescriptionData type
DateTimeStamp
Mandatory
Stamp denoting the date and time of the requestString
RequestID
Mandatory
Unique request identificationString
merchantId
Mandatory
Unique merchant identificationString
fromDate
Mandatory
Initial date of transaction periodString
toDate
Mandatory
Final date of transaction periodString
ibanValidation
Mandatory
IBAN Validation service tag to be denoted as trueBoolean
banks
Mandatory
Array of banks and consentsObject
code
Mandatory
Unique bank identification codeString
consentId
Mandatory
Unique consent identificationString
accountId
Mandatory
Unique account identificationString
iban
Mandatory
Unique IBAN identification details with
XX Country Code and 0000000000000000000000 as account number
String

Sample response

{
  "success": true,
  "payload": [
    {
      "code": "Bank_Code",
      "data": {
        "accountId": "Account_Id",
        "account": [
        {
          "accountHolderName": "Account_Holder_Name",
          "accountHolderShortName": "Account_Holder_Short_Name",
          "status": "Account_Status",
          "currency": "Currency",
          "nickname": "Account_Nickname",
          "accountType": "Account_Type",
          "accountSubType": "Account_Sub_Type",
          "accountIdentifiers": [
            {
              "identificationType": "Identification_Type",
              "identification": "Identification_Details",
              "name": "Name"
            },
            {
              "identificationType": "Identification_Type",
              "identification": "Identification_Details",
              "name": "Name"
            }
          ],
          "servicer": {
            "identificationType": "Servicer_Identification_Type",
            "identification": "Servicer_Identification"
          },
          "statusUpdateDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
          "description": "Account_Description",
          "openingDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
          "maturityDate": "YYYY-MM-DDTHH:MM:SS.SSSZ"
        }]
      },
      "links": {
        "self": "https://"
      },
      "meta": {
        "totalPages": 0
      },
      "ibanValidation": "failed"
    }
  ]
}

Response description

JSON TagDescription
successProcess success status represented as true or false
payloadTag carrying the response information
codeUnique bank identification code
dataTag carrying the response data of the accounts
accountIdUnique bank account identification code
accountHolderNameFull name of the account holder
accountHolderShortNameShort name of the account holder
statusCurrent status of the account as active or inactive
currencyDefault currency of the account
nicknameNickname of the account holder
accountTypeType of the account
accountSubTypeSub-type of the account
accountIdentifiersAccount identifiers information tag
identificationTypeType of account identification
identificationUnique identification details
nameName of the account as per identification
servicerAccount servicer details tag
identificationTypeType of servicer account identification
identificationUnique servicer identification details
statusUpdateDateTimeEffective date and time of the last update of account information
descriptionDescription of the account information
openingDateDate of opening of the bank account
maturityDateDate of maturity of the bank account
linksRedirect link
selfOwn link/URL details
metaMeta tag
totalPagesInformation displayed in terms of pages
ibanValidationResult of the IBAN Validation process for the account