API Reference
Guides
Login
Signup
Introduction
Getting Started
Authentication
Changelog
Errors
Error Types
Pagination
Core Resources
Institutions
Institutions model
List all institutions
Retrieve an institution
Permissions
Linking Accounts
End User
End user model
Get end user
Add end user
Delete end user
Get end user by ID
Consents
Consents model
List Consents
Revoke Consent
Auth Session
Auth Session model
Create Auth Session
Banking Api
Introduction
Accounts
Account model
List all accounts
Balance
Balance model
List all Balances
Transactions
Transaction model
List all Transactions
Products
Product model
Get all Products
Get Product Details
Payee
Payee model
Get all Payees
Direct Debits
Direct Debit model
Get Direct Debits
Scheduled Payments
Scheduled Payment model
Get Scheduled Payments
Energy Api
Introduction
Accounts
Account model
List all accounts
Balances
Balance model
List all balances
DER
DER model
List all DER
Invoices
Invoice model
List all Invoices
Service Points
Service Point model
List all Service Points
Usage
Usage model
Retrieve Usage
Billing
Billing model
List all Bills
Concessions
Concession model
List all Concessions
Plans
Plan model
List all Plans
Retrieve a Plan
Payment Schedule
Payment Schedule model
List all Payment Schedule
Common api
Identity
Identity model
Retrieve Customer Details
Getting Started
Contact us
for access to the sandbox
Go to the
settings page
and click
Access Keys > Add Key
Store your
client_id
and
client_secret
somewhere safe, you won't be able to access them again
Use these credentials to
authenticate
and receive a
access_token
Use the
access_token
to
create an end user
note down the
end_user_id
Create a
custom auth flow
to authenticate your end users, click through each option on the left sidebar.
Start an auth session
, the returned url will simulate how your end users can give consent to access data
Navigate to the
auth_url
returned and click through the prompts to give consent
You can now explore the different routes in this documentation using your
end_user_id
and
access_token
Was this page helpful?
Yes
No