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:
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
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": "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 Tag | Description | Data type |
---|---|---|
DateTimeStamp Mandatory | Stamp denoting the date and time of the request | String |
RequestID Mandatory | Unique request identification | String |
merchantId Mandatory | Unique merchant identification | String |
fromDate Mandatory | Initial date of transaction period | String |
toDate Mandatory | Final date of transaction period | String |
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 | String |
consentId Mandatory | Unique consent identification | String |
iban Mandatory | Unique IBAN identification details withXX 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 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
Endpoint details
Endpoint URL | Method | Authentication requirements |
---|---|---|
/v1/api/observice/accountsById | POST | 1. 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 Tag | Description | Data type |
---|---|---|
DateTimeStamp Mandatory | Stamp denoting the date and time of the request | String |
RequestID Mandatory | Unique request identification | String |
merchantId Mandatory | Unique merchant identification | String |
fromDate Mandatory | Initial date of transaction period | String |
toDate Mandatory | Final date of transaction period | String |
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 | String |
consentId Mandatory | Unique consent identification | String |
accountId Mandatory | Unique account identification | String |
iban Mandatory | Unique IBAN identification details withXX 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 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 |
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 |
links | Redirect link |
self | Own link/URL details |
meta | Meta tag |
totalPages | Information displayed in terms of pages |
ibanValidation | Result of the IBAN Validation process for the account |
Updated 4 months ago