## Get bank detail

`GET /v1/bank-details/:id`

Returns a bank detail by ID with all record fields.

## Parameters

| Parameter | Type | Required | Description |
|----------|-----|:-----:|---------|
| `id` (path) | number | yes | Bank detail ID |

## Examples

### curl — personal key

```bash
curl "https://vibecode.bitrix24.com/v1/bank-details/19" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth app

```bash
curl "https://vibecode.bitrix24.com/v1/bank-details/19" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

### JavaScript — personal key

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/bank-details/19', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Account:', data.name, '— BIC', data.rqBik)
```

### JavaScript — OAuth app

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/bank-details/19', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()
```

## Response fields

| Field | Type | Description |
|------|-----|---------|
| `success` | boolean | Always `true` on success |
| `data` | object | The bank detail object |
| `data.id` | number | Bank detail ID |
| `data.entityId` | number | ID of the owner requisite. Source: `GET /v1/requisites` |
| `data.countryId` | number | Country ID. `0` — country not set |
| `data.name` | string | Bank detail name |
| `data.active` | boolean | Whether the record is active |
| `data.sort` | number | Sort order |
| `data.code` | string \| null | Symbolic code for external integrations |
| `data.xmlId` | string \| null | External identifier for synchronization |
| `data.originatorId` | string \| null | Source system ID |
| `data.comments` | string \| null | Comment on the record |
| `data.createdAt` | datetime | Creation date (ISO 8601) |
| `data.updatedAt` | datetime \| null | Last modification date (ISO 8601) |
| `data.createdBy` | number | Creator ID |
| `data.modifyBy` | number \| null | Last editor ID |
| `data.rqBankName` | string \| null | Bank name |
| `data.rqBankAddr` | string \| null | Bank address |
| `data.rqBankRouteNum` | string \| null | Bank routing number |
| `data.rqBankCode` | string \| null | Bank code |
| `data.rqBik` | string \| null | BIC |
| `data.rqAccNum` | string \| null | Current account |
| `data.rqCorAccNum` | string \| null | Correspondent account |
| `data.rqSwift` | string \| null | SWIFT code |
| `data.rqIban` | string \| null | IBAN |
| `data.rqIik` | string \| null | IIK (Kazakhstan) |
| `data.rqMfo` | string \| null | MFO (Ukraine) |
| `data.rqAccName` | string \| null | Account name |
| `data.rqAccCurrency` | string \| null | Account currency |
| `data.rqAccType` | string \| null | Account type |
| `data.rqAgencyName` | string \| null | Agency name |
| `data.rqBic` | string \| null | BIC (international, separate from `rqBik`) |
| `data.rqCodeb` | string \| null | Bank code (France, `RQ_CODEB`) |
| `data.rqCodeg` | string \| null | Branch code (France, `RQ_CODEG`) |
| `data.rqRib` | string \| null | RIB (France) |

Full list of fields with types and the `readonly` flag — [Bank detail fields](/docs/entities/bank-details/fields).

## Response example

```json
{
  "success": true,
  "data": {
    "id": 19,
    "entityId": 1,
    "countryId": 0,
    "createdAt": "2026-06-10T10:14:29.000Z",
    "updatedAt": null,
    "createdBy": 1,
    "modifyBy": null,
    "name": "Current account",
    "code": null,
    "xmlId": null,
    "originatorId": null,
    "active": true,
    "sort": 500,
    "rqBankName": null,
    "rqBankCode": null,
    "rqBankAddr": null,
    "rqBankRouteNum": null,
    "rqBik": "044525225",
    "rqMfo": null,
    "rqAccName": null,
    "rqAccNum": "40702810500000000001",
    "rqAccType": null,
    "rqIik": null,
    "rqAccCurrency": null,
    "rqCorAccNum": null,
    "rqIban": null,
    "rqSwift": "SABRRUMM",
    "rqBic": null,
    "rqCodeb": null,
    "rqCodeg": null,
    "rqRib": null,
    "rqAgencyName": null,
    "comments": null
  }
}
```

## Error response example

404 — bank detail not found:

```json
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "The RequisiteBankDetail with ID '999999' is not found"
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 404 | `ENTITY_NOT_FOUND` | No bank detail with this ID found |
| 403 | `SCOPE_DENIED` | API key lacks the `crm` scope |
| 401 | `TOKEN_MISSING` | API key has no configured tokens |

Full list of common API errors — [Errors](/docs/errors).

## Known specifics

**`entityTypeId` is absent from the response.** The `entityTypeId` field is passed on bank detail creation (always `8` — requisite), but it is not returned in the `get` and `list` responses. This is an owner field, write-only.

**`countryId` equals `0` for records without a country.** If no country is set on creation, the field returns the numeric value `0`, not `null`.

## See also

- [Bank detail fields](/docs/entities/bank-details/fields)
- [List bank details](/docs/entities/bank-details/list)
- [Update bank detail](/docs/entities/bank-details/update)
- [Delete bank detail](/docs/entities/bank-details/delete)
- [Requisites](/docs/entities/requisites)
- [Limits and optimization](/docs/optimization)