API / Developer

OpenAPI

Also known as: Swagger, OAS

Definition

OpenAPI (formerly Swagger) is the open standard for describing REST APIs in YAML/JSON format. It enables generating interactive docs, SDKs and mock servers automatically.

LATAM context

An OpenAPI spec describes every endpoint, its parameters, request/response schemas, authentication and examples. It's the shared language between frontend devs, backend devs and testing tools.

Concrete example

finO$'s OpenAPI spec is published, so you can generate a Go client without waiting for an official SDK: `openapi-generator-cli generate -i https://api.getfinos.com/api/v1/openapi.json -g go -o ./finos-go-sdk`.

How it shows up on your bank statement

It's the formal description of an API, not something present in a bank statement. Its practical value is that clients get generated, responses get validated, and documentation gets written from that one file instead of twice.

How does finO$ handle this?

The spec lives at api.getfinos.com/api/v1/openapi.json and is the source for this site's API reference.

Related terms

REST API

Need to convert bank statements into structured data?

Start free Go to my dashboard

See the API reference

Just one file? Use the free converter to convert your bank statement to Excel.

Frequently asked questions about OpenAPI

What's the point of the OpenAPI file if docs already exist?

Because it's executable: you can generate a client in your language, load it into tools like Postman, or automatically validate that responses match the contract. Documentation explains; a specification gets verified.

If a field isn't in the OpenAPI spec, does it exist?

Treat it as if it doesn't. The specification is the contract, and building on undocumented fields means relying on something that can change with no warning and no new version.