- Integrations
- Identity
- Platform liveness probeGET
- Get JSON Web Key SetGET
- Login with identifier and passwordPOST
- Logout and invalidate refresh tokenPOST
- Verify MFA during loginPOST
- Refresh access tokenPOST
- Register a new userPOST
- Initiate step-up authenticationPOST
- Verify step-up MFA and issue step-up tokenPOST
- Verify email OTPPOST
- Verify phone OTPPOST
- Platform liveness probeGET
- Get current user profileGET
- GET /v1/users/me/mfaGET
- PATCH /v1/users/me/mfaPATCH
- DELETE /v1/users/me/mfa/totpDELETE
- POST /v1/users/me/mfa/totp/confirmPOST
- POST /v1/users/me/mfa/totp/setupPOST
- Change password (step-up required)POST
- Update user profilePATCH
- Platform liveness probe
- Finance
- List openable account typesGET
- List user accountsGET
- Open account (step-up required)POST
- Aggregated balance history across accountsGET
- Submit account open requestPOST
- List my account open requestsGET
- Get accounts summary totalsGET
- Get account detailsGET
- Account balance historyGET
- List account ledger transactionsGET
- List issuable card productsGET
- List user cardsGET
- Issue card on existing account (step-up required)POST
- Open account and issue card (step-up required)POST
- Get card detailsGET
- Reveal card CVV (step-up required)GET
- Reveal card numberGET
- Block or unblock cardPATCH
- List recent transfer recipientsGET
- Search transactions and recipientsGET
- List available transfer typesGET
- Create transfer (step-up required)POST
- List user transfersGET
- Quote transfer fees and FXPOST
- Get transfer detailsGET
- Cancel pending transfer (step-up required)POST
- List openable account types
- 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, or unblock 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
- 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
- Reject pending transfer
- Export ledger transaction statement
- AML
- Crypto
- Compliance
- Notifications
- Identity
- Tickets
- 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
- AdminAccountDetail
- 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
- KYCDraftResponse
- KYCStatusResponse
- KYCSubmitResponse
- CryptoAsset
- CryptoWallet
- CryptoAssetsResponse
- CryptoWalletList
- CryptoAccountBalance
- CryptoBalanceSnapshots
- CryptoTransaction
- CryptoTransactionList
- CryptoQuote
- CryptoOrder
- CryptoOrderList
- CryptoWithdrawal
- CryptoDeposit
- CryptoDepositList
- AdminCryptoWallet
- AdminCryptoWalletList
- AdminCryptoWalletBalance
- HealthResponse
POST /v1/users/me/mfa/totp/setup
POST
/v1/users/me/mfa/totp/setup
secret, qr_code_url, and base64 QR image. Must be confirmed with POST .../totp/confirm before TOTP is active.Request
Authorization
JWT Bearer
Add the parameter
Authorization
to HeadersExample:
Authorization: ********************or
Body Params application/json
Examples
Responses
🟢200
application/json
Bodyapplication/json
🟠400BadRequest
🟠401Unauthorized
🟠403Forbidden
🟠404NotFound
🟠409Conflict
🔴500InternalError
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/v1/users/me/mfa/totp/setup' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"property1": "string",
"property2": "string"
}'Response Response Example
200 - Example 1
{
"secret": "string",
"qr_code_url": "string",
"qr_code_base64": "string"
}Modified at 2026-06-23 04:24:01