Schedule Bulk FI Requests (File Upload)
Bulk Operations
Schedule Bulk FI Requests (File Upload)
Schedule multiple FI requests by uploading a CSV or JSON file.
POST
Schedule Bulk FI Requests (File Upload)
Overview
The File Upload API allows you to schedule bulk FI requests by uploading a file containing consent IDs and optional configuration.Notes
- Supported file formats are CSV and JSON only.
- Maximum file size is 10 MB.
- Files must be UTF-8 encoded (without BOM for CSV).
Authentication
This API requires authentication using the following headers:Your unique client identifier provided by FinPro during onboarding.
Your confidential client secret key provided by FinPro.
The unique identifier for your application.
Your organization’s unique identifier assigned by FinPro.
Must be set to
multipart/form-data.Request Parameters
The request uses multipart form data with the following fields:The CSV or JSON file containing consent IDs and optional per-row configuration. Maximum size: 10 MB.
Optional batch identifier (5-60 characters, alphanumeric with hyphens and underscores). If omitted, the server generates one.
Optional alias for
reference_id. If both are provided, reference_id is used.Optional JSON or JSON string with global defaults:
fiDataRangeFrom, fiDataRangeTo, configId.Optional alias for
global_config.Global default start date for financial data (ISO 8601 format). Applied to rows that don’t specify their own value.
Global default end date for financial data (ISO 8601 format). Applied to rows that don’t specify their own value.
Global default analytics configuration ID. Applied to rows that don’t specify their own value.
File Formats
CSV Format
The CSV file must have a header row with the following columns:| Column | Required | Description |
|---|---|---|
consentId | Yes | The consent identifier (UUID format) |
fiDataRangeFrom | No | Start date override (ISO 8601 format) |
fiDataRangeTo | No | End date override (ISO 8601 format) |
configId | No | Analytics config override |
- Header row is required
- UTF-8 encoding (no BOM)
- Comma delimiter
- Empty cells use the global defaults provided in form data
- Wrap values in quotes if they contain commas
JSON Format
The JSON file can be either an array or an object with aconsents_list array:
consent_id and consentId are accepted in JSON rows.
Response Parameters
The API version that processed the request.
The timestamp when the response was generated (ISO 8601 format).
A unique transaction ID for this API call.
The status of the API call. Returns
"success" when the file is accepted.A human-readable message describing the result.
Contains batch details and tracking information.
Success Response Example
Error Responses
Unsupported File Type
When the uploaded file is not CSV or JSON:400 Bad Request
File Too Large
When the file exceeds the maximum size:413 Payload Too Large
Duplicate Reference ID
When thereference_id already exists:
409 Conflict
Common Error Codes
| Error Code | Description |
|---|---|
UnsupportedFileType | The file format is not CSV or JSON. |
FileTooLarge | The file exceeds the 10 MB limit. |
DuplicateReferenceId | A batch with this reference_id already exists. |
InvalidFileContent | The file content could not be parsed (malformed CSV/JSON). |
