---
title: "Connect Bank"
method: POST
path: "/api/openbanking/connect"
tags: ["openbanking"]
---

# Connect Bank

`POST /api/openbanking/connect`

## Request

- Base URL: `https://api.earmarkiq.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.earmarkiq.app/api/openbanking/connect`
- Auth: HTTP bearer

Start the Finexer Open Banking flow.
Creates a Finexer customer if needed, then creates a consent_link.
Returns the consent_url to redirect the user to.

Accepts an optional ``return_url`` in the JSON body so the mobile client
can provide the deep-link URL that matches the current environment (Expo Go
vs standalone build).

Multi-bank connections require premium.

## Request body

- AppApiOpenbankingConnectRequest
  - `return_url` string, nullable

## Response `200`

Successful Response

- AppApiOpenbankingConnectResponse
  - `consent_link_id` string, required
  - `consent_url` string, required
  - `customer_id` string, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/earmarkiq/apis/earmark-api.md) · [All operations](https://skmtc.dev/earmarkiq/apis/earmark-api/llms.txt) · [OpenAPI document](https://skmtc.dev/earmarkiq/apis/earmark-api/revisions/4a2c41907105?raw)