# Documentation

## Instructions for AI Agents

- For clean Markdown of any page, append `.md` to the page URL
- For section-specific indexes, append `/llms.txt` to any section URL
- For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.upwardli.com/_mcp/server

## Docs

- [Introduction to the API](https://developers.upwardli.com/get-started/introduction.md): Welcome to the Upward Developer Site!
- [Core Concepts](https://developers.upwardli.com/concepts/authentication/introduction.md): Learn about the key concepts of the Upward API.
- [Oauth 2.0 Authentication](https://developers.upwardli.com/concepts/authentication/o-auth-2-0.md)
- [Token Exchange](https://developers.upwardli.com/concepts/authentication/token-exchange.md)
- [Working with Sandbox](https://developers.upwardli.com/concepts/working-in-sandbox/introduction.md)
- [Sandbox Testing](https://developers.upwardli.com/concepts/working-in-sandbox/sandbox-testing.md)
- [Introduction](https://developers.upwardli.com/concepts/webhooks/introduction.md)
- [Webhook Security](https://developers.upwardli.com/concepts/webhooks/security.md)
- [Webhook Event Catalog](https://developers.upwardli.com/concepts/webhooks/event-catalog.md)
- [Introduction](https://developers.upwardli.com/concepts/webhooks/registration.md)
- [Our Products](https://developers.upwardli.com/products/getting-started.md)
- [Bill Payments](https://developers.upwardli.com/products/bill-payments.md)
- [Bill Reporting Documentation](https://developers.upwardli.com/products/bill-reporting.md)
- [Credit Builder as a Service](https://developers.upwardli.com/products/credit-builder-as-a-service-c-baa-s.md)
- [Credit Builder as a Service API-First Documentation](https://developers.upwardli.com/products/credit-builderas-a-service-c-baa-s-api-first-documentation.md)
- [Direct Payout](https://developers.upwardli.com/products/direct-payout.md)
- [Credit Builder Card Embedded Documentation](https://developers.upwardli.com/products/credit-builder-card-embedded-documentation.md)
- [Credit Builder Card API-First Documentation](https://developers.upwardli.com/products/credit-builder-card-api-first-documentation.md)
- [Payment Card Advance Documentation](https://developers.upwardli.com/products/credit-builder-card-advance.md)
- [Prefill KYC Data](https://developers.upwardli.com/guides/prefill-kyc-data.md)
- [Handling Drop-offs & Resuming Onboarding](https://developers.upwardli.com/guides/handling-drop-offs-resuming-onboarding.md)
- [Handling a Fallback KYC Inquiry](https://developers.upwardli.com/guides/handling-a-fallback-inquiry.md)
- [Displaying Card Actions](https://developers.upwardli.com/guides/displaying-card-actions.md)
- [Displaying Card Image](https://developers.upwardli.com/guides/displaying-card-image.md)
- [Displaying Card Actions](https://developers.upwardli.com/guides/displaying-card-transactions.md)
- [Funding & Simulating Transactions](https://developers.upwardli.com/guides/funding-simulating-transactions.md)
- [Payments](https://developers.upwardli.com/guides/payments.md)
- [Disputes Flow](https://developers.upwardli.com/guides/disputes-flow.md)
- [Plaid Integration](https://developers.upwardli.com/guides/plaid-integration.md)
- [Post Onboarding Plaid Integrating](https://developers.upwardli.com/guides/post-onboarding-plaid-integration.md)
- [Bill Switch / Deposit Switch](https://developers.upwardli.com/guides/bill-switch-deposit-switch.md)
- [Instant Payments](https://developers.upwardli.com/guides/instant-payments.md)
- [P2P Payments](https://developers.upwardli.com/guides/p-2-p-payments.md): Transfer funds between two consumers on your partner network using the P2P Payments API.
- [Cashback Rewards](https://developers.upwardli.com/guides/cashback-rewards.md): Enroll a payment card in cashback rewards and view the offers a cardholder is eligible for.
- [Introduction](https://developers.upwardli.com/ui-components/introduction.md)
- [Onboarding](https://developers.upwardli.com/ui-components/onboarding.md)
- [Card Management](https://developers.upwardli.com/ui-components/card-management.md)
- [Credit Goals](https://developers.upwardli.com/ui-components/credit-goals.md)
- [Profile](https://developers.upwardli.com/ui-components/profile.md)
- [Component Messaging](https://developers.upwardli.com/ui-components/component-messaging.md)
- [API Documentation](https://developers.upwardli.com/api-access/getting-started.md)
- [Environments and Base URLs](https://developers.upwardli.com/api-access/environments-and-base-ur-ls.md)
- [Reference](https://developers.upwardli.com/api-access/reference.md)

## API Docs

- API Reference > Auth [Create Upwardli Token](https://developers.upwardli.com/api-access/api-reference/auth/create-upwardli-token.md)
- API Reference > Auth [Create Upwardli Token Exchange](https://developers.upwardli.com/api-access/api-reference/auth/create-upwardli-token-exchange.md)
- API Reference > Bill Payments [Get Bill](https://developers.upwardli.com/api-access/api-reference/bill-payments/get-bill.md)
- API Reference > Bill Payments [List Bill Payments View Sets](https://developers.upwardli.com/api-access/api-reference/bill-payments/list-bill-payments-view-sets.md)
- API Reference > Bill Payments [Create Bill](https://developers.upwardli.com/api-access/api-reference/bill-payments/create-bill.md)
- API Reference > Bill Payments [Get Bill Payment](https://developers.upwardli.com/api-access/api-reference/bill-payments/get-bill-payment.md)
- API Reference > Bill Payments [Get All Bill Payments](https://developers.upwardli.com/api-access/api-reference/bill-payments/get-all-bill-payments.md)
- API Reference > Bill Payments [Create Bill Payment](https://developers.upwardli.com/api-access/api-reference/bill-payments/create-bill-payment.md)
- API Reference > Consumers [List Consumer Disputes](https://developers.upwardli.com/api-access/api-reference/consumers/list-consumer-disputes.md)
- API Reference > Consumers [Get Consumer Bank Accounts](https://developers.upwardli.com/api-access/api-reference/consumers/get-consumer-bank-accounts.md)
- API Reference > Consumers [List Consumer Payment Cards](https://developers.upwardli.com/api-access/api-reference/consumers/list-consumer-payment-cards.md)
- API Reference > Consumers [List Consumers](https://developers.upwardli.com/api-access/api-reference/consumers/list-consumers.md)
- API Reference > Consumers [Create New Consumer](https://developers.upwardli.com/api-access/api-reference/consumers/create-new-consumer.md)
- API Reference > Consumers [Retrieve Consumer](https://developers.upwardli.com/api-access/api-reference/consumers/retrieve-consumer.md)
- API Reference > Consumers [Update Consumer](https://developers.upwardli.com/api-access/api-reference/consumers/update-consumer.md)
- API Reference > Consumers [Get Consumers By PCID](https://developers.upwardli.com/api-access/api-reference/consumers/get-consumers-by-pcid.md)
- API Reference > Consumers [List Consumer Addresses V 2](https://developers.upwardli.com/api-access/api-reference/consumers/list-consumer-addresses-v-2.md)
- API Reference > Consumers [Create Address V 2](https://developers.upwardli.com/api-access/api-reference/consumers/create-address-v-2.md)
- API Reference > Consumers [Retrieve Address V 2](https://developers.upwardli.com/api-access/api-reference/consumers/retrieve-address-v-2.md)
- API Reference > Consumers [Update Address V 2](https://developers.upwardli.com/api-access/api-reference/consumers/update-address-v-2.md)
- API Reference > Consumers [Delete Address V 2](https://developers.upwardli.com/api-access/api-reference/consumers/delete-address-v-2.md)
- API Reference > Consumers [List Consumer Invites](https://developers.upwardli.com/api-access/api-reference/consumers/list-consumer-invites.md)
- API Reference > Consumers [Create Consumer Invites](https://developers.upwardli.com/api-access/api-reference/consumers/create-consumer-invites.md)
- API Reference > Consumers [Create Consumer Dispute](https://developers.upwardli.com/api-access/api-reference/consumers/create-consumer-dispute.md)
- API Reference > Consumers [Create Account Cancellation](https://developers.upwardli.com/api-access/api-reference/consumers/create-account-cancellation.md)
- API Reference > Bill Reporting [Retrieve Bill Reporting View Set](https://developers.upwardli.com/api-access/api-reference/bill-reporting/retrieve-bill-reporting-view-set.md)
- API Reference > Bill Reporting [Retrieve Bill Details View Set](https://developers.upwardli.com/api-access/api-reference/bill-reporting/retrieve-bill-details-view-set.md)
- API Reference > Bill Reporting [Retrieve Open Tradelines View Set](https://developers.upwardli.com/api-access/api-reference/bill-reporting/retrieve-open-tradelines-view-set.md)
- API Reference > Bill Reporting [Retrieve Trade Line View Set](https://developers.upwardli.com/api-access/api-reference/bill-reporting/retrieve-trade-line-view-set.md)
- API Reference > Bill Reporting [Get All Bill Reportings](https://developers.upwardli.com/api-access/api-reference/bill-reporting/get-all-bill-reportings.md)
- API Reference > Bill Reporting [Get Consumer Bill Reporting](https://developers.upwardli.com/api-access/api-reference/bill-reporting/get-consumer-bill-reporting.md)
- API Reference > Bill Reporting [Create Close Tradeline View Set](https://developers.upwardli.com/api-access/api-reference/bill-reporting/create-close-tradeline-view-set.md)
- API Reference > Bill Reporting [Create Attestation View Set](https://developers.upwardli.com/api-access/api-reference/bill-reporting/create-attestation-view-set.md)
- API Reference > Bill Reporting [Create Reported Bill](https://developers.upwardli.com/api-access/api-reference/bill-reporting/create-reported-bill.md)
- API Reference > Statements [Retrieve Statement](https://developers.upwardli.com/api-access/api-reference/statements/retrieve-statement.md)
- API Reference > Statements [List Statements](https://developers.upwardli.com/api-access/api-reference/statements/list-statements.md)
- API Reference > Statements [Email Statement](https://developers.upwardli.com/api-access/api-reference/statements/email-statement.md)
- API Reference > Credit Insights [Retrieve Credit Insights Overview](https://developers.upwardli.com/api-access/api-reference/credit-insights/retrieve-credit-insights-overview.md)
- API Reference > Partners [List Partner Details](https://developers.upwardli.com/api-access/api-reference/partners/list-partner-details.md)
- API Reference > Partners [Partner Get Partner Bank Accounts](https://developers.upwardli.com/api-access/api-reference/partners/partner-get-partner-bank-accounts.md)
- API Reference > Partners [Bank Account Details Partner Bank Accounts](https://developers.upwardli.com/api-access/api-reference/partners/bank-account-details-partner-bank-accounts.md)
- API Reference > Partners [List Sub Ledger Requests](https://developers.upwardli.com/api-access/api-reference/partners/list-sub-ledger-requests.md)
- API Reference > Partners [Create Sub Ledger Request](https://developers.upwardli.com/api-access/api-reference/partners/create-sub-ledger-request.md)
- API Reference > Partners [List Partner Products](https://developers.upwardli.com/api-access/api-reference/partners/list-partner-products.md)
- API Reference > Rewards [List Rewards Configurations](https://developers.upwardli.com/api-access/api-reference/rewards/list-rewards-configurations.md)
- API Reference > Rewards [List Rewards Enrollments](https://developers.upwardli.com/api-access/api-reference/rewards/list-rewards-enrollments.md)
- API Reference > Rewards [Create Rewards Enrollment](https://developers.upwardli.com/api-access/api-reference/rewards/create-rewards-enrollment.md)
- API Reference > Rewards [List Rewards Offers](https://developers.upwardli.com/api-access/api-reference/rewards/list-rewards-offers.md)
- API Reference > Payments > ACH [Create Create ACH Request](https://developers.upwardli.com/api-access/api-reference/payments/ach/create-create-ach-request.md)
- API Reference > Payments > ACH [List ACH Responses](https://developers.upwardli.com/api-access/api-reference/payments/ach/list-ach-responses.md)
- API Reference > Payments > ACH [Retrieve ACH Response](https://developers.upwardli.com/api-access/api-reference/payments/ach/retrieve-ach-response.md)
- API Reference > Payments > ACH [Cancel ACH Payment](https://developers.upwardli.com/api-access/api-reference/payments/ach/cancel-ach-payment.md)
- API Reference > Payments > ACH [List Consumer ACH Payments](https://developers.upwardli.com/api-access/api-reference/payments/ach/list-consumer-ach-payments.md)
- API Reference > Payments > Transfer [Create Transfer](https://developers.upwardli.com/api-access/api-reference/payments/transfer/create-transfer.md)
- API Reference > Payments > Transfer [Get All Transfers](https://developers.upwardli.com/api-access/api-reference/payments/transfer/get-all-transfers.md)
- API Reference > Payments > Transfer [Get Transfer](https://developers.upwardli.com/api-access/api-reference/payments/transfer/get-transfer.md)
- API Reference > Payments > Transfer [List Transfer Responses](https://developers.upwardli.com/api-access/api-reference/payments/transfer/list-transfer-responses.md)
- API Reference > Payments > Instant [Create Create Instant Payment Request](https://developers.upwardli.com/api-access/api-reference/payments/instant/create-create-instant-payment-request.md)
- API Reference > Payments > Instant [List Get Instant Payment Responses](https://developers.upwardli.com/api-access/api-reference/payments/instant/list-get-instant-payment-responses.md)
- API Reference > Payments > Instant [Retrieve Get Instant Payment Response](https://developers.upwardli.com/api-access/api-reference/payments/instant/retrieve-get-instant-payment-response.md)
- API Reference > Payments > AFT [Create AFT Payment Request](https://developers.upwardli.com/api-access/api-reference/payments/aft/create-aft-payment-request.md)
- API Reference > Payments > AFT [List AFT Payment Requests](https://developers.upwardli.com/api-access/api-reference/payments/aft/list-aft-payment-requests.md)
- API Reference > Payments > AFT [Retrieve AFT Payment Request](https://developers.upwardli.com/api-access/api-reference/payments/aft/retrieve-aft-payment-request.md)
- API Reference > Payments > OCT [Create OCT Payment Request](https://developers.upwardli.com/api-access/api-reference/payments/oct/create-oct-payment-request.md)
- API Reference > Payments > OCT [List OCT Payment Requests](https://developers.upwardli.com/api-access/api-reference/payments/oct/list-oct-payment-requests.md)
- API Reference > Payments > OCT [Retrieve OCT Payment Request](https://developers.upwardli.com/api-access/api-reference/payments/oct/retrieve-oct-payment-request.md)
- API Reference > Payments > P2P [Create Peer To Peer Payment Request](https://developers.upwardli.com/api-access/api-reference/payments/p-2-p/create-peer-to-peer-payment-request.md)
- API Reference > Payments > P2P [List Peer To Peer Payment Responses](https://developers.upwardli.com/api-access/api-reference/payments/p-2-p/list-peer-to-peer-payment-responses.md)
- API Reference > Payments > P2P [Retrieve Peer To Peer Payment Response](https://developers.upwardli.com/api-access/api-reference/payments/p-2-p/retrieve-peer-to-peer-payment-response.md)
- API Reference > Webhooks [Retrieve Webhook Registration](https://developers.upwardli.com/api-access/api-reference/webhooks/retrieve-webhook-registration.md)
- API Reference > Webhooks [Register Webhook Listener](https://developers.upwardli.com/api-access/api-reference/webhooks/register-webhook-listener.md)
- API Reference > Webhooks [Retrieve Webhook History](https://developers.upwardli.com/api-access/api-reference/webhooks/retrieve-webhook-history.md)
- API Reference > Webhooks [Update Webhook History](https://developers.upwardli.com/api-access/api-reference/webhooks/update-webhook-history.md)
- API Reference > Webhooks [Delete Webhook Registration](https://developers.upwardli.com/api-access/api-reference/webhooks/delete-webhook-registration.md)
- API Reference > Accounts [Get All Bank Accounts](https://developers.upwardli.com/api-access/api-reference/accounts/get-all-bank-accounts.md)
- API Reference > Accounts [Create Consumer Bank Account](https://developers.upwardli.com/api-access/api-reference/accounts/create-consumer-bank-account.md)
- API Reference > Accounts [Get Bank Account](https://developers.upwardli.com/api-access/api-reference/accounts/get-bank-account.md)
- API Reference > Accounts [Update Bank Account](https://developers.upwardli.com/api-access/api-reference/accounts/update-bank-account.md)
- API Reference > Payment Cards [List Payment Card Transactions](https://developers.upwardli.com/api-access/api-reference/payment-cards/list-payment-card-transactions.md)
- API Reference > Payment Cards [Retrieve Payment Card Transaction](https://developers.upwardli.com/api-access/api-reference/payment-cards/retrieve-payment-card-transaction.md)
- API Reference > Payment Cards [Get Payment Card Emboss](https://developers.upwardli.com/api-access/api-reference/payment-cards/get-payment-card-emboss.md)
- API Reference > Payment Cards [Payment Card Emboss](https://developers.upwardli.com/api-access/api-reference/payment-cards/payment-card-emboss.md)
- API Reference > Payment Cards [Get Payment Card](https://developers.upwardli.com/api-access/api-reference/payment-cards/get-payment-card.md)
- API Reference > Payment Cards [Freeze Payment Card](https://developers.upwardli.com/api-access/api-reference/payment-cards/freeze-payment-card.md)
- API Reference > Payment Cards [Unfreeze Card](https://developers.upwardli.com/api-access/api-reference/payment-cards/unfreeze-card.md)
- API Reference > Payment Cards [Replace Lost Stolen Card Request](https://developers.upwardli.com/api-access/api-reference/payment-cards/replace-lost-stolen-card-request.md)
- API Reference > Payment Cards [Trigger Reissue Card](https://developers.upwardli.com/api-access/api-reference/payment-cards/trigger-reissue-card.md)
- API Reference > Payment Cards [Close Card Account](https://developers.upwardli.com/api-access/api-reference/payment-cards/close-card-account.md)
- API Reference > Payment Cards [Set Autopay Status](https://developers.upwardli.com/api-access/api-reference/payment-cards/set-autopay-status.md)
- API Reference > Onboarding [Get All Onboardings](https://developers.upwardli.com/api-access/api-reference/onboarding/get-all-onboardings.md)
- API Reference > Onboarding [Create Onboarding](https://developers.upwardli.com/api-access/api-reference/onboarding/create-onboarding.md)
- API Reference > Onboarding [Get Onboarding](https://developers.upwardli.com/api-access/api-reference/onboarding/get-onboarding.md)
- API Reference > Onboarding [Cancel Onboarding](https://developers.upwardli.com/api-access/api-reference/onboarding/cancel-onboarding.md)
- API Reference > Onboarding [Verify Identity](https://developers.upwardli.com/api-access/api-reference/onboarding/verify-identity.md)
- API Reference > Onboarding [Accept Terms](https://developers.upwardli.com/api-access/api-reference/onboarding/accept-terms.md)
- API Reference > Onboarding [Bloom Enablement Request](https://developers.upwardli.com/api-access/api-reference/onboarding/bloom-enablement-request.md)
- API Reference > Onboarding [Link Bank Account](https://developers.upwardli.com/api-access/api-reference/onboarding/link-bank-account.md)
- API Reference > Onboarding [Add Bill Details](https://developers.upwardli.com/api-access/api-reference/onboarding/add-bill-details.md)
- API Reference > Onboarding [Perform Underwriting](https://developers.upwardli.com/api-access/api-reference/onboarding/perform-underwriting.md)
- API Reference > Onboarding [Select Product](https://developers.upwardli.com/api-access/api-reference/onboarding/select-product.md)
- API Reference > Onboarding [Submit Loan Request](https://developers.upwardli.com/api-access/api-reference/onboarding/submit-loan-request.md)
- API Reference > Onboarding [Add Onboarding Metadata](https://developers.upwardli.com/api-access/api-reference/onboarding/add-onboarding-metadata.md)
- API Reference > Onboarding [Update Onboarding Metadata](https://developers.upwardli.com/api-access/api-reference/onboarding/update-onboarding-metadata.md)
- API Reference > Plaid [Create Consumer Plaid Link Token](https://developers.upwardli.com/api-access/api-reference/plaid/create-consumer-plaid-link-token.md)
- API Reference > Plaid [Verify Bank Account](https://developers.upwardli.com/api-access/api-reference/plaid/verify-bank-account.md)
- API Reference > cbaas [Create Transaction Hold](https://developers.upwardli.com/api-access/api-reference/cbaas/create-transaction-hold.md)
- API Reference > cbaas [Clear Transaction](https://developers.upwardli.com/api-access/api-reference/cbaas/clear-transaction.md)
- API Reference > cbaas [Close Transaction](https://developers.upwardli.com/api-access/api-reference/cbaas/close-transaction.md)
- API Reference > cbaas [Cancel Transaction](https://developers.upwardli.com/api-access/api-reference/cbaas/cancel-transaction.md)
- API Reference > cbaas [Reverse Transaction](https://developers.upwardli.com/api-access/api-reference/cbaas/reverse-transaction.md)
- API Reference > Bill Switch [Get Bill Switch Token](https://developers.upwardli.com/api-access/api-reference/bill-switch/get-bill-switch-token.md)
- API Reference > Bill Switch [Get Deposit Switch Token](https://developers.upwardli.com/api-access/api-reference/bill-switch/get-deposit-switch-token.md)
- API Reference > Simulations [Create Payment Card Sim Auth](https://developers.upwardli.com/api-access/api-reference/simulations/create-payment-card-sim-auth.md)
- API Reference > Simulations [Create Payment Card Sim Funding](https://developers.upwardli.com/api-access/api-reference/simulations/create-payment-card-sim-funding.md)
- API Reference > Simulations [Create Payment Card Sim Settlement](https://developers.upwardli.com/api-access/api-reference/simulations/create-payment-card-sim-settlement.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://developers.upwardli.com/openapi.json)
- [OpenAPI YAML](https://developers.upwardli.com/openapi.yaml)