Skip to main content

Crate ibanchecker

Crate ibanchecker 

Source
Expand description

Official Rust client for the ibanchecker.cash IBAN validation API.

Validate IBANs across 92 countries, validate up to 100 IBANs per request, extract IBANs from free text, look up country format specifications and resolve SWIFT/BIC codes.

Every method except Client::country_format needs an API key, including Client::lookup_bic; without one the API answers 401 and the call returns Error::Authentication. A free key arrives by email in seconds: request it at https://ibanchecker.cash/api-docs. Paid plans are at https://ibanchecker.cash/pricing.

What a key can call follows its plan. A free key covers Client::validate only, 100 requests a month. Client::validate_bulk and Client::lookup_bic need the Basic plan or above, and Client::extract the Growth plan or above. A call outside the key’s plan returns Error::Api with status 403 and code PLAN_REQUIRED. A key whose email address has a verified account at https://ibanchecker.cash/dashboard can try the methods its plan lacks, with smaller limits per call.

Client::validate and Client::lookup_bic count one request per call. Client::validate_bulk counts one request per IBAN and Client::extract one per IBAN found (at least one per call). Client::country_format works without a key, limited to 100 requests an hour per IP.

let api_key = std::env::var("IBANCHECKER_API_KEY").expect("set IBANCHECKER_API_KEY");
let client = ibanchecker::Client::with_api_key(api_key);

let result = client.validate("DE89 3704 0044 0532 0130 00").await?;
if result.valid {
    println!("{} {}", result.bank_name, result.bic);
} else {
    println!("{} ({})", result.error, result.error_code);
}

A malformed IBAN is not an error: Client::validate returns a ValidationResult with valid false and an error plus error_code explaining why. Error is returned for transport, authentication, plan, quota and server-side problems only.

§Tri-state fields

national_check_valid, sepa and swift are Option<bool>. The API distinguishes false from absent, so None means “not known for this IBAN” rather than “no”.

§Raw responses

Every model keeps the untouched response body in raw, so a field added to the API later is reachable without waiting for a client release.

Structs§

ApiError
What the API said about a failure.
BankRecord
The institution behind a SWIFT/BIC code.
BatchResult
The result of a bulk validation or a text extraction. Results come back in the same order as the input.
BbanField
One segment of a country’s BBAN, in the order it appears in the IBAN.
Client
Client for the ibanchecker.cash API.
ClientBuilder
Builds a Client.
FormatSpec
The IBAN format specification for one country.
ValidationResult
The result of validating one IBAN.

Enums§

Error
Everything that can go wrong on the way to a result.

Constants§

DEFAULT_BASE_URL
The production API.
VERSION
The version that goes out in the User-Agent header.

Type Aliases§

Result
The result of every call in this crate.