generated: '2026-09-25' method: derived generator: derive-vocabulary.py source: - openapi/ibanforge-account-api-openapi.yml - openapi/ibanforge-api-keys-api-openapi.yml - openapi/ibanforge-bic-api-openapi.yml - openapi/ibanforge-compliance-api-openapi.yml - openapi/ibanforge-credits-api-openapi.yml vocabulary: name: IBANforge Domain Vocabulary description: 'Terms declared by IBANforge''s own API contract: its resource groups, objects and enumerations, with the contract''s definitions. Derived, not authored.' version: '2026-09-25' terms: - term: Account definition: 'The account page, https://ibanforge.com/account, for a person in a browser: a 6-digit code mailed to the address of the keys, then a read-only session cookie that shows every key of that address. Rotating or revoking a key still takes the key itself.' tags: - Resource Group source: openapi/ibanforge-account-api-openapi.yml - term: API Keys definition: API key management — mint a key with or without an email address, claim it, rotate it, check its usage tags: - Resource Group source: openapi/ibanforge-api-keys-api-openapi.yml - term: BIC definition: BIC/SWIFT lookup endpoints (paid via x402) tags: - Resource Group source: openapi/ibanforge-bic-api-openapi.yml - term: Compliance definition: Compliance check endpoint — IBAN validation + sanctions + SEPA + VoP + risk score (paid via x402) tags: - Resource Group source: openapi/ibanforge-compliance-api-openapi.yml - term: Credits definition: Prepaid credit bundles — pay once in USDC (x402), get an API key with N credits; batch validation debits 1 credit per IBAN tags: - Resource Group source: openapi/ibanforge-credits-api-openapi.yml - term: Free definition: Free endpoints — no payment required tags: - Resource Group source: openapi/ibanforge-free-api-openapi.yml - term: IBAN definition: IBAN validation endpoints (paid via x402) tags: - Resource Group source: openapi/ibanforge-iban-api-openapi.yml - term: MCP definition: Model Context Protocol endpoint for AI agents (Streamable HTTP) tags: - Resource Group source: openapi/ibanforge-mcp-api-openapi.yml - term: Swiss Clearing definition: Swiss BC-Nummer / IID clearing lookup (paid via x402) tags: - Resource Group source: openapi/ibanforge-swiss-clearing-api-openapi.yml - term: AccountKey definition: 'Object declared by the contract with fields: key_prefix, created_at, plan, allowance, credits, subscription, calls_this_month, last_call_at, alerts, address_proven, actions.' tags: - Object source: openapi/ibanforge-account-api-openapi.yml#/components/schemas/AccountKey - term: ApiError definition: 'Object declared by the contract with fields: error, message.' tags: - Object source: openapi/ibanforge-account-api-openapi.yml#/components/schemas/ApiError - term: AccountOverview definition: 'Object declared by the contract with fields: email, session_expires_at, month, page, pages, keys, inactive_keys.' tags: - Object source: openapi/ibanforge-account-api-openapi.yml#/components/schemas/AccountOverview - term: StatsOverview definition: 'Object declared by the contract with fields: total_operations, by_type, total_revenue_usdc, total_revenue_attempted_usdc, revenue_note, top_countries, last_7_days.' tags: - Object source: openapi/ibanforge-api-keys-api-openapi.yml#/components/schemas/StatsOverview - term: BICLookupResult definition: 'Object declared by the contract with fields: attribution, bic, bic8, bic11, found, valid_format, institution, country, city, address, address_available, postal_address. (14 more)' tags: - Object source: openapi/ibanforge-bic-api-openapi.yml#/components/schemas/BICLookupResult - term: ComplianceResult definition: 'Object declared by the contract with fields: sanctions, reachability, vop, risk_score, risk_level, flags.' tags: - Object source: openapi/ibanforge-compliance-api-openapi.yml#/components/schemas/ComplianceResult - term: IBANValidationResult definition: 'Object declared by the contract with fields: trial, attribution, iban, valid, bank_code_holder, checks, national_check_digits, country, check_digits, bban, bic, formatted. (14 more)' tags: - Object source: openapi/ibanforge-compliance-api-openapi.yml#/components/schemas/IBANValidationResult - term: BicComplianceResponse definition: 'The answer to POST /v1/iban/compliance with a `bic`: the bank screened directly, without an IBAN. `found` says whether our directory names the institution, independently of the screen: found false with bank_sanctioned true is a real combination.' tags: - Object source: openapi/ibanforge-compliance-api-openapi.yml#/components/schemas/BicComplianceResponse - term: ReferenceCheckBlock definition: 'Served inside POST /v1/iban/validate when a `reference` was supplied. Carries TWO independent verdicts: `valid` (the reference checksum) and `pairing` (whether it may legally travel with this account). A reference can be arithmetically valid and still illegal on that IBAN, and the reverse. Each verdict names its own document.' tags: - Object source: openapi/ibanforge-compliance-api-openapi.yml#/components/schemas/ReferenceCheckBlock - term: IBANFormatResult definition: 'Object declared by the contract with fields: iban, valid, formatted, country, check_digits, bban, error, error_detail, upgrade_to_full_validation.' tags: - Object source: openapi/ibanforge-free-api-openapi.yml#/components/schemas/IBANFormatResult - term: HealthResponse definition: 'Object declared by the contract with fields: status, version, served_at, uptime_seconds, bic_database_entries, bic_data_last_updated, bic_sources, frozen_bic_sources.' tags: - Object source: openapi/ibanforge-free-api-openapi.yml#/components/schemas/HealthResponse - term: PaymentReferenceResult definition: 'Object declared by the contract with fields: reference, scheme, valid, status, check_digit_expected, also_valid_as, source, as_of, note, pairing_verdict.' tags: - Object source: openapi/ibanforge-free-api-openapi.yml#/components/schemas/PaymentReferenceResult - term: ChClearingResult definition: 'Object declared by the contract with fields: attribution, iid, found, institution, address, bic, payment_services, sic_iid, qr_iid, qr_iid_source, qr_iids, valid_on. (2 more)' tags: - Object source: openapi/ibanforge-swiss-clearing-api-openapi.yml#/components/schemas/ChClearingResult