Consent Request V2

​

Overview

​

Endpoint

POST {{Base_URL}}/v2/requestconsent

​

Authentication

​

Request Body

​

Important Notes

• VUA Format: The VUA must follow the exact format identifier@onemoney where the identifier matches the party identifier value. The domain @onemoney is case-sensitive and required.
• Party Identifier Validation: The API validates that the partyIdentifierType and partyIdentifierValue match the expected format. Mobile numbers must be exactly 10 digits, and PAN must follow the standard Indian PAN format.
• Product ID Configuration: The productID must exist in your FinPro portal configuration before making this API call. Requests with invalid or non-existent product IDs will be rejected.
• Account ID Uniqueness: While not enforced by the API, it’s recommended to use unique accountID values per consent request to avoid confusion when processing webhooks and tracking consent status.

​

Response

​

Success Response (200 OK)

{
  "status": "success",
  "ver": "1.21.0",
  "data": {
    "status": "PENDING",
    "consent_handle": "3a3f2d96-fc3b-42e5-804f-e65d10a4be98"
  }
}

​

Error Response (400 Bad Request)

{
  "ver": "1.21.0",
  "timestamp": "2025-10-01T10:55:32.710Z",
  "errorCode": "InvalidRequest",
  "errorMsg": "Request has Invalid ProductID  2",
  "status": "FP0001"
}

​

Common Error Codes

​

Example Request

curl --location '{{Base_URL}}/v2/requestconsent' \
--header 'client_id: {{Client_Id}}' \
--header 'client_secret: {{Client_Secret}}' \
--header 'organisationId: {{Organisation_Id}}' \
--header 'appIdentifier: {{App_Identifier}}' \
--header 'Content-Type: application/json' \
--data '{
    "productID": "TESTWM01",
    "vua": "9876543210@onemoney",
    "partyIdentifierType": "MOBILE",
    "partyIdentifierValue": "9876543210",
    "accountID": "test123"
}'

const response = await fetch('{{Base_URL}}/v2/requestconsent', {
  method: 'POST',
  headers: {
    'client_id': '{{Client_Id}}',
    'client_secret': '{{Client_Secret}}',
    'organisationId': '{{Organisation_Id}}',
    'appIdentifier': '{{App_Identifier}}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    productID: 'TESTWM01',
    vua: '9876543210@onemoney',
    partyIdentifierType: 'MOBILE',
    partyIdentifierValue: '9876543210',
    accountID: 'test123'
  })
});

const data = await response.json();
console.log(data);

import requests

url = "{{Base_URL}}/v2/requestconsent"
headers = {
    "client_id": "{{Client_Id}}",
    "client_secret": "{{Client_Secret}}",
    "organisationId": "{{Organisation_Id}}",
    "appIdentifier": "{{App_Identifier}}",
    "Content-Type": "application/json"
}
payload = {
    "productID": "TESTWM01",
    "vua": "9876543210@onemoney",
    "partyIdentifierType": "MOBILE",
    "partyIdentifierValue": "9876543210",
    "accountID": "test123"
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

​

Next Steps

1. Store the Consent Handle: Persist the consent_handle returned in the response to your database, linked to the accountID you provided. This allows you to track the consent lifecycle and correlate webhook events.
2. Redirect the Customer: Since V2 does not return a web redirection URL directly, use the Web Redirection Encryption API to generate an encrypted URL that redirects the customer to the Account Aggregator consent flow. Alternatively, consider using the V3 API which returns a redirection URL in the response itself.
3. Configure Webhooks: Ensure you have webhook endpoints configured in the FinPro admin portal to receive consent lifecycle notifications (Approve, Reject, Revoke, Expire).
4. Monitor Status: Use the Consent List APIs to poll for consent status updates, or rely on webhook notifications for real-time status changes.
5. Handle Customer Decision: When the customer approves the consent (notified via webhook), you can proceed to request FI data using the Data Management APIs. If rejected, handle the rejection gracefully in your application workflow.

​

API Version Comparison

• V2 (this API): Returns only a consent handle with PENDING status. Requires manual customer redirection mechanism.
• V3: Returns a webRedirectionUrl that can be used to automatically redirect customers to the AA consent interface. Supports FIP filtering and redirect URL configuration.