# Carbn Connect

## Docs

- [Get Crypto Balance](https://docs.carbn.xyz/api-reference/account-management/get-crypto-balance.md): Get the crypto balance for a user in USD. Returns a decimal number representing the balance.
- [Register Destination Account](https://docs.carbn.xyz/api-reference/account-management/register-destination-account.md): Register a new destination account (bank account or card) for a user
- [Register Wallet](https://docs.carbn.xyz/api-reference/account-management/register-wallet.md): Register a new wallet for a user
- [Get Offramp Transaction Status](https://docs.carbn.xyz/api-reference/audit-&-reporting/get-offramp-transaction-status.md): Get the current status of a specific offramp transaction by its ID
- [Get Onramp Audit](https://docs.carbn.xyz/api-reference/audit-&-reporting/get-onramp-audit.md): Get audit information for onramp transactions for a specific wallet
- [Get Onramp Transaction Status](https://docs.carbn.xyz/api-reference/audit-&-reporting/get-onramp-transaction-status.md): Get the current status of a specific onramp transaction by its ID
- [Authentication](https://docs.carbn.xyz/api-reference/authentication.md): Learn how to authenticate with the Carbn Connect API
- [Create Custody Wallet](https://docs.carbn.xyz/api-reference/custody-wallet/create-custody-wallet.md): Create a Carbn custody wallet for a user on the specified chain
- [Custody Wallet Transfer](https://docs.carbn.xyz/api-reference/custody-wallet/custody-wallet-transfer.md): Initiate a transfer from a Carbn custody wallet to an external address
- [Get Custody Wallet](https://docs.carbn.xyz/api-reference/custody-wallet/get-custody-wallet.md): Get details of a Carbn custody wallet by ID
- [Get Custody Wallet Transactions](https://docs.carbn.xyz/api-reference/custody-wallet/get-custody-wallet-transactions.md): Get paginated list of transactions for a custody wallet
- [Get Custody Wallet Transfer Status](https://docs.carbn.xyz/api-reference/custody-wallet/get-custody-wallet-transfer-status.md): Get the status of a custody wallet transfer by transaction ID
- [Get Total Custody Wallet Balances](https://docs.carbn.xyz/api-reference/custody-wallet/get-total-custody-wallet-balances.md): Get aggregated balances across all custody wallets for all supported cryptocurrencies
- [Error Handling](https://docs.carbn.xyz/api-reference/errors.md): Understand Carbn API error codes, responses, and handling
- [Get Carbn Currency Exchange Rate](https://docs.carbn.xyz/api-reference/exchange/get-carbn-currency-exchange-rate.md): Get the current exchange rate from source currency to target currency using Carbn's rates
- [Get Open Banking Payment Status](https://docs.carbn.xyz/api-reference/open-banking/get-open-banking-payment-status.md): Get the status and details of an Open Banking payment by payment ID
- [Accept Offramp Quote](https://docs.carbn.xyz/api-reference/payments/accept-offramp-quote.md): Accept a quote and initiate the offramp transfer
- [Get Offramp Quote](https://docs.carbn.xyz/api-reference/payments/get-offramp-quote.md): Get a quote for converting crypto to fiat and sending to a registered destination account
- [Initiate Offramp](https://docs.carbn.xyz/api-reference/payments/initiate-offramp.md): Initiate an offramp transfer. Returns a cryptocurrency deposit address where users should send their crypto. Once crypto is deposited, it will be converted to fiat and sent to the registered destination account.
- [Initiate Offramp Payout](https://docs.carbn.xyz/api-reference/payments/initiate-offramp-payout.md): Initiate a payout after crypto has been deposited to the offramp address. This converts the deposited crypto to fiat and sends it to the registered destination account.
- [Onramp Transfer](https://docs.carbn.xyz/api-reference/payments/onramp-transfer.md): Initiate a new onramp transfer
- [Create Payout](https://docs.carbn.xyz/api-reference/payouts/create-payout.md): Create a local currency payout to a user's bank account using their available balance.
- [Get Payout Balances](https://docs.carbn.xyz/api-reference/payouts/get-payout-balances.md): Retrieve available payout balances for a user, grouped by currency.
- [Get Payout Status](https://docs.carbn.xyz/api-reference/payouts/get-payout-status.md): Retrieve the current status and details of a payout.
- [Create User Onboarding Session](https://docs.carbn.xyz/api-reference/user-management/create-user-onboarding-session.md): Create a new user onboarding session and generate a hosted KYC link. This endpoint is used for the hosted KYC flow where users complete verification through a pre-built compliance interface. The returned onboarding URL redirects users to complete their KYC verification.
- [Generate User Consent](https://docs.carbn.xyz/api-reference/user-management/generate-user-consent.md): Record user acceptance of terms and conditions and generate a consent ID
- [Get All Users](https://docs.carbn.xyz/api-reference/user-management/get-all-users.md): Get a list of all users in the system
- [Get User Details](https://docs.carbn.xyz/api-reference/user-management/get-user-details.md): Retrieve detailed information about a user including their KYC status, verification state, and any requirements due. For comprehensive guides on handling user statuses and rejection reasons, see our [User Status Documentation](/documentation/developer-platform/users/compliance/user-status) and [Reje…
- [Update User](https://docs.carbn.xyz/api-reference/user-management/update-user.md): Update user information. All fields are optional - only include fields that need to be updated.
- [User Onboarding](https://docs.carbn.xyz/api-reference/user-management/user-onboarding.md): Create a new user with KYC information
- [Register Webhook](https://docs.carbn.xyz/api-reference/webhook-management/register-webhook.md): Register a new webhook endpoint to receive event notifications. Webhooks are created with `status: "disabled"` by default and must be enabled using the PUT endpoint. For comprehensive webhook setup and verification guides, see [Configure Webhooks](/documentation/getting-started/configure-webhook) an…
- [Trigger Webhook Event](https://docs.carbn.xyz/api-reference/webhook-management/trigger-webhook-event.md): Manually trigger a webhook event for testing purposes using the webhook's unique ID
- [Update Webhook](https://docs.carbn.xyz/api-reference/webhook-management/update-webhook.md): Update an existing webhook's URL and status. Webhooks are created with 'disabled' status by default and must be enabled using this endpoint.
- [Changelog](https://docs.carbn.xyz/changelog/overview.md): Stay up to date with the latest changes and improvements to Carbn Connect
- [Payouts](https://docs.carbn.xyz/documentation/developer-platform/monitoring/payouts.md): Integrate fiat payouts to bank accounts using Carbn
- [Transfer Status](https://docs.carbn.xyz/documentation/developer-platform/monitoring/transfer-status.md): Monitor and track transfer states throughout the complete payment lifecycle
- [Webhook Verification](https://docs.carbn.xyz/documentation/developer-platform/monitoring/webhook-verification.md): Verify webhook authenticity using RSA signature verification
- [Enhanced Due Diligence](https://docs.carbn.xyz/documentation/developer-platform/users/compliance/enhanced-due-diligence.md): Additional verification requirements for high-risk users and increased limits
- [KYC Requirements](https://docs.carbn.xyz/documentation/developer-platform/users/compliance/kyc-requirements.md): Identity verification requirements for individuals and businesses
- [Overview](https://docs.carbn.xyz/documentation/developer-platform/users/compliance/overview.md): User management and compliance verification
- [Rejection Reasons](https://docs.carbn.xyz/documentation/developer-platform/users/compliance/rejection-reasons.md): Understanding user rejection reasons and how to handle them
- [User Onboarding Status](https://docs.carbn.xyz/documentation/developer-platform/users/compliance/user-status.md): User onboarding status and how to handle them
- [Configure Webhooks](https://docs.carbn.xyz/documentation/getting-started/configure-webhook.md): Set up real-time notifications for payment status updates
- [Create Your First Payment](https://docs.carbn.xyz/documentation/getting-started/first-payment.md)
- [Onboard Your First User](https://docs.carbn.xyz/documentation/getting-started/onboard-first-user.md): Ready to onboard and verify your first user
- [Get Setup with Carbn](https://docs.carbn.xyz/documentation/getting-started/setup.md): Let’s get you setup and help navigate our APIs
- [Introduction](https://docs.carbn.xyz/documentation/home/introduction.md)
- [Geographic Coverage](https://docs.carbn.xyz/documentation/network/geographic-coverage.md)
- [Payment Rails & Currency](https://docs.carbn.xyz/documentation/network/supported-payment-methods.md)
- [Welcome](https://docs.carbn.xyz/welcome.md)

## OpenAPI Specs

- [openapi](https://docs.carbn.xyz/api-reference/openapi.json)