MOmodernfi
Institution Opt-Outs

Add Account Institution Opt Out

Changed on

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.

post/digital-banking/v1/accounts/{account_id}/institution-opt-outs

Request

Path parameters

string uuid required
OR
string required

Query parameters

id_type'INSTITUTION'

Type of the account id. Institution accounts ids are external ids and come from the institution.

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

Request body

federal_idstring 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_bystring email required

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

Response

Successful Response

is_editableboolean 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.

Changes