Consent List with Unique Accounts

​

Overview

• Deduplication: Returns unique accounts even when multiple consents exist for the same account across different time periods or statuses.
• Status Filtering: Filter consents by one or more status values (PENDING, ACTIVE, REJECTED, REVOKED, EXPIRED) to focus on specific consent states.
• Pagination Support: Handle large result sets efficiently with configurable page size and page number parameters, preventing performance issues with extensive consent histories.
• Account Details: Each consent includes detailed account information in the accounts array, providing visibility into which specific financial accounts are linked.

​

Endpoint

POST {{Base_URL}}/v1/accounts/getconsentslist

​

Authentication

​

Request Body

​

Important Notes

• Mobile Number Format: The mobile number must be exactly 10 digits without any country code, spaces, hyphens, or other special characters. Examples: 9876543210 (correct), +919876543210 (incorrect).
• Status Filtering: The status array is case-sensitive. Use uppercase values exactly as documented: PENDING, ACTIVE, etc. Invalid status values may be ignored or cause validation errors.
• Pagination Behavior: When pageSize is specified but pageNumber is not, the API returns the first page. When neither is specified, all results are returned without pagination.
• Empty Status Array: If you provide an empty status array [], the API may return no results or behave as if no status filter was applied, depending on implementation. To get all statuses, omit the status parameter entirely.

​

Response

​

Success Response (200 OK) - Without Pagination

{
  "ver": "1.21.0",
  "status": "success",
  "data": [
    {
      "consentID": null,
      "consentHandle": "0af1551f-fc7d-4f11-adf8-eb4530e2965d",
      "status": "REJECTED",
      "productID": "TESTWM01",
      "accountID": "test",
      "aaId": "onemoney-aa",
      "consentCreationData": "2025-08-13T11:52:14.000Z",
      "consent_expiry": "2026-08-13 11:52:14",
      "accounts": [],
      "vua": "9674987439@onemoney"
    },
    {
      "consentID": null,
      "consentHandle": "9ee16215-2ab4-4fe4-a471-69dd5ef336d9",
      "status": "PENDING",
      "productID": "TESTWM01",
      "accountID": "test",
      "aaId": "onemoney-aa",
      "consentCreationData": "2025-07-01T17:50:31.000Z",
      "consent_expiry": "2026-07-01 17:50:31",
      "accounts": [],
      "vua": "9674987439@onemoney"
    }
  ]
}

​

Success Response (200 OK) - With Pagination

{
  "ver": "1.21.0",
  "status": "success",
  "pageDetails": {
    "totalRecords": 12,
    "currentPageNumber": 1,
    "totalPages": 6
  },
  "data": [
    {
      "consentID": null,
      "consentHandle": null,
      "status": "PENDING",
      "productID": "TESTWM01",
      "accountID": "TESTWM011756192348554",
      "aaId": "onemoney-aa",
      "consentCreationData": "2025-08-26T07:12:41.000Z",
      "consent_expiry": "2026-08-26 07:12:41",
      "accounts": [],
      "vua": "9674987439@onemoney"
    },
    {
      "consentID": null,
      "consentHandle": null,
      "status": "PENDING",
      "productID": "TESTWM01",
      "accountID": "TESTWM011756192324598",
      "aaId": "onemoney-aa",
      "consentCreationData": "2025-08-26T07:12:18.000Z",
      "consent_expiry": "2026-08-26 07:12:18",
      "accounts": [],
      "vua": "9674987439@onemoney"
    }
  ]
}

​

Consent Object Fields

​

Account Object Structure

​

Error Response (400 Bad Request)

{
  "ver": "1.21.0",
  "timestamp": "2025-10-01T11:44:17.019Z",
  "errorCode": "InvalidRequest",
  "errorMsg": " [ mobileNumber must be valid 10 digit ] "
}

​

Common Error Codes

​

Example Request

curl --location '{{Base_URL}}/v1/accounts/getconsentslist' \
--header 'Content-Type: application/json' \
--header 'client_id: {{Client_Id}}' \
--header 'client_secret: {{Client_Secret}}' \
--header 'organisationId: {{Organisation_Id}}' \
--header 'appIdentifier: {{App_Identifier}}' \
--data '{
    "mobileNumber": "9876543210",
    "productID": "TESTWM01",
    "status": ["PENDING", "ACTIVE"]
}'

​

Use Cases

​

Paginated Consent Dashboard

class ConsentDashboard {
  constructor(mobileNumber, productID) {
    this.mobileNumber = mobileNumber;
    this.productID = productID;
    this.pageSize = 20;
  }

  async loadPage(pageNumber, statusFilter = null) {
    const result = await getUniqueAccountConsents(
      this.mobileNumber,
      this.productID,
      {
        status: statusFilter,
        pageNumber,
        pageSize: this.pageSize
      }
    );

    return {
      consents: result.data,
      pagination: result.pageDetails || {
        totalRecords: result.data.length,
        currentPageNumber: 1,
        totalPages: 1
      }
    };
  }

  async loadAllPages(statusFilter = null) {
    const allConsents = [];
    let currentPage = 1;
    let totalPages = 1;

    do {
      const result = await this.loadPage(currentPage, statusFilter);
      allConsents.push(...result.consents);
      totalPages = result.pagination.totalPages;
      currentPage++;
    } while (currentPage <= totalPages);

    return allConsents;
  }
}

​

Status-Based Filtering

def categorize_consents(mobile_number, product_id):
    """Get consents organized by status categories"""
    categories = {
        'actionRequired': get_unique_account_consents(
            mobile_number, product_id, status=['PENDING']
        ),
        'activeConsents': get_unique_account_consents(
            mobile_number, product_id, status=['ACTIVE']
        ),
        'pastConsents': get_unique_account_consents(
            mobile_number, product_id, status=['REJECTED', 'REVOKED', 'EXPIRED']
        )
    }

    return {
        category: {
            'count': len(result['data']),
            'consents': result['data']
        }
        for category, result in categories.items()
    }

​

Export All Consents for Reporting

async function exportConsentReport(mobileNumber, productID) {
  const allConsents = [];
  let pageNumber = 1;
  let hasMorePages = true;

  while (hasMorePages) {
    const response = await getUniqueAccountConsents(mobileNumber, productID, {
      pageNumber,
      pageSize: 100  // Larger page size for efficient batch processing
    });

    allConsents.push(...response.data);

    if (response.pageDetails) {
      hasMorePages = pageNumber < response.pageDetails.totalPages;
      pageNumber++;
    } else {
      hasMorePages = false;  // No pagination, got all results
    }
  }

  return generateCSVReport(allConsents);
}

​

Best Practices

1. Use Pagination for Large Datasets: Always use pagination when displaying consents in UI. This improves performance and user experience, especially for customers with many consents.
2. Status Filtering: Use status filters to reduce data transfer and focus on relevant consents. For example, show only ACTIVE and PENDING consents in the main dashboard, with expired/revoked consents in a history section.
3. Cache Page Results: Cache individual page results with appropriate TTL (e.g., 5-10 minutes) to reduce API calls when users navigate back and forth between pages.
4. Handle Empty Accounts Array: The accounts array may be empty for PENDING or REJECTED consents. Design your UI to handle this gracefully by showing appropriate messaging.
5. Deduplication Awareness: This API returns deduplicated results. If you need to see every individual consent request (including duplicates), use the V1 or V2 list APIs instead.
6. Progress Indicators: When loading multiple pages, show progress indicators to users. Calculate progress as currentPage / totalPages using the pageDetails metadata.

​

API Version Comparison

• V1 (Basic List): Uses mobile number only. Returns all consents in flat list without deduplication or pagination. Simple but may have performance issues with large datasets.
• V2 (Enhanced List): Supports multiple identifier types (mobile, email, PAN). Includes account ID filtering. Still returns flat list without pagination.
• V1 Unique Accounts (this API): Provides deduplicated view of unique accounts. Supports status filtering and pagination. Best for customer-facing dashboards and large datasets.

• You need to display unique accounts without duplicate consent entries
• You’re working with customers who have many consents and need pagination
• You want to filter consents by specific status values
• You’re building customer dashboards or administrative interfaces that require organized, filterable views
• Performance and scalability are concerns due to potentially large consent lists