Block an account

This endpoint is used to delete existing data and block new data from being stored on the specified account. This may be necessary in order to comply with certain rules, regulations, or standards.
This endpoint does several things.

1. It immediately and permanently deletes most data from the account object. Certain information is retained that is necessary for MX to prevent the account from being re-added.
2. It prevents MX from creating or storing any additional data associated with the account, for example transactions, holdings, statements, etc.
3. It immediately and permanently deletes all data associated with the account, for example transactions, holdings, statements, etc.

This action is scoped to the member the account belongs to. This means that if the real world account is connected or reconnected via another member, the block will have no effect on that account.
This action cannot be taken on manual accounts, in other words accounts with is_manual is true. Attempting to perform a block on a manual account will result in a 400 Bad Request error with the message Manually created accounts cannot be blocked.
Objects deleted as a result of blocking an account will issue a webhook for that object with the action set to deleted. For example, account deleted, transaction deleted, etc. There is no special webhook or action for blocking.
This endpoint accepts the optional MX-Skip-Webhook header and skip_webhook parameter.

PUT

/accounts/{account_guid}/block

Path Parameters

Field	Required	Type
account_guid The unique identifier for the account. Defined by MX	Required	String

Loading...