API reference
API reference
Every endpoint of the service, generated from its OpenAPI description.
The pages in this section are generated at build time from openapi.yaml,
the same document a running instance serves at /openapi.yaml. They cannot
drift from the service, because there is nothing hand written to drift.
Two surfaces exist side by side. The v2 routes are the current API, with a structured answer per check. The v1 routes reproduce openiban.com exactly, so an existing client changes its base URL and nothing else.
Two properties of the data are worth reading before integrating:
- A check with
"ok": nullcould not be performed. That is not a failure, and the overallvaliddoes not count it as one. - Scheme membership is recorded per institution, not per account. A status
of
unknownmeans the BIC is absent from the EPC register, which is common for banks reachable through a central institution, so it must not be read as "not supported".