> ## Documentation Index
> Fetch the complete documentation index at: https://docs.greip.io/llms.txt
> Use this file to discover all available pages before exploring further.
# IBAN Validation
> This method enables you to validate International Bank Account Numbers (IBANs) and obtain essential information about the country associated with each IBAN.
By using this API, you can ensure that the IBANs are formatted correctly and gain insights into the banking institution, enhancing security and accuracy in financial transactions.
export const MCPCallout = () => {
return
;
};
## Authentication
Include your API key in the `Authorization` header:
```http theme={null}
Authorization: Bearer
```
API v2 accepts the key only in this header, not in query parameters or request bodies. See [Authentication](/authentication).
### Path parameters
The International Bank Account Number (IBAN) you want to validate.
Sample value: `BE71096123456769`, or `BE71 0961 2345 6769`.
### Query parameters
The format command is used to get a response in a specific format.
Expected values: `JSON`, `XML`, `CSV`, or `Newline`
For more information please refer to [Response format](/options/response-format).
The mode command is used in the development stage to simulate the integration process before releasing it to the production environment.
Expected values: `live`, or `test`.
For more information please refer to [Development environment](/options/development-environment).
Optional label for your own analytics or support correlation (for example a product or channel name).
The user\_id command can be used to identify requests sent by specific users to monitor in the [Events page](/knowledge-base/events-and-alerts/overview).
Expected values: email address, phone number, user id, name, etc.
For more information please refer to [User identifier](/options/user-identifier).
```json Success theme={null}
{
"success": true,
"data": {
"is_valid": true,
"iban": "BE71096123456769",
"formats": {
"machine": "BE71096123456769",
"human": "BE71 0961 2345 6769",
"obfuscated": "BE** **** **** 6769"
},
"country": {
"name": "Belgium",
"iana": "be",
"iso3166": "BE",
"currency": "EUR",
"central_bank": {
"url": "http://www.nbb.be/",
"name": "National Bank of Belgium"
},
"membership": "eu_member",
"is_eu": true,
"length": 16,
"is_sepa": true,
"swift_official": true
},
"bank": {
"identifier": "GEBABEBB",
"name": "BNP Paribas Fortis",
"short_name": null,
"branch_code": null,
"bban": null
}
},
"execution_ms": 1
}
```
```json Error theme={null}
{
"success": false,
"code": 101,
"type": "invalid_key",
"description": "The API Key is missing or invalid."
}
```
### Response properties
`true` when the request succeeded; `false` on error.
A boolean value that you can rely on to determine if the IBAN is valid or not.
The IBAN value from the request.
Machine format of the IBAN.
Human-readable format of the IBAN.
Obfuscated format of the IBAN.
Country name where the issuing bank is located.
IANA country identifier when available.
Country code in ISO 3166-1 alpha-2 format when available.
Currency of the country.
The name of the central bank of the issuing country.
The URL of the central bank of the issuing country.
Membership type of the bank.
Determines whether the user is located within the European Union (EU) and is relevant for processing transactions or validations specific to EU countries.
IBAN length in this country when known.
Example IBAN for the country when available.
Indicates whether the IBAN belongs to a country participating in the Single Euro Payments Area (SEPA)
Typically indicates whether the IBAN corresponds to an official institution or entity that is part of the SWIFT network, which facilitates international financial transactions.
Issuing bank details when available.
Bank identifier (BIC/SWIFT) when available.
Bank name.
Short bank name when available.
Branch code when available.
Basic Bank Account Number segment when available.
Time taken to process the request (milliseconds).
## OpenAPI
````yaml openapi/v2.json GET /lookup/iban/{iban}
openapi: 3.0.3
info:
title: Greip API v2 (docs playground)
version: 2.0.0
servers:
- url: https://v2.greipapi.com
security: []
paths:
/lookup/iban/{iban}:
get:
summary: IBAN validation
operationId: lookupIban
parameters:
- name: iban
in: path
required: true
schema:
type: string
- name: format
in: query
schema:
type: string
default: JSON
- name: mode
in: query
schema:
type: string
default: live
- name: source
in: query
schema:
type: string
- name: user_id
in: query
schema:
type: string
responses:
'200':
description: OK
security:
- bearerAuth: []
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.