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

Auth Session

A single-use session for an end-user to authorise data sharing from an institution

Auth Session Endpoints

post/v1/auth/session

The Auth Session model

An object that represents an end user's auth session.

Attributes

Expand all
auth_url
stringrequired

The computed auth URL.

expires_at
integerrequired

The computed auth URL expires at.

id
stringrequired

The client id.

session_id
stringrequired

Session Id

Response
{
    "auth_url": "auth-session.com/redirect-url",
    "expires_at": 1213467,
    "id": "5qcql2s0bn9qfh1m5qd1sl4gth",
    "session_id": "ea564d-56012s4-6ds4564"
}
POST

/v1/auth/session

Add Auth Session

Create a new Session for the Authentication flow

Parameters

cancel_uribodystringrequired

Your url to cancel an auth flow

end_user_idbodystringrequired

The end_user that will be consenting with an external provider

redirect_uribodystringrequired

Where the end user will be redirected to on success

Request
POST/v1/auth/session
curl --request POST \
     --url https://api.fiskil.com/v1/auth/session \
     --header 'Authorization: Bearer {access_token}' \
     --header 'accept: application/json; charset=UTF-8' \
     --header 'content-type: application/json; charset=UTF-8' \
     --data '
{
    "cancel_uri": "https://acme.com/cancel",
    "end_user_id": "22325VgWkf6GkW2149t633Bucup",
    "redirect_uri": "https://acme.com/success"
}
'
Response
{
    "auth_url": "auth-session.com/redirect-url",
    "expires_at": 1213467,
    "id": "5qcql2s0bn9qfh1m5qd1sl4gth",
    "session_id": "ea564d-56012s4-6ds4564"
}

Was this page helpful?