Welcome to Fiskil! This guide will help you get up and running with your Fiskil integration in no time. Whether you're building a banking or energy application, follow these steps to connect your users' accounts and start pulling data.
Start by creating an account through the Fiskil Console. Once registered, you can generate your API keys and access the tools needed to integrate Fiskil into your app or website.
Fiskil authenticates your API requests using API keys generated from the console. Here's how to exchange your API keys for an access token:
In the Fiskil Console, generate your client_id
and client_secret
.
Make a POST request to the /v1/token
endpoint:
curl --location --request POST 'https://api.fiskil.com/v1/token' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
"client_id": "your_client_id",
"client_secret": "your_client_secret"
}'
Tip: Check out the [API Reference](/authentication) for code snippets in various programming languages.
Security Note: Store the returned `access_token` securely. All integrations must be handled on the server-side to protect sensitive data.
An End User represents a user of your app. You need to create this object to link accounts and manage consent.
Make a POST request to /v1/end-user
with the user's details:
curl --request POST \
--url https://api.fiskil.com/v1/end-user \
--header 'Authorization: Bearer ${access_token}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"email": "user@example.com",
"name": "User Name",
"phone": "+1234567890"
}'
Store the end_user_id
returned in the response for future API calls.
Tip: Retrieve an existing `end_user_id` using the GET `/end-user` endpoint if needed.
Fiskil's APIs are use case agnostic, but it's crucial to ensure your users understand what data they're consenting to share.
Navigate to the Customize UI page in the Fiskil Console.
Update:
Note: To gain production access, you must only collect data essential for your product or service.
An Auth Session facilitates linking a user's account through the consent flow you designed.
Make a POST request to /v1/auth/session
:
curl --request POST \
--url https://api.fiskil.com/v1/auth/session \
--header 'Authorization: Bearer ${access_token}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"cancel_uri": "https://yourapp.com/cancel",
"end_user_id": "${end_user_id}",
"redirect_uri": "https://yourapp.com/redirect"
}'
{
"auth_url": "https://auth.fiskil.com/?session_id=your_session_id",
"expires_at": "2025-12-31T23:59:59Z",
"session_id": "your_session_id"
}
Redirect users to the auth_url
. This will launch the consent flow UI you configured.
Once the user has completed the consent flow, you can access their data using Fiskil's Banking or Energy APIs.
Endpoint | Description |
---|---|
Identity API | Retrieve identity information of connected bank accounts |
Account API | Get account details of connected bank accounts |
Balance API | Access balance data of connected bank accounts |
Transaction API | Fetch transaction history of connected bank accounts |
Payee API | Get payee details linked to connected bank accounts |
Direct Debit API | View direct debits from connected bank accounts |
Scheduled Payment API | List scheduled payments from connected bank accounts |
Endpoint | Description |
---|---|
Identity API | Retrieve identity information of connected energy accounts |
Account API | Get account details of connected energy accounts |
Balance API | Access balance data of connected energy accounts |
Concession API | View concessions applied to connected energy accounts |
Billing API | Retrieve billing information from connected energy accounts |
Invoice API | Get invoice data for connected energy accounts |
Usage API | Access usage and interval data for connected energy accounts |
Servicepoint API | Retrieve site information for connected energy accounts |
DER API | Obtain Distributed Energy Resources (DER) data |
Scheduled Payment API | List scheduled payments from connected energy accounts |
Not a developer? No worries! Reach out to Fiskil's certified experts or explore our Open Source examples.
🎉 That's it! You're now set up with Fiskil. Let us know what you're building—we'd love to help you out or even feature your product on our blog.
Was this page helpful?