> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# finAPI

> Search finAPI's bank catalog, inspect client configuration, and provision end users for BaFin-regulated open banking access

## At a glance

* **Availability**: Experimental ([how to enable](/cloud/integrations)).
* **Auth**: OAuth 2.0 (client credentials).
* **Connection**: Veryfront mints machine-to-machine tokens from the client ID and secret in the project's environment variables.
* **Docs**: [https://docs.finapi.io/](https://docs.finapi.io/)

## Credentials

Set these per environment. See [Connect an integration](/cloud/integrations).

| Variable               | Required | Description                                                                                                       |
| ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------- |
| `FINAPI_CLIENT_ID`     | Yes      | finAPI Access client identifier issued with your license or sandbox registration [Docs](https://docs.finapi.io/). |
| `FINAPI_CLIENT_SECRET` | Yes      | finAPI Access client secret paired with the client identifier [Docs](https://docs.finapi.io/).                    |

## Setup

1. **Get client credentials**: Request finAPI Access credentials (client\_id and client\_secret) from finAPI at [https://www.finapi.io/en/contact-us/](https://www.finapi.io/en/contact-us/). New customers start with a free sandbox client; the Live environment requires a license agreement.
2. **Set environment variables**: Add FINAPI\_CLIENT\_ID and FINAPI\_CLIENT\_SECRET to your .env.
3. **Verify access**: Run Get Client Configuration. Access tokens are minted automatically via the OAuth2 client\_credentials grant against [https://live.finapi.io/api/v2/oauth/token](https://live.finapi.io/api/v2/oauth/token) - no user login is involved.

* This connector pins the Live environment (live.finapi.io). For sandbox testing, point a copy of the connector at sandbox.finapi.io - the token and API paths are identical. Live access may additionally be IP-restricted.
* Most finAPI data endpoints (bank connections, accounts, transactions, securities) require a USER access token obtained per end user via the password grant. The client\_credentials token used here only covers client-level endpoints: bank catalog search, client configuration, and user provisioning.
* Users created on the Live instance count towards your finAPI license agreement.

Provider API reference: [https://docs.finapi.io/](https://docs.finapi.io/)

## Tools

| Tool                     | Access | Description                                                                                                                        |
| ------------------------ | ------ | ---------------------------------------------------------------------------------------------------------------------------------- |
| Search Banks             | Read   | Search finAPI's database of supported banks by name, BLZ, BIC, or city, with interface and location filters                        |
| Get Bank                 | Read   | Retrieve a single bank from finAPI's catalog by its identifier, including supported interfaces and login requirements              |
| Get Client Configuration | Read   | Get your finAPI client's configuration: token validity periods, callback URLs, enabled bank sets, and consent settings             |
| Create User              | Write  | Provision a new finAPI end user (one per application end user); user-level operations then authenticate with that user's own token |

## Example prompts

* Search finAPI for a German bank by name or BLZ and show which banking interfaces it supports.
* Show my finAPI client configuration and summarize token validity periods and enabled bank sets.