Retrieve the list of consent templates (products) configured in the FinPro admin portal for your organization.
| Header | Type | Description |
|---|---|---|
Content-Type | string | Must be set to application/json for proper request processing |
client_id | string | The unique client identifier assigned to your FIU organization during onboarding |
client_secret | string | The secret key paired with your client_id for secure authentication |
organisationId | string | Your organization’s unique identifier in the FinPro system |
appIdentifier | string | The application identifier that distinguishes different applications within your organization |
| Parameter | Type | Required | Description |
|---|---|---|---|
productId | string | Optional | The specific consent template code to retrieve. If omitted, the API returns all active consent templates configured for your organization. Must contain only alphanumeric characters, underscores, hyphens, and periods. |
| Field | Type | Description |
|---|---|---|
ver | string | The version of the FinPro API that processed the request |
status | string | The outcome of the API call. Possible values: success, failure |
data | array | An array of consent template objects containing the configuration details |
data[].productName | string | The human-readable name of the consent template as configured in the admin portal |
data[].productCode | string | The unique identifier (template code) used to reference this consent template in API calls |
data[].productDescription | string | A descriptive text explaining the purpose or use case of this consent template |
data[].consentFrom | string (ISO 8601) | The start date and time from which the consent becomes valid |
data[].consentTo | string (ISO 8601) | The end date and time until which the consent remains valid. The duration between consentFrom and consentTo determines the consent validity period |
data[].consentMode | string | How the fetched data is handled. VIEW means data is not stored, STORE means data can be persisted |
data[].fetchType | string | The frequency pattern for data retrieval. ONETIME for single fetch, PERIODIC for recurring fetches |
data[].fiTypes | string | Comma-separated list of Financial Information schema types included in this consent template (e.g., DEPOSIT, MUTUAL_FUNDS, INSURANCE_POLICIES) |
data[].consentTypes | string | Comma-separated list indicating which sections of financial information are requested: PROFILE (account holder details), SUMMARY (aggregated data), TRANSACTIONS (detailed transaction history) |
data[].dataRangeFrom | string (ISO 8601) | The earliest date for which financial data should be retrieved |
data[].dataRangeTo | string (ISO 8601) | The most recent date for which financial data should be retrieved. The period between dataRangeFrom and dataRangeTo defines the historical data range |
data[].dataLifeUnit | string | The time unit for data retention. Possible values: DAY, MONTH, YEAR, INF (infinite) |
data[].dataLifeValue | number | The numeric value indicating how long data can be retained, measured in the unit specified by dataLifeUnit |
data[].frequencyUnit | string | The time unit for periodic data fetch frequency. Possible values: DAY, MONTH, YEAR, INF |
data[].frequencyValue | number | The numeric value indicating how often data should be fetched, measured in the unit specified by frequencyUnit |
data[].fiFetch | string | The mechanism for triggering data fetches. MANUAL requires explicit FIU API calls, AUTOMATIC fetches data automatically, AUTO MANUAL supports both modes |
data[].createdAt | string (ISO 8601) | The timestamp when this consent template was created in the FinPro admin portal |
organisationId does not match any registered FIU organization in the FinPro system.
fiTypes field can contain any combination of the following Account Aggregator financial information schema types:
X-RateLimit-Limit: The maximum number of requests allowed in the time windowX-RateLimit-Remaining: The number of requests remaining in the current windowX-RateLimit-Reset: The Unix timestamp when the rate limit window resetsYour unique client identifier provided by MoneyOne during FIU onboarding
Your confidential client secret provided by MoneyOne
Your organization's unique identifier in the FinPro system
Application-specific identifier for tracking API calls
Request body for retrieving consent templates (products) configured in the FinPro admin portal.
The specific consent template code to retrieve. If omitted, the API returns all active consent templates configured for your organization. Must contain only alphanumeric characters, underscores, hyphens, and periods.
^[a-zA-Z0-9_\-.]+$Products retrieved successfully
Response containing the list of consent templates (products) configured for the organization.