apyhub-logo
5 atoms
Base tier

About

This Utility API lets you validate IBAN code.
IBAN (International Bank Account Number) codes are like unique identification numbers for bank accounts worldwide. They provide many benefits when used in applications that involve international money transfers. IBAN codes make it easier to transfer money across borders, improve the accuracy of transfers, enhance security, streamline processes, and ensure compliance with regulations. So, IBAN code validation is an important tool for facilitating international money transfers in a safe, efficient, and compliant way.

API Playground

Documentation

validate iban
POST
https://api.apyhub.com/validate/iban

Request example

1
curl --location --request POST 'https://api.apyhub.com/validate/iban' \
2
--header 'apy-token: {{token}}' \
3
--header 'Content-Type: application/json' \
4
--data '{
5
"iban":"FR7630006000011234567890189"
6
}'
Method: POST
Content Type: application/json
Request Body
AttributeTypeMandatoryDescription
ibanstringYesThe IBAN code that you want to validate. for example: FR7630006000011234567890189
Sample Response
A successful request returns the data object with below mentioned attributes if the code is valid. If its not not then it will simply returns data: false
1
{
2
"data": {
3
"valid": true,
4
"iban": "FR7630006000011234567890189",
5
"bban": "30006000011234567890189",
6
"printable_format": "FR76 3000 6000 0112 3456 7890 189",
7
"country_code": "FR",
8
"sepa_country": true
9
}
10
}

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
200The request was successful.
400Invalid input.
401Required authentication information is either missing or not valid for the resource.
500If any unexpected error occurs while processing the request.

Authentication

All requests to ApyHub services need to be authenticated, currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from workspace settings (on the left side of the navbar) and go to applications.
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
"error": {
3
"code": 105,
4
"message": "Invalid URL"
5
}
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.