API ReferenceGuides
Introduction
Getting Started
Authentication
Changelog
Errors
Pagination

Core Resources

Institutions
Permissions
Linking Accounts
End User
Consents
Auth Session

Banking Api

Introduction
Accounts
Balance
Transactions
Products
Payee
Direct Debits
Scheduled Payments

Energy Api

Introduction
Accounts
Balances
DER
Invoices
Service Points
Usage
Billing
Concessions
Plans
Payment Schedule

Common api

Identity

Consents

A Consent represents the access period and scope of data an End User allows a Client (you) to access. We handle a lot of the compliance requirements around Consents, but we also recommend alerting your customers of their consents. These APIs will help you to embed an End Users personalised consents into your application.

Consents Endpoints

get/v1/consent
delete/v1/consent/{arrangement_id}

The Consents model

An object that represents your Consents

Attributes

Expand all
active
booleanrequired

Indicates whether consent is active or not

app_name
stringrequired

Your application name

arrangement_id
stringrequired

CDR arrangement ID provided by DH.

created_at
stringrequired

When the Consent was created

duration
integerrequired

The time period access was granted. Its in seconds

end_user_email
stringrequired

End users email

end_user_id
stringrequired

ID of the end user that authorised the consent

expires_at
stringrequired

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

institution_id
stringrequired

The identifier for the institution the Consent is held with.

institution_name
stringrequired

Institution name

institution_type
stringrequired

Institution Type

last_accessed
stringrequired

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

permissions
arrayrequired

A list of the data permissions granted.

termination_reason
stringrequired

Reason for consent termination

Response
{
    "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": "482c0e2b-5866-46b1-b795-220b7bba45b5",
    "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"
}
GET

/v1/consent

List Consent

Retrieve all consents for a specific End User.

Parameters

end_user_idquerystring

The ID of the end user to list consents for

activequeryboolean

Filter to include only active or inactive (i.e. revoked or expired) consents

Request
GET/v1/consent
curl --request GET \
     --url https://api.fiskil.com/v1/consent?end_user_id={end_user_id}&active={active} \
     --header 'Authorization: Bearer {access_token}' \
     --header 'accept: application/json; charset=UTF-8' \
     --header 'content-type: application/json; charset=UTF-8'
Response
[
    {
        "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": "482c0e2b-5866-46b1-b795-220b7bba45b5",
        "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"
    },
    {
        "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": "482c0e2b-5866-46b1-b795-220b7bba45b5",
        "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"
    },
    {
        "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": "482c0e2b-5866-46b1-b795-220b7bba45b5",
        "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"
    }
]

Was this page helpful?