- Integrations
- Identity
- Platform liveness probe
- Get JSON Web Key Set
- Login with identifier and password
- Logout and invalidate refresh token
- Verify MFA during login
- Refresh access token
- Register a new user
- Initiate step-up authentication
- Verify step-up MFA and issue step-up token
- Verify email OTP
- Verify phone OTP
- Platform liveness probe
- Get current user profile
- GET /v1/users/me/mfa
- PATCH /v1/users/me/mfa
- DELETE /v1/users/me/mfa/totp
- POST /v1/users/me/mfa/totp/confirm
- POST /v1/users/me/mfa/totp/setup
- Change password (step-up required)
- Update user profile
- Finance
- List openable account types
- List user accounts
- Open account (step-up required)
- Aggregated balance history across accounts
- Submit account open request
- List my account open requests
- Get accounts summary totals
- Get account details
- Account balance history
- List account ledger transactions
- List issuable card products
- List user cards
- Issue card on existing account (step-up required)
- Open account and issue card (step-up required)
- Get card details
- Reveal card CVV (step-up required)
- Reveal card number
- Block or unblock card
- List recent transfer recipients
- Search transactions and recipients
- List available transfer types
- Create transfer (step-up required)
- List user transfers
- Quote transfer fees and FX
- Get transfer details
- Cancel pending transfer (step-up required)
- Admin
- Finance
- List pending account requests
- Review account request
- List account types
- Create account type
- Get account type
- Update account type
- Delete account type
- List accounts
- Open account for user
- Count accounts
- Get account detail
- Clear AML flag on account
- Close, block, unblock, freeze, or unfreeze account
- List account ledger transactions
- List account transfers
- List card payment systems
- Create card payment system
- Get card payment system
- Update card payment system
- List card products
- Create card product
- Get card product
- Update card product
- Issue card (admin)
- Open account and issue card (admin)
- Block or unblock card (admin)
- Create fee rule
- List fee rules
- Get fee rule
- Update fee rule
- List FX rates
- Upsert FX rate
- Export ledger transaction statement
- List transfer type configuration
- Update transfer type configuration
- Create admin credit/debit adjustment
- Count transfers by status
- List pending transfers
- Get transfer details (admin)
- Cancel pending transfer
- Execute pending transfer
- Place compliance hold on account funds
- Reject pending transfer
- Release compliance hold
- AML
- Crypto
- Compliance
- List KYB applications
- Get KYB application by user
- Count KYB applications
- Get KYB application details
- Review KYB application
- List KYC applications
- Get KYC application by user
- Count KYC applications
- List EDD cases
- Get KYC application details
- Get EDD case with latest screening
- Review KYC application
- Update EDD case status
- Notifications
- Identity
- Tickets
- Reconciliation
- Finance
- Crypto
- Get crypto portfolio balance
- Get crypto balance history snapshots
- List crypto assets and ensure wallets
- List crypto deposits
- Create crypto order from quote
- List crypto orders
- Get crypto order
- Get buy/sell quote
- List crypto transactions
- List user crypto wallets
- Create crypto withdrawal (step-up required)
- Privy custodian webhook
- Compliance
- Submit KYB application
- Get my KYB application
- POST /v1/kyb/applications/{id}/documents
- POST /v1/kyb/applications/{id}/documents/upload-url
- POST /v1/kyb/applications/{id}/documents/{document_id}/confirm
- Submit KYC application
- Get my KYC application
- Get KYC draft prefilled from profile
- POST /v1/kyc/applications/{id}/documents
- POST /v1/kyc/applications/{id}/documents/upload-url
- POST /v1/kyc/applications/{id}/documents/{document_id}/confirm
- Skip KYC when allowed
- Notifications
- Tickets
- Schemas
- Problem
- Address
- RegisterRequest
- LoginRequest
- MFAVerifyRequest
- OpenAccountRequest
- TransferRequest
- CryptoWithdrawalRequest
- CreateTicketRequest
- KYCSubmitRequest
- KYBSubmitRequest
- AdminTransferAdjustRequest
- CountResponse
- MessageResponse
- TokenResponse
- RegisterResponse
- LoginResponse
- StepUpInitResponse
- StepUpVerifyResponse
- UserProfile
- UserProfileDetails
- MFASettings
- TOTPSetupResponse
- JWKSResponse
- AdminUser
- AdminUserList
- PermissionActionsResponse
- UserPermissionsResponse
- AccountType
- AccountTypeList
- TransferTypeConfig
- TransferTypeList
- CardProduct
- CardProductList
- UserAccount
- UserAccountList
- AccountsSummary
- UserAccountDetail
- AccountOpenRequest
- AccountOpenRequestList
- Transaction
- TransactionListResponse
- StatementLine
- TransactionStatementList
- BalancePoint
- BalanceHistory
- AllAccountsBalanceHistory
- Card
- CardList
- CardNumberResponse
- CardCVVResponse
- CardWithAccountResponse
- Transfer
- AdminTransfer
- TransferList
- AdminTransferList
- TransferQuote
- RecentRecipient
- RecentRecipientList
- SearchResponse
- AdminAccount
- AdminAccountList
- BalanceBreakdown
- AdminAccountDetail
- ComplianceHoldCreated
- ReconciliationRun
- ReconciliationRunList
- ReconciliationDiscrepancy
- ReconciliationDiscrepancyList
- FeeRule
- FeeRuleList
- FxRate
- FxRateList
- CardPaymentSystem
- CardPaymentSystemList
- AdminCardProduct
- AdminCardProductList
- AMLRule
- AMLRuleList
- AMLFlag
- AMLFlagList
- Notification
- NotificationListResponse
- NotificationPreferencesResponse
- NotificationType
- NotificationTypeList
- NotificationTemplate
- NotificationTemplateList
- TemplateVariablesResponse
- TicketSummary
- TicketListResponse
- TicketDetail
- TicketMessage
- TicketCloseResponse
- UploadURLResponse
- DocumentCreatedResponse
- AttachmentCreatedResponse
- KYCApplication
- KYCApplicationDetail
- KYCApplicationList
- KYBApplication
- KYBApplicationDetail
- KYBApplicationList
- EDDCase
- EDDCaseDetail
- EDDCaseList
- KYCDraftResponse
- KYCStatusResponse
- KYCSubmitResponse
- CryptoAsset
- CryptoWallet
- CryptoAssetsResponse
- CryptoWalletList
- CryptoAccountBalance
- CryptoBalanceSnapshots
- CryptoTransaction
- CryptoTransactionList
- CryptoQuote
- CryptoOrder
- CryptoOrderList
- CryptoWithdrawal
- CryptoDeposit
- CryptoDepositList
- AdminCryptoWallet
- AdminCryptoWalletList
- AdminCryptoWalletBalance
- HealthResponse
BalanceBreakdown
{
"ledger_balance": "string",
"available_balance": "string",
"reserved": "string",
"blocked": "string",
"pending_inbound": "string",
"fee_accrued": "string",
"hold_total": "string",
"credit_limit": "string",
"active_cards": 0,
"pending_transfers": 0
}