API ↔ CLI Cross-Reference

Every Koywe REST endpoint exposed by @koyweforest/cli v0.14.1, indexed by resource. Start here if you already know which HTTP endpoint you want to call and need the matching CLI invocation.

The reverse view (indexed by CLI command) is on the CLI Command Reference page. The underlying JSON is published at /cli-commands.json.

126 commands map directly onto REST endpoints. 16 commands are CLI-only (local auth, guided flows, config) and are listed at the end.

Root endpoints

`applicant-company-roles`

Method	Path	CLI	Description
`GET`	`/applicant-company-roles`	`koywe reference company-roles`	List applicant company roles

`auth`

Method	Path	CLI	Description
`POST`	`/auth/credentials/rotate-secret`	`koywe auth rotate-secret`	Rotate API secret for the current API user
`GET`	`/auth/me`	`koywe auth me`	Get current user information
`POST`	`/auth/organizations/{orgId}/api-users/mfa/prepare`	`koywe auth mfa prepare`	Start delegated MFA enrollment by sending your public key
`POST`	`/auth/organizations/{orgId}/credentials`	`koywe auth credentials create-org`	Create API credentials for an organization
`POST`	`/auth/organizations/{orgId}/merchants/{merchantId}/credentials`	`koywe auth credentials create`	Create API credentials for a merchant
`POST`	`/auth/organizations/{orgId}/merchants/{merchantId}/pos/credentials/create`	`koywe auth credentials create-pos`	Create POS credentials for a merchant
`POST`	`/auth/sign-in`	`koywe auth login`	Authenticate with API key and secret

`banks`

Method	Path	CLI	Description
`GET`	`/banks`	`koywe banks list`	List available banks

`countries`

Method	Path	CLI	Description
`GET`	`/countries`	`koywe countries list`	List available countries
`GET`	`/countries/{countrySymbol}/economic-activities`	`koywe countries economic-activities`	List economic activities for a country
`GET`	`/countries/{countrySymbol}/states`	`koywe countries states`	List states for a country
`GET`	`/countries/{countrySymbol}/states/{stateId}`	`koywe countries state-info`	Get state details
`GET`	`/countries/{countrySymbol}/states/{stateId}/counties`	`koywe countries counties`	List counties for a state
`GET`	`/countries/{countrySymbol}/states/{stateId}/counties/{countyId}`	`koywe countries county-info`	Get county details

`currencies`

Method	Path	CLI	Description
`GET`	`/currencies`	`koywe currencies list`	List available currencies
`GET`	`/currencies/{id}`	`koywe currencies info`	Get currency details by ID
`GET`	`/currencies/symbol/{symbol}`	`koywe currencies by-symbol`	Get currency by symbol

`documents`

Method	Path	CLI	Description
`GET`	`/documents`	`koywe documents list`	List available document types

`economic-activities`

Method	Path	CLI	Description
`GET`	`/economic-activities`	`koywe countries economic-activities-all`	List all economic activities (global, not country-specific)

`global-feature-flags`

Method	Path	CLI	Description
`GET`	`/global-feature-flags`	`koywe reference feature-flags`	List global feature flags

`me`

Method	Path	CLI	Description
`POST`	`/me/notifications`	`koywe notifications send-personal`	Send a personal notification

`onboarding`

Method	Path	CLI	Description
`GET`	`/onboarding/me`	`koywe onboarding me`	Get your onboarding status

`organizations`

Method	Path	CLI	Description
`GET`	`/organizations`	`koywe org list`	List all organizations

`payment-method`

Method	Path	CLI	Description
`GET`	`/payment-method`	`koywe payment-methods list`	List available payment methods
`GET`	`/payment-method/card/merchants/{merchantId}/verify`	`koywe payment-methods verify-card`	Verify card payment method for a merchant

`pre-onboarding`

