SingleView IBAN Verification API services validates the IBANs with account information in real-time promoting payment efficiency and reducing payment errors and frauds service.

IBAN Verification helps confirm that the provided IBAN is valid and belongs to the right person.

📘
Mandatory information

The user must provide the valid credentials in the header

Encrypted and valid Signature and an active "Access Token."

Request format as specified with all the mandatory details with appropriate request tags

🌐Domain details

Sandbox API - https://sandboxapi.onesingleview.com

Production/LIVE API - To be provided upon onboarding

Verify IBAN

Try in API Reference ➜

Endpoint details

Endpoint URL	Method	Authentication requirements
`/api/v1/getbeneficary/bankdetails`	POST	1/. `clientsecret` 2. `clientid` 3. `SVReferenceId` 4.`CompanyId` 5. `Device` 6. `Authorization: Bearer` (Token) 7. `Signature`

Sample request

curl --location 'https://sandboxapi.onesingleview.com/api/v1/getbeneficary/bankdetails' \
--header 'clientsecret: Enter-Client-Secret'
--header 'clientid: Enter-Client-Id'
--header 'CompanyId: Enter-Company-Id'
--header 'SVReferenceID: Enter-SV-Reference-Id'
--header 'Device: Device-type'
--header 'Authorization: Bearer <Enter-Token>'
--header 'Content-Type: application/json'
--data '{
"Message": {
  "OSVBeneficiaryBankDetailsRequest": {
    "OSVBeneficiaryBankDetails": [
      {
        "IBANAccount": "Enter_IBAN",
        "NationalId": "Enter_National_ID"
      },
      {
        "IBANAccount": "Enter_IBAN",
        "NationalId": "Enter_National_ID"
      },
      {
        "IBANAccount": "Enter_IBAN",
        "NationalId": "Enter_National_ID"
      }
    ]
  }
},
"Signature": "Enter_Signature"
}'

Request description:

JSON Tag	Description	Data type
Message Mandatory	Header information (client credentials)	Object & String
OSVBeneficiaryBankDetailsRequest Mandatory	Root node	Object
OSVBeneficiaryBankDetails Mandatory	This tag contains bank request	Object
IBANAccount Mandatory	Unique IBAN information	String
NationalId Specific Mandatory	Unique national identification of the account holder Mandatory for all banks except SNB	String
Signature Mandatory	Encrypted string obtained by processing request body with Private Key/Certificate through SHA-256 with RSA Algorithm (Crypto : JCE Sign)	String

Sample responses

{
  "OSVBeneficiaryBankDetailsResponse": {
    "BeneficiaryBankDetailsMessage": [
      {
        "BankCode": "Bank_Code",
        "TransactionReferenceNumber": "Transaction_Reference_Number",
        "StatusCode": "Active",
        "StatusDetail": "Success",
        "BICCode": "BIC",
        "InstitutionName": "Institution_Name",
        "BeneficiaryNameMasked": "Masked_Name",
        "City": "City",
        "ZipCode": "ZIP_Code",
        "NationalId": "National_Id",
        "InstitutionStatus": "Active"
      }
    ]
  }
}

{
  "OSVBeneficiaryBankDetailsResponse": {
    "BeneficiaryBankDetailsMessage": [
      {
        "BankCode": "Bank_Code",
        "TransactionReferenceNumber": "Transaction_Reference_Number",
        "StatusCode": "Inactive",
        "StatusDetail": "Failed",
        "BICCode": "",
        "InstitutionName": null,
        "BeneficiaryNameMasked": null,
        "City": "",
        "ZipCode": "",
        "NationalId": null,
        "InstitutionStatus": "Inactive"
      }
    ]
  }
}

Response description

JSON Tag	Description	Data type
OSVBeneficiaryBankDetailsResponse	Root node	Object
BeneficiaryBankDetailsMessage	Element root containing response of every bank	Object
BankCode	Name of the bank Ex: “ALRAJHI”, “SABB”	String
TransactionReferenceNumber	Sender company code/Identifier provided by the bank during on-boarding	String
StatusCode	`Active` or `Inactive`	String
StatusDetail	Success/Failed response detail	String
BICCode	Unique Bank Identification/Identifier Code	String
InstitutionName	Name of the institution	String
BeneficiaryNameMasked	Beneficiary name displayed with masked characters	String
City	City of the institution	String
ZipCode	Zip code of the institution	String
NationalId	National ID of the account owner	String
InstitutionStatus	Status of the institution to be `Active` or `Inactive`	String

📘Mandatory information

Verify IBAN

Endpoint details

Sample request

Sample responses

📘
Mandatory information