v1

latestOpenAPI 3.0.02026-07-22132134279.3 KB

consent_management

Update Auto Access

Set a consented app's auto update status. Use this endpoint to allow or disallow an app to automatically add new accounts to an end user's consent. This sets the consent object's auto_enable_future_accounts field to true or false.

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

Request body

automatic_accessboolean required

Example request

{
  "automatic_access": true
}

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"
}