# Baanx API

## Docs

- [Authenticate User](https://docs.baanx.com/api-reference/auth/login.md): Authenticate user with email and password to obtain an access token
- [Send OTP Code](https://docs.baanx.com/api-reference/auth/login-otp.md): Send one-time password code to user's phone for two-factor authentication
- [Logout User](https://docs.baanx.com/api-reference/auth/logout.md): Invalidate access token and end user session
- [Generate Authorization Code](https://docs.baanx.com/api-reference/auth/oauth-authorize.md): Third step of OAuth 2.0 flow - generate authorization code from JWT and access tokens
- [Initiate OAuth Authorization](https://docs.baanx.com/api-reference/auth/oauth-authorize-initiate.md): First step of OAuth 2.0 Authorization Code Flow with PKCE
- [Revoke OAuth Authorization](https://docs.baanx.com/api-reference/auth/oauth-revoke.md): Permanently revoke OAuth authorization and invalidate all tokens
- [Exchange Code for Tokens](https://docs.baanx.com/api-reference/auth/oauth-token.md): Final OAuth step - exchange authorization code or refresh token for access tokens
- [Get Onboarding Details](https://docs.baanx.com/api-reference/auth/register.md): Retrieve user onboarding details and current registration status
- [Update Physical Address](https://docs.baanx.com/api-reference/auth/register-address.md): Submit physical address during registration onboarding
- [Send Registration Email](https://docs.baanx.com/api-reference/auth/register-email-send.md): Initiate registration by sending verification code to user's email
- [Verify Email Code](https://docs.baanx.com/api-reference/auth/register-email-verify.md): Verify email code and create user account with initial details
- [Update Mailing Address](https://docs.baanx.com/api-reference/auth/register-mailing-address.md): Submit mailing address for US residents to complete registration
- [Update Personal Details](https://docs.baanx.com/api-reference/auth/register-personal-details.md): Submit personal information for KYC verification during registration
- [Send Phone Verification SMS](https://docs.baanx.com/api-reference/auth/register-phone-send.md): Send SMS verification code to user's phone number during registration
- [Verify Phone Code](https://docs.baanx.com/api-reference/auth/register-phone-verify.md): Verify SMS code and update user onboarding with phone number
- [Generate KYC Verification Session](https://docs.baanx.com/api-reference/auth/register-verification.md): Generate a Veriff verification session URL for identity verification during registration
- [Get Registration Settings](https://docs.baanx.com/api-reference/auth/settings.md): Retrieve configuration settings required for building registration forms
- [Generate Card Details Token](https://docs.baanx.com/api-reference/card/details-token.md): Generate a secure token for displaying sensitive card details through an image-based display
- [Freeze Card](https://docs.baanx.com/api-reference/card/freeze.md): Temporarily disable the card to prevent all transaction authorizations
- [Order a Card](https://docs.baanx.com/api-reference/card/order.md): Order a new card for the authenticated user
- [Generate PIN View Token](https://docs.baanx.com/api-reference/card/pin-token.md): Generate a secure token for viewing the card PIN through an image-based display
- [Generate PIN Set Token](https://docs.baanx.com/api-reference/card/set-pin-token.md): Generate a secure token for setting or changing the card PIN through a PCI-compliant hosted interface
- [Get Card Status](https://docs.baanx.com/api-reference/card/status.md): Retrieve the current status and details of the authenticated user's card
- [Get Card Transactions](https://docs.baanx.com/api-reference/card/transactions.md): Retrieve paginated card transaction history with optional filtering
- [Generate Transaction Statement](https://docs.baanx.com/api-reference/card/transactions-statement.md): Generate a downloadable transaction statement in CSV or PDF format
- [Unfreeze Card](https://docs.baanx.com/api-reference/card/unfreeze.md): Reactivate a frozen card to resume transaction authorizations
- [Create Onboarding Consent](https://docs.baanx.com/api-reference/consent/create-onboarding-consent.md): Create a new consent set during user onboarding before a userId exists
- [Get Consent Audit Trail](https://docs.baanx.com/api-reference/consent/get-consent-audit.md): Retrieve paginated audit log of all consent changes for a user
- [Get Consent Set by ID](https://docs.baanx.com/api-reference/consent/get-consent-set.md): Retrieve a specific consent set with all consent records
- [Get Consent Sets by Onboarding ID](https://docs.baanx.com/api-reference/consent/get-onboarding-consent.md): Retrieve all consent sets associated with an onboarding ID
- [Get User Consent Status](https://docs.baanx.com/api-reference/consent/get-user-consent.md): Retrieve user consent status with optional full details
- [Link User to Consent Set](https://docs.baanx.com/api-reference/consent/link-user-to-consent.md): Associate a userId with an existing consent set created during onboarding
- [Revoke Consent](https://docs.baanx.com/api-reference/consent/revoke-consent.md): Revoke a specific consent while maintaining immutable audit trail
- [Get Blockchain Configuration](https://docs.baanx.com/api-reference/delegation/chain-config.md): Retrieve blockchain network configuration including chain IDs, token contract addresses, and spender addresses required for wallet delegation
- [Complete EVM Wallet Delegation](https://docs.baanx.com/api-reference/delegation/evm-post-approval.md): Finalize delegation of spending authority from EVM-compatible wallets (Step 3 of 3)
- [Get Delegation Token](https://docs.baanx.com/api-reference/delegation/get-token.md): Retrieve a single-use delegation token to initiate wallet delegation, with optional gas faucet
- [Complete Solana Wallet Delegation](https://docs.baanx.com/api-reference/delegation/solana-post-approval.md): Finalize delegation of spending authority from Solana wallets (Step 3 of 3)
- [API Reference](https://docs.baanx.com/api-reference/introduction.md): Complete API reference for the Baanx multi-tenant gateway
- [Create Order](https://docs.baanx.com/api-reference/order/create.md): Initiate an order for a product such as a premium account upgrade or metal card. Returns a unique order reference to pass to your payment gateway.
- [Get Available Products](https://docs.baanx.com/api-reference/order/enum-products.md): Fetch the list of active orderable products available to the current user, including eligibility status.
- [Get Order Status](https://docs.baanx.com/api-reference/order/status.md): Fetch the current status of an order by ID. Use this to poll for async completion after a payment is submitted.
- [Get User Referral Code](https://docs.baanx.com/api-reference/referral/get-referral-code.md): Retrieve the referral code for the authenticated user
- [Validate Referral Code](https://docs.baanx.com/api-reference/referral/validate-referral-code.md): Validate a referral code entered by a user during registration
- [Get User Details](https://docs.baanx.com/api-reference/user/get-user.md): Retrieves profile information for the authenticated user, including personal details, contact information, and verification status
- [Start User Verification](https://docs.baanx.com/api-reference/user/verification.md): Generates a verification session URL for identity verification
- [Get Credit Wallet Balance](https://docs.baanx.com/api-reference/wallet/credit.md): Retrieve the authenticated user's credit wallet balance and details
- [Withdraw from Credit Wallet](https://docs.baanx.com/api-reference/wallet/credit-withdraw.md): Initiate a withdrawal from credit wallet to external wallet address
- [Estimate Credit Withdrawal Fees](https://docs.baanx.com/api-reference/wallet/credit-withdraw-estimation.md): Calculate network fees for withdrawing funds from the credit wallet
- [Get External Wallets](https://docs.baanx.com/api-reference/wallet/external.md): Retrieve non-custodial wallet addresses registered by the user
- [Get External Wallet Priority](https://docs.baanx.com/api-reference/wallet/external-priority-get.md): Retrieve the current priority order of external wallets for transaction funding
- [Update External Wallet Priority](https://docs.baanx.com/api-reference/wallet/external-priority-put.md): Update the priority order of external wallets for transaction funding
- [Get Wallet Transaction History](https://docs.baanx.com/api-reference/wallet/history.md): Retrieve paginated transaction history for credit, reward, or internal wallets
- [Get/Create Internal Wallets](https://docs.baanx.com/api-reference/wallet/internal.md): Retrieve or create custodial wallets managed by the Baanx platform
- [Unlink Wallet from Card](https://docs.baanx.com/api-reference/wallet/internal-card-linked-delete.md): Remove a custodial wallet from card payment sources
- [List Card-Linked Wallets](https://docs.baanx.com/api-reference/wallet/internal-card-linked-get.md): Retrieve all custodial wallets currently linked to the user's card
- [Link Wallet to Card](https://docs.baanx.com/api-reference/wallet/internal-card-linked-post.md): Link a custodial wallet to the card as a payment source
- [Update Linked Wallet Priority](https://docs.baanx.com/api-reference/wallet/internal-card-linked-priority.md): Update the priority order of card-linked custodial wallets
- [Withdraw from Internal Wallet](https://docs.baanx.com/api-reference/wallet/internal-withdraw.md): Initiate withdrawal from custodial wallet to external blockchain address
- [Get Reward Wallet Balance](https://docs.baanx.com/api-reference/wallet/reward.md): Retrieve the authenticated user's reward wallet balance and details
- [Withdraw from Reward Wallet](https://docs.baanx.com/api-reference/wallet/reward-withdraw.md): Initiate a withdrawal from reward wallet to external wallet address
- [Estimate Reward Withdrawal Fees](https://docs.baanx.com/api-reference/wallet/reward-withdraw-estimation.md): Calculate network fees for withdrawing funds from the reward wallet
- [Remove Addresses from Whitelist](https://docs.baanx.com/api-reference/wallet/whitelist-delete.md): Remove one or more pre-approved external wallet addresses from the whitelist
- [Get Whitelisted Addresses](https://docs.baanx.com/api-reference/wallet/whitelist-get.md): Retrieve pre-approved external wallet addresses for secure withdrawals
- [Add Addresses to Whitelist](https://docs.baanx.com/api-reference/wallet/whitelist-post.md): Add one or more pre-approved external wallet addresses for secure withdrawals
- [Create Webhook Endpoint](https://docs.baanx.com/api-reference/webhooks/create-webhook.md): Create a new webhook configuration for receiving event notifications
- [Delete Webhook Endpoint](https://docs.baanx.com/api-reference/webhooks/delete-webhook.md): Permanently delete a webhook configuration
- [Get Event Delivery Logs](https://docs.baanx.com/api-reference/webhooks/event-logs.md): Retrieve all delivery attempts for a specific event
- [Get Event Status](https://docs.baanx.com/api-reference/webhooks/event-status.md): Retrieve the current processing status of a specific event
- [Get Webhook Endpoint](https://docs.baanx.com/api-reference/webhooks/get-webhook.md): Retrieve a specific webhook configuration by ID
- [List Events](https://docs.baanx.com/api-reference/webhooks/list-events.md): Retrieve a list of events for the authenticated partner
- [List Webhook Endpoints](https://docs.baanx.com/api-reference/webhooks/list-webhooks.md): Retrieve all webhook configurations for the authenticated partner
- [Retry Event Delivery](https://docs.baanx.com/api-reference/webhooks/retry-event.md): Manually trigger a retry of event delivery to webhooks
- [Rotate Webhook Signing Key](https://docs.baanx.com/api-reference/webhooks/rotate-key.md): Generate a new API key for webhook signature verification
- [Update Webhook Endpoint](https://docs.baanx.com/api-reference/webhooks/update-webhook.md): Update an existing webhook configuration
- [Get Webhook Delivery Logs](https://docs.baanx.com/api-reference/webhooks/webhook-logs.md): Retrieve delivery logs for a specific webhook endpoint
- [Card Lifecycle Management](https://docs.baanx.com/guides/card/management.md): Control card status with freeze, unfreeze, and state management operations
- [Card Ordering](https://docs.baanx.com/guides/card/ordering.md): Complete guide to ordering and activating virtual cards for your users
- [Card Operations Overview](https://docs.baanx.com/guides/card/overview.md): Comprehensive guide to managing physical and virtual cards, PIN operations, and transactions
- [Physical cards and premium accounts](https://docs.baanx.com/guides/card/physical.md): Physical card ordering and account upgrades
- [Secure PIN Operations](https://docs.baanx.com/guides/card/pin-operations.md): Token-based PIN management with PCI-compliant image delivery
- [Transaction Management](https://docs.baanx.com/guides/card/transactions.md): Query transaction history, apply filters, and generate statements
- [Compliance & Best Practices](https://docs.baanx.com/guides/consent/compliance.md): Regulatory requirements, audit strategies, and best practices for consent management
- [Implementation Guide](https://docs.baanx.com/guides/consent/implementation.md): Step-by-step guide to integrating consent management into your application
- [Consent Management Overview](https://docs.baanx.com/guides/consent/overview.md): Understand the Baanx consent management system, policy types, and workflow for regulatory compliance
- [Troubleshooting](https://docs.baanx.com/guides/consent/troubleshooting.md): Common issues, error codes, and solutions for consent management
- [EVM Chains (Linea & Ethereum)](https://docs.baanx.com/guides/delegation/evm-chains.md): EVM-specific delegation implementation for Linea and Ethereum networks
- [Implementation Guide](https://docs.baanx.com/guides/delegation/implementation.md): Complete step-by-step guide to implementing wallet delegation
- [Delegation Overview](https://docs.baanx.com/guides/delegation/overview.md): Understanding non-custodial wallet delegation for card payments
- [Priority Management](https://docs.baanx.com/guides/delegation/priority.md): Configure and optimize wallet charging priority for transactions
- [Redelegation](https://docs.baanx.com/guides/delegation/redelegation.md): When and how to update existing wallet delegations
- [Solana Implementation](https://docs.baanx.com/guides/delegation/solana.md): Solana-specific delegation implementation with SPL Token delegation
- [Welcome to Baanx API](https://docs.baanx.com/guides/introduction.md): Build powerful financial applications with cryptocurrency wallets and card payments
- [API Mode Flow](https://docs.baanx.com/guides/oauth/api-mode.md): Implement OAuth 2.0 with custom authentication UI
- [OAuth 2.0 Quick Start](https://docs.baanx.com/guides/oauth/quickstart.md): Get started with OAuth 2.0 authorization in minutes
- [Security Best Practices](https://docs.baanx.com/guides/oauth/security.md): Essential security guidelines for OAuth 2.0 implementation
- [Token Management](https://docs.baanx.com/guides/oauth/token-management.md): Master token lifecycle, refresh strategies, and best practices
- [OAuth Troubleshooting](https://docs.baanx.com/guides/oauth/troubleshooting.md): Common issues and solutions for OAuth 2.0 implementation
- [Authentication](https://docs.baanx.com/guides/user/authentication.md): Complete guide to user login, OTP verification, session management, and logout flows
- [User Management Overview](https://docs.baanx.com/guides/user/overview.md): Complete guide to user registration, authentication, and profile management
- [Profile Management](https://docs.baanx.com/guides/user/profile.md): Complete guide to viewing and managing user profile information, settings, and verification status
- [User Registration](https://docs.baanx.com/guides/user/registration.md): Complete step-by-step guide to implementing the multi-step registration flow with email/phone verification and KYC data collection
- [Wallet-to-Card Linking](https://docs.baanx.com/guides/wallet/custodial/card-linking.md): Connect internal wallets to cards for seamless cryptocurrency payments
- [Custodial Wallets](https://docs.baanx.com/guides/wallet/custodial/index.md): Platform-managed wallets with simplified user experience and whitelist-based security
- [Internal Wallet Operations](https://docs.baanx.com/guides/wallet/custodial/internal-wallets.md): Create and manage custodial wallets across multiple blockchain networks
- [Whitelist Management](https://docs.baanx.com/guides/wallet/custodial/whitelist.md): Manage approved withdrawal addresses for secure custodial wallet operations
- [Withdrawal Operations](https://docs.baanx.com/guides/wallet/custodial/withdrawals.md): Withdraw funds from custodial wallets to whitelisted external addresses
- [External Wallet Operations](https://docs.baanx.com/guides/wallet/non-custodial/external-wallets.md): View and manage user-controlled external wallets registered via delegation
- [Non-Custodial Wallets](https://docs.baanx.com/guides/wallet/non-custodial/index.md): User-controlled wallets with delegation-based spending authority for card payments
- [External Wallet Priority](https://docs.baanx.com/guides/wallet/non-custodial/priority.md): Control wallet priority for card payments and credit/reward withdrawals
- [Wallet Management Overview](https://docs.baanx.com/guides/wallet/overview.md): Understand custodial and non-custodial wallet models and choose the right approach for your integration
- [Delivery & Retry Policy](https://docs.baanx.com/guides/webhooks/delivery.md): How webhooks are delivered, what status codes to return, and how failed deliveries are retried
- [Event Types & Payload Structure](https://docs.baanx.com/guides/webhooks/events.md): Available event types, subscription patterns, and the standard webhook payload
- [KYC Status Events](https://docs.baanx.com/guides/webhooks/kyc-events.md): Complete reference for KYC status change webhooks, payload fields, and failure codes
- [Webhooks Overview](https://docs.baanx.com/guides/webhooks/overview.md): Receive real-time event notifications from the Baanx platform
- [Security & Signature Verification](https://docs.baanx.com/guides/webhooks/security.md): Verify webhook authenticity using HMAC-SHA256 signatures and protect against replay attacks

## OpenAPI Specs

- [openapi](https://docs.baanx.com/api-reference/openapi.json)