Retrieve Account
Changed onRetrieves an account visible to the credential by ID or public route, including its crypto wallet.
Request
- Base URL: https://api.whop.com/api/v1
- URL: https://api.whop.com/api/v1/accounts/{id}
- Auth: HTTP bearer
Path parameters
Account ID, prefixed biz_, its public route, or me for the account associated with the current Account API key. User tokens have no single account, so they cannot use me.
Query parameters
Also return the trading account under trading: its address and its Hyperliquid WebSocket subscriptions. Requires crypto_wallet:trade:read, crypto_wallet:trade, or crypto_wallet:manage permission and an Ethereum wallet; null otherwise.
Response
account settling on stablecoin rails
Example response
{
"balances": [
{
"balance": "1500.0",
"breakdown": {
"available": "1500.0",
"in_transit": "0",
"pending": "0",
"pending_settlements": [
{
"amount": "0.0",
"date": "2026-01-01"
}
],
"reserve": "0"
},
"icon_url": "https://assets.whop.com/tokens/usdt.png",
"name": "Tether USD",
"price_usd": 1,
"symbol": "USDT",
"value_usd": "1500.00"
}
],
"banner_image_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"business_address": {
"city": "Austin",
"country": "US",
"line1": "4180 Burnet Rd",
"line2": "Suite 2",
"postal_code": "78756",
"state": "TX"
},
"business_name": "Shine Time Auto Detailing, LLC",
"business_type": "software",
"cancellation_policy": {
"content_type": "application/pdf",
"created_at": "2026-01-01T12:00:00.000Z",
"filename": "evidence.pdf",
"id": "file_xxxxxxxxxxxxxx",
"multipart_chunk_size": 5242880,
"multipart_upload_id": "upload-id",
"multipart_upload_urls": [
{
"part_number": 1,
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
}
],
"object": "file",
"size": 9670,
"upload_headers": {},
"upload_status": "pending",
"upload_url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf",
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"visibility": "private"
},
"capabilities": {
"accept_bank_payments": "active",
"accept_bnpl_payments": "inactive",
"accept_card_payments": "active",
"bank_deposit": "inactive",
"card_deposit": "active",
"card_issuing": "inactive",
"crypto_deposit": "active",
"crypto_payout": "inactive",
"instant_payout": "inactive",
"run_ads": "active",
"standard_payout": "inactive",
"transfer": "inactive"
},
"cards": {
"kind": "individual",
"status": "approved"
},
"collect_vat_id": true,
"company_formation": {
"documents": [
{
"id": "file_xxxxxxxxxxxxxx",
"name": "Articles of Organization",
"type": "articles_of_organization",
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
],
"legal_name": "Shine Time Auto Detailing, LLC",
"signatures": {
"form8821": {
"expires_at": "2026-01-01T12:00:00.000Z",
"status": "pending",
"url": "https://sign.doola.com/shine-time-auto-detailing/form8821"
},
"ss4": {
"expires_at": "2026-01-01T12:00:00.000Z",
"status": "pending",
"url": "https://sign.doola.com/shine-time-auto-detailing/form8821"
}
},
"state_registered": true
},
"country": "us",
"created_at": "2026-01-01T12:00:00.000Z",
"description": "Mobile ceramic coating, paint correction, and interior detailing across the Austin metro.",
"email": "marcus@shinetime.example",
"eula": {
"content_type": "application/pdf",
"created_at": "2026-01-01T12:00:00.000Z",
"filename": "evidence.pdf",
"id": "file_xxxxxxxxxxxxxx",
"multipart_chunk_size": 5242880,
"multipart_upload_id": "upload-id",
"multipart_upload_urls": [
{
"part_number": 1,
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
}
],
"object": "file",
"size": 9670,
"upload_headers": {},
"upload_status": "pending",
"upload_url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf",
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"visibility": "private"
},
"financing": {
"application_id": "inrq_xxxxxxxxxxxxxx",
"status": "awaiting_review"
},
"home_preferences": [
"hide_member_count"
],
"id": "biz_xxxxxxxxxxxxxx",
"industry_type": "trading",
"invoice_prefix": "SHINE",
"level": {
"boosted": true,
"current": 1,
"points": 41000,
"points_by_source": {
"cards": 40000,
"trading": 1000
},
"points_to_next": 59000,
"resets_at": "2026-01-01T12:00:00.000Z"
},
"logo_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"metadata": {
"external_id": "shop_4417",
"region": "austin"
},
"onboarding_type": "seller",
"opengraph_image_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"opengraph_image_variant": "black",
"orchestration_enabled": true,
"owner": {
"id": "user_xxxxxxxxxxxxxx",
"name": "Dana Whitfield",
"profile_picture": {
"url": "https://ui-avatars.com/api/"
},
"username": "danawhitfield"
},
"parent_account": {
"fees": {
"crypto_swap_markup": {
"fixed_fee_usd": 0,
"percentage_fee": 3
},
"transfer_markup": {
"fixed_fee_usd": 0,
"percentage_fee": 0
}
},
"id": "biz_xxxxxxxxxxxxxx",
"logo_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"route": "shine-time-holdings",
"title": "Shine Time Holdings"
},
"partner": {
"profile_picture": {
"url": "https://ui-avatars.com/api/"
}
},
"payment_controls": {
"dispute_alert_auto_refund": {
"threshold_usd": 500
},
"dispute_alert_fee_usd": 29,
"pending_auto_topup_fee_percentage": 2,
"reserve": {
"hold_period_days": 14,
"percentage": 15
},
"resolution_center_auto_refund": {
"card_threshold_usd": 50,
"financing_threshold_usd": 25,
"paypal_threshold_usd": 40
},
"restricted_payment_methods": [
"card_visa"
],
"undated_pending_reason": "pending_information_request",
"withdrawal_schedule": {
"frequency": "manual"
}
},
"platform_credits": [
{
"amount": "-1234.56",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
}
],
"privacy_policy": {
"content_type": "application/pdf",
"created_at": "2026-01-01T12:00:00.000Z",
"filename": "evidence.pdf",
"id": "file_xxxxxxxxxxxxxx",
"multipart_chunk_size": 5242880,
"multipart_upload_id": "upload-id",
"multipart_upload_urls": [
{
"part_number": 1,
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
}
],
"object": "file",
"size": 9670,
"upload_headers": {},
"upload_status": "pending",
"upload_url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf",
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"visibility": "private"
},
"product_tax_code": {
"id": "ptc_xxxxxxxxxxxxxx",
"name": "General - Digital Goods",
"product_type": "digital"
},
"recommended_actions": [
{
"action": "apply_for_financing",
"blocked_capabilities": [
"accept_bnpl_payments"
],
"cta": "https://whop.com/dashboard/biz_xxxxxxxxxxxxxx/settings/payments/",
"cta_label": "Apply",
"description": "Let customers pay over time with buy now, pay later.",
"icon_url": "https://whop.com/illustrations/orange/piggy-bank.svg",
"impact_score": 86,
"reasoning": "Financing lifts conversion on the $249 ceramic coating, the priciest job on the menu.",
"status": "optional",
"title": "Offer financing at checkout"
}
],
"require_2fa": true,
"required_actions": [
{
"action": "verify_identity",
"blocked_capabilities": [
"standard_payout"
],
"cta": "https://whop.com/dashboard/biz_xxxxxxxxxxxxxx/balance/",
"cta_label": "Verify now",
"description": "Complete verification to withdraw your earnings.",
"icon_url": "https://whop.com/illustrations/orange/shield.svg",
"status": "required",
"title": "Complete your identity verification"
}
],
"return_policy": {
"content_type": "application/pdf",
"created_at": "2026-01-01T12:00:00.000Z",
"filename": "evidence.pdf",
"id": "file_xxxxxxxxxxxxxx",
"multipart_chunk_size": 5242880,
"multipart_upload_id": "upload-id",
"multipart_upload_urls": [
{
"part_number": 1,
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
}
],
"object": "file",
"size": 9670,
"upload_headers": {},
"upload_status": "pending",
"upload_url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf",
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"visibility": "private"
},
"rewards": [
{
"qualification_amount": {
"amount": "-1234.56",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"qualification_progress": {
"amount": "-1234.56",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"qualification_type": "sales",
"reward_amount": {
"amount": "-1234.56",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"status": "in_progress"
}
],
"route": "biz_xxxxxxxxxxxxxx",
"shipping_policy": {
"content_type": "application/pdf",
"created_at": "2026-01-01T12:00:00.000Z",
"filename": "evidence.pdf",
"id": "file_xxxxxxxxxxxxxx",
"multipart_chunk_size": 5242880,
"multipart_upload_id": "upload-id",
"multipart_upload_urls": [
{
"part_number": 1,
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
}
],
"object": "file",
"size": 9670,
"upload_headers": {},
"upload_status": "pending",
"upload_url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf",
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"visibility": "private"
},
"social_links": [
{
"id": "social_1",
"title": "@shinetimedetail",
"url": "https://instagram.com/shinetimedetail",
"website": "instagram"
}
],
"status": "active",
"status_reason": "Suspended - Fraudulent activity",
"store_page_config": {
"accent_color": "red",
"layout": "compact",
"profile_variant": "business",
"whop_affiliate_link": true
},
"target_audience": "Owners of new and enthusiast vehicles in Austin, TX",
"tax_collection_enabled_states": [
"TX"
],
"tax_identifiers": [
{
"id": "txid_xxxxxxxxxxxxxx",
"tax_id_type": "eu_vat",
"tax_id_value": "DE123456789"
}
],
"tax_remitted_by": "self",
"tax_type": "inclusive",
"terms_of_service": {
"content_type": "application/pdf",
"created_at": "2026-01-01T12:00:00.000Z",
"filename": "evidence.pdf",
"id": "file_xxxxxxxxxxxxxx",
"multipart_chunk_size": 5242880,
"multipart_upload_id": "upload-id",
"multipart_upload_urls": [
{
"part_number": 1,
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
}
],
"object": "file",
"size": 9670,
"upload_headers": {},
"upload_status": "pending",
"upload_url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf",
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"visibility": "private"
},
"three_ds_level": "mandate_challenge",
"title": "Shine Time Auto Detailing",
"total_usd": "50.00",
"trading": {
"hyperliquid": {
"websocket_subscriptions": [
{
"channel": "clearinghouse_state"
}
]
},
"object": "trading_account",
"provider": "hyperliquid"
},
"use_logo_as_opengraph_image_fallback": true,
"verification": {
"business": null,
"individual": null
},
"wallet": {
"address": "0xabc123",
"id": "cwal_xxxxxxxxxxxxxx",
"network": "ethereum"
},
"website": "https://shinetimedetail.com"
}Changes
- breaking
removed the required property
from the response with the status - warning
added the new
acss_debitenum value to the//////response property for the response status - warning
added the new
addienum value to the//////response property for the response status - warning
added the new
affirmenum value to the//////response property for the response status - warning
added the new
afterpay_clearpayenum value to the//////response property for the response status - warning
added the new
almaenum value to the//////response property for the response status - warning
added the new
amazon_payenum value to the//////response property for the response status - warning
added the new
au_becs_debitenum value to the//////response property for the response status - warning
added the new
bacs_debitenum value to the//////response property for the response status - warning
added the new
billieenum value to the//////response property for the response status - warning
added the new
capchase_payenum value to the//////response property for the response status - warning
added the new
card_installments_sixenum value to the//////response property for the response status - warning
added the new
card_installments_threeenum value to the//////response property for the response status - warning
added the new
card_installments_twelveenum value to the//////response property for the response status - warning
added the new
cashappenum value to the//////response property for the response status - warning
added the new
claritypayenum value to the//////response property for the response status - warning
added the new
flex_payenum value to the//////response property for the response status - warning
added the new
klarnaenum value to the//////response property for the response status - warning
added the new
klarna_pay_nowenum value to the//////response property for the response status - warning
added the new
kriyaenum value to the//////response property for the response status - warning
added the new
kueskienum value to the//////response property for the response status - warning
added the new
linkenum value to the//////response property for the response status - warning
added the new
monduenum value to the//////response property for the response status - warning
added the new
oneyenum value to the//////response property for the response status - warning
added the new
oney_3xenum value to the//////response property for the response status - warning
added the new
oney_4xenum value to the//////response property for the response status - warning
added the new
pay_by_bankenum value to the//////response property for the response status - warning
added the new
paypalenum value to the//////response property for the response status - warning
added the new
paytoenum value to the//////response property for the response status - warning
added the new
scalapayenum value to the//////response property for the response status - warning
added the new
sepa_debitenum value to the//////response property for the response status - warning
added the new
sequraenum value to the//////response property for the response status - warning
added the new
sezzleenum value to the//////response property for the response status - warning
added the new
splititenum value to the//////response property for the response status - warning
added the new
sunbitenum value to the//////response property for the response status - warning
added the new
tabbyenum value to the//////response property for the response status - warning
added the new
tamaraenum value to the//////response property for the response status - warning
added the new
us_bank_accountenum value to the//////response property for the response status - warning
added the new
venmoenum value to the//////response property for the response status - warning
added the new
zipenum value to the//////response property for the response status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
/////to the response with the status
- breaking
- warning
added the new
compliance_reviewenum value to the/////response property for the response status - warning
added the new
update_payout_profileenum value to the/////response property for the response status
- warning