@whop/cli 0.14.0 → 0.14.2

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.
Files changed (40) hide show
  1. package/README.md +2 -2
  2. package/dist/index.js +25130 -10229
  3. package/dist/index.js.map +1 -1
  4. package/package.json +2 -2
  5. package/skills/whop-accounts/SKILL.md +195 -15
  6. package/skills/whop-ad-campaigns/SKILL.md +193 -15
  7. package/skills/whop-ad-groups/SKILL.md +258 -16
  8. package/skills/whop-ads/SKILL.md +190 -14
  9. package/skills/whop-api-keys/SKILL.md +112 -12
  10. package/skills/whop-app-builds/SKILL.md +68 -8
  11. package/skills/whop-apps/SKILL.md +135 -12
  12. package/skills/whop-audiences/SKILL.md +71 -8
  13. package/skills/whop-bounties/SKILL.md +104 -9
  14. package/skills/whop-bounty-submissions/SKILL.md +82 -9
  15. package/skills/whop-cards/SKILL.md +120 -8
  16. package/skills/whop-checkout-configurations/SKILL.md +64 -8
  17. package/skills/whop-deposits/SKILL.md +13 -5
  18. package/skills/whop-disputes/SKILL.md +86 -9
  19. package/skills/whop-events/SKILL.md +90 -8
  20. package/skills/whop-exports/SKILL.md +329 -7
  21. package/skills/whop-ledgers/SKILL.md +38 -6
  22. package/skills/whop-media/SKILL.md +28 -7
  23. package/skills/whop-members/SKILL.md +51 -6
  24. package/skills/whop-memberships/SKILL.md +137 -13
  25. package/skills/whop-notifications/SKILL.md +91 -12
  26. package/skills/whop-partners/SKILL.md +102 -12
  27. package/skills/whop-payouts/SKILL.md +130 -9
  28. package/skills/whop-people/SKILL.md +50 -6
  29. package/skills/whop-permissions/SKILL.md +8 -5
  30. package/skills/whop-plans/SKILL.md +152 -12
  31. package/skills/whop-products/SKILL.md +141 -13
  32. package/skills/whop-resolution-center-cases/SKILL.md +222 -17
  33. package/skills/whop-shipments/SKILL.md +66 -8
  34. package/skills/whop-social-accounts/SKILL.md +112 -11
  35. package/skills/whop-stats/SKILL.md +50 -6
  36. package/skills/whop-swaps/SKILL.md +63 -8
  37. package/skills/whop-team-members/SKILL.md +80 -9
  38. package/skills/whop-transfers/SKILL.md +67 -8
  39. package/skills/whop-users/SKILL.md +271 -18
  40. package/skills/whop-verifications/SKILL.md +51 -9
@@ -9,14 +9,85 @@ A Team Member is a member of an account's team: the link between a user and an a
9
9
 
10
10
  Use the Team Members API to list an account's team, add a user to the team with a system role, change a member's role, and remove members. Adding a user who has not yet accepted sends an invitation instead.
11
11
 
12
- ## Commands
12
+ # whop team-members create
13
13
 
14
- | Command | Description |
15
- |---------|-------------|
16
- | `whop team-members list` | List Team Members |
17
- | `whop team-members create` | Create Team Member |
18
- | `whop team-members delete` | Delete Team Member |
19
- | `whop team-members get` | Retrieve Team Member |
20
- | `whop team-members update` | Update Team Member |
14
+ Create Team Member
21
15
 
22
- Run `whop team-members <command> --help` for options, or `whop team-members <command> --schema` for full argument details.
16
+ ## Options
17
+
18
+ | Flag | Type | Required | Default | Description |
19
+ |------|------|----------|---------|-------------|
20
+ | `--account_id` | `string` | yes | | Account ID, prefixed `biz_`. |
21
+ | `--email` | `string` | no | | Email address to invite. Mutually exclusive with `user_id`. If the email already belongs to a Whop account it is treated the same as passing that account's `user_id`; otherwise a pending invite is created for the email. |
22
+ | `--role` | `string` | yes | | The system role to grant. |
23
+ | `--user_id` | `string` | no | | The user to add to the team, prefixed `user_`. Mutually exclusive with `email`. |
24
+ | `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
25
+
26
+ > Confirm with the user before executing this destructive command.
27
+
28
+ ---
29
+
30
+ # whop team-members delete
31
+
32
+ Delete Team Member
33
+
34
+ ## Arguments
35
+
36
+ | Name | Type | Required | Description |
37
+ |------|------|----------|-------------|
38
+ | `id` | `string` | yes | Team member ID — `ausr_` for accepted members, `ausri_` for pending invites. |
39
+
40
+ > Confirm with the user before executing this destructive command.
41
+
42
+ ---
43
+
44
+ # whop team-members get
45
+
46
+ Retrieve Team Member
47
+
48
+ ## Arguments
49
+
50
+ | Name | Type | Required | Description |
51
+ |------|------|----------|-------------|
52
+ | `id` | `string` | yes | Team member ID — `ausr_` for accepted members, `ausri_` for pending invites. |
53
+
54
+ ---
55
+
56
+ # whop team-members list
57
+
58
+ List Team Members
59
+
60
+ ## Options
61
+
62
+ | Flag | Type | Required | Default | Description |
63
+ |------|------|----------|---------|-------------|
64
+ | `--account_id` | `string` | no | | Account ID, prefixed `biz_`. |
65
+ | `--status` | `string` | no | | Only return members with this status: `joined` (accepted members) or `pending` (pending invites). Both are returned by default. |
66
+ | `--user_id` | `string` | no | | Only return the membership for this user ID, prefixed `user_`. |
67
+ | `--role` | `string` | no | | Only return members with this role. `custom` matches members on a dashboard-managed custom role. |
68
+ | `--created_before` | `string` | no | | Only return members added before this ISO 8601 timestamp. |
69
+ | `--created_after` | `string` | no | | Only return members added after this ISO 8601 timestamp. |
70
+ | `--order` | `string` | no | | Field used to sort members. |
71
+ | `--direction` | `string` | no | | Sort direction. Defaults to `desc`. |
72
+ | `--first` | `number` | no | | Number of members to return. Defaults to 20; maximum 100. |
73
+ | `--after` | `string` | no | | Cursor for the next page of members. |
74
+
75
+ ---
76
+
77
+ # whop team-members update
78
+
79
+ Update Team Member
80
+
81
+ ## Arguments
82
+
83
+ | Name | Type | Required | Description |
84
+ |------|------|----------|-------------|
85
+ | `id` | `string` | yes | Team member ID — `ausr_` for accepted members, `ausri_` for pending invites. |
86
+
87
+ ## Options
88
+
89
+ | Flag | Type | Required | Default | Description |
90
+ |------|------|----------|---------|-------------|
91
+ | `--role` | `string` | yes | | The system role to grant. |
92
+
93
+ > Confirm with the user before executing this destructive command.
@@ -9,13 +9,72 @@ Transfers move value between identities on Whop. They are used for account-to-ac
9
9
 
10
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
11
 
12
- ## Commands
12
+ # whop transfers create
13
13
 
14
- | Command | Description |
15
- |---------|-------------|
16
- | `whop transfers list` | List Transfers |
17
- | `whop transfers create` | Create Transfer |
18
- | `whop transfers recipients` | List Transfer Recipients |
19
- | `whop transfers get` | Retrieve Transfer |
14
+ Create Transfer
20
15
 
21
- Run `whop transfers <command> --help` for options, or `whop transfers <command> --schema` for full argument details.
16
+ ## Options
17
+
18
+ | Flag | Type | Required | Default | Description |
19
+ |------|------|----------|---------|-------------|
20
+ | `--amount` | `number` | yes | | The amount to move, in the transfer currency. For example 25.00. |
21
+ | `--currency` | `string` | no | | Currency, such as `usd`. Required for ledger transfers. |
22
+ | `--destination_id` | `string` | no | | The recipient. Required for ledger and wallet_send (a user_/biz_/ldgr_ ID, or — for sends — an email). Omit for claim_link. |
23
+ | `--expires_at` | `unknown` | no | | claim_link only. Link expiry as an ISO 8601 timestamp. Defaults to 24 hours from creation. |
24
+ | `--idempotence_key` | `unknown` | no | | Ledger transfers and wallet sends. A unique key that makes retries safe. Retrying with the same key returns the original transfer, or attaches to the original wallet send, instead of moving money twice. |
25
+ | `--metadata` | `unknown` | no | | Ledger transfers only. Custom key-value pairs attached to the transfer. Max 50 keys, 100 chars per key, 500 chars per string value. |
26
+ | `--notes` | `unknown` | no | | Ledger transfers only. A short note describing the transfer. |
27
+ | `--origin_id` | `string` | yes | | The account sending the funds. A user ID (user_xxx), account ID (biz_xxx), or ledger account ID (ldgr_xxx). |
28
+ | `--redeemable_count` | `number` | no | | claim_link only. How many different users can claim the link. Defaults to 1. |
29
+ | `--type` | `string` | no | | The kind of money movement, which decides what comes back. Defaults to ledger. `ledger` moves credit between two Whop balances and returns a `transfer`; `wallet_send` sends USDT from the origin account's Ethereum wallet and returns a `send`; `claim_link` funds a shareable link anyone with the URL can redeem and returns a `claim_link`. A `ledger` transfer from a stablecoin-rails account settles on-chain when covered, and still returns a `transfer`. |
30
+ | `--idempotency-key` | `string` | yes | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
31
+
32
+ > Confirmation policy: For `--type ledger` only, the user's request to execute the transfer counts as confirmation when it includes exact `--origin_id`, `--destination_id`, `--amount`, and `--currency` values and both IDs use a `biz_`, `user_`, or `ldgr_` prefix. Execute that confirmed transfer yourself. This exception does not apply to `wallet_send` or `claim_link`; ask for explicit confirmation before executing those transfer types. Always include a unique `--idempotency-key`. If a result is uncertain, retry the same transfer with the same key.
33
+
34
+ ---
35
+
36
+ # whop transfers get
37
+
38
+ Retrieve Transfer
39
+
40
+ ## Arguments
41
+
42
+ | Name | Type | Required | Description |
43
+ |------|------|----------|-------------|
44
+ | `id` | `string` | yes | The transfer ID. |
45
+
46
+ ---
47
+
48
+ # whop transfers list
49
+
50
+ List Transfers
51
+
52
+ ## Options
53
+
54
+ | Flag | Type | Required | Default | Description |
55
+ |------|------|----------|---------|-------------|
56
+ | `--origin_id` | `string` | no | | Filter to transfers sent from this account. Provide this or destination_id. |
57
+ | `--destination_id` | `string` | no | | Filter to transfers received by this account. Provide this or origin_id. |
58
+ | `--order` | `string` | no | | Sort column. Defaults to created_at. |
59
+ | `--direction` | `string` | no | | Sort direction. Defaults to desc. |
60
+ | `--created_before` | `string` | no | | Only transfers created strictly before this ISO 8601 timestamp. |
61
+ | `--created_after` | `string` | no | | Only transfers created strictly after this ISO 8601 timestamp. |
62
+ | `--first` | `number` | no | `50` | Number of transfers to return from the start of the window. |
63
+ | `--after` | `string` | no | | Cursor to fetch the page after (from page_info.end_cursor). |
64
+ | `--last` | `number` | no | | Number of transfers to return from the end of the window. |
65
+ | `--before` | `string` | no | | Cursor to fetch the page before (from page_info.start_cursor). |
66
+
67
+ ---
68
+
69
+ # whop transfers recipients
70
+
71
+ List Transfer Recipients
72
+
73
+ ## Options
74
+
75
+ | Flag | Type | Required | Default | Description |
76
+ |------|------|----------|---------|-------------|
77
+ | `--origin_id` | `string` | yes | | The originating account ID, prefixed `biz_`. |
78
+ | `--query` | `string` | no | | Search users and accounts by name, username, or ID, in the dashboard's relevance order — this additionally requires the member:basic:read scope. Omit it to get the origin account's team members followed by your own other accounts. Complete email addresses return no matches. |
79
+ | `--first` | `number` | no | `20` | Number of recipients per page. Search queries preserve the dashboard's 20-result maximum. |
80
+ | `--after` | `string` | no | | Cursor to fetch the page after (from page_info.end_cursor). |
@@ -9,21 +9,274 @@ A User represents a person on Whop. Users have a public profile and can buy prod
9
9
 
10
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
11
 
12
- ## Commands
13
-
14
- | Command | Description |
15
- |---------|-------------|
16
- | `whop users list` | List Users |
17
- | `whop users me` | Retrieve Current User |
18
- | `whop users update-me` | Update Current User |
19
- | `whop users preferences` | Retrieve |
20
- | `whop users update-preferences` | Update |
21
- | `whop users set-notification-preferences` | Set |
22
- | `whop users experience-notification-preferences` | List Experiences |
23
- | `whop users notification-topic-preferences` | List Topics |
24
- | `whop users get` | Retrieve User |
25
- | `whop users update` | Update User |
26
- | `whop users access` | Check User Access |
27
- | `whop users recommend_actions` | List Recommended Actions |
28
-
29
- Run `whop users <command> --help` for options, or `whop users <command> --schema` for full argument details.
12
+ # whop users access
13
+
14
+ Check User Access
15
+
16
+ ## Arguments
17
+
18
+ | Name | Type | Required | Description |
19
+ |------|------|----------|-------------|
20
+ | `id` | `string` | yes | The user_ tag or username to check access for. |
21
+ | `resource_id` | `string` | yes | An account (biz_), product (prod_), or experience (exp_) ID. |
22
+
23
+ ---
24
+
25
+ # whop users delete-passkey
26
+
27
+ Delete
28
+
29
+ ## Arguments
30
+
31
+ | Name | Type | Required | Description |
32
+ |------|------|----------|-------------|
33
+ | `id` | `string` | yes | Passkey ID, prefixed `wcred_`. |
34
+
35
+ ## Options
36
+
37
+ | Flag | Type | Required | Default | Description |
38
+ |------|------|----------|---------|-------------|
39
+ | `--authenticator_data` | `string` | yes | | The `authenticatorData` from the WebAuthn assertion, base64url-encoded. |
40
+ | `--client_data_json` | `string` | yes | | The `clientDataJSON` from the WebAuthn assertion, base64url-encoded. |
41
+ | `--signature` | `string` | yes | | The `signature` from the WebAuthn assertion, base64url-encoded. |
42
+
43
+ > Confirm with the user before executing this destructive command.
44
+
45
+ ---
46
+
47
+ # whop users experience-notification-preferences
48
+
49
+ List Experiences
50
+
51
+ ## Options
52
+
53
+ | Flag | Type | Required | Default | Description |
54
+ |------|------|----------|---------|-------------|
55
+ | `--first` | `number` | no | | The number of preferences to return. |
56
+ | `--after` | `string` | no | | A cursor; returns preferences after this position. |
57
+
58
+ ---
59
+
60
+ # whop users get
61
+
62
+ Retrieve User
63
+
64
+ ## Arguments
65
+
66
+ | Name | Type | Required | Description |
67
+ |------|------|----------|-------------|
68
+ | `id` | `string` | yes | User ID (prefixed `user_`) or username. |
69
+
70
+ ## Options
71
+
72
+ | Flag | Type | Required | Default | Description |
73
+ |------|------|----------|---------|-------------|
74
+ | `--account_id` | `string` | no | | When set, returns the user's account-specific profile overrides for this account. |
75
+
76
+ ---
77
+
78
+ # whop users list
79
+
80
+ List Users
81
+
82
+ ## Options
83
+
84
+ | Flag | Type | Required | Default | Description |
85
+ |------|------|----------|---------|-------------|
86
+ | `--query` | `string` | no | | A search term to filter users by name or username. |
87
+ | `--first` | `number` | no | | The number of users to return (max 50). |
88
+ | `--after` | `string` | no | | A cursor; returns users after this position. |
89
+ | `--last` | `number` | no | | The number of users to return from the end of the range. |
90
+ | `--before` | `string` | no | | A cursor; returns users before this position. |
91
+
92
+ ---
93
+
94
+ # whop users me
95
+
96
+ Retrieve Current User
97
+
98
+ ## Options
99
+
100
+ | Flag | Type | Required | Default | Description |
101
+ |------|------|----------|---------|-------------|
102
+ | `--account_id` | `string` | no | | When set, returns your account-specific profile overrides for this account. |
103
+ | `--include_balance_history` | `boolean` | no | | Also compute your balance history (opt-in; runs a heavier query). Ignored for callers without balance-read scope. |
104
+ | `--from` | `string` | no | | Balance-history window start, ISO 8601 date or datetime. Defaults to 30 days ago. Only used with `include_balance_history`. |
105
+ | `--to` | `string` | no | | Balance-history window end, ISO 8601 date or datetime. Defaults to now. Only used with `include_balance_history`. |
106
+ | `--interval` | `string` | no | | Balance-history point granularity. Defaults to `day`. Only used with `include_balance_history`. |
107
+ | `--time_zone` | `string` | no | | IANA time zone the balance-history points are bucketed in. Defaults to `UTC`. Only used with `include_balance_history`. |
108
+
109
+ ---
110
+
111
+ # whop users me-oauth_grants
112
+
113
+ List OAuth Grants
114
+
115
+ ## Options
116
+
117
+ | Flag | Type | Required | Default | Description |
118
+ |------|------|----------|---------|-------------|
119
+ | `--app_id` | `string` | no | | Only return grants for this app, prefixed `app_`. An app the user has never authorized returns an empty list. |
120
+ | `--first` | `number` | no | | The number of grants to return (default 20, max 100). |
121
+ | `--after` | `string` | no | | A cursor; returns grants after this position. |
122
+ | `--last` | `number` | no | | The number of grants to return from the end of the range. |
123
+ | `--before` | `string` | no | | A cursor; returns grants before this position. |
124
+ | `--order` | `string` | no | | The field to sort grants by. |
125
+ | `--direction` | `string` | no | | Sort direction. |
126
+
127
+ ---
128
+
129
+ # whop users notification-topic-preferences
130
+
131
+ List Topics
132
+
133
+ ## Options
134
+
135
+ | Flag | Type | Required | Default | Description |
136
+ |------|------|----------|---------|-------------|
137
+ | `--channel` | `string` | no | | Only return preferences for this delivery channel (or not narrowed to a channel). |
138
+ | `--account_id` | `string` | no | | Only return preferences scoped to this account's member notifications (`biz_` tag). |
139
+ | `--team_account_id` | `string` | no | | Only return preferences scoped to this account's team notifications (`biz_` tag). |
140
+ | `--experience_id` | `string` | no | | Only return preferences scoped to this experience (`exp_` tag). |
141
+ | `--topic_id` | `string` | no | | Only return preferences scoped to this notification topic (`topic_` tag). |
142
+ | `--first` | `number` | no | | The number of preferences to return. |
143
+ | `--after` | `string` | no | | A cursor; returns preferences after this position. |
144
+
145
+ ---
146
+
147
+ # whop users passkey-challenge
148
+
149
+ Create Challenge
150
+
151
+ ## Options
152
+
153
+ | Flag | Type | Required | Default | Description |
154
+ |------|------|----------|---------|-------------|
155
+ | `--challenge_type` | `string` | yes | | The ceremony this challenge is for. |
156
+ | `--passkey_id` | `string` | no | | The passkey the ceremony targets, prefixed `wcred_`. Required when `challenge_type` is `deletion`, ignored otherwise. |
157
+ | `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
158
+
159
+ > Confirm with the user before executing this destructive command.
160
+
161
+ ---
162
+
163
+ # whop users passkeys
164
+
165
+ List
166
+
167
+ ## Options
168
+
169
+ | Flag | Type | Required | Default | Description |
170
+ |------|------|----------|---------|-------------|
171
+ | `--first` | `number` | no | | The number of passkeys to return (default 20, max 100). |
172
+ | `--after` | `string` | no | | A cursor; returns passkeys after this position. |
173
+ | `--last` | `number` | no | | The number of passkeys to return from the end of the range. |
174
+ | `--before` | `string` | no | | A cursor; returns passkeys before this position. |
175
+ | `--order` | `string` | no | | The field to sort passkeys by. |
176
+ | `--direction` | `string` | no | | Sort direction. |
177
+
178
+ ---
179
+
180
+ # whop users preferences
181
+
182
+ Retrieve
183
+
184
+ ---
185
+
186
+ # whop users recommend_actions
187
+
188
+ List Recommended Actions
189
+
190
+ ## Arguments
191
+
192
+ | Name | Type | Required | Description |
193
+ |------|------|----------|-------------|
194
+ | `id` | `string` | yes | `me`, or the authenticated user's own `user_` tag or username. |
195
+
196
+ ---
197
+
198
+ # whop users register-passkey
199
+
200
+ Register
201
+
202
+ ## Options
203
+
204
+ | Flag | Type | Required | Default | Description |
205
+ |------|------|----------|---------|-------------|
206
+ | `--attestation_object` | `string` | yes | | The `attestationObject` from the WebAuthn attestation response, base64url-encoded. |
207
+ | `--client_data_json` | `string` | yes | | The `clientDataJSON` from the WebAuthn attestation response, base64url-encoded. |
208
+ | `--credential_id` | `string` | yes | | The WebAuthn credential ID the authenticator returned, base64url-encoded. |
209
+ | `--nickname` | `string` | yes | | A name for this passkey, usually the device it lives on. 255 characters or fewer. |
210
+ | `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
211
+
212
+ > Confirm with the user before executing this destructive command.
213
+
214
+ ---
215
+
216
+ # whop users set-notification-preferences
217
+
218
+ Set
219
+
220
+ ## Options
221
+
222
+ | Flag | Type | Required | Default | Description |
223
+ |------|------|----------|---------|-------------|
224
+ | `--preferences` | `array` | yes | | The preferences to set, at most 100 per request. |
225
+
226
+ > Confirm with the user before executing this destructive command.
227
+
228
+ ---
229
+
230
+ # whop users update
231
+
232
+ Update User
233
+
234
+ ## Arguments
235
+
236
+ | Name | Type | Required | Description |
237
+ |------|------|----------|-------------|
238
+ | `id` | `string` | yes | User ID (prefixed `user_`) or username. |
239
+
240
+ ## Options
241
+
242
+ | Flag | Type | Required | Default | Description |
243
+ |------|------|----------|---------|-------------|
244
+ | `--account_id` | `string` | no | | The account whose profile override to update. Required for API key callers. |
245
+ | `--bio` | `string` | no | | |
246
+ | `--name` | `string` | no | | |
247
+ | `--profile_picture` | `object` | no | | |
248
+ | `--username` | `string` | no | | |
249
+
250
+ > Confirm with the user before executing this destructive command.
251
+
252
+ ---
253
+
254
+ # whop users update-me
255
+
256
+ Update Current User
257
+
258
+ ## Options
259
+
260
+ | Flag | Type | Required | Default | Description |
261
+ |------|------|----------|---------|-------------|
262
+ | `--account_id` | `string` | no | | When set, updates the authenticated user's profile override for this account instead of their global profile. |
263
+ | `--bio` | `string` | no | | |
264
+ | `--name` | `string` | no | | |
265
+ | `--profile_picture` | `object` | no | | |
266
+ | `--username` | `string` | no | | |
267
+
268
+ > Confirm with the user before executing this destructive command.
269
+
270
+ ---
271
+
272
+ # whop users update-preferences
273
+
274
+ Update
275
+
276
+ ## Options
277
+
278
+ | Flag | Type | Required | Default | Description |
279
+ |------|------|----------|---------|-------------|
280
+ | `--investigation_enabled` | `boolean` | no | | Whether investigation mode is enabled for the user. Only meaningful for staff users with investigation access. |
281
+
282
+ > Confirm with the user before executing this destructive command.
@@ -9,17 +9,59 @@ A Verification represents a legal identity for a person or business. Accounts an
9
9
 
10
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
11
 
12
- ## Commands
12
+ # whop verifications create
13
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 |
14
+ Create Verification
20
15
 
21
- Run `whop verifications <command> --help` for options, or `whop verifications <command> --schema` for full argument details.
16
+ ## Options
17
+
18
+ | Flag | Type | Required | Default | Description |
19
+ |------|------|----------|---------|-------------|
20
+ | `--account_id` | `string` | no | | Account or user ID whose identity you want to verify. Use a `biz_` account ID for account verifications, or the caller's `user_` ID for personal verification. |
21
+ | `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
22
+
23
+ > Confirm with the user before executing this destructive command.
24
+
25
+ ---
26
+
27
+ # whop verifications get
28
+
29
+ Retrieve Verification
30
+
31
+ ## Arguments
32
+
33
+ | Name | Type | Required | Description |
34
+ |------|------|----------|-------------|
35
+ | `verification_id` | `string` | yes | Verification profile ID, prefixed `idpf_`. |
36
+
37
+ ---
38
+
39
+ # whop verifications list
40
+
41
+ List Verifications
42
+
43
+ ## Options
44
+
45
+ | Flag | Type | Required | Default | Description |
46
+ |------|------|----------|---------|-------------|
47
+ | `--account_id` | `string` | no | | Account or user ID whose verifications you want to list. Use a `biz_` account ID, or the caller's `user_` ID for personal verifications. |
48
+ | `--order` | `string` | no | | Field used to sort returned verifications. |
49
+ | `--direction` | `string` | no | | Sort direction for returned verifications. |
50
+
51
+ ---
52
+
53
+ # whop verifications update
54
+
55
+ Update Verification
56
+
57
+ ## Arguments
58
+
59
+ | Name | Type | Required | Description |
60
+ |------|------|----------|-------------|
61
+ | `verification_id` | `string` | yes | Verification profile ID, prefixed `idpf_`. |
62
+
63
+ > Confirm with the user before executing this destructive command.
22
64
 
23
65
  ## Steps that finish in the browser
24
66
 
25
- Some commands respond with a URL the user must open in a browser to finish the flow (`authorize_url`, `session_url`, `deposit_url`) — the CLI cannot complete that step itself. When a response contains one of these fields, or the CLI prints "Action required: open this link in the user's browser", open that link in the user's browser for them, tell them what to complete there, then re-run the matching `get`/`list` command to confirm the step finished.
67
+ Some commands respond with a URL the user must open in a browser to finish the flow (`authorize_url`, `session_url`, `deposit_url`, `checkout_url`) — the CLI cannot complete that step itself. When a response contains one of these fields, or the CLI prints "Action required: open this link in the user's browser", open that link in the user's browser for them, tell them what to complete there, then re-run the matching `get`/`list` command to confirm the step finished.