Bulk Status
Bulk Operations
Bulk Status
Query the processing status of a bulk batch with per-record details, filtering, and pagination.
POST
Bulk Status
Overview
The Bulk Status API allows you to check the processing status of a bulk batch, including detailed information about each individual consent record. This API supports filtering by status and retry eligibility, pagination for large batches, and optional balance details viainclude_balances.
Notes
- Use the
reference_idyou provided when scheduling the batch to query status. - For large batches, use pagination to retrieve results in manageable chunks.
include_balances=trueenriches records withaccount_details.- Failed records include retry eligibility information to help you decide next steps.
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
application/json.Request Body
The unique reference ID you provided when scheduling the batch.
Optional filters to narrow down the results.
Page number for pagination.
Number of records per page. Maximum: 1000.
Whether to include account balance details in each record.
Request Example
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" for successful queries.Contains batch status information.
Record Object
Each record in therecords array contains:
| Field | Type | Description |
|---|---|---|
id | integer | Unique identifier for this record |
consent_id | string | The consent ID |
status | string | Record status (see Row Status Values) |
retry_eligible | string | Retry eligibility (Yes, No, YesWithModifications) |
session_id | string | FI request session ID (if request was made) |
error | object | Error details (if failed) |
account_details | array | Present only if include_balances=true |
Success Response Example
Status Values
Batch Status Values
| Status | Description |
|---|---|
READY | Batch accepted and ready for processing |
IN_PROGRESS | Records are being processed |
COMPLETED | All records processed successfully |
FAILED | Batch-level failure |
Row Status Values
| Status | Description |
|---|---|
READY | Record validated, ready for processing |
IN_PROGRESS | FI request sent, awaiting response |
COMPLETED | Data fetched successfully |
FAILED | Processing failed |
Retry Eligibility Values
| Value | Description | Action |
|---|---|---|
Yes | Can retry as-is | Retry without changes |
No | Cannot retry (permanent failure) | Review error and fix source issue |
YesWithModifications | Can retry with changes | Apply suggested modifications before retry |
Error Responses
Batch Not Found
When thereference_id does not exist:
404 Not Found