List Account Institution Opt Outs

List the institutions an account's funds are excluded from.

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:

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