IBANforge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for IBANforge IBAN API

3 actions 3 updates phrasing extends openapi/ibanforge-iban-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.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/v1/iban/validate'].post
$.paths['/v1/iban/batch'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for IBANforge IBAN API
  version: 1.0.0
extends: openapi/ibanforge-iban-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: 2
- target: $.paths['/v1/iban/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a single IBAN
      effect: read
      questions:
      - Is this IBAN valid, and which bank and BIC does it map to?
      - Can I try IBAN validation without a key or payment?
      - Can I check a payment reference alongside the IBAN in one call?
      instructions:
      - text: Validate IBAN {iban}.
        slots:
          iban: requestBody.iban
      - text: Validate {iban} and check reference {reference} against it.
        slots:
          iban: requestBody.iban
          reference: requestBody.reference
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/iban/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate up to 100 IBANs at once
      effect: read
      questions:
      - Can I validate a whole list of IBANs in one request?
      - What does a batch of 100 IBANs cost?
      instructions:
      - text: 'Validate these IBANs in one batch: {ibans}.'
        slots:
          ibans: requestBody.ibans
      - text: Run a batch check on the list {ibans}.
        slots:
          ibans: requestBody.ibans
      method: generated
      generated: '2026-09-26'