Method	Path	CLI	Description
`POST`	`/pre-onboarding/registration-draft`	`koywe pre-onboarding drafts create`	Create a new registration draft
`GET`	`/pre-onboarding/registration-draft/{draftId}`	`koywe pre-onboarding drafts info`	Get a registration draft by ID
`PUT`	`/pre-onboarding/registration-draft/{draftId}`	`koywe pre-onboarding drafts update`	Update an existing registration draft (auto-merges with existing data)
`POST`	`/pre-onboarding/registration-form/{draftId}`	`koywe pre-onboarding drafts submit`	Submit a registration draft for review
`GET`	`/pre-onboarding/registrations`	`koywe pre-onboarding registrations list`	List all registrations
`GET`	`/pre-onboarding/registrations/{registrationId}/status`	`koywe pre-onboarding registrations status`	Get registration status

`users`

Method	Path	CLI	Description
`GET`	`/users/me`	`koywe users me`	Get the authenticated user profile
`GET`	`/users/organizations/{orgId}/invitations`	`koywe users org-invitations list`	List invitations at the organization level
`POST`	`/users/organizations/{orgId}/invitations`	`koywe users org-invitations create`	Invite a user at the organization level
`GET`	`/users/organizations/{orgId}/merchants/{merchantId}/invitations`	`koywe users invitations list`	List invitations for the current merchant
`POST`	`/users/organizations/{orgId}/merchants/{merchantId}/invitations`	`koywe users invitations create`	Invite a user to the merchant

Organization-scoped endpoints

Prefix: /organizations/{orgId}/

`balances`

Method	Path	CLI	Description
`GET`	`/organizations/{orgId}/balances`	`koywe org balances`	Get organization balances

`feature-flags`

Method	Path	CLI	Description
`GET`	`/organizations/{orgId}/feature-flags`	`koywe org feature-flags`	Get organization feature flags

`merchants`

Method	Path	CLI	Description
`GET`	`/organizations/{orgId}/merchants`	`koywe merchant list`	List merchants in the current organization
`POST`	`/organizations/{orgId}/merchants`	`koywe merchant create`	Create a new merchant
`DELETE`	`/organizations/{orgId}/merchants/{merchantId}`	`koywe merchant delete`	Delete a merchant
`GET`	`/organizations/{orgId}/merchants/{merchantId}`	`koywe merchant info`	Get current merchant details
`PUT`	`/organizations/{orgId}/merchants/{merchantId}`	`koywe merchant update`	Update merchant details

`policy`

Method	Path	CLI	Description
`DELETE`	`/organizations/{orgId}/policy`	`koywe policy delete`	Delete the current policy
`GET`	`/organizations/{orgId}/policy`	`koywe policy info`	Get current policy configuration
`POST`	`/organizations/{orgId}/policy`	`koywe policy create`	Create a new policy
`GET`	`/organizations/{orgId}/policy/approvals`	`koywe policy approvals list`	List pending policy approvals
`GET`	`/organizations/{orgId}/policy/approvals/{approvalId}`	`koywe policy approvals info`	Get approval details
`POST`	`/organizations/{orgId}/policy/approvals/{approvalId}/approve`	`koywe policy approvals approve`	Approve a pending approval (requires MFA)
`POST`	`/organizations/{orgId}/policy/approvals/{approvalId}/reject`	`koywe policy approvals reject`	Reject a pending approval (requires MFA)
`GET`	`/organizations/{orgId}/policy/audit`	`koywe policy audit`	View policy audit log
`POST`	`/organizations/{orgId}/policy/rules`	`koywe policy rules create`	Add a rule to the policy
`DELETE`	`/organizations/{orgId}/policy/rules/{ruleId}`	`koywe policy rules delete`	Delete a policy rule
`PUT`	`/organizations/{orgId}/policy/rules/{ruleId}`	`koywe policy rules update`	Update a policy rule
`PUT`	`/organizations/{orgId}/policy/rules/reorder`	`koywe policy rules reorder`	Reorder policy rules

`users`

Method	Path	CLI	Description
`GET`	`/organizations/{orgId}/users`	`koywe users org-list`	List users at the organization level
`PUT`	`/organizations/{orgId}/users`	`koywe users org-update-roles`	Update roles for a user at the organization level

`webauthn`

