v1

latestOpenAPI 3.0.02026-07-22132134279.3 KB

consent_management

Update Consented Account

Updates a consent by enabling or disabling an account. Use this endpoint when an end user wants to change whether or not an account is shared with an app.

put/api/{version}/consent_management/{ConsentPublicId}/accounts/{AccountId}

Path parameters

ConsentPublicIdstring required

The consent id. This value is returned in the GET Consent List as id.

AccountIdstring required

The account id selected for update.

versionstring required

Example:v4

API version. Indicates which FDX version is in use.

Request body

enabledboolean required

Response

Successful response

idstring

application_namestring

application_icon_urlstring nullable

created_atstring

last_accessedstring

auto_enable_future_accountsboolean

consented_onstring

revoked_atstring nullable

Example response

{
  "id": "_sadfa3CKHJ23LKJHKJHLlNaODPmH1LqSb4",
  "application_name": "Centz",
  "application_icon_url": "https://www.example.com",
  "created_at": "2024-06-14T19:48:18.354Z",
  "last_accessed": "2024-05-14T19:48:31.352Z",
  "accounts": [
    {
      "enabled": true,
      "nickname": "Lacrosse Fund",
      "account_id": "1234123412341234",
      "account_number_display": "XXXXXXXX1111"
    }
  ],
  "auto_enable_future_accounts": true,
  "consented_on": "2024-05-14T19:48:18.352Z"
}