IBAN Validation

Verify and validate IBAN details

SingleView IBAN validation API service checks whether an IBAN is correctly structured according to the international standard and verifies the correctness of the owner.

Endpoint details

Endpoint URL

Method

Authentication requirements

/v1/api/erp/svibanValServiceRQ

POST

1. clientid
2. clientsecret
3. signature

Validate IBAN Service

Sample request

curl --location --request POST 'https://servicesuat.onesingleview.com/v1/api/erp/svibanValServiceRQ' \
--header 'clientid: Enter_Client_ID' \
--header 'clientsecret: Enter_Client_Secret' \
--header 'signature: Enter_Signature' \
--header 'Content-Type: application/json' \
--data-raw '{
"svibanValServiceRQ": {
  "groupCode": "Enter_Group_Code",
  "company": [
    {
      "companyCode": "Enter_Company_Code",
      "userName": "Enter_Username",
      "ibans": [
        {
          "iban": "Enter_IBAN",
          "nationalId": "Enter_National_ID"
        }
      ]
    }
  ]
}
}'

Request description

JSON Tag

Description

Data Type

clientid Mandatory

Unique client identification details

  • Length of input:
    Min 3 Characters
    Max 20 Characters_

String

clientsecret
Mandatory

Unique client secret code

  • Length of input:
    Min 3 Characters
    Max 20 Characters_

String

signature
Mandatory

64-Bit string obtained by processing client signature key through Base-64 and SHA-256

String

svibanValServiceRQ
Mandatory

Tag carrying information on request for IBAN Validation service

Object

groupCode
Optional

Unique group identification code

  • Length of input:
    Min 3 Characters
    Max 20 Characters_

Numerical

company
Mandatory

Tag carrying information about company

Object

companyCode
Mandatory

Unique company identification code

  • Length of input:
    Min 3 Characters
    Max 20 Characters_

Numerical

userName
Mandatory

Unique user identification name

  • Length of input:
    Min 3 Characters
    Max 20 Characters_

String

ibans
Mandatory

Tag carrying information on IBANs to be validated

Object

iban
Mandatory

Unique International Bank Account Number
Length of the input: Max 24 Characters

String

nationalId
Mandatory

Unique national identification details of the provided IBAN's account owner
Length of the input: Max 10 Digits

Numerical

Sample response

{
  "svibanValServiceRS": {
    "company": [
      {
        "companyCode": "Company_Code",
        "userName": "Username",
        "ibans": [
          {
            "TransactionReferenceNumber": "",
            "StatusCode": "Status_Code",
            "IsActive": "Active",
            "StatusDetail": "Status_Details",
            "InstitutionName": "Name_of_The_Institute",
            "BeneficiaryNameMasted": "ABDU** ***",
            "NationalId": "1010597589",
            "IBAN": "SA8037446151848416184848",
            "InstitutionStatus": "",
            "BICCode": "",
            "BankName": "SABB"
          }
        ]
      }
    ]
  }
}

Response description

JSON TagDescriptionData Type
svibanValServiceRSTag carrying information on process response for IBAN validation servicesObject
companyTag carrying information on companyObject
companyCodeUnique company identification codeNumerical
userNameUnique usernameString
ibansTag carrying information on validated IBANs in the responseObject
TransactionReferenceNumberUnique transaction reference number for the IBAN verification operationString
StatusCodeValidation status displayed via codeNumerical
IsActiveStatus of the account represented as Active or InactivaeString
StatusDetailValidation status detailsString
InstitutionNameName of the institution to whom the IBAN belongsString
BeneficiaryNameMaskedName of the beneficiary masked in asterisksString
NationalIdUnique national identification details of the account ownerString
IBANUnique IBAN of the beneficiary processed in the requestString
InstitutionStatusStatus of the institutionString
BICCodeUnique BIC codeString
BankNameName of the bankString