Skip to main content
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:
string
required
Your unique client identifier provided by FinPro during onboarding.
string
required
Your confidential client secret key provided by FinPro.
string
required
The unique identifier for your application.
string
required
Your organization’s unique identifier assigned by FinPro.
string
required
Must be set to multipart/form-data.

Request Parameters

The request uses multipart form data with the following fields:
file
required
The CSV or JSON file containing consent IDs and optional per-row configuration. Maximum size: 10 MB.
string
Optional batch identifier (5-60 characters, alphanumeric with hyphens and underscores). If omitted, the server generates one.
string
Optional alias for reference_id. If both are provided, reference_id is used.
string
Optional JSON or JSON string with global defaults: fiDataRangeFrom, fiDataRangeTo, configId.
string
Optional alias for global_config.
string
Global default start date for financial data (ISO 8601 format). Applied to rows that don’t specify their own value.
string
Global default end date for financial data (ISO 8601 format). Applied to rows that don’t specify their own value.
string
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: CSV Example:
CSV Rules:
  • 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 a consents_list array:
Both consent_id and consentId are accepted in JSON rows.

Response Parameters

string
The API version that processed the request.
string
The timestamp when the response was generated (ISO 8601 format).
string
A unique transaction ID for this API call.
string
The status of the API call. Returns "success" when the file is accepted.
string
A human-readable message describing the result.
object
Contains batch details and tracking information.

Success Response Example

Error Responses

Unsupported File Type

When the uploaded file is not CSV or JSON:
HTTP Status Code: 400 Bad Request

File Too Large

When the file exceeds the maximum size:
HTTP Status Code: 413 Payload Too Large

Duplicate Reference ID

When the reference_id already exists:
HTTP Status Code: 409 Conflict

Common Error Codes