MOmodernfi
Institution Opt-Outs

Remove Account Institution Opt Out

Changed on

Remove one institution, of either type, from an account sole owner's exclusions and return the account's exclusions. Removing an institution that is not excluded changes nothing. Rejected with 403 when the institution does not allow self-service exclusions or the account has more than one owner.

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

Request

Path parameters

string uuid required
OR
string required
federal_idstring required

Federal id of the excluded institution, as returned by the list call.

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

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