consent

List consents by an email front-door

List consents belonging to a client by an email

get/consent/dashboard

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/consent/dashboard
  • Auth: HTTP bearer

Response

OK response.

account_idsstring[] required

List of IDs of accounts that were authorised for this consent. The details of the accounts can be looked up using the Accounts API for the appropriate industry.

activeboolean required

Indicates whether consent is active or not

app_logostring required

URL to a logo of your application

app_namestring required

Your application name

arrangement_idstring required

CDR arrangement ID provided by DH.

created_atstring required

When the Consent was created

durationinteger required

The time period access was granted. Its in seconds

end_user_emailstring required

End users email

end_user_idstring required

ID of the end user that authorised the consent

expires_atstring required

RFC3339 date-time that the consent expires (or already expired) at

institution_idstring required

The identifier for the institution the Consent is held with.

institution_logostring required

Institution logo

institution_namestring required

Institution name

institution_typestring required

Institution Type

last_accessedstring required

The last time the ADR, or Fiskil used the consent to access data.

last_consentstring required

The last time the Consent was acknowledged by the End User.

permissionsstring[] required

A list of the data permissions granted.

termination_reasonstring required

Reason for consent termination

Example response

[
  {
    "account_ids": [
      "1234567890",
      "1234567891"
    ],
    "active": true,
    "app_logo": "https://acme.com/app-logo.png",
    "app_name": "MyCoolApp",
    "arrangement_id": "94549a73-a554-4b76-b824-d96898829751",
    "created_at": "2021-03-18T02:46:42Z",
    "duration": 7776000,
    "end_user_email": "tony.stark@example.com",
    "end_user_id": "eu_2yRHN2ag2y4p8kCtm5DOeccZEXB",
    "expires_at": "2023-01-01T10:42:40Z",
    "institution_id": "11",
    "institution_logo": "https://example.com/images/gringotts-logo.png",
    "institution_name": "Gringgotts",
    "institution_type": "banking",
    "last_accessed": "2023-01-02T10:42:42Z",
    "last_consent": "2023-01-01T10:42:40Z",
    "permissions": [
      "accounts",
      "balances",
      "transactions"
    ],
    "termination_reason": "Expired or Revoked"
  },
  {
    "account_ids": [
      "1234567890",
      "1234567891"
    ],
    "active": true,
    "app_logo": "https://acme.com/app-logo.png",
    "app_name": "MyCoolApp",
    "arrangement_id": "94549a73-a554-4b76-b824-d96898829751",
    "created_at": "2021-03-18T02:46:42Z",
    "duration": 7776000,
    "end_user_email": "tony.stark@example.com",
    "end_user_id": "eu_2yRHN2ag2y4p8kCtm5DOeccZEXB",
    "expires_at": "2023-01-01T10:42:40Z",
    "institution_id": "11",
    "institution_logo": "https://example.com/images/gringotts-logo.png",
    "institution_name": "Gringgotts",
    "institution_type": "banking",
    "last_accessed": "2023-01-02T10:42:42Z",
    "last_consent": "2023-01-01T10:42:40Z",
    "permissions": [
      "accounts",
      "balances",
      "transactions"
    ],
    "termination_reason": "Expired or Revoked"
  },
  {
    "account_ids": [
      "1234567890",
      "1234567891"
    ],
    "active": true,
    "app_logo": "https://acme.com/app-logo.png",
    "app_name": "MyCoolApp",
    "arrangement_id": "94549a73-a554-4b76-b824-d96898829751",
    "created_at": "2021-03-18T02:46:42Z",
    "duration": 7776000,
    "end_user_email": "tony.stark@example.com",
    "end_user_id": "eu_2yRHN2ag2y4p8kCtm5DOeccZEXB",
    "expires_at": "2023-01-01T10:42:40Z",
    "institution_id": "11",
    "institution_logo": "https://example.com/images/gringotts-logo.png",
    "institution_name": "Gringgotts",
    "institution_type": "banking",
    "last_accessed": "2023-01-02T10:42:42Z",
    "last_consent": "2023-01-01T10:42:40Z",
    "permissions": [
      "accounts",
      "balances",
      "transactions"
    ],
    "termination_reason": "Expired or Revoked"
  },
  {
    "account_ids": [
      "1234567890",
      "1234567891"
    ],
    "active": true,
    "app_logo": "https://acme.com/app-logo.png",
    "app_name": "MyCoolApp",
    "arrangement_id": "94549a73-a554-4b76-b824-d96898829751",
    "created_at": "2021-03-18T02:46:42Z",
    "duration": 7776000,
    "end_user_email": "tony.stark@example.com",
    "end_user_id": "eu_2yRHN2ag2y4p8kCtm5DOeccZEXB",
    "expires_at": "2023-01-01T10:42:40Z",
    "institution_id": "11",
    "institution_logo": "https://example.com/images/gringotts-logo.png",
    "institution_name": "Gringgotts",
    "institution_type": "banking",
    "last_accessed": "2023-01-02T10:42:42Z",
    "last_consent": "2023-01-01T10:42:40Z",
    "permissions": [
      "accounts",
      "balances",
      "transactions"
    ],
    "termination_reason": "Expired or Revoked"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.