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

End User

An object that represents your User, End User's are used for linking accounts.

End User Endpoints

get/v1/end-users
post/v1/end-users
delete/v1/end-users/{id}
get/v1/end-users/{id}

The End User model

Retrieves an end user object.

Attributes

Expand all
email
stringoptional

An End Users email address. This should be their primary email, as it is used for notifying the End User about their consents.

id
stringrequired

A unique identifier for the End User object.

name
stringoptional

An End Users name.

phone
stringoptional

An End Users Phone. It is used for notifying the End User about their consents.

Response
{
    "email": "john_starmer@gmail.com",
    "id": "482c0e2b-5866-46b1-b795-220b7bba45b5",
    "name": "John Starmer",
    "phone": "+614123456789"
}
GET

/v1/end-users

Get End User

Get end user using email ID.

Parameters

emailquerystring

Email address to filter end users by

Request
GET/v1/end-users
curl --request GET \
     --url https://api.fiskil.com/v1/end-users?email={email} \
     --header 'Authorization: Bearer {access_token}' \
     --header 'accept: application/json; charset=UTF-8' \
     --header 'content-type: application/json; charset=UTF-8'
Response
[
    {
        "email": "john_starmer@gmail.com",
        "id": "482c0e2b-5866-46b1-b795-220b7bba45b5",
        "name": "John Starmer",
        "phone": "+614123456789"
    },
    {
        "email": "john_starmer@gmail.com",
        "id": "482c0e2b-5866-46b1-b795-220b7bba45b5",
        "name": "John Starmer",
        "phone": "+614123456789"
    },
    {
        "email": "john_starmer@gmail.com",
        "id": "482c0e2b-5866-46b1-b795-220b7bba45b5",
        "name": "John Starmer",
        "phone": "+614123456789"
    },
    {
        "email": "john_starmer@gmail.com",
        "id": "482c0e2b-5866-46b1-b795-220b7bba45b5",
        "name": "John Starmer",
        "phone": "+614123456789"
    }
]
POST

/v1/end-users

Add End User

Create a new End User for linking accounts.

Parameters

abnbodystringoptional

Australian Business Number (ABN) of the end user if they represent a business

emailbodystringoptional

An End Users email address. This should be their primary email, as it is used for notifying the End User about their consents.

namebodystringoptional

Name of the end user

phonebodystringoptional

An End Users Phone number in E.164 format

Request
POST/v1/end-users
curl --request POST \
     --url https://api.fiskil.com/v1/end-users \
     --header 'Authorization: Bearer {access_token}' \
     --header 'accept: application/json; charset=UTF-8' \
     --header 'content-type: application/json; charset=UTF-8' \
     --data '
{
    "abn": "51 824 753 556",
    "email": "john_starmer@gmail.com",
    "name": "John Starmer",
    "phone": "+614123456789"
}
'
Response
{
    "end_user_id": "83064af3-bb81-4514-a6d4-afba340825cd"
}
DELETE

/v1/end-users/{id}

Delete End User

Deletes an existing End User for linking accounts.

Parameters

idpathstringrequired

The id of the end user to delete.

Request
DELETE/v1/end-users/{id}
curl --request DELETE \
     --url https://api.fiskil.com/v1/end-users/{id} \
     --header 'Authorization: Bearer {access_token}' \
     --header 'accept: application/json; charset=UTF-8' \
     --header 'content-type: application/json; charset=UTF-8'
GET

/v1/end-users/{id}

Get End User by ID

Gets details of an end user by ID

Parameters

idpathstringrequired

ID of the end user to fetch.

Request
GET/v1/end-users/{id}
curl --request GET \
     --url https://api.fiskil.com/v1/end-users/{id} \
     --header 'Authorization: Bearer {access_token}' \
     --header 'accept: application/json; charset=UTF-8' \
     --header 'content-type: application/json; charset=UTF-8'
Response
{
    "email": "john_starmer@gmail.com",
    "id": "482c0e2b-5866-46b1-b795-220b7bba45b5",
    "name": "John Starmer",
    "phone": "+614123456789"
}

Was this page helpful?