|An identifier that uniquely identifies the bank or financial institution on the OBP-API instance.
|
|### Format
|
|`bank_id` **SHOULD be of the form `<human-friendly>-<UUID>`** — a short, readable prefix that names the institution, followed by a hyphen and a UUID. The human-friendly prefix preserves scannability in URLs and logs; the UUID suffix guarantees global uniqueness across OBP instances and federations.
|
|Examples:
|
|- `bisb-7f3a9c2b-1d4e-4b6a-9c0f-5e2d1a3b8c0d`
|- `bnpp-irb-it-01-2a3b...c4d5`
|
|It SHOULD NOT contain spaces. It MUST be unique on the OBP-API instance (enforced at the database level) and SHOULD be globally unique across all OBP instances (achieved by the UUID suffix).
|
|### Earlier conventions
|
|Older OBP releases used purely human-friendly identifiers like `bnpp-irb.01.it.it` (sandbox convention: `financialinstitution.sequence.region.language`) or the institution's BIC. Existing bank_ids in production will not be renamed retroactively — the new convention applies to **newly created banks** going forward. Federation logic must therefore handle both shapes (with and without UUID suffix) indefinitely.
|
|Example value: gh.29.uk
|
|## Version history
|
|The JSON field name for this identifier changed across OBP-API versions:
|
|- **v6.0.0+** (current): `bank_id` — the canonical field name in both request and response bodies (e.g. `PostBankJson600`, `BankJson600`).
|- **v5.0.0**: `id` (Option[String]) — see `PostBankJson500` / `BankJson500`.
|- **v4.0.0**: `id` (String), plus a now-removed `short_name` field — see `PostBankJson400` / `BankJson400`.
|
|The v6 createBank request body shape is exactly:
|`bank_id`, `bank_code`, `full_name`, `logo`, `website`, `bank_routings`.
|
|If you're regenerating client code from older docs, samples, or LLM training data, double-check
|the field name — sending `id` to v6 endpoints will silently produce an empty `bank_id` and
|fail validation with a confusing length error.