IBANforge · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for IBANforge Free API
13 actions
13 updates
phrasing
extends
openapi/ibanforge-free-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for IBANforge's API. It is a proposal applied on top of the contract, not a document IBANforge publishes.
What the actions change
x-apievangelist-phrasing
Targets 13
$.info
$.paths['/v1/iban/format'].get
$.paths['/v1/ch/qr-bill/check'].post
$.paths['/v1/address/check'].post
$.paths['/v1/reference/validate'].get
$.paths['/v1/reference/validate'].post
$.paths['/v1/iban/structure'].get
$.paths['/v1/iban/structure/{country}'].get
$.paths['/v1/feedback'].post
$.paths['/v1/feedback/{id}'].get
$.paths['/v1/test-iban'].get
$.paths['/v1/demo'].get
$.paths['/health'].get
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for IBANforge Free API
version: 1.0.0
extends: openapi/ibanforge-free-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 12
- target: $.paths['/v1/iban/format'].get
update:
x-apievangelist-phrasing:
intent: Check an IBAN's format and checksum for free
effect: read
questions:
- Is there a free way to check an IBAN's mod-97 checksum and length?
- Does the free format check tell me if the bank code actually exists?
- Can I pass an IBAN written in groups of four with spaces?
instructions:
- text: Check the format of IBAN {iban}.
slots:
iban: query.iban
- text: Pre-filter {iban} for a malformed checksum or wrong length, no key needed.
slots:
iban: query.iban
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/ch/qr-bill/check'].post
update:
x-apievangelist-phrasing:
intent: Check a Swiss QR-bill payload
effect: read
questions:
- Does my Swiss QR-bill still use a combined (type K) address?
- Can I verify the QR reference and QR-IBAN pairing in a QR-bill text?
- Will my QR-bill stop working after the November 2026 cutoff?
instructions:
- text: 'Check this Swiss QR-bill payload: {payload}'
slots:
payload: requestBody.payload
- text: Validate the QR-bill text {payload} and propose a structured address if needed.
slots:
payload: requestBody.payload
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/address/check'].post
update:
x-apievangelist-phrasing:
intent: Check a postal address against ISO 20022 rules
effect: read
questions:
- Is my structured postal address ready for the November 2026 ISO 20022 deadline?
- Which payment schemes can a postal address be checked against?
- Why is the cbpr+ scheme refused for address checks?
instructions:
- text: Check address {address} against the {scheme} rules.
slots:
scheme: requestBody.scheme
address: requestBody.address
- text: 'Validate this ISO 20022 PostalAddress for Fedwire: {address}; use scheme {scheme}.'
slots:
scheme: requestBody.scheme
address: requestBody.address
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/reference/validate'].get
update:
x-apievangelist-phrasing:
intent: Validate a structured payment reference
effect: read
questions:
- Is this RF creditor reference checksum correct?
- Which payment reference formats can be checked for free?
- Why does a Norwegian KID come back as unverifiable?
instructions:
- text: Validate payment reference {reference}.
slots:
reference: query.reference
- text: Check {reference} as a {reference_type} reference.
slots:
reference: query.reference
reference_type: query.reference_type
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/reference/validate'].post
update:
x-apievangelist-phrasing:
intent: Validate a payment reference sent as JSON
effect: read
questions:
- Can I send a payment reference in a JSON body instead of the query string?
- What if my reference has characters that are awkward to URL-encode?
instructions:
- text: Validate reference {reference} by posting it in a JSON body.
slots:
reference: requestBody.reference
- text: Post {reference} as JSON and check it as type {reference_type}.
slots:
reference: requestBody.reference
reference_type: requestBody.reference_type
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/iban/structure'].get
update:
x-apievangelist-phrasing:
intent: List all supported IBAN countries
effect: read
questions:
- Which countries use IBANs, and how long is each one?
- Which IBAN countries are SEPA members?
instructions:
- text: List every supported IBAN country with its length.
- text: Show all IBAN countries and whether they are in SEPA.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/iban/structure/{country}'].get
update:
x-apievangelist-phrasing:
intent: Get the IBAN format template for a country
effect: read
questions:
- Where does the bank code sit inside a country's IBAN?
- Can I get an example IBAN for a specific country to copy?
- Is Verification of Payee mandatory in a given country?
instructions:
- text: Show the IBAN structure for {country}.
slots:
country: path.country
- text: Give me the BBAN field positions and an example IBAN for {country}.
slots:
country: path.country
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/feedback'].post
update:
x-apievangelist-phrasing:
intent: Report wrong data or claim an x402 refund
effect: write
questions:
- How do I report a wrong or stale BIC answer?
- Can I get a refund for a paid x402 call that answered wrongly?
instructions:
- text: Report that {endpoint} returned {got} instead of {expected}.
slots:
endpoint: requestBody.endpoint
got: requestBody.got
expected: requestBody.expected
- text: Claim a refund for x402 transaction {tx_hash} on {endpoint}.
slots:
tx_hash: requestBody.tx_hash
endpoint: requestBody.endpoint
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/feedback/{id}'].get
update:
x-apievangelist-phrasing:
intent: Check the status of a feedback report
effect: read
questions:
- Has my data error report been handled yet?
- What details of a submitted report are public?
instructions:
- text: Check the status of feedback report {id}.
slots:
id: path.id
- text: Tell me where report {id} stands.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/test-iban'].get
update:
x-apievangelist-phrasing:
intent: Generate test IBANs with real bank codes
effect: read
questions:
- Where can I get test IBANs that use real registered bank codes?
- Which countries can test IBANs be generated for?
instructions:
- text: Generate {count} test IBANs for {country}.
slots:
count: query.count
country: query.country
- text: Give me a test IBAN from a random supported country.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/demo'].get
update:
x-apievangelist-phrasing:
intent: See free demo validation results
effect: read
questions:
- Can I see sample IBAN validation and compliance results without paying?
- What does a validation answer look like on the official example IBANs?
instructions:
- text: Show me the free demo results.
- text: Fetch the example validations, compliance check and BIC rows from the demo.
method: generated
generated: '2026-09-26'
- target: $.paths['/health'].get
update:
x-apievangelist-phrasing:
intent: Check API health and uptime
effect: read
questions:
- Is the IBANforge API up right now?
- What is the current uptime of the service?
instructions:
- text: Check the API health status.
- text: Show the service uptime and basic stats.
method: generated
generated: '2026-09-26'