# Rightfoot API

> API documentation for Rightfoot - leading provider of passwordless, consumer-permissioned financial data

## Docs

- [Introduction](https://docs.rightfoot.com/introduction.md): Welcome to the Rightfoot API documentation
- [Authentication](https://docs.rightfoot.com/authentication.md): Learn how to authenticate with the Rightfoot API
- [Quickstart](https://docs.rightfoot.com/quickstart.md): Get started with the Rightfoot API in minutes
- [Submit Balance Check](https://docs.rightfoot.com/api-reference/stable/submit-balance-request.md): Submit a batch of authorizers for balance checks
- [Submit Balance Check (CSV)](https://docs.rightfoot.com/api-reference/stable/submit-batch-csv.md): Submit a batch of authorizers for balance checks via CSV upload
- [Retrieve Balance Results](https://docs.rightfoot.com/api-reference/stable/get-balances.md): Retrieve processed balances for a batch
- [Retrieve Balance Results (CSV)](https://docs.rightfoot.com/api-reference/stable/get-balances-csv.md): Download balance results for one or more batches as a CSV file
- [Create Monitoring Schedule](https://docs.rightfoot.com/api-reference/monitoring/create-scheduled-balance-request.md): Create a recurring scheduled balance request for authorizers
- [Retrieve Schedule Details](https://docs.rightfoot.com/api-reference/monitoring/get-schedule.md): Retrieve details about a scheduled balance request
- [Update Schedule](https://docs.rightfoot.com/api-reference/monitoring/update-schedule.md): Update an existing scheduled balance request
- [Retrieve Authorizer Balance History](https://docs.rightfoot.com/api-reference/monitoring/get-authorizer-history.md): Retrieve balance check history for a specific authorizer
- [Remove Schedule Authorizers](https://docs.rightfoot.com/api-reference/monitoring/remove-schedule-authorizers.md): Remove authorizers from a scheduled balance request
- [IP Allowlisting](https://docs.rightfoot.com/api-reference/webhooks/ip-allowlist.md): Static IP addresses Rightfoot uses to send webhooks
- [Balance Check Run Completed](https://docs.rightfoot.com/api-reference/webhooks/balance-batch-completed.md): Fires when a balance check run completes
- [Balance Threshold Alert](https://docs.rightfoot.com/api-reference/webhooks/balance-threshold-alert.md): Webhook notification when authorizers meet or exceed configured balance thresholds

## OpenAPI Specs

- [openapi](https://docs.rightfoot.com/api-reference/openapi.yaml)