---
updatedAt: 2025-09-24T14:10:01.000Z
agentTools:
projectIndex: https://docs.bridgeapi.io/v2021.06.01/llms.txt
---
# Bank resource
| Field | Description |
| --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`
*long* | Bank's unique identifier. |
| `name`
*string* | Bank's name. |
| `parent_name`
*string* | If the bank is a subsidiary, then we will expose it's parent name here |
| `country_code`
*string* | Bank's [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code.
Currently we only support banks from `FR`, `ES`, `IT`, `PT`, `DE`, `NL` and `LU`. |
| `primary_color` | Hexadecimal code (without "#") |
| `secondary_color` | Hexadecimal code (without "#") |
| `logo_url` | |
| `form`
*array* | An array of [bank field](#section-bank-field) that holds the online bank connection form information and requirements. |
| `capabilities`
*array* | An array of the bank's capabilities : `ais`, `account_check`, `single_transfer`, `bulk_transfer`, `single_payment`, `single_payment_scheduled`, `bulk_payment` and `bulk_payment_scheduled`. |
| `transfer`
*list* | This field is exposed if the bank has `single_transfer` and/or `bulk_transfer`.
The list contains fields: `nb_max_transactions`, `max_size_label` and `multiple_dates_transfers`. |
| `payment`
*list* | This field is exposed if the bank has `single_payment` and/or `bulk_payment`.
The list contains fields: `nb_max_transactions`, `max_size_label`, `multiple_dates_payments` and `sender_iban_available`. |
| `channel_type`
*array* | Channel type available for this bank. Possible values: "dsp2", "direct\_access" |
## BANK FIELD
| Field | Description |
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `label`
*string* | Field's name on the bank's website. |
| `type`
*string* | Field's type.
Possible values: `USER`, `PWD`, `PWD2`.
Depending on the bank:
- `USER` represents a customer's id.
- `PWD` represents a customer's password.
- `PWD2` represents an additional customer's password, memorable question or passphrase. |
| `isNum`
*string* | "1" meaning that the field only accepts numbers. |
| `maxLength`
*number* | Field's maximum length.
`null` meaning their is no limit. |
## Example bank resource
```json
{
"id": 17,
"name": "La Banque Postale Particulier",
"parent_name": "La Banque Postale",
"country_code": "FR",
"primary_color": null,
"secondary_color": null,
"logo_url": "https://web.bankin.com/img/banks-logo/france/02_BanquePostale@2x.png",
"form": [
{
"label": "Identifiant",
"type": "USER",
"isNum": "0",
"maxLength": 11
},
{
"label": "Mot de passe",
"type": "PWD",
"isNum": "1",
"maxLength": 6
}
],
"authentication_type": "INTERNAL_CREDS",
"capabilities": [
"ais",
"single_transfer",
"single_payment"
],
"transfer": {
"nb_max_transactions": 1,
"max_size_label": 140,
"multiple_dates_transfers": false
},
"payment": {
"nb_max_transactions": 1,
"max_size_label": 140,
"multiple_dates_payments": false,
"sender_iban_available": true
},
"channel_type": [
"dsp2",
"direct_access"
]
}
```