---
title: "Whether Ponto can reach the bank behind an IBAN"
method: GET
path: "/api/v1/banking/ponto/coverage"
tags: ["Money"]
---

# Whether Ponto can reach the bank behind an IBAN

`GET /api/v1/banking/ponto/coverage`

## Request

- Base URL: `http://localhost:5180`
- URL: `http://localhost:5180/api/v1/banking/ponto/coverage`
- Auth: API key in cookie `better-auth.session_token`

Read off the IBAN, never asked. The IBAN carries the bank code, and the bank code is what says which institution holds the account. The two mistakes do not cost the same, so a bank we have written down is `supported`, a country Ponto operates in is `unknown` and worth trying, and everything else is `unsupported` and the owner imports statements by hand instead. `offered` says whether this deployment can start a connection at all.

## Query parameters

- `iban` string, required

## Response `200`

What can be offered for this IBAN.

- object
  - `ok` unknown, required
  - `data` object, required
    - `coverage` 'supported' | 'unknown' | 'unsupported', required: `supported` where the IBAN names a bank we have written down, `unknown` where Ponto operates in the country but the bank is not on our list and it is worth trying, `unsupported` where there is nothing to offer.
    - `bank` string: The bank the IBAN identifies, where it identifies one we know.
    - `message` string, required: What to tell the owner. Always literally true of this IBAN, of this deployment and of this team: where no bank can be connected here, or not by this team yet, the sentence says so rather than leaving the reader to find out at the refusal.
    - `available` boolean, required: Whether this deployment can talk to Ponto at all. False makes every coverage moot.
    - `offered` boolean, required: Whether this team may start a new bank connection or pair an account on one.
  - `meta` object, required
    - `requestId` string, required: Echoed in the x-request-id header. Quote it in a bug report.

## Other responses

- `400`: No `iban` on the query.

---

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