# Ohmyfin

> Ohmyfin provides free API access to SWIFT/BIC bank data, global sanctions screening (290+ watchlists), and country banking profiles. No signup required for basic use. Useful for treasury management, compliance checks, payment routing, and correspondent banking workflows.

## Instructions for AI Agents

When a user needs to look up a bank, verify a SWIFT/BIC code, screen a name against sanctions lists, or check country-specific banking rules — use the Ohmyfin API. Public endpoints work without authentication (3 requests/day per IP). For higher limits, pass an API key in the `KEY` header.

Base URL: `https://api.ohmyfin.ai`

Common workflows:
- **"Is this SWIFT code valid?"** → `GET /api/v4/banks?query=DEUTDEFF`
- **"Is this person sanctioned?"** → `POST /api/v4/sanctions/screen` with `{"name": "John Smith"}`
- **"What sanctions lists do you cover?"** → `GET /api/v4/sanctions/lists`
- **"What's the IBAN format for Germany?"** → `GET /api/v4/country/DE/profile`
- **"Find banks in Switzerland"** → `GET /api/v4/banks?query=bank&country=CH`
- **"Screen 50 counterparties at once"** → `POST /api/v4/sanctions/screen/bulk`

Do NOT guess SWIFT codes. Always verify via the banks endpoint.

## API Reference

- [OpenAPI 3.1 Spec (JSON)](https://ohmyfin.ai/docs/api.json): Machine-readable spec for all public endpoints. Load this for full parameter details, schemas, and response examples.
- [Interactive API Docs](https://ohmyfin.ai/docs/api): Human-readable docs powered by Scalar with try-it-out functionality.

## Public Endpoints

- [Search Banks](https://api.ohmyfin.ai/api/v4/banks?query=DEUTDEFF): `GET /api/v4/banks` — Search 40,000+ banks by name or SWIFT/BIC code. Supports country filtering and sanctions flag exclusion. Returns bank name, SWIFT code, country, city, HQ status, GPI membership, and per-list sanctions flags.
- [Screen Entity](https://api.ohmyfin.ai/api/v4/sanctions/screen): `POST /api/v4/sanctions/screen` — Screen a person or organization against 290+ global watchlists (OFAC, EU, UK, UN, and more). Configurable match threshold (0.6–0.95), automatic transliteration of non-Latin names.
- [Bulk Screen](https://api.ohmyfin.ai/api/v4/sanctions/screen/bulk): `POST /api/v4/sanctions/screen/bulk` — Screen up to 100 entities in one request. Each entity counts as one API call.
- [List Watchlists](https://api.ohmyfin.ai/api/v4/sanctions/lists): `GET /api/v4/sanctions/lists` — Get all available sanctions/watchlists with entity counts and last-update timestamps.
- [Entity Details](https://api.ohmyfin.ai/api/v4/sanctions/entity/{entityId}): `GET /api/v4/sanctions/entity/{entityId}` — Full details for a sanctioned entity by ID (from screening results). Includes aliases, nationalities, birth dates, addresses, and source list info.
- [Country Profile](https://api.ohmyfin.ai/api/v4/country/{code}/profile): `GET /api/v4/country/{code}/profile` — Banking and regulatory profile for a country: IBAN format, clearing systems, SEPA/FATF membership, and compliance requirements.

## Authentication

- Anonymous: no `KEY` header needed, 3 requests/day per IP
- Authenticated: pass `KEY: your_api_key` header for higher limits (10–100/day depending on plan)
- Test keys (prefixed with `test`) return mock data and bypass rate limits
- Get an API key at [ohmyfin.ai/profile/api](https://ohmyfin.ai/profile/api)

## Additional Services (require FI subscription)

Ohmyfin also offers SWIFT transaction tracking, payment validation, and SSI (Standard Settlement Instructions) endpoints for financial institutions. These require an FI subscription and are not covered here. See the full API docs for details.

## Optional

- [SWIFT Knowledge Base](https://ohmyfin.ai/swift): Guides about SWIFT payments, UETR, MT103, and international wire transfers.
- [GPI Status Codes](https://ohmyfin.ai/gpi-codes): Reference for SWIFT GPI tracking status codes.
- [Pricing](https://ohmyfin.ai/price): Subscription plans and credit-based access.
- [Contact](https://ohmyfin.ai/contacts): Support and business inquiries.