Skip to main content
POST
Schedule Bulk FI Requests

Overview

The Schedule Bulk FI Requests API allows you to submit multiple Financial Information (FI) requests in a single API call.

Notes

  • Each batch requires a unique reference_id for tracking purposes. This ID is provided by you and must be unique across all your batches.
  • Duplicates in consents_list are accepted and will be scheduled as separate rows.
  • You can specify global defaults for date ranges and config that apply to all records, with optional per-row overrides.
  • Maximum batch size is 10,000 consents per request.

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 application/json.

Request Body

string
required
A unique identifier for this batch, provided by you. Must be alphanumeric with hyphens and underscores allowed, between 5-60 characters. This ID is used for tracking and querying batch status.
array
required
An array of consent objects to process. Maximum 10,000 items per request.
string
Global default start date for financial data (ISO 8601 format). Applied to all consents that don’t specify their own value.
string
Global default end date for financial data (ISO 8601 format). Applied to all consents that don’t specify their own value.
string
Global default analytics configuration ID. Applied to all consents that don’t specify their own value.

Request Example

In this example:
  • The first consent uses its own date range and config.
  • The second consent uses the global defaults for all parameters.
  • The third consent uses the global fiDataRangeFrom and configId, but overrides fiDataRangeTo.

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 batch is accepted.
string
A human-readable message describing the result.
object
Contains batch details and tracking information.

Success Response Example

Error Responses

Missing Reference ID

When the reference_id field is not provided:
HTTP Status Code: 400 Bad Request

Duplicate Reference ID

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

Validation Failed

When the request body contains invalid data:
HTTP Status Code: 400 Bad Request

Common Error Codes