API Documentation
v2.0.1 Postman
Documentation

Unaport.ai – Unified Portal for Financial Data

A suite of APIs designed for seamless integration in financial services — enabling account aggregation, consent management, and data sharing. This guide helps developers integrate, authenticate, and build on the Unaport platform.

v2.0.1 Released 28th July 2025

What's New

  • Alerts & Nudges — receive proactive notifications and reminders based on financial data
  • Multi Account Aggregator Support — APIs now support integration with multiple AAs
  • Flexible configuration to add or manage multiple AAs with improved routing logic
  • Enhanced error handling and logging for multi-AA interactions
🌟

Introduction

The Unaport.ai API is a fully RESTful interface that delivers all responses in JSON format. It covers three main areas: consent management, data retrieval, and analytics.

🔐
Authentication

Login API to get Bearer tokens, Refresh Token API for session continuity, and Get Organisation Details API.

📑
Consents

Create consent templates, raise consents with or without templates, check status, revoke consents, and receive webhook notifications.

📊
Data Reports

Fetch data status, retrieve session data, export data — all tied to approved consent handles.

📈
Analytics

Single and aggregate account analytics, both sync and async — generate, fetch, and export detailed ML-powered reports.


🌐

Environments

All development and testing must be done in the UAT/Sandbox environment before switching to Production.

UAThttps://common.sandbox.unaport.com
LIVEhttps://common.premium.unaport.com
SDK UAThttps://sdk.sandbox.unaport.com/view
SDK LIVEhttps://sdk.premium.unaport.com/view

🛠️

Response Status Codes

CodeStatusMeaning
200OKSuccessful request
201CreatedNew resource successfully created
400Bad RequestInvalid request, often due to missing or malformed parameters
401UnauthorizedNo valid API key or Bearer token provided
403ForbiddenInsufficient permissions for the requested resource
500Server ErrorAn issue on Unaport.ai's server side