> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.modernfi.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.modernfi.com/_mcp/server.

# Add Account Institution Opt Out

POST https://api.modernfi.com/digital-banking/v1/accounts/{account_id}/institution-opt-outs
Content-Type: application/json

Exclude one institution for an account's sole owner and return the account's exclusions. Rejected with 403 when the institution does not allow self-service exclusions or the account has more than one owner.

Reference: https://docs.modernfi.com/api-reference/accounts/institution-opt-outs/add

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://api.modernfi.com` (Production, default)
- `https://api.uat.modernfi.com` (UAT)
- `http://localhost:8000` (Local)

## Request

### Path parameters

- `account_id` (DigitalBankingV1AccountsAccountIdInstitutionOptOutsPostParametersAccountId, required)

### Query parameters

- `id_type` (enum, optional, nullable) — Type of the account id. Must be 'institution' or 'None'.
  - Allowed values: `INSTITUTION`

### Body (application/json)

This endpoint expects an AddAccountInstitutionOptOutRequest.

- `federal_id` (string, required) — Institution to exclude, as a federal id. A bare certificate number is taken as the caller's own institution type. Only institutions of the caller's own type can be added. Adding an institution that is already excluded changes nothing.
- `submitted_by` (string, required) — Email of the user making the change, recorded in the exclusion history.

## Response

### 200

Successful Response

- `opt_outs` (list of InstitutionOptOutDetail, required) — Institutions this account's funds are excluded from: every owner's exclusions combined, ordered by federal id. Empty when nothing is excluded.
- `is_editable` (boolean, required) — True when the depositor may change these exclusions with the add and remove calls: the institution allows self-service exclusions and the account has a single owner. When false, show the exclusions read-only; the institution changes them.

## Errors

### 400 Bad Request Error

Bad Request - Invalid input or validation error

- `detail` (list of map from string to any, required)

### 401 Unauthorized Error

Unauthenticated - Invalid or missing authentication credentials

- `detail` (string, required)

### 403 Forbidden Error

Unauthorized - Insufficient permissions to access resource

- `detail` (string, required)

### 422 Unprocessable Entity Error

Validation Error

- `detail` (list of ValidationError, optional)

### 500 Internal Server Error

Internal Server Error

- `detail` (string, required)

## Types

### DigitalBankingV1AccountsAccountIdInstitutionOptOutsPostParametersAccountId

- string
- string

### InstitutionOptOutDetail

- `federal_id` (string, required) — Identity of the excluded institution: `F` plus its FDIC certificate number for a bank, or `N` plus its NCUA charter number for a credit union. The letter matters, since a bank and a credit union can share a number.
- `name` (string, required) — Display name: the institution's ModernFi network name when it is a network member, its FDIC/NCUA name otherwise, or the federal id when neither resolves.
- `city` (string, required, nullable) — City of the institution's headquarters; null when the federal id does not resolve.
- `state` (string, required, nullable) — Two-letter state code of the institution's headquarters; null when the federal id does not resolve.

### ValidationError

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)
- `input` (any, optional)
- `ctx` (ValidationErrorCtx, optional)

### ValidationErrorLocItems

- string
- integer

### ValidationErrorCtx

## Examples

**Request**

```json
{
  "federal_id": "string",
  "submitted_by": "string"
}
```

**Response**

```json
{
  "opt_outs": [
    {
      "federal_id": "string",
      "name": "string",
      "city": "string",
      "state": "string"
    }
  ],
  "is_editable": true
}
```

**SDK Code**

```python
import requests

url = "https://api.modernfi.com/digital-banking/v1/accounts/string/institution-opt-outs"

payload = {
    "federal_id": "string",
    "submitted_by": "string"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.modernfi.com/digital-banking/v1/accounts/string/institution-opt-outs';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"federal_id":"string","submitted_by":"string"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.modernfi.com/digital-banking/v1/accounts/string/institution-opt-outs"

	payload := strings.NewReader("{\n  \"federal_id\": \"string\",\n  \"submitted_by\": \"string\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.modernfi.com/digital-banking/v1/accounts/string/institution-opt-outs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"federal_id\": \"string\",\n  \"submitted_by\": \"string\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.modernfi.com/digital-banking/v1/accounts/string/institution-opt-outs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"federal_id\": \"string\",\n  \"submitted_by\": \"string\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.modernfi.com/digital-banking/v1/accounts/string/institution-opt-outs', [
  'body' => '{
  "federal_id": "string",
  "submitted_by": "string"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.modernfi.com/digital-banking/v1/accounts/string/institution-opt-outs");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"federal_id\": \"string\",\n  \"submitted_by\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "federal_id": "string",
  "submitted_by": "string"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.modernfi.com/digital-banking/v1/accounts/string/institution-opt-outs")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```