Skip to main content
GET
/
v1
/
balances
/
csv
Retrieve Balance Results (CSV)
curl --request GET \
  --url https://api.rightfoot.com/v1/balances/csv \
  --header 'Authorization: Bearer <token>'
"Authorizer ID,Batch ID,Institution,Phone,Zip,Balance,Status,Creator,Timestamp,meta_customer_ref\nauthz-001,8ac1f4a6-1234-4abc-9d3e-001122334455,Bank of America,+15551234567,10001,2843.51,SUCCESS,jane.doe@acme.com,2026-05-17T19:24:12+00:00,CR-9981\nauthz-002,8ac1f4a6-1234-4abc-9d3e-001122334455,Wells Fargo,,90210,,NO_MATCH,,2026-05-17T19:25:03+00:00,\n"

Documentation Index

Fetch the complete documentation index at: https://docs.rightfoot.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Retrieve Balance Results (CSV)

Download balance results for one or more batches as a CSV file. The CSV includes the same columns produced by the Bigfoot dashboard download (Institution, Phone, Zip, Creator) in addition to the core fields returned by Retrieve Balance Results.
This endpoint returns a richer field set than GET /v1/balances. Use it when you need the full dashboard-style export. For paginated JSON per row, use GET /v1/balances.

​
Multiple batches in a single export

Repeat the batch_ids query parameter to fetch multiple batches in one CSV. All batches must belong to the authenticated requester — if any do not, the request is rejected with 403 and no file is returned. 
curl -X GET 'https://api.rightfoot.com/v1/balances/csv?batch_ids=8ac1f4a6-1234-4abc-9d3e-001122334455&batch_ids=12c4d6ee-aaaa-4abc-9d3e-bbbbccccdddd' \
  -H 'Authorization: Bearer rf_live_...' \
  -o balances.csv

​
Response

Returns text/csv; charset=utf-8 with Content-Disposition: attachment; filename="batch-export-<timestamp>.csv". The CSV contains a header row followed by one row per balance result. The first nine columns are fixed; additional meta_<key> columns are appended alphabetically when any authorizer in the result set has metadata.
ColumnDescription
Authorizer IDYour authorizer’s unique identifier.
Batch IDThe batch this result belongs to.
InstitutionFull name of the financial institution.
PhoneAuthorizer phone number, if known.
ZipAuthorizer zip code, if known.
BalanceAccount balance in USD (decimal). Empty when unavailable.
StatusOne of SUCCESS, NO_MATCH, ACCOUNT_CLOSED, BANK_UNSUPPORTED, RETRIEVAL_FAILED, RETRY_LIMIT, PROCESSING_ERROR.
CreatorDisplay name of the dashboard user who submitted the request. Empty for API submissions.
TimestampISO-8601 timestamp (UTC) when the result was recorded.
meta_<key>One column per metadata key set on any authorizer in the result.

​
Example response

Authorizer ID,Batch ID,Institution,Phone,Zip,Balance,Status,Creator,Timestamp,meta_customer_ref
authz-001,8ac1f4a6-1234-4abc-9d3e-001122334455,Bank of America,+15551234567,10001,2843.51,SUCCESS,jane.doe@acme.com,2026-05-17T19:24:12+00:00,CR-9981
authz-002,8ac1f4a6-1234-4abc-9d3e-001122334455,Wells Fargo,,90210,,NO_MATCH,,2026-05-17T19:25:03+00:00,

​
Errors

StatusCause
400Missing batch_ids or one of the values is not a valid UUID.
401Missing or invalid API key.
403One or more requested batches don’t belong to the authenticated requester.
500Internal server error.

​
Best Practices

  1. Stream to disk - CSV exports can be large; use -o (cURL) or stream the response body rather than buffering it in memory
  2. Match by Authorizer ID - Pair rows back to your records using the Authorizer ID column, which mirrors the authorizer_unique_id you submitted
  3. Check Status per row - An empty Balance paired with a non-SUCCESS Status indicates the balance check failed for that authorizer

Authorizations

​
Authorization
string
header
required

Authentication to the API is performed via Bearer Token Authentication. Provide your API key as the bearer token in the Authorization header.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Query Parameters

​
batch_ids
string<uuid>[]
required

One or more batch IDs to export. Repeat the parameter to fetch multiple batches in a single CSV (?batch_ids=<id1>&batch_ids=<id2>). All batches must belong to the authenticated requester.

Response

CSV file containing one row per balance result.

The response is of type string.