API Documentation

Base URL

https://wireline-api.vercel.app/api

Field Indicators

Required- Field must be provided for the request to succeed

Optional- Field can be omitted without causing an error

Authentication

All endpoints (except root) require an API key passed as a query parameter:

?api_key=your_api_key_here

Endpoints Overview

1. Root Endpoint

GET / - API status check

2. IBAN Validation

Validate IBAN codes and get bank info

3. SWIFT Validation

Validate SWIFT/BIC codes

4. Wireline Management

Create and retrieve Wirelines

5. API Key Usage

Track API usage statistics

1. Root Endpoint

GET /

Returns a simple status message indicating the API is live.

Request:

GET /api/

Response:

{ "Wireline API is live." }

Status Code:200 OK

2. IBAN Validation Endpoints

2.1 GET /iban/{iban}/

Full IBAN validation with detailed bank information.

Request:

GET /api/iban/DE89370400440532013000/?api_key=your_api_key

Parameters:

ibanRequiredstring - The IBAN to validate (path parameter)

api_keyRequiredstring - Your API key (query parameter)

Success Response (200 OK):

{ "iban": "DE89370400440532013000", "country_code": "DE", "bban": "370400440532013000", "bank_account": "532013000", "bank_name": "Commerzbank AG", "bank_phone": "+49 69 13620", "bank_address": "Kaiserplatz 1, 60311 Frankfurt am Main", "bank_bic": "COBADEFFXXX", "bank_city": "Frankfurt am Main", "bank_state": "Hessen", "bank_zip": "60311" }

Error Responses:

400 Bad Request - Invalid API Key:

{ "error": "Invalid API key" }

400 Bad Request - Invalid IBAN:

{ "error": "Invalid IBAN" }

3. SWIFT Validation Endpoints

3.1 GET /swift/{swift}/

Validate SWIFT/BIC codes and retrieve bank information.

Request:

GET /api/swift/COBADEFFXXX/?api_key=your_api_key

Parameters:

swiftRequiredstring - The SWIFT/BIC code to validate (path parameter)

api_keyRequiredstring - Your API key (query parameter)

Success Response (200 OK):

{ "bank_code": "COBA", "country_code": "DE", "location_code": "DE", "branch_code": "XXX", "bic11": "COBADEFFXXX", "bic8": "COBADEFF", "head_office": true, "supported": true, "country_name": "Germany", "currency_code": "EUR", "country_supported": true, "bank_name": "Commerzbank AG", "city": "Frankfurt am Main", "address": "Kaiserplatz 1, 60311 Frankfurt am Main" }

Error Response:

400 Bad Request - Invalid SWIFT:

{ "error": "Invalid Swift" }

4. Wireline Management Endpoints

4.1 POST /wireline/create/

Create a new Wireline with comprehensive validation.

Request:

POST /api/wireline/create/?api_key=your_api_key Content-Type: application/json { "iban": "DE89370400440532013000", "swift": "COBADEFFXXX", "currency_code": "EUR", "account_name": "John Doe Account", "routing_number": "123456789", "bank_address": "123 Main Street, City, Country" }

Request Body Schema:

ibanRequiredstring - IBAN to validate

swiftRequiredstring - SWIFT/BIC code

currency_codeRequiredstring - Currency code (e.g., EUR, USD)

account_nameRequiredstring - Account holder name

routing_numberOptionalstring - Bank routing number

bank_addressRequiredstring - Bank address

Success Response (201 Created):

{ "success": true, "wireline": "WLN-DE-42" }

Error Responses:

400 Bad Request - Invalid IBAN:

{ "success": false, "error": "Wireline cannot be created with invalid IBAN" }

400 Bad Request - IBAN/SWIFT Mismatch:

{ "success": false, "error": "Cannot create wireline, IBAN and Swift don't match" }

4.2 GET /wireline/{tag}/

Retrieve Wireline information by tag.

Request:

GET /api/wireline/WLN-DE-42/?api_key=your_api_key

Parameters:

tagRequiredstring - The Wireline tag (format: WLN-{country_code}-{index}) (path parameter)

api_keyRequiredstring - Your API key (query parameter)

Success Response (200 OK):

{ "iban": "DE89370400440532013000", "swift": "COBADEFFXXX", "currency_code": "EUR", "account_name": "John Doe Account", "account_number": "532013000", "routing_number": "123456789", "bank_name": "Commerzbank AG", "bank_address": "123 Main Street, City, Country" }

Error Response:

404 Not Found - Wireline Not Found:

{ "error": "Wireline not found" }

5. API Key Usage Endpoint

5.1 GET /api-key/usage/

Get usage statistics for your API key.

Request:

GET /api/api-key/usage/?api_key=your_api_key

Parameters:

api_keyRequiredstring - Your API key (query parameter)

Success Response (200 OK):

{ "validate_iban_basic": 150, "validate_iban_full": 75, "validate_swift": 30, "get_wireline": 25, "create_wireline": 10 }

Response Codes Summary

Status Code	Description	Common Causes
200	OK	Successful request
201	Created	Resource successfully created
400	Bad Request	Invalid API key, missing required fields, validation errors
404	Not Found	Resource not found
500	Internal Server Error	Server-side errors