Method	Path	CLI	Description
`POST`	`/organizations/{orgId}/webauthn/challenge`	`koywe auth mfa challenge`	Request an MFA challenge nonce
`POST`	`/organizations/{orgId}/webauthn/challenge` `/verify`	`koywe auth mfa challenge-sign`	Full MFA flow: challenge → sign → verify → return mfaToken
`POST`	`/organizations/{orgId}/webauthn/verify`	`koywe auth mfa verify`	Submit a signed stamp to verify MFA and receive an mfaToken

`webhook-event-types`

Method	Path	CLI	Description
`GET`	`/organizations/{orgId}/webhook-event-types`	`koywe webhooks event-types`	List available webhook event types, grouped by category

`webhook-events`

Method	Path	CLI	Description
`GET`	`/organizations/{orgId}/webhook-events`	`koywe webhooks events list`	List webhook events
`GET`	`/organizations/{orgId}/webhook-events/{eventId}`	`koywe webhooks events info`	Get webhook event details
`GET`	`/organizations/{orgId}/webhook-events/{eventId}/deliveries`	`koywe webhooks events deliveries`	Get deliveries for a webhook event
`POST`	`/organizations/{orgId}/webhook-events/{eventId}/replay`	`koywe webhooks events replay`	Replay a webhook event delivery

`webhooks`

Method	Path	CLI	Description
`GET`	`/organizations/{orgId}/webhooks`	`koywe webhooks list`	List webhooks for the current organization
`POST`	`/organizations/{orgId}/webhooks`	`koywe webhooks create`	Create a new webhook
`DELETE`	`/organizations/{orgId}/webhooks/{webhookId}`	`koywe webhooks delete`	Delete a webhook
`GET`	`/organizations/{orgId}/webhooks/{webhookId}`	`koywe webhooks info`	Get webhook details
`POST`	`/organizations/{orgId}/webhooks/{webhookId}/pause`	`koywe webhooks pause`	Pause a webhook
`POST`	`/organizations/{orgId}/webhooks/{webhookId}/ping`	`koywe webhooks ping`	Send a test ping to a webhook
`POST`	`/organizations/{orgId}/webhooks/{webhookId}/resume`	`koywe webhooks resume`	Resume a paused webhook
`POST`	`/organizations/{orgId}/webhooks/{webhookId}/rotate-secret`	`koywe webhooks rotate-secret`	Rotate webhook secret
`PATCH`	`/organizations/{orgId}/webhooks/{webhookId}/subscriptions`	`koywe webhooks subscriptions update`	Update the event types a webhook endpoint is subscribed to

Merchant-scoped endpoints

Prefix: /organizations/{orgId}/merchants/{merchantId}/

`accounts`

Method	Path	CLI	Description
`GET`	`/organizations/{orgId}/merchants/{merchantId}/accounts`	`koywe bank-accounts list`	List external bank accounts
`POST`	`/organizations/{orgId}/merchants/{merchantId}/accounts`	`koywe bank-accounts create`	Create an external bank account
`DELETE`	`/organizations/{orgId}/merchants/{merchantId}/accounts/{accountId}`	`koywe bank-accounts delete`	Delete a bank account
`GET`	`/organizations/{orgId}/merchants/{merchantId}/accounts/{accountId}`	`koywe bank-accounts info`	Get bank account details
`PUT`	`/organizations/{orgId}/merchants/{merchantId}/accounts/{accountId}`	`koywe bank-accounts update`	Update a bank account
`GET`	`/organizations/{orgId}/merchants/{merchantId}/accounts/{accountId}/balance`	`koywe bank-accounts balance`	Get balance for a specific account
`GET`	`/organizations/{orgId}/merchants/{merchantId}/accounts/{accountId}/reports/ledger-entry/{entryId}`	`koywe reports ledger-entry`	Get a specific ledger entry
`GET`	`/organizations/{orgId}/merchants/{merchantId}/accounts/{accountId}/reports/ledger-statement`	`koywe reports ledger`	Get ledger statement for an account
`GET`	`/organizations/{orgId}/merchants/{merchantId}/accounts/{accountId}/reports/orders`	`koywe reports orders`	Get orders report for an account
`GET`	`/organizations/{orgId}/merchants/{merchantId}/accounts/balances`	`koywe bank-accounts balances`	Get balances for all accounts
`POST`	`/organizations/{orgId}/merchants/{merchantId}/accounts/confirm-mfa`	`koywe bank-accounts confirm-mfa`	Confirm MFA for a pending account approval
`GET`	`/organizations/{orgId}/merchants/{merchantId}/accounts/search`	`koywe bank-accounts search`	Search bank accounts

`bankIncome`

Method	Path	CLI	Description
`GET`	`/organizations/{orgId}/merchants/{merchantId}/bankIncome/accounts`	`koywe bank-accounts deposit-info`	Get deposit account information (bank income)

`contacts`

Method	Path	CLI	Description
`GET`	`/organizations/{orgId}/merchants/{merchantId}/contacts`	`koywe contacts list`	List contacts for the current merchant
`POST`	`/organizations/{orgId}/merchants/{merchantId}/contacts`	`koywe contacts create`	Create a new contact
`DELETE`	`/organizations/{orgId}/merchants/{merchantId}/contacts/{contactId}`	`koywe contacts delete`	Delete a contact
`GET`	`/organizations/{orgId}/merchants/{merchantId}/contacts/{contactId}`	`koywe contacts info`	Get contact details
`PUT`	`/organizations/{orgId}/merchants/{merchantId}/contacts/{contactId}`	`koywe contacts update`	Update an existing contact
`GET`	`/organizations/{orgId}/merchants/{merchantId}/contacts/{contactId}/accounts`	`koywe contacts accounts list`	List accounts for a contact
`POST`	`/organizations/{orgId}/merchants/{merchantId}/contacts/{contactId}/accounts`	`koywe contacts accounts create`	Create an account for a contact
`DELETE`	`/organizations/{orgId}/merchants/{merchantId}/contacts/{contactId}/accounts/{accountId}`	`koywe contacts accounts delete`	Delete an account for a contact
`GET`	`/organizations/{orgId}/merchants/{merchantId}/contacts/{contactId}/accounts/{accountId}`	`koywe contacts accounts info`	Get account details for a contact
`PUT`	`/organizations/{orgId}/merchants/{merchantId}/contacts/{contactId}/accounts/{accountId}`	`koywe contacts accounts update`	Update an account for a contact
`POST`	`/organizations/{orgId}/merchants/{merchantId}/contacts/{contactId}/accounts/confirm-mfa`	`koywe contacts accounts confirm-mfa`	Confirm MFA for a pending contact account approval
`DELETE`	`/organizations/{orgId}/merchants/{merchantId}/contacts/{contactId}/documents`	`koywe contacts documents delete`	Delete documents for a contact

`deals`

Method	Path	CLI	Description
`GET`	`/organizations/{orgId}/merchants/{merchantId}/deals`	`koywe deals list`	List deals for the current merchant
`POST`	`/organizations/{orgId}/merchants/{merchantId}/deals`	`koywe deals create`	Create a new deal
`GET`	`/organizations/{orgId}/merchants/{merchantId}/deals/{dealId}`	`koywe deals info`	Get deal details by ID
`POST`	`/organizations/{orgId}/merchants/{merchantId}/deals/{dealId}/confirm`	`koywe deals confirm`	Confirm MFA for a pending deal approval
`POST`	`/organizations/{orgId}/merchants/{merchantId}/deals/{dealId}/transfer`	`koywe deals transfer`	Transfer a scheduled deal

`features`

Method	Path	CLI	Description
`GET`	`/organizations/{orgId}/merchants/{merchantId}/features`	`koywe merchant features`	List features for the current merchant

`notifications`

Method	Path	CLI	Description
`POST`	`/organizations/{orgId}/merchants/{merchantId}/notifications`	`koywe notifications send`	Send a notification for a merchant

`onboarding`

Method	Path	CLI	Description
`GET`	`/organizations/{orgId}/merchants/{merchantId}/onboarding/kyb`	`koywe onboarding kyb list`	List KYB processes for a merchant
`POST`	`/organizations/{orgId}/merchants/{merchantId}/onboarding/kyb`	`koywe onboarding kyb trigger`	Trigger a KYB process for a merchant
`GET`	`/organizations/{orgId}/merchants/{merchantId}/onboarding/kyb/{kybId}`	`koywe onboarding kyb status`	Get KYB process status

`orders`

Method	Path	CLI	Description
`GET`	`/organizations/{orgId}/merchants/{merchantId}/orders`	`koywe orders list`	List orders for the current merchant
`POST`	`/organizations/{orgId}/merchants/{merchantId}/orders`	`koywe orders create`	Create a new order (PAYIN, PAYOUT, ONRAMP, OFFRAMP, BALANCE_TRANSFER, PAYMENT_LINK, INTER_MERCHANT_TRANSFER)
`GET`	`/organizations/{orgId}/merchants/{merchantId}/orders/{orderId}`	`koywe orders info`	Get order details by ID
`PATCH`	`/organizations/{orgId}/merchants/{merchantId}/orders/{orderId}`	`koywe orders update`	Update an order (e.g. associate a blockchain tx hash)
`POST`	`/organizations/{orgId}/merchants/{merchantId}/orders/{orderId}/confirm`	`koywe orders confirm`	Confirm an ON_HOLD order via MFA
`POST`	`/organizations/{orgId}/merchants/{merchantId}/orders/{orderId}/notification`	`koywe orders notify`	Send a notification for an order
`GET`	`/organizations/{orgId}/merchants/{merchantId}/orders/{orderId}/sign`	`koywe orders sign prepare`	Get the signing payload for an ON_HOLD order
`POST`	`/organizations/{orgId}/merchants/{merchantId}/orders/{orderId}/sign/confirm`	`koywe orders sign confirm`	Submit a stamped signature for an order
`GET`	`/organizations/{orgId}/merchants/{merchantId}/orders/external/{externalId}`	`koywe orders get-by-external-id`	Get order by external (merchant-provided) ID

`quotes`

Method	Path	CLI	Description
`POST`	`/organizations/{orgId}/merchants/{merchantId}/quotes`	`koywe quotes create`	Create a new quote
`GET`	`/organizations/{orgId}/merchants/{merchantId}/quotes/{quoteId}`	`koywe quotes info`	Get quote details

`users`

Method	Path	CLI	Description
`GET`	`/organizations/{orgId}/merchants/{merchantId}/users`	`koywe users list`	List users for the current merchant
`PUT`	`/organizations/{orgId}/merchants/{merchantId}/users`	`koywe users update-roles`	Update roles for a user at the merchant level

`virtual-accounts`

Method	Path	CLI	Description
`GET`	`/organizations/{orgId}/merchants/{merchantId}/virtual-accounts`	`koywe bank-accounts virtual list`	List virtual bank accounts
`POST`	`/organizations/{orgId}/merchants/{merchantId}/virtual-accounts`	`koywe bank-accounts virtual create`	Create a virtual bank account
`PATCH`	`/organizations/{orgId}/merchants/{merchantId}/virtual-accounts/{accountId}/alias`	`koywe bank-accounts virtual update-alias`	Update virtual account alias

CLI-only commands (no REST endpoint)

These commands are local to the CLI — browser-based auth handshakes, guided multi-step flows, and config management. They orchestrate multiple API calls or manipulate local state, so they don’t map one-to-one to a single endpoint.

CLI	Description
`koywe auth browser-login`	Authenticate via browser-based login
`koywe auth mfa keygen`	Generate a P-256 keypair for delegated signing
`koywe auth mfa sign`	Sign a body with your delegated P-256 key (local operation, no API call)
`koywe config profile add`	Create a new profile
`koywe config profile list`	List all profiles
`koywe config profile remove`	Remove a profile (cannot remove the active profile)
`koywe config profile use`	Switch to a named profile
`koywe config reset`	Reset all configuration and cached tokens
`koywe config set`	Set a configuration value in the active profile
`koywe config show`	Display current configuration (active profile)
`koywe flow deal`	Create a crypto deal: get quote → create deal → optionally transfer
`koywe flow order`	Create an order: get quote → create order → wait for approval if needed
`koywe init`	Set up CLI credentials: log in via browser, then create API keys via the API
`koywe merchant select`	Set the active merchant context
`koywe org select`	Set the active organization context
`koywe setup`	New user setup: sign up via browser, then submit a pre-onboarding registration