@whop/cli 0.4.0 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{api-7L74UEG4.js → api-P7EWPZKG.js} +2 -2
- package/dist/{chunk-2K4WBZA5.js → chunk-GKKJXDPK.js} +15498 -14834
- package/dist/chunk-GKKJXDPK.js.map +1 -0
- package/dist/index.js +274 -184
- package/dist/index.js.map +1 -1
- package/package.json +3 -2
- package/skills/whop-accounts/SKILL.md +22 -0
- package/skills/whop-ad-campaigns/SKILL.md +24 -0
- package/skills/whop-ad-groups/SKILL.md +24 -0
- package/skills/whop-ads/SKILL.md +24 -0
- package/skills/whop-audiences/SKILL.md +20 -0
- package/skills/whop-cards/SKILL.md +21 -0
- package/skills/whop-checkout-configurations/SKILL.md +21 -0
- package/skills/whop-deposits/SKILL.md +19 -0
- package/skills/whop-ledgers/SKILL.md +19 -0
- package/skills/whop-payouts/SKILL.md +19 -0
- package/skills/whop-plans/SKILL.md +23 -0
- package/skills/whop-products/SKILL.md +22 -0
- package/skills/whop-referrals/SKILL.md +22 -0
- package/skills/whop-swaps/SKILL.md +21 -0
- package/skills/whop-transfers/SKILL.md +20 -0
- package/skills/whop-users/SKILL.md +22 -0
- package/skills/whop-verifications/SKILL.md +21 -0
- package/dist/chunk-2K4WBZA5.js.map +0 -1
- /package/dist/{api-7L74UEG4.js.map → api-P7EWPZKG.js.map} +0 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@whop/cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.6.0",
|
|
4
4
|
"description": "The Whop CLI — build and manage Whop apps from your terminal. Human and agent friendly.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"agent",
|
|
@@ -21,7 +21,8 @@
|
|
|
21
21
|
"whop-cli": "dist/index.js"
|
|
22
22
|
},
|
|
23
23
|
"files": [
|
|
24
|
-
"dist"
|
|
24
|
+
"dist",
|
|
25
|
+
"skills"
|
|
25
26
|
],
|
|
26
27
|
"type": "module",
|
|
27
28
|
"exports": {
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: whop-accounts
|
|
3
|
+
description: "A business on Whop: profile, wallet, capabilities, settings. Run `whop accounts --help` for usage details."
|
|
4
|
+
requires_bin: whop
|
|
5
|
+
command: whop accounts
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
An Account represents a person or business in Whop. Each account has its own profile, wallet, and settings, so you can create one for every customer, creator, merchant, or seller your integration supports.
|
|
9
|
+
|
|
10
|
+
Create an account when someone needs to hold funds, receive payments, send money, or use account-scoped API features. Save the returned `id` and `wallet` details, and use `metadata` to store your own stable identifier, like a user ID from your system.
|
|
11
|
+
|
|
12
|
+
## Commands
|
|
13
|
+
|
|
14
|
+
| Command | Description |
|
|
15
|
+
|---------|-------------|
|
|
16
|
+
| `whop accounts list` | List Accounts |
|
|
17
|
+
| `whop accounts create` | Create Account |
|
|
18
|
+
| `whop accounts me` | Retrieve Requesting Account |
|
|
19
|
+
| `whop accounts get` | Retrieve Account |
|
|
20
|
+
| `whop accounts update` | Update Account |
|
|
21
|
+
|
|
22
|
+
Run `whop accounts <command> --help` for options, or `whop accounts <command> --schema` for full argument details.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: whop-ad-campaigns
|
|
3
|
+
description: Platform, objective, and budget for a set of ads. Run `whop ad-campaigns --help` for usage details.
|
|
4
|
+
requires_bin: whop
|
|
5
|
+
command: whop ad-campaigns
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
An Ad Campaign is the top-level container for paid ads on an ad network. It sets the platform, objective, and budget strategy shared by its [ad groups](https://docs.whop.com/api-reference/beta/ad-groups/ad-group) and ads.
|
|
9
|
+
|
|
10
|
+
Use the Ad Campaigns API to create campaigns, list campaigns for an account, retrieve or update campaign settings, and pause or resume campaign delivery.
|
|
11
|
+
|
|
12
|
+
## Commands
|
|
13
|
+
|
|
14
|
+
| Command | Description |
|
|
15
|
+
|---------|-------------|
|
|
16
|
+
| `whop ad-campaigns list` | List Ad Campaigns |
|
|
17
|
+
| `whop ad-campaigns create` | Create an Ad Campaign |
|
|
18
|
+
| `whop ad-campaigns delete` | Delete an Ad Campaign |
|
|
19
|
+
| `whop ad-campaigns get` | Retrieve an Ad Campaign |
|
|
20
|
+
| `whop ad-campaigns update` | Update an Ad Campaign |
|
|
21
|
+
| `whop ad-campaigns pause` | Pause an Ad Campaign |
|
|
22
|
+
| `whop ad-campaigns unpause` | Unpause an Ad Campaign |
|
|
23
|
+
|
|
24
|
+
Run `whop ad-campaigns <command> --help` for options, or `whop ad-campaigns <command> --schema` for full argument details.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: whop-ad-groups
|
|
3
|
+
description: Audience, placements, and schedule within a campaign. Run `whop ad-groups --help` for usage details.
|
|
4
|
+
requires_bin: whop
|
|
5
|
+
command: whop ad-groups
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
An Ad Group sits inside an [ad campaign](https://docs.whop.com/api-reference/beta/ad-campaigns/ad-campaign) and controls delivery for [ads](https://docs.whop.com/api-reference/beta/ads/ad). It sets the audience, placements, schedule, budget, and optimization goal for its ads.
|
|
9
|
+
|
|
10
|
+
Use the Ad Groups API to create ad groups in campaigns, list or retrieve targeting and delivery settings, update budgets or targeting, delete groups that should stop running, and pause or resume delivery.
|
|
11
|
+
|
|
12
|
+
## Commands
|
|
13
|
+
|
|
14
|
+
| Command | Description |
|
|
15
|
+
|---------|-------------|
|
|
16
|
+
| `whop ad-groups list` | List Ad Groups |
|
|
17
|
+
| `whop ad-groups create` | Create an Ad Group |
|
|
18
|
+
| `whop ad-groups delete` | Delete an Ad Group |
|
|
19
|
+
| `whop ad-groups get` | Retrieve an Ad Group |
|
|
20
|
+
| `whop ad-groups update` | Update an Ad Group |
|
|
21
|
+
| `whop ad-groups pause` | Pause an Ad Group |
|
|
22
|
+
| `whop ad-groups unpause` | Unpause an Ad Group |
|
|
23
|
+
|
|
24
|
+
Run `whop ad-groups <command> --help` for options, or `whop ad-groups <command> --schema` for full argument details.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: whop-ads
|
|
3
|
+
description: "The creative: copy, assets, and destination URL. Run `whop ads --help` for usage details."
|
|
4
|
+
requires_bin: whop
|
|
5
|
+
command: whop ads
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
An Ad is the individual creative unit delivered by an [ad group](https://docs.whop.com/api-reference/beta/ad-groups/ad-group). It holds the copy, creative assets, and destination URL for one ad.
|
|
9
|
+
|
|
10
|
+
Use the Ads API to list ads for an account, create ads inside ad groups, retrieve or update creative details, delete ads that should stop running, and pause or resume delivery.
|
|
11
|
+
|
|
12
|
+
## Commands
|
|
13
|
+
|
|
14
|
+
| Command | Description |
|
|
15
|
+
|---------|-------------|
|
|
16
|
+
| `whop ads list` | List Ads |
|
|
17
|
+
| `whop ads create` | Create an Ad |
|
|
18
|
+
| `whop ads delete` | Delete an Ad |
|
|
19
|
+
| `whop ads get` | Retrieve an Ad |
|
|
20
|
+
| `whop ads update` | Update an Ad |
|
|
21
|
+
| `whop ads pause` | Pause an Ad |
|
|
22
|
+
| `whop ads unpause` | Unpause an Ad |
|
|
23
|
+
|
|
24
|
+
Run `whop ads <command> --help` for options, or `whop ads <command> --schema` for full argument details.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: whop-audiences
|
|
3
|
+
description: Reusable targeting lists for ad groups. Run `whop audiences --help` for usage details.
|
|
4
|
+
requires_bin: whop
|
|
5
|
+
command: whop audiences
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
An Audience represents a customer list uploaded to Whop for ad targeting. Audiences belong to an account and sync to supported ad platforms as custom audiences.
|
|
9
|
+
|
|
10
|
+
Use the Audiences API to create audiences from CSV uploads, monitor processing status, and list or delete audiences for an account. Created audiences are usable for targeting after processing reaches `ready` or `partial`.
|
|
11
|
+
|
|
12
|
+
## Commands
|
|
13
|
+
|
|
14
|
+
| Command | Description |
|
|
15
|
+
|---------|-------------|
|
|
16
|
+
| `whop audiences list` | List Audiences |
|
|
17
|
+
| `whop audiences create` | Create Audience |
|
|
18
|
+
| `whop audiences delete` | Delete Audience |
|
|
19
|
+
|
|
20
|
+
Run `whop audiences <command> --help` for options, or `whop audiences <command> --schema` for full argument details.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: whop-cards
|
|
3
|
+
description: Issue cards that spend from a balance. Run `whop cards --help` for usage details.
|
|
4
|
+
requires_bin: whop
|
|
5
|
+
command: whop cards
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
Cards represent Whop-issued virtual payment cards that spend from an account or user balance. Cards can be assigned to cardholders and configured with spending limits for controlled spending.
|
|
9
|
+
|
|
10
|
+
Use the Cards API to issue cards, list cards for an account or user, and retrieve active card details such as the card number and CVC.
|
|
11
|
+
|
|
12
|
+
## Commands
|
|
13
|
+
|
|
14
|
+
| Command | Description |
|
|
15
|
+
|---------|-------------|
|
|
16
|
+
| `whop cards list` | List Cards |
|
|
17
|
+
| `whop cards create` | Create Card |
|
|
18
|
+
| `whop cards get` | Retrieve Card |
|
|
19
|
+
| `whop cards update` | Update Card |
|
|
20
|
+
|
|
21
|
+
Run `whop cards <command> --help` for options, or `whop cards <command> --schema` for full argument details.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: whop-checkout-configurations
|
|
3
|
+
description: Turn a plan into a shareable, prefilled checkout link. Run `whop checkout-configurations --help` for usage details.
|
|
4
|
+
requires_bin: whop
|
|
5
|
+
command: whop checkout-configurations
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
A Checkout Configuration is a reusable checkout link owned by an account. In `payment` mode it sells a specific plan; in `setup` mode it collects and saves payment details without charging. Each configuration can also override which payment methods are accepted and how 3D Secure is enforced for that checkout.
|
|
9
|
+
|
|
10
|
+
Use the Checkout Configurations API to create checkout links for an existing or inline plan, list configurations for an account, retrieve the configuration behind a checkout URL, and delete links that should no longer be used.
|
|
11
|
+
|
|
12
|
+
## Commands
|
|
13
|
+
|
|
14
|
+
| Command | Description |
|
|
15
|
+
|---------|-------------|
|
|
16
|
+
| `whop checkout-configurations list` | List checkout configurations |
|
|
17
|
+
| `whop checkout-configurations create` | Create a checkout configuration |
|
|
18
|
+
| `whop checkout-configurations delete` | Delete a checkout configuration |
|
|
19
|
+
| `whop checkout-configurations get` | Retrieve a checkout configuration |
|
|
20
|
+
|
|
21
|
+
Run `whop checkout-configurations <command> --help` for options, or `whop checkout-configurations <command> --schema` for full argument details.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: whop-deposits
|
|
3
|
+
description: Add funds to a balance. Run `whop deposits --help` for usage details.
|
|
4
|
+
requires_bin: whop
|
|
5
|
+
command: whop deposits
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
Deposits describe ways to add funds to an account balance, including hosted deposit pages, bank deposit instructions, and supported crypto wallet addresses.
|
|
9
|
+
|
|
10
|
+
Use the Deposits API to create deposit instructions for an account and retrieve existing bank deposit activity.
|
|
11
|
+
|
|
12
|
+
## Commands
|
|
13
|
+
|
|
14
|
+
| Command | Description |
|
|
15
|
+
|---------|-------------|
|
|
16
|
+
| `whop deposits list` | Retrieve Deposits |
|
|
17
|
+
| `whop deposits create` | Create Deposit |
|
|
18
|
+
|
|
19
|
+
Run `whop deposits <command> --help` for options, or `whop deposits <command> --schema` for full argument details.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: whop-ledgers
|
|
3
|
+
description: The activity feed behind an account or user's balance. Run `whop ledgers --help` for usage details.
|
|
4
|
+
requires_bin: whop
|
|
5
|
+
command: whop ledgers
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
A Ledger Activity row is a single financial event on an account's ledger — a payment, withdrawal, refund, transfer, on-chain deposit, swap, or card transaction. Each row is derived from the underlying ledger lines and carries a typed `resource` and `source` so you can present and link the event without extra lookups.
|
|
9
|
+
|
|
10
|
+
Use Ledger Activity to build a statement or transaction feed for an account or user. Reconcile against your own records with `amount` (signed, in the currency's smallest precision units) and `posted_at`, and use `available_at` to know when inflows became withdrawable.
|
|
11
|
+
|
|
12
|
+
## Commands
|
|
13
|
+
|
|
14
|
+
| Command | Description |
|
|
15
|
+
|---------|-------------|
|
|
16
|
+
| `whop ledgers list` | List Financial Activity |
|
|
17
|
+
| `whop ledgers report` | Get Financial Report |
|
|
18
|
+
|
|
19
|
+
Run `whop ledgers <command> --help` for options, or `whop ledgers <command> --schema` for full argument details.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: whop-payouts
|
|
3
|
+
description: Send money from a balance to a bank or wallet. Run `whop payouts --help` for usage details.
|
|
4
|
+
requires_bin: whop
|
|
5
|
+
command: whop payouts
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
Payouts represent money sent from an account balance to an external destination, such as a bank account or other supported payout method.
|
|
9
|
+
|
|
10
|
+
Use the Payouts API to list payout history, monitor payout statuses, and show expected arrival details for funds leaving an account.
|
|
11
|
+
|
|
12
|
+
## Commands
|
|
13
|
+
|
|
14
|
+
| Command | Description |
|
|
15
|
+
|---------|-------------|
|
|
16
|
+
| `whop payouts list` | List Payouts |
|
|
17
|
+
| `whop payouts methods` | List Payout Methods |
|
|
18
|
+
|
|
19
|
+
Run `whop payouts <command> --help` for options, or `whop payouts <command> --schema` for full argument details.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: whop-plans
|
|
3
|
+
description: "Pricing for a product: one-time, recurring, trials, stock. Run `whop plans --help` for usage details."
|
|
4
|
+
requires_bin: whop
|
|
5
|
+
command: whop plans
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
A Plan defines how customers buy a product. It controls pricing, billing cadence, availability, tax behavior, checkout fields, and purchase visibility.
|
|
9
|
+
|
|
10
|
+
Use the Plans API to create plans for products, list existing plans, retrieve or update plan configuration, calculate tax for checkout, and delete plans that should no longer be offered.
|
|
11
|
+
|
|
12
|
+
## Commands
|
|
13
|
+
|
|
14
|
+
| Command | Description |
|
|
15
|
+
|---------|-------------|
|
|
16
|
+
| `whop plans list` | List Plans |
|
|
17
|
+
| `whop plans create` | Create Plan |
|
|
18
|
+
| `whop plans delete` | Delete Plan |
|
|
19
|
+
| `whop plans get` | Retrieve Plan |
|
|
20
|
+
| `whop plans update` | Update Plan |
|
|
21
|
+
| `whop plans calculate_tax` | Calculate Tax |
|
|
22
|
+
|
|
23
|
+
Run `whop plans <command> --help` for options, or `whop plans <command> --schema` for full argument details.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: whop-products
|
|
3
|
+
description: The things you sell. Each owns plans and a store page. Run `whop products --help` for usage details.
|
|
4
|
+
requires_bin: whop
|
|
5
|
+
command: whop products
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
A Product is a digital good or service sold on Whop. Products may contain plans for pricing and/or experiences for content delivery.
|
|
9
|
+
|
|
10
|
+
Use the Products API to create products, list products visible to your credentials, retrieve product details, update product metadata or merchandising fields, and delete products that should no longer be sold.
|
|
11
|
+
|
|
12
|
+
## Commands
|
|
13
|
+
|
|
14
|
+
| Command | Description |
|
|
15
|
+
|---------|-------------|
|
|
16
|
+
| `whop products list` | List Products |
|
|
17
|
+
| `whop products create` | Create Product |
|
|
18
|
+
| `whop products delete` | Delete Product |
|
|
19
|
+
| `whop products get` | Retrieve Product |
|
|
20
|
+
| `whop products update` | Update Product |
|
|
21
|
+
|
|
22
|
+
Run `whop products <command> --help` for options, or `whop products <command> --schema` for full argument details.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: whop-referrals
|
|
3
|
+
description: Track who referred a purchase and what they earn. Run `whop referrals --help` for usage details.
|
|
4
|
+
requires_bin: whop
|
|
5
|
+
command: whop referrals
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
Referrals track businesses referred to Whop and the earnings generated from their processing volume. They help you see much volume your referred businesses have processed and how much you've earned from them.
|
|
9
|
+
|
|
10
|
+
Use the Referrals API to list referred businesses, retrieve one referral, and review earnings across all referrals or for a single referred business.
|
|
11
|
+
|
|
12
|
+
## Commands
|
|
13
|
+
|
|
14
|
+
| Command | Description |
|
|
15
|
+
|---------|-------------|
|
|
16
|
+
| `whop referrals list` | List business referrals |
|
|
17
|
+
| `whop referrals businesses-leaderboard` | Retrieve the business referral leaderboard |
|
|
18
|
+
| `whop referrals get` | Retrieve a business referral |
|
|
19
|
+
| `whop referrals earnings` | List a business referral's earnings |
|
|
20
|
+
| `whop referrals partners` | Enroll as a Whop partner |
|
|
21
|
+
|
|
22
|
+
Run `whop referrals <command> --help` for options, or `whop referrals <command> --schema` for full argument details.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: whop-swaps
|
|
3
|
+
description: Convert a balance between currencies. Run `whop swaps --help` for usage details.
|
|
4
|
+
requires_bin: whop
|
|
5
|
+
command: whop swaps
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
Swaps convert value between supported tokens, chains, or wallet destinations for an account. A swap quote describes the expected output, fees, and approval requirements before you create the swap.
|
|
9
|
+
|
|
10
|
+
Use the Swaps API to quote a conversion, create the swap, list recent swaps, and retrieve status until the transaction completes.
|
|
11
|
+
|
|
12
|
+
## Commands
|
|
13
|
+
|
|
14
|
+
| Command | Description |
|
|
15
|
+
|---------|-------------|
|
|
16
|
+
| `whop swaps status` | List Swaps |
|
|
17
|
+
| `whop swaps create` | Create Swap |
|
|
18
|
+
| `whop swaps quote` | Create Swap Quote |
|
|
19
|
+
| `whop swaps get` | Retrieve Swap |
|
|
20
|
+
|
|
21
|
+
Run `whop swaps <command> --help` for options, or `whop swaps <command> --schema` for full argument details.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: whop-transfers
|
|
3
|
+
description: Move funds between Whop accounts and users. Run `whop transfers --help` for usage details.
|
|
4
|
+
requires_bin: whop
|
|
5
|
+
command: whop transfers
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
Transfers move value between identities on Whop. They are used for account-to-account money movement, user payouts inside Whop, crypto transfers, and claim links depending on the destination type.
|
|
9
|
+
|
|
10
|
+
Use the Transfers API to create a transfer, list previous transfers, and retrieve a transfer by ID when reconciling money movement between accounts or users.
|
|
11
|
+
|
|
12
|
+
## Commands
|
|
13
|
+
|
|
14
|
+
| Command | Description |
|
|
15
|
+
|---------|-------------|
|
|
16
|
+
| `whop transfers list` | List Transfers |
|
|
17
|
+
| `whop transfers create` | Create Transfer |
|
|
18
|
+
| `whop transfers get` | Retrieve Transfer |
|
|
19
|
+
|
|
20
|
+
Run `whop transfers <command> --help` for options, or `whop transfers <command> --schema` for full argument details.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: whop-users
|
|
3
|
+
description: "A person on Whop: profile and connected identities. Run `whop users --help` for usage details."
|
|
4
|
+
requires_bin: whop
|
|
5
|
+
command: whop users
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
A User represents a person on Whop. Users have a public profile and can buy products, join accounts, and access experiences.
|
|
9
|
+
|
|
10
|
+
Use the Users API to search for users, retrieve or update profiles, and check whether a user has access to an account, product, or experience.
|
|
11
|
+
|
|
12
|
+
## Commands
|
|
13
|
+
|
|
14
|
+
| Command | Description |
|
|
15
|
+
|---------|-------------|
|
|
16
|
+
| `whop users list` | List Users |
|
|
17
|
+
| `whop users me` | Update Current User |
|
|
18
|
+
| `whop users get` | Retrieve User |
|
|
19
|
+
| `whop users update` | Update User |
|
|
20
|
+
| `whop users access` | Check User Access |
|
|
21
|
+
|
|
22
|
+
Run `whop users <command> --help` for options, or `whop users <command> --schema` for full argument details.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: whop-verifications
|
|
3
|
+
description: Identity review required before payouts and card issuing. Run `whop verifications --help` for usage details.
|
|
4
|
+
requires_bin: whop
|
|
5
|
+
command: whop verifications
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
A Verification represents an identity review for a person or business. Accounts and users complete verification when Whop needs to confirm who they are before enabling payouts or compliance-sensitive workflows.
|
|
9
|
+
|
|
10
|
+
Use the Verifications API to start or resume a hosted verification session, check review status, and submit requested details or documents. If `requested_information` contains items, submit answers with [Update Verification](https://docs.whop.com/api-reference/beta/verifications/update-verification).
|
|
11
|
+
|
|
12
|
+
## Commands
|
|
13
|
+
|
|
14
|
+
| Command | Description |
|
|
15
|
+
|---------|-------------|
|
|
16
|
+
| `whop verifications list` | List Verifications |
|
|
17
|
+
| `whop verifications create` | Create Verification |
|
|
18
|
+
| `whop verifications get` | Retrieve Verification |
|
|
19
|
+
| `whop verifications update` | Update Verification |
|
|
20
|
+
|
|
21
|
+
Run `whop verifications <command> --help` for options, or `whop verifications <command> --schema` for full argument details.
|