Getting started overview

Integrating with IBANforge involves a sequence of steps designed to enable quick access to its financial validation services. The core process includes account creation, API key generation, and making a programmatic call to one of its API endpoints. IBANforge's API is primarily RESTful, supporting JSON for request and response bodies, aligning with common web service integration patterns. The platform offers a free tier that permits up to 500 API requests per month, suitable for initial testing and development before transitioning to higher-volume usage tiers.

The API is designed for various use cases, including real-time IBAN validation, reducing payment errors, and enhancing fraud prevention measures by verifying bank account details. It supports key operations like IBAN validation, BIC lookup, and SEPA validation. The following table provides a high-level overview of the initial integration steps:

Step What to do Where to find it
1. Account Creation Register for an IBANforge account to access the dashboard. IBANforge homepage
2. API Key Generation Generate a unique API key for authenticating your requests. IBANforge dashboard > API Settings
3. Environment Setup Install necessary libraries (e.g., requests for Python). Your development environment, IBANforge documentation
4. First Request Construct and send an API call using your key. IBANforge API reference

Create an account and get keys

To begin using IBANforge, you must first create an account. Navigate to the IBANforge website and locate the sign-up option. The registration process typically requires an email address and password. Upon successful registration, you will gain access to your personal IBANforge dashboard.

Within the dashboard, the primary credential for API access is the API key. This key authenticates your application's requests to the IBANforge API. To generate your API key:

  1. Log in to your IBANforge account.
  2. Navigate to the section typically labeled "API Settings" or "Developer Settings" within your dashboard.
  3. Look for an option to "Generate New API Key" or similar.
  4. Once generated, your API key will be displayed. It is crucial to store this key securely and treat it as sensitive information, similar to a password. Do not hardcode it directly into client-side code or expose it publicly.

IBANforge supports a RESTful API architecture which relies on standard HTTP methods (GET, POST) and typically uses API keys for authentication, often passed as a header or query parameter. This approach is a common standard for securing web APIs, as described in guides like the Google Cloud API key authentication overview.

Your first request

After obtaining your API key, you can make your first programmatic request. This example demonstrates how to validate an IBAN using the /validate endpoint. IBANforge provides SDKs for Python, Node.js, PHP, and Ruby, simplifying integration. Below are examples using Python and Node.js, which are primary language examples cited in the documentation.

Python example

First, ensure you have the requests library installed:

pip install requests

Then, execute the following Python code, replacing YOUR_API_KEY with your actual key and YOUR_IBAN with the IBAN you wish to validate:


import requests
import json

api_key = "YOUR_API_KEY"
iban_to_validate = "DE89370400440532013000" # Example IBAN

url = "https://api.ibanforge.com/validate"
headers = {
    "Content-Type": "application/json",
    "X-Api-Key": api_key
}
payload = {
    "iban": iban_to_validate
}

try:
    response = requests.post(url, headers=headers, data=json.dumps(payload))
    response.raise_for_status() # Raise an exception for HTTP errors (4xx or 5xx)
    
    data = response.json()
    print(json.dumps(data, indent=2))
    
    if data.get("valid"):
        print(f"IBAN {iban_to_validate} is valid.")
    else:
        print(f"IBAN {iban_to_validate} is invalid. Reason: {data.get('reason', 'N/A')}")
        
except requests.exceptions.HTTPError as http_err:
    print(f"HTTP error occurred: {http_err} - {response.text}")
except requests.exceptions.ConnectionError as conn_err:
    print(f"Connection error occurred: {conn_err}")
except requests.exceptions.Timeout as timeout_err:
    print(f"Timeout error occurred: {timeout_err}")
except requests.exceptions.RequestException as req_err:
    print(f"An unexpected error occurred: {req_err}")

Node.js example

First, initialize your project and install axios for HTTP requests:

npm init -y
npm install axios

Then, use the following Node.js code, replacing YOUR_API_KEY and YOUR_IBAN:


const axios = require('axios');

const apiKey = "YOUR_API_KEY";
const ibanToValidate = "DE89370400440532013000"; // Example IBAN

const url = "https://api.ibanforge.com/validate";
const headers = {
    "Content-Type": "application/json",
    "X-Api-Key": apiKey
};
const payload = {
    iban: ibanToValidate
};

axios.post(url, payload, { headers })
    .then(response => {
        console.log(JSON.stringify(response.data, null, 2));
        if (response.data.valid) {
            console.log(`IBAN ${ibanToValidate} is valid.`);
        } else {
            console.log(`IBAN ${ibanToValidate} is invalid. Reason: ${response.data.reason || 'N/A'}`);
        }
    })
    .catch(error => {
        if (error.response) {
            // The request was made and the server responded with a status code
            // that falls out of the range of 2xx
            console.error(`Error ${error.response.status}: ${JSON.stringify(error.response.data, null, 2)}`);
        } else if (error.request) {
            // The request was made but no response was received
            console.error("No response received:", error.request);
        } else {
            // Something happened in setting up the request that triggered an Error
            console.error("Error setting up request:", error.message);
        }
    });

Common next steps

After successfully making your first API call, consider these next steps to further integrate IBANforge into your application:

  1. Explore Additional Endpoints: Review the IBANforge API reference for other available endpoints, such as BIC lookup or SEPA validation, depending on your application's requirements.
  2. Implement Error Handling: Robust error handling is crucial for production applications. Design your code to gracefully manage various API responses, including validation failures, rate limit errors, and authentication issues.
  3. Integrate with SDKs: While direct HTTP requests are feasible, utilizing one of the official IBANforge SDKs (Python, Node.js, PHP, Ruby) can streamline development by abstracting HTTP requests and handling data serialization.
  4. Monitor Usage: Keep track of your API usage through the IBANforge dashboard to ensure you stay within your free tier limits or your chosen paid plan. This helps in managing costs and anticipating scaling needs.
  5. Security Best Practices: Always transmit your API key securely. For server-side applications, use environment variables. For client-side applications, ensure that API calls are proxied through your backend to avoid exposing the key. Adhere to general API security guidelines, such as those recommended by Cloudflare API Shield documentation.
  6. Upgrade Your Plan: If your application requires more than the 500 free requests per month, consider upgrading to a paid plan. Starting at $9/month for 5,000 requests, IBANforge offers various tiers to accommodate different usage volumes.
  7. Review Compliance: IBANforge is GDPR compliant. If your application handles personal data, ensure your overall system also adheres to relevant data protection regulations.

Troubleshooting the first call

Encountering issues during your first API call is common. Here are some troubleshooting steps:

  • Check API Key: Ensure your API key is correct and has not been truncated or mistyped. Verify it against the key displayed in your IBANforge dashboard. An incorrect key will typically result in a 401 Unauthorized or 403 Forbidden HTTP status code.
  • Verify Endpoint URL: Confirm that the API endpoint URL (e.g., https://api.ibanforge.com/validate) is accurate. Mismatched URLs can lead to 404 Not Found errors. Consult the IBANforge API reference for precise endpoint details.
  • Content-Type Header: The API expects requests with a Content-Type: application/json header. Mismatches can cause the API to reject the request, often with a 400 Bad Request.
  • Request Body Format: Ensure the JSON payload for your request is correctly formatted and includes all required parameters (e.g., "iban": "..." for validation). Malformed JSON or missing parameters will generally result in a 400 Bad Request.
  • Internet Connectivity: Verify your development environment has stable internet access to reach the IBANforge API servers.
  • Rate Limiting: If you are making many requests in a short period, you might hit rate limits. The IBANforge documentation should detail rate limits and provide appropriate HTTP headers (like X-RateLimit-Limit, X-RateLimit-Remaining) to monitor your usage. Exceeding limits typically returns a 429 Too Many Requests status.
  • Examine Response Body: For non-2xx status codes, the API response body often contains detailed error messages that can help diagnose the problem. Log the full response (status code and body) during development.
  • Consult Documentation: The official IBANforge documentation is the primary resource for specific error codes and their meanings.