Accounts
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.
- 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.
- It prevents MX from creating or storing any additional data associated with the account, for example transactions, holdings, statements, etc.
- It immediately and permanently deletes all data associated with the account, for example transactions, holdings, statements, etc.
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
Block an account
Authorizations
To authenticate with the Platform API, include your Base64-encoded client_id and api_key in the Authorization header of every request:
-H 'Authorization: Basic BASE_64_ENCODING_OF{client_id:api_key}'
Headers
MX Platform API version.
Example:
"v20250224"
Path Parameters
The unique id for an account.
The unique identifier for a user, beginning with the prefix USR-.
Response
200
OK

