# Rightfoot API

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

- [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
- [Enroll and Update Borrowers](https://docs.rightfoot.com/api-reference/payments/create-payment-enrollments.md): Enroll borrowers and update them by re-sending — one route for your whole file
- [Remove Borrowers from Monitoring](https://docs.rightfoot.com/api-reference/payments/delete-payment-enrollments.md): Stop monitoring a batch of borrowers without deleting anything about them
- [Retrieve Payment Results](https://docs.rightfoot.com/api-reference/payments/get-payment-events.md): Every payment event Rightfoot holds for one borrower, oldest first
- [Report Payment Results (CSV)](https://docs.rightfoot.com/api-reference/payments/upload-payment-results.md): Upload the outcomes of your debits so Rightfoot can match and act on them
- [Processor Keys in the Portal](https://docs.rightfoot.com/api-reference/payments/processor-keys-portal.md): Add, tag and manage your processor keys from the Rightfoot portal — no API call needed
- [Add a Processor Key](https://docs.rightfoot.com/api-reference/payments/create-payment-connection.md): Register a processor API key and choose which borrowers and payment types it takes
- [List Processor Keys](https://docs.rightfoot.com/api-reference/payments/list-payment-connections.md): Every key registered for your account, and which payment types have no default
- [Update a Processor Key](https://docs.rightfoot.com/api-reference/payments/update-payment-connection.md): Rename a key, change its payment types, make it the default, or replace the key itself
- [Delete a Processor Key](https://docs.rightfoot.com/api-reference/payments/delete-payment-connection.md): Revoke a key and remove it from your account
- [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](/api-reference/openapi.yaml)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.