Overview
FinPro’s Consent Management module provides Financial Information Users with complete control over the customer consent lifecycle, from creation and approval to revocation and expiry. The system handles all aspects of RBI-compliant consent orchestration, including customer redirection to Account Aggregators, real-time status tracking via webhooks, and bulk operations for high-volume use cases.Consent Lifecycle
The consent journey follows a well-defined lifecycle with multiple states and transitions:1
Creation
FIU calls the Consent Request API with customer identifier and product template
2
Pending
Customer receives redirect URL to Account Aggregator for approval
3
Active
Customer approves consent within the AA interface
4
Paused / Resumed
Customer temporarily pauses or resumes data sharing
5
Revoked / Expired
Consent ends due to customer revocation or validity expiry
Consent States
| State | Description | Next Possible States |
|---|---|---|
| PENDING | Consent created, awaiting customer approval | ACTIVE, REJECTED |
| ACTIVE | Customer approved, data fetch authorized | PAUSED, REVOKED, EXPIRED |
| REJECTED | Customer declined consent request | (Terminal state) |
| PAUSED | Customer temporarily stopped data sharing | RESUMED, REVOKED |
| RESUMED | Customer reactivated previously paused consent | PAUSED, REVOKED, EXPIRED |
| REVOKED | Customer permanently withdrew consent | (Terminal state) |
| EXPIRED | Consent validity period elapsed | (Terminal state) |
Consent Request APIs
FinPro offers multiple API versions to support different integration patterns and use cases.V2 Consent Request (Legacy)
The V2 API provides basic consent creation with essential parameters. Key Parameters:productID: Reference to pre-configured consent templatevua: Customer’s Virtual User Address (mobile@aa or pan@aa)accountID: FIU’s internal customer/journey identifierredirect: Boolean indicating if redirect URL should be generated
API Documentation
View V2 Consent Request Details
V3 Consent Request (Standard)
The V3 API adds support for enhanced customer attributes and custom configurations. Additional Parameters:name: Customer’s full nameemail: Customer’s email addressaccountRef: Additional reference numbers for trackingcustomAttributes: Free-form metadata for journey tracking
API Documentation
View V3 Consent Request Details
V4 Consent Request (Advanced)
The V4 API provides maximum flexibility with template overrides and dynamic consent configuration. Advanced Capabilities:- Override consent template parameters at request time
- Specify custom FI types, date ranges, and fetch frequencies
- Apply transaction-level filters (amount, type, narration patterns)
- Support for multi-product consent bundles
API Documentation
View V4 Consent Request Details
Consent Templates
Consent templates define the structure, scope, and behavior of consent requests. Templates are pre-configured in the FinPro admin portal and referenced byproductID in API calls.
Template Configuration
Purpose and Compliance
Purpose and Compliance
Purpose Code: RBI/SEBI/NPCI-defined purpose codes (e.g., 101 for personal loans, 102 for housing loans)Template Name: Customer-facing name displayed in AA interfaceDescription: Detailed explanation of why data is being requestedRegulatory Compliance: Automatic validation against RBI AA framework requirements
Consent Validity
Consent Validity
Start Date: When the consent becomes active (immediate or future-dated)End Date: When the consent automatically expiresMaximum Validity: Configurable up to regulatory limits (typically 1-2 years)
Consent Type
Consent Type
ONETIME: Single data fetch upon approvalPERIODIC: Recurring data fetches at specified intervalsFrequency: For periodic consents, defines fetch cadence (daily, weekly, monthly)
Financial Information Types
Financial Information Types
Select which types of financial data can be fetched:
- Savings Accounts
- Current Accounts
- Term Deposits (FD/RD)
- Mutual Funds
- Equities and Debentures
- Insurance Policies (Life, General)
- NPS Accounts
- Bonds and Government Securities
- GST Returns
Data Range
Data Range
From Date: Historical data start point (e.g., 6 months ago, 1 year ago)To Date: Data end point (typically current date)Maximum Range: Configurable based on use case (regulatory limits apply)
Data Filters (Optional)
Data Filters (Optional)
Transaction Amount Filters: Specify minimum/maximum transaction amounts to fetchCredit/Debit Filters: Restrict to only credits, only debits, or bothNarration Patterns: Include/exclude transactions based on description keywordsDate Filters: Fetch data only from specific date ranges within the overall consent period
Template Management
Creating Templates:- Navigate to Admin Portal → Consent Templates
- Click Create New Template
- Configure all template parameters
- Save and note the generated
productID
- Template updates apply only to new consent requests
- Existing active consents continue using the original template configuration
- Version control tracks all template changes for audit purposes
- Templates with active consents cannot be deleted
- Mark templates as inactive to prevent new consent creation while preserving historical records
Bulk Consent Management
For high-volume operations, FinPro provides batch APIs and admin interfaces to manage consents at scale.Bulk Consent Creation
Use Cases:- Pre-approval campaigns where customer lists are uploaded
- Loan portfolio monitoring requiring consent setup for multiple borrowers
- Collections campaigns targeting specific customer segments
- Upload CSV file with customer details (VUA, accountID, productID)
- FinPro processes batch and creates consent requests
- Redirect URLs are generated for each customer
- Webhooks notify of approval/rejection for each consent
- Batch size should not exceed 10,000 records per upload
- Include valid email/mobile for customer communication
- Ensure VUA format is correct (mobile@aa or pan@aa)
Bulk Consent Revocation
Use Cases:- Loan closure scenarios where ongoing monitoring is no longer needed
- Compliance requirements to cease data collection
- Customer request to revoke multiple consents
- Navigate to Admin Portal → Bulk Operations
- Upload list of consent IDs or accountIDs to revoke
- Confirm bulk revocation action
- System sends revocation requests to respective AAs
- Webhook notifications confirm completion
API Documentation
View Consent Revocation API
Webhook Notifications
FinPro sends real-time webhook notifications for all consent lifecycle events, enabling FIUs to react immediately to customer actions.Supported Events
| Event | Trigger | Recommended Action |
|---|---|---|
| CONSENT_APPROVED | Customer approves consent in AA | Trigger FI data fetch |
| CONSENT_REJECTED | Customer declines consent request | Update application status, notify user |
| CONSENT_REVOKED | Customer withdraws active consent | Cease data fetching, update records |
| CONSENT_EXPIRED | Consent validity period ends | Prompt customer for renewal if needed |
| CONSENT_PAUSED | Customer pauses data sharing | Suspend recurring fetches |
| CONSENT_RESUMED | Customer reactivates paused consent | Resume recurring data fetches |
Webhook Security
HMAC Signature Verification: Every webhook payload includes anX-Webhook-Signature header containing an HMAC-SHA256 signature.
Verification Process:
- Always verify signatures before processing webhook data
- Reject requests with missing or invalid signatures
- Rotate webhook secrets periodically via admin portal
- Log all webhook receipts for audit trails
Webhook Payload Examples
Consent Listing and Tracking
FinPro provides APIs to query consent status and history for individual customers or across the entire portfolio.Consent List APIs
Consent List
Retrieve all consents for a customer or accountID
Consent List V2
Enhanced listing with pagination and filtering
Unique Accounts
Get distinct linked accounts across all consents
Query Parameters
Filter by:accountID: FIU’s internal customer identifiervua: Customer’s Virtual User AddressconsentId: Specific consent identifierproductID: Consent template referencestatus: Filter by consent state (ACTIVE, EXPIRED, etc.)
page: Page number (default: 1)limit: Results per page (default: 20, max: 100)
sortBy: Field to sort by (createdAt, expiryDate, status)sortOrder: ASC or DESC
Consent Revocation
FIUs can programmatically revoke consents on behalf of customers or in response to business logic.Revocation Scenarios
Loan Closure: When a loan is fully repaid, revoke recurring monitoring consents to cease data collection. Non-Disbursal: If a loan application is rejected, revoke the consent to avoid unnecessary data fetching. Customer Request: Honor customer requests to stop data sharing by revoking consents via API. Compliance: Revoke consents in response to regulatory requirements or data deletion requests.Revocation API
API Documentation
View Consent Revocation API Details
Best Practices
Design Consent Templates Thoughtfully
Design Consent Templates Thoughtfully
Keep templates focused on specific use cases. Avoid overly broad consent scopes that may confuse customers or trigger regulatory scrutiny.
Implement Robust Webhook Handling
Implement Robust Webhook Handling
Ensure webhook endpoints are highly available, respond quickly (within 5 seconds), and implement retry logic for failed processing.
Track Consent Status Consistently
Track Consent Status Consistently
Maintain a local copy of consent states synchronized via webhooks. Use Consent List APIs to reconcile discrepancies.
Respect Customer Revocations
Respect Customer Revocations
Immediately cease data fetching upon receiving revocation webhooks. Failure to honor revocations can result in compliance violations.
Automate Consent Renewal
Automate Consent Renewal
For long-term monitoring use cases, prompt customers to renew consents before expiry to maintain uninterrupted data access.
Monitor Consent Approval Rates
Monitor Consent Approval Rates
Track approval vs rejection rates to identify friction points in the consent journey. Optimize template descriptions and customer communication.
Integration Checklist
1
Configure Consent Templates
Create templates in FinPro admin portal for each product journey
2
Set Up Webhook Endpoints
Deploy webhook handlers with signature verification
3
Integrate Consent Request APIs
Call appropriate API version (V2/V3/V4) based on requirements
4
Handle Redirect Flow
Redirect customers to AA using provided URL or deep link
5
Process Webhook Events
React to consent lifecycle events in real-time
6
Implement Consent Revocation
Add logic to revoke consents when business conditions require
7
Test End-to-End Flows
Validate consent creation, approval, data fetch, and revocation in UAT
