FIU API Flow — Consent, Data & Analytics¶
This page outlines the end-to-end API usage flow for a Financial Information User (FIU) integrating with the Account Aggregator framework.
FIU Setup Flow — One-Time¶
This flow is executed only once during onboarding/setup to retrieve FIU’s organisation and product details.
flowchart TD
T[Get Access Token
FIU retrieves auth token for secure API calls] --> A[Get Organisation Details
FIU retrieves registered organisation details] A --> B[Get Product Template / Product ID
FIU fetches available product templates]
FIU retrieves auth token for secure API calls] --> A[Get Organisation Details
FIU retrieves registered organisation details] A --> B[Get Product Template / Product ID
FIU fetches available product templates]
Steps:
| Step | Description |
|---|---|
| 0. Get Access Token | FIU retrieves an authentication token to authorize all subsequent API calls. This is required before fetching organisation or product details. [{{baseUrl}}/public/user/login], [{{baseUrl}}/public/user/refreshToken] |
| 1. Get Organisation Details | FIU retrieves registered organisation details, including Organisation ID, which is needed for subsequent API calls. [{{baseUrl}}/FIU/getClientOrganisation] |
| 2. Get Product Template / Product ID | FIU fetches available product templates and selects the Product ID for later consent requests. [{{appUrl}}/FIU/ProductList/{{org_id}}] |
Customer Flow — Consent, Data & Analytics¶
This flow is executed per customer using the Orgid productId from setup flow.
flowchart TD
T[Get Access Token
FIU retrieves auth token for secure API calls] --> C[Raise Consent Request with Template
FIU initiates consent journey for customer approval] C --> D[Consent Notification
Unaport.ai notifies FIU when customer approves/rejects consent] D --> E[Data Notification
Unaport.ai sends callback when customer data is ready] E --> F[Fetch Data
FIU retrieves customer data using session ID] F --> G[Generate Analytics
Process data to generate insights and summaries] G --> H[Analytics Notification
Callback sent when analytics is ready] H --> I[Fetch Analytics Result
Retrieve processed analytics summary in JSON] I --> J[Export Analytics
Download analytics in XLSX format for reporting]
FIU retrieves auth token for secure API calls] --> C[Raise Consent Request with Template
FIU initiates consent journey for customer approval] C --> D[Consent Notification
Unaport.ai notifies FIU when customer approves/rejects consent] D --> E[Data Notification
Unaport.ai sends callback when customer data is ready] E --> F[Fetch Data
FIU retrieves customer data using session ID] F --> G[Generate Analytics
Process data to generate insights and summaries] G --> H[Analytics Notification
Callback sent when analytics is ready] H --> I[Fetch Analytics Result
Retrieve processed analytics summary in JSON] I --> J[Export Analytics
Download analytics in XLSX format for reporting]
Steps:
| Step | Description |
|---|---|
| 0. Get Access Token | FIU retrieves an authentication token to authorize subsequent API calls. Ensures all requests are secure. [{{baseUrl}}/public/user/login] [{{baseUrl}}/public/user/refreshToken] |
| 1. Raise Consent Request with Template | FIU initiates consent for the customer using Product ID from setup flow. Triggers the consent journey for customer approval. [{{appUrl}}/FIU/Consents/product/{{org_id}}] |
| 2. Consent Notification | Once the customer approves or rejects, Unaport.ai sends consent status updates to FIU via callback. [FIU Consent Webhook URL] |
| 3. Data Notification | Once the customer’s financial data is ready, Unaport.ai sends a data notification to FIU via callback. [FIU Data Webhook URL] |
| 4. Fetch Data | FIU retrieves the approved customer data using the session ID. [{{appUrl}}/FIU/FifetchDataBySessionId/{{sessionId}}] |
| 5. Generate Analytics | FIU processes the fetched data to generate insights, trends, and summary metrics. [{{appUrl}}/FIU/FI/Analytic/async/{{org_id}}/{{sessionId}}] |
| 6. Analytics Notification | FIU receives a callback when the analytics processing is complete. [FIU Analytics Webhook URL] |
| 7. Fetch Analytics Result JSON | FIU retrieves the processed analytics summary in JSON format for further display or integration. [{{appUrl}}/FIU/Analitic/ID/{{sessionId}}] |
| 8. Export Analytics XLSX | FIU can download the analytics in XLSX format for reporting or offline use. [{{appUrl}}/FIU/Analitic/Export/ID] |