v1

latestOpenAPI 3.0.02026-07-22132134279.3 KB

consent_management

Consent list

Returns all data sharing information for an end user. Use this endpoint to list an end user's current data sharing choices. Each of the end user's connected apps has a separate consent which is detailed in the response by a consent object. The consent object includes details such as the app's id, name, icon, and the sharing status of the end-user's accounts.

get/api/{version}/consent_management

Path parameters

versionstring required

Example:v4

API version. Indicates which FDX version is in use.

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

All 132 operations