Add Account Institution Opt Out

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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

account_idstringRequired

Query parameters

id_typeenum or nullOptional

Type of the account id. Must be 'institution' or 'None'.

Allowed values:

Request

This endpoint expects an object.

federal_idstringRequiredformat: "^[FN]?\d{1,7}$"<=8 characters

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_bystringRequiredformat: "email"<=128 characters

Email of the user making the change, recorded in the exclusion history.

Response

Successful Response

opt_outslist of objects

Institutions this account’s funds are excluded from: every owner’s exclusions combined, ordered by federal id. Empty when nothing is excluded.

is_editableboolean

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

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error