Overview

# Ink Account Aggregator Integrate with India's Account Aggregator ecosystem as an AA, FIU, or FIP — one set of REST APIs, compliant with the latest ReBIT and community specifications. [Get started :material-arrow-right:](get_started.md){ .md-button .md-button--primary } [Read the API guidelines](guidelines.md){ .md-button }

Welcome to Ink Account Aggregator! This guide provides comprehensive instructions for integrating and utilizing our Account Aggregator APIs.

Our primary role is as an Account Aggregator (AA) within the ecosystem, but we also offer modules responsible for implementing Financial Information User (FIU) functionality along with the associated APIs. FIUs and Financial Information Providers (FIPs) can seamlessly integrate these modules into their production environments, ensuring a swift onboarding process into the AA ecosystem.

Alternatively, FIUs or FIPs can choose to develop their own FIU or FIP modules using our AA REST API. To assist with this, Ink provides an AA API sandbox (ink_aa_integration), a resource that implements essential REST APIs for an AA. This guide includes all the vital information necessary for FIUs or FIPs to interface effectively with our AA REST API, enabling seamless integration into the AA ecosystem.

We ensure compatibility with the latest community and ReBIT API specifications for our simulators. If you encounter issues or have questions, feel free to contact us at connect@ink-aa.com.

Where to start

- :material-rocket-launch:{ .lg .middle } **Get Started** --- Understand FIU and FIP consent/data workflows before you write any code. [:octicons-arrow-right-24: Get started](get_started.md) - :material-account-key:{ .lg .middle } **Register with Ink AA** --- Onboard your organization and obtain your ecosystem credentials. [:octicons-arrow-right-24: Registration guide](ink_aa_register.md) - :material-swap-horizontal:{ .lg .middle } **TSP Integration** --- Wire up your TSP systems against the Ink AA REST APIs. [:octicons-arrow-right-24: TSP integration](ink_aa_integration.md) - :material-cellphone-link:{ .lg .middle } **UI Integration** --- Embed the Ink AA consent journey into your product's UI. [:octicons-arrow-right-24: UI integration](ink_ui_integration.md) - :material-database-export:{ .lg .middle } **FIU Integration** --- Request consent and pull financial information as an FIU. [:octicons-arrow-right-24: FIU integration](ink_fiu_integration.md) - :material-book-open-variant:{ .lg .middle } **How-To & Guidelines** --- Signing requests, key generation, and other practical recipes. [:octicons-arrow-right-24: How-to guides](how_to.md)

Glossary

Term	Definition
AA (Account Aggregator)	Facilitates secure information exchange between FIUs/Customers and FIPs.
FIP (Financial Information Provider)	Holds customer account information and shares encrypted data upon consent and request from the FIU or customer.
FIU (Financial Information User)	Requests consent via an AA and, upon approval, accesses data as a consumer.

Header	Set by	Purpose
aa_api_key	AA → FIP/FIU	Generated by the FIP or FIU and provided to the AA.
fip_api_key	FIP → AA	Provided by the AA; used alongside x-jws-signature.
client_api_key	FIU → AA	Generated by the AA; used alongside x-jws-signature on every call.
x-jws-signature	Sender	Detached-content JWS signature of the request/response body — required on every signed API call. See How-To for how to generate it.

API information

All API requests and responses adhere to the JSON format. The APIs support GET and POST methods and utilize HTTP response codes to indicate status and errors.

Key requirements

• Content-Type: All requests must include application/json.
• Body format: The body must be valid JSON.
• Protocol: APIs use the secure https protocol.

Version

We strictly adhere to the latest API specifications, currently at 2.0.0, as defined by ReBIT and the community.