Without a connector
Introduction
This section will guide you through the implementation of the full aggregation process to access Algoan's score without the use of a connector.
⚠️ Important: Since you will create resources with your own credentials, you need to implement this on your server side to use our APIs.
1. Create a banks user
To begin with, you need to create a Banks User which represents a user about to connect to their bank.
Use the POST /v1/banks-users
API to create a new Banks User with these parameters:
adenTriggers.onSynchronizationFinished
: Set this parameter totrue
. It will automatically trigger the score calculation when the Banks User status will be updated toFINISHED
.partnerId
(optional): Algoan gives you the possibility to set your own identifier, if you need to match Algoan's unique identifier with your system.
2. Fetch accounts and transactions
To calculate the score, Algoan needs the user's bank accounts and transactions. After retrieving them, you have to create:
- Accounts using the
POST /v1/banks-users/:id/accounts
to create bank accounts - Transactions using the
POST /v1/banks-users/:id/accounts/:accountId/transactions
to transfer transactions from each bank accounts.
3. Get the score result
When the transfer is finished, the Banks User status needs to be updated to FINISHED
. Since the onSynchronizationFinished
flag is set to true
, it will start the score calculation.
Once it is complete, an aden_analysis_completed
event will be sent to your REST Hooks. Please refer to the initialize your REST Hook section for more details.
Your connector needs to get the associated Banks User. You will then be able to find the aden
property.