# Sumvin API

## Docs

- [API Conventions](https://docs.sumvin.com/api-conventions.md): Patterns and conventions used across the Sumvin Platform API
- [Delete Account](https://docs.sumvin.com/api-reference/accounts/delete-account.md)
- [Get Account](https://docs.sumvin.com/api-reference/accounts/get-account.md)
- [Get Link Config](https://docs.sumvin.com/api-reference/accounts/get-link-config.md)
- [Initiate Link](https://docs.sumvin.com/api-reference/accounts/initiate-link.md)
- [List Accounts](https://docs.sumvin.com/api-reference/accounts/list-accounts.md)
- [Sync Account](https://docs.sumvin.com/api-reference/accounts/sync-account.md)
- [Update Account](https://docs.sumvin.com/api-reference/accounts/update-account.md)
- [Link Pint To Agent Task](https://docs.sumvin.com/api-reference/agent-task-pints/link-pint-to-agent-task.md)
- [Unlink Pint From Agent Task](https://docs.sumvin.com/api-reference/agent-task-pints/unlink-pint-from-agent-task.md)
- [Cancel Agent Task](https://docs.sumvin.com/api-reference/agent-tasks/cancel-agent-task.md)
- [Get Agent Task](https://docs.sumvin.com/api-reference/agent-tasks/get-agent-task.md)
- [Get Agent Task By Id](https://docs.sumvin.com/api-reference/agent-tasks/get-agent-task-by-id.md)
- [List Agent Tasks](https://docs.sumvin.com/api-reference/agent-tasks/list-agent-tasks.md)
- [List All Agent Tasks](https://docs.sumvin.com/api-reference/agent-tasks/list-all-agent-tasks.md)
- [Trigger Agent Task](https://docs.sumvin.com/api-reference/agent-tasks/trigger-agent-task.md)
- [Update Agent Task](https://docs.sumvin.com/api-reference/agent-tasks/update-agent-task.md)
- [Create User Token](https://docs.sumvin.com/api-reference/agent/create-user-token.md): Create a short-lived agent token scoped to a specific user.
- [Revoke Agent Token](https://docs.sumvin.com/api-reference/agent/revoke-agent-token.md): Revoke an agent token.
- [Create a new API key](https://docs.sumvin.com/api-reference/api-keys/create-a-new-api-key.md)
- [Get API key details](https://docs.sumvin.com/api-reference/api-keys/get-api-key-details.md)
- [List API keys for the organisation](https://docs.sumvin.com/api-reference/api-keys/list-api-keys-for-the-organisation.md)
- [Revoke an API key](https://docs.sumvin.com/api-reference/api-keys/revoke-an-api-key.md)
- [Get asset details](https://docs.sumvin.com/api-reference/assets/get-asset-details.md): Retrieve detailed information about a specific asset by its symbol.
- [Get current asset price](https://docs.sumvin.com/api-reference/assets/get-current-asset-price.md): Retrieve the current market price for an asset in a specified fiat currency.
- [List supported assets](https://docs.sumvin.com/api-reference/assets/list-supported-assets.md): Retrieve a paginated list of supported assets (cryptocurrencies and fiat currencies).
- [List organisation audit events](https://docs.sumvin.com/api-reference/audit-events/list-organisation-audit-events.md): Returns a paginated, newest-first list of audit events for the organisation. Use `cursor` (the `next_cursor` from a previous response) to page through results.
- [Delete auth config for an environment](https://docs.sumvin.com/api-reference/auth-config/delete-auth-config-for-an-environment.md)
- [Get auth config for an environment](https://docs.sumvin.com/api-reference/auth-config/get-auth-config-for-an-environment.md)
- [Set auth config for an environment](https://docs.sumvin.com/api-reference/auth-config/set-auth-config-for-an-environment.md)
- [Add Bank Connection Products](https://docs.sumvin.com/api-reference/bank-linking/add-bank-connection-products.md)
- [Create Bank Processor Token](https://docs.sumvin.com/api-reference/bank-linking/create-bank-processor-token.md)
- [Delete Bank Connection](https://docs.sumvin.com/api-reference/bank-linking/delete-bank-connection.md)
- [Get Bank Connection](https://docs.sumvin.com/api-reference/bank-linking/get-bank-connection.md)
- [Get Institutions](https://docs.sumvin.com/api-reference/bank-linking/get-institutions.md)
- [List Bank Connections](https://docs.sumvin.com/api-reference/bank-linking/list-bank-connections.md)
- [List investment holdings](https://docs.sumvin.com/api-reference/bank-linking/list-investment-holdings.md): List the positions held in a linked investment account.
- [List investment transactions](https://docs.sumvin.com/api-reference/bank-linking/list-investment-transactions.md): List trades and other activity for a linked investment account, filtered by date range and paginated.
- [Refresh Bank Connection](https://docs.sumvin.com/api-reference/bank-linking/refresh-bank-connection.md)
- [Repair Bank Connection](https://docs.sumvin.com/api-reference/bank-linking/repair-bank-connection.md)
- [Sync investment holdings and transactions](https://docs.sumvin.com/api-reference/bank-linking/sync-investment-holdings-and-transactions.md): Trigger a refresh of holdings and transactions for a linked investment account.
- [Create Budget](https://docs.sumvin.com/api-reference/budgets/create-budget.md)
- [Delete Budget](https://docs.sumvin.com/api-reference/budgets/delete-budget.md)
- [Get Budget](https://docs.sumvin.com/api-reference/budgets/get-budget.md)
- [List Budgets](https://docs.sumvin.com/api-reference/budgets/list-budgets.md)
- [Update Budget](https://docs.sumvin.com/api-reference/budgets/update-budget.md)
- [Get Card Funding](https://docs.sumvin.com/api-reference/card-funding/get-card-funding.md)
- [Update Card Funding](https://docs.sumvin.com/api-reference/card-funding/update-card-funding.md)
- [Activate Card](https://docs.sumvin.com/api-reference/cards/activate-card.md)
- [Freeze Card](https://docs.sumvin.com/api-reference/cards/freeze-card.md)
- [Get Card](https://docs.sumvin.com/api-reference/cards/get-card.md)
- [List Cards](https://docs.sumvin.com/api-reference/cards/list-cards.md)
- [Report Lost Card](https://docs.sumvin.com/api-reference/cards/report-lost-card.md)
- [Report Stolen Card](https://docs.sumvin.com/api-reference/cards/report-stolen-card.md)
- [Unfreeze Card](https://docs.sumvin.com/api-reference/cards/unfreeze-card.md)
- [Create Session](https://docs.sumvin.com/api-reference/chat/create-session.md)
- [Delete Session](https://docs.sumvin.com/api-reference/chat/delete-session.md)
- [Get Session](https://docs.sumvin.com/api-reference/chat/get-session.md)
- [List Messages](https://docs.sumvin.com/api-reference/chat/list-messages.md)
- [List Sessions](https://docs.sumvin.com/api-reference/chat/list-sessions.md)
- [Save Messages](https://docs.sumvin.com/api-reference/chat/save-messages.md)
- [Update Session](https://docs.sumvin.com/api-reference/chat/update-session.md)
- [Upload Chat Attachment](https://docs.sumvin.com/api-reference/chat/upload-chat-attachment.md)
- [Approve a CLI sign-in](https://docs.sumvin.com/api-reference/cli/approve-a-cli-sign-in.md): Approve a pending sign-in request. The authenticated user confirms the short user code shown by the CLI; the request is bound to that user and advanced to approved.
- [Deny a CLI sign-in](https://docs.sumvin.com/api-reference/cli/deny-a-cli-sign-in.md): Deny a pending or approved sign-in request. The authenticated user rejects the request, moving it to a terminal denied state.
- [Exchange an approved sign-in for a token](https://docs.sumvin.com/api-reference/cli/exchange-an-approved-sign-in-for-a-token.md): Trade an approved device code for a personal access token. The plaintext token is returned exactly once in this response. The exchange is single-use: a device code that has already been exchanged returns 409, and an expired one returns 410.
- [List personal access tokens](https://docs.sumvin.com/api-reference/cli/list-personal-access-tokens.md): List the calling user's personal access tokens. Each entry carries its id, label, scopes, derived status (active, revoked, or expired), and timestamps. Token plaintext is never returned.
- [Poll a CLI sign-in](https://docs.sumvin.com/api-reference/cli/poll-a-cli-sign-in.md): Poll the status of a sign-in request using its device code. Returns the current status while the request is pending or approved; a terminal request (exchanged, denied, or expired) returns 410. The personal access token is never returned here — exchange it at the personal-access-tokens endpoint.
- [Revoke a personal access token](https://docs.sumvin.com/api-reference/cli/revoke-a-personal-access-token.md): Revoke one of the calling user's personal access tokens. Revocation takes effect immediately — a revoked token stops authenticating on its very next request. Revoking an already-revoked token is a no-op.
- [Start a CLI sign-in](https://docs.sumvin.com/api-reference/cli/start-a-cli-sign-in.md): Begin a device-authorization sign-in for the CLI. Returns a device code for the CLI to poll and exchange, a short user code for the person to confirm in the browser, the verification URL, and the polling cadence.
- [Get Connector](https://docs.sumvin.com/api-reference/connectors/get-connector.md)
- [List Connectors](https://docs.sumvin.com/api-reference/connectors/list-connectors.md)
- [Add a CORS origin](https://docs.sumvin.com/api-reference/cors-origins/add-a-cors-origin.md)
- [List CORS origins](https://docs.sumvin.com/api-reference/cors-origins/list-cors-origins.md)
- [Remove a CORS origin](https://docs.sumvin.com/api-reference/cors-origins/remove-a-cors-origin.md)
- [Get current member profile](https://docs.sumvin.com/api-reference/dashboard/get-current-member-profile.md)
- [Create an environment](https://docs.sumvin.com/api-reference/environments/create-an-environment.md)
- [Delete an environment](https://docs.sumvin.com/api-reference/environments/delete-an-environment.md)
- [Get environment details](https://docs.sumvin.com/api-reference/environments/get-environment-details.md)
- [List environments](https://docs.sumvin.com/api-reference/environments/list-environments.md)
- [Update an environment](https://docs.sumvin.com/api-reference/environments/update-an-environment.md)
- [Get the Explore catalog](https://docs.sumvin.com/api-reference/explore/get-the-explore-catalog.md): Returns the curated Explore catalog grouped into 8 type-keyed sections. Each item is hydrated per-user with eligibility (based on the user's connectors) and filtered by any feature flag configured for that item. Section ordering is client-owned; the API always returns all 8 section keys even when em…
- [Enable or update a feature for an environment](https://docs.sumvin.com/api-reference/features/enable-or-update-a-feature-for-an-environment.md)
- [Get a specific feature for an environment](https://docs.sumvin.com/api-reference/features/get-a-specific-feature-for-an-environment.md)
- [List features for an environment](https://docs.sumvin.com/api-reference/features/list-features-for-an-environment.md)
- [Remove a feature from an environment](https://docs.sumvin.com/api-reference/features/remove-a-feature-from-an-environment.md)
- [Health Check](https://docs.sumvin.com/api-reference/health/health-check.md)
- [Accept Insight](https://docs.sumvin.com/api-reference/insights/accept-insight.md)
- [Dismiss Insight](https://docs.sumvin.com/api-reference/insights/dismiss-insight.md)
- [Get Insight](https://docs.sumvin.com/api-reference/insights/get-insight.md)
- [List Insights](https://docs.sumvin.com/api-reference/insights/list-insights.md)
- [Approve Ipa](https://docs.sumvin.com/api-reference/ipa/approve-ipa.md)
- [Cancel Ipa](https://docs.sumvin.com/api-reference/ipa/cancel-ipa.md)
- [Clarify Ipa](https://docs.sumvin.com/api-reference/ipa/clarify-ipa.md)
- [Create IPA](https://docs.sumvin.com/api-reference/ipa/create-ipa.md): Creates a new Intelligent Purchase Authorization from a natural-language request.
- [Get Ipa](https://docs.sumvin.com/api-reference/ipa/get-ipa.md)
- [Get Ipa Events](https://docs.sumvin.com/api-reference/ipa/get-ipa-events.md)
- [List Ipas](https://docs.sumvin.com/api-reference/ipa/list-ipas.md)
- [Create KYC applicant](https://docs.sumvin.com/api-reference/kyc/create-kyc-applicant.md)
- [Get a KYC document image](https://docs.sumvin.com/api-reference/kyc/get-a-kyc-document-image.md)
- [Get a KYC document image for a user](https://docs.sumvin.com/api-reference/kyc/get-a-kyc-document-image-for-a-user.md)
- [Get Access Token](https://docs.sumvin.com/api-reference/kyc/get-access-token.md): Generate a Sumsub SDK access token to start KYC verification.
- [Get current KYC verification status](https://docs.sumvin.com/api-reference/kyc/get-current-kyc-verification-status.md): Get the current KYC verification status.
- [Get detailed KYC verification information](https://docs.sumvin.com/api-reference/kyc/get-detailed-kyc-verification-information.md): Get detailed KYC verification information.
- [Get KYC details for a user](https://docs.sumvin.com/api-reference/kyc/get-kyc-details-for-a-user.md)
- [Get required KYC documents statuses](https://docs.sumvin.com/api-reference/kyc/get-required-kyc-documents-statuses.md)
- [List uploaded KYC document images](https://docs.sumvin.com/api-reference/kyc/list-uploaded-kyc-document-images.md)
- [Submit KYC application for review](https://docs.sumvin.com/api-reference/kyc/submit-kyc-application-for-review.md)
- [Upload a KYC document image](https://docs.sumvin.com/api-reference/kyc/upload-a-kyc-document-image.md)
- [Add a member to the organisation](https://docs.sumvin.com/api-reference/members/add-a-member-to-the-organisation.md)
- [List organisation members](https://docs.sumvin.com/api-reference/members/list-organisation-members.md)
- [Remove a member from the organisation](https://docs.sumvin.com/api-reference/members/remove-a-member-from-the-organisation.md)
- [Update a member](https://docs.sumvin.com/api-reference/members/update-a-member.md)
- [Create a new organisation](https://docs.sumvin.com/api-reference/organisation/create-a-new-organisation.md)
- [Get organisation details](https://docs.sumvin.com/api-reference/organisation/get-organisation-details.md)
- [Update organisation](https://docs.sumvin.com/api-reference/organisation/update-organisation.md)
- [Create a payment link](https://docs.sumvin.com/api-reference/payment-links/create-a-payment-link.md): Create a shareable payment link from a signed EIP-712 PurchaseIntent. The returned slug is derived from the signature so the URL itself is cryptographically bound to the requester.
- [Get a payment link by slug](https://docs.sumvin.com/api-reference/payment-links/get-a-payment-link-by-slug.md): Fetch a payment link owned by the authenticated user.
- [Get a payment link (public)](https://docs.sumvin.com/api-reference/payment-links/get-a-payment-link-public.md): Fetch a payment link by its public slug. No authentication required. Returns the signed EIP-712 mandate, signature, nonce, accepted chains, and asset so a payer can verify and settle.
- [List payment links](https://docs.sumvin.com/api-reference/payment-links/list-payment-links.md): List payment links owned by the authenticated user. Use `from_date` / `to_date` to filter by creation date (accepts epoch ms or YYYY-MM-DD).
- [Open or settle a payment link](https://docs.sumvin.com/api-reference/payment-links/open-or-settle-a-payment-link.md): Single agent-facing endpoint for a payment link. Browsers receive an HTML landing that bounces to the canonical public resource. Agents receive an x402 v2 ``402 Payment Required`` challenge on first hit and retry the same URL with a ``PAYMENT-SIGNATURE`` header carrying a signed payload for the chos…
- [Exchange Pint](https://docs.sumvin.com/api-reference/pint/exchange-pint.md)
- [Get Nonce](https://docs.sumvin.com/api-reference/pint/get-nonce.md): Return the next PINT nonce for ``wallet``.
- [Get Pint Detail Internal](https://docs.sumvin.com/api-reference/pint/get-pint-detail-internal.md)
- [Get Pint Detail Sis](https://docs.sumvin.com/api-reference/pint/get-pint-detail-sis.md)
- [Get Pint Status](https://docs.sumvin.com/api-reference/pint/get-pint-status.md)
- [List Pint Tokens](https://docs.sumvin.com/api-reference/pint/list-pint-tokens.md)
- [List Pints Endpoint](https://docs.sumvin.com/api-reference/pint/list-pints-endpoint.md)
- [List Pints Sis](https://docs.sumvin.com/api-reference/pint/list-pints-sis.md)
- [Revoke Pint](https://docs.sumvin.com/api-reference/pint/revoke-pint.md)
- [Submit Pint Signature](https://docs.sumvin.com/api-reference/pint/submit-pint-signature.md): Submit a wallet-signed EIP-712 signature to activate a PENDING PINT.
- [Get Provider](https://docs.sumvin.com/api-reference/providers/get-provider.md)
- [Get a ramp transaction](https://docs.sumvin.com/api-reference/ramp/get-a-ramp-transaction.md): Returns a single ramp transaction by id, scoped to the authenticated user.
- [Get ramp quotes](https://docs.sumvin.com/api-reference/ramp/get-ramp-quotes.md): Returns ranked quotes from supported providers for a fiat ↔ crypto trade. Direction (buy or sell) is inferred from which side of `from_asset`/`to_asset` is fiat. `chain_id` describes the crypto leg of the trade.
- [List ramp transactions](https://docs.sumvin.com/api-reference/ramp/list-ramp-transactions.md): Returns a page of ramp transactions for the authenticated user, scoped to their Meld customer record. Use this to reconcile state between widget sessions opened via `POST /v0/ramp/sessions` and the live provider state. For status changes between polls, poll `GET /v0/ramp/transactions/{id}` on a back…
- [Open a ramp widget session](https://docs.sumvin.com/api-reference/ramp/open-a-ramp-widget-session.md): Creates a hosted widget session for a fiat ↔ crypto trade. Direction is inferred from `from_asset`/`to_asset`. The response carries a `widget_url` the client renders in a webview or iframe.
- [Delete Receipt](https://docs.sumvin.com/api-reference/receipts/delete-receipt.md)
- [Download Receipt](https://docs.sumvin.com/api-reference/receipts/download-receipt.md)
- [Upload Receipt](https://docs.sumvin.com/api-reference/receipts/upload-receipt.md)
- [Set monthly gas sponsorship budget](https://docs.sumvin.com/api-reference/rpc-billing/set-monthly-gas-sponsorship-budget.md): Update the maximum USD spend per calendar month for gas sponsorship on this organisation. Requests that would exceed the budget are rejected with 402 until the next month begins or the budget is raised.
- [Get Safe deployment configuration](https://docs.sumvin.com/api-reference/safe/get-safe-deployment-configuration.md): Returns the deterministic Safe address and the factory parameters needed to deploy it on the specified chain. The predicted address is usable as a UserOperation `sender` even before the Safe contract is deployed — the first UserOperation can include the factory and factoryData to deploy the Safe in…
- [Poll UserOperation status](https://docs.sumvin.com/api-reference/safe/poll-useroperation-status.md): Returns the lifecycle status of a previously submitted UserOperation. Once the operation is included on-chain, the response also includes the transaction hash, block number, gas used, gas cost, and a `receipt` link to the underlying transaction receipt.
- [Submit a sponsored UserOperation](https://docs.sumvin.com/api-reference/safe/submit-a-sponsored-useroperation.md): Submits a signed UserOperation for sponsorship and bundler delivery. Sumvin fills in the paymaster fields, signs as paymaster, and forwards the operation to the bundler. The response returns the UserOperation hash so the client can poll for terminal status. Send an `Idempotency-Key` header to make r…
- [Get Challenge](https://docs.sumvin.com/api-reference/siwe-auth/get-challenge.md)
- [Verify And Create Wallet](https://docs.sumvin.com/api-reference/siwe-auth/verify-and-create-wallet.md)
- [Get Strategy](https://docs.sumvin.com/api-reference/strategies/get-strategy.md)
- [List Strategies](https://docs.sumvin.com/api-reference/strategies/list-strategies.md)
- [Exchange Pint For Token](https://docs.sumvin.com/api-reference/token-exchange/exchange-pint-for-token.md)
- [Get transaction details](https://docs.sumvin.com/api-reference/transactions/get-transaction-details.md): Retrieve detailed information about a specific transaction by its external ID.
- [List user transactions](https://docs.sumvin.com/api-reference/transactions/list-user-transactions.md): Retrieve a paginated list of transactions across all funding sources (wallets, bank accounts, cards).
- [Connect Service](https://docs.sumvin.com/api-reference/user-connectors/connect-service.md)
- [Disconnect Service](https://docs.sumvin.com/api-reference/user-connectors/disconnect-service.md)
- [Get User Connector](https://docs.sumvin.com/api-reference/user-connectors/get-user-connector.md)
- [List User Connectors](https://docs.sumvin.com/api-reference/user-connectors/list-user-connectors.md)
- [Update User Connector](https://docs.sumvin.com/api-reference/user-connectors/update-user-connector.md)
- [Create Rule](https://docs.sumvin.com/api-reference/user-rules/create-rule.md)
- [Delete Rule](https://docs.sumvin.com/api-reference/user-rules/delete-rule.md)
- [Get Rule](https://docs.sumvin.com/api-reference/user-rules/get-rule.md)
- [List user rules](https://docs.sumvin.com/api-reference/user-rules/list-user-rules.md): List all rules for the authenticated user with optional filtering and pagination.
- [Update Rule](https://docs.sumvin.com/api-reference/user-rules/update-rule.md)
- [Disable Strategy](https://docs.sumvin.com/api-reference/user-strategies/disable-strategy.md)
- [Enable Strategy](https://docs.sumvin.com/api-reference/user-strategies/enable-strategy.md)
- [Get User Strategy](https://docs.sumvin.com/api-reference/user-strategies/get-user-strategy.md)
- [List User Strategies](https://docs.sumvin.com/api-reference/user-strategies/list-user-strategies.md)
- [Update User Strategy](https://docs.sumvin.com/api-reference/user-strategies/update-user-strategy.md)
- [Create User Account](https://docs.sumvin.com/api-reference/user/create-user-account.md)
- [Delete User Profile Picture](https://docs.sumvin.com/api-reference/user/delete-user-profile-picture.md)
- [Get Onboarding Events](https://docs.sumvin.com/api-reference/user/get-onboarding-events.md)
- [Get Onboarding Safe](https://docs.sumvin.com/api-reference/user/get-onboarding-safe.md)
- [Get Onboarding Steps](https://docs.sumvin.com/api-reference/user/get-onboarding-steps.md): Return the computed onboarding state for the authenticated user: the current step, per-step status (completed/current/submitted/skipped/pending), feature-gate metadata, and HAL navigation links. This is a pure read — it does not record events or mutate state.
- [Get personalized calls-to-action](https://docs.sumvin.com/api-reference/user/get-personalized-calls-to-action.md): Returns cached CTAs for the user. On cache miss, triggers workflow generation and returns generating=true. Stale cache (>24h) returns existing CTAs while triggering a background refresh.
- [Get User Account](https://docs.sumvin.com/api-reference/user/get-user-account.md): Return the authenticated user's profile. The optional ``expand`` query parameter accepts ``wallets`` and ``status_history``; any other value is silently ignored to keep the endpoint forward- and backward-compatible during client rollouts (e.g. legacy clients still passing the retired ``onboarding``…
- [Get User Assets](https://docs.sumvin.com/api-reference/user/get-user-assets.md)
- [Submit Onboarding Safe](https://docs.sumvin.com/api-reference/user/submit-onboarding-safe.md)
- [Submit Onboarding Step Route](https://docs.sumvin.com/api-reference/user/submit-onboarding-step-route.md): Submit the user's current onboarding step. The body's ``step`` must match the user's current step; submitting any other step returns **409 Conflict** with the user's current step in the response so the client can self-correct. Returns **200 OK** when the transition is fully synchronous. Returns **20…
- [Update Phone](https://docs.sumvin.com/api-reference/user/update-phone.md)
- [Update Username](https://docs.sumvin.com/api-reference/user/update-username.md)
- [Upload User Profile Picture](https://docs.sumvin.com/api-reference/user/upload-user-profile-picture.md)
- [Verify Phone](https://docs.sumvin.com/api-reference/user/verify-phone.md)
- [Get user information by SRI](https://docs.sumvin.com/api-reference/users/get-user-information-by-sri.md)
- [List users for the caller's organisation](https://docs.sumvin.com/api-reference/users/list-users-for-the-callers-organisation.md)
- [Resolve Username](https://docs.sumvin.com/api-reference/users/resolve-username.md)
- [Get Wallet Balance Summary](https://docs.sumvin.com/api-reference/wallet-assets/get-wallet-balance-summary.md)
- [List Wallet Asset Transactions](https://docs.sumvin.com/api-reference/wallet-assets/list-wallet-asset-transactions.md)
- [List Wallet Assets](https://docs.sumvin.com/api-reference/wallet-assets/list-wallet-assets.md)
- [Create Wallet](https://docs.sumvin.com/api-reference/wallets/create-wallet.md)
- [Delete Wallet](https://docs.sumvin.com/api-reference/wallets/delete-wallet.md)
- [Get Wallet](https://docs.sumvin.com/api-reference/wallets/get-wallet.md)
- [List Wallets](https://docs.sumvin.com/api-reference/wallets/list-wallets.md)
- [Update Wallet](https://docs.sumvin.com/api-reference/wallets/update-wallet.md)
- [Handle Alchemy Webhook](https://docs.sumvin.com/api-reference/webhooks/handle-alchemy-webhook.md)
- [Handle Sumsub Webhook](https://docs.sumvin.com/api-reference/webhooks/handle-sumsub-webhook.md)
- [Receive a Meld webhook event](https://docs.sumvin.com/api-reference/webhooks/receive-a-meld-webhook-event.md): Receives signed webhook events from Meld for the configured tenant. Used for KYC status changes, ramp transaction lifecycle (`TRANSACTION_CRYPTO_PENDING`, `TRANSACTION_CRYPTO_TRANSFERRING`, `TRANSACTION_CRYPTO_COMPLETE`, `TRANSACTION_CRYPTO_FAILED`), and bank-linking events. The exact strings appear…
- [Create Widget](https://docs.sumvin.com/api-reference/widgets/create-widget.md)
- [Delete Widget](https://docs.sumvin.com/api-reference/widgets/delete-widget.md)
- [Get Widget](https://docs.sumvin.com/api-reference/widgets/get-widget.md)
- [List Widgets](https://docs.sumvin.com/api-reference/widgets/list-widgets.md)
- [Reorder Widgets](https://docs.sumvin.com/api-reference/widgets/reorder-widgets.md)
- [Update Widget](https://docs.sumvin.com/api-reference/widgets/update-widget.md)
- [Authentication](https://docs.sumvin.com/authentication.md): How to authenticate with the Sumvin Platform API and SIS API
- [Auth model](https://docs.sumvin.com/concepts/auth-model.md): The three credentials Sumvin uses and which one belongs on which call.
- [Card issuing](https://docs.sumvin.com/concepts/card-issuing.md): The conceptual model behind Sumvin's card issuing surface — the card, its funding wallet, and its state.
- [Environments, organisations, and CORS](https://docs.sumvin.com/concepts/environments-organisations-cors.md): How a partner partitions an integration into isolated namespaces with their own credentials and origins.
- [Errands](https://docs.sumvin.com/concepts/errands.md): An agent's scope-bound tasking run — Intent, Authorization, and Vigilance — built on a user's Stamped Mandates.
- [HAL links, RFC 7807, idempotency, pagination](https://docs.sumvin.com/concepts/hal-rfc7807-idempotency-pagination.md): The four cross-cutting HTTP conventions every Sumvin API follows.
- [KYC and attestation](https://docs.sumvin.com/concepts/kyc-and-attestation.md): How raw KYC outcomes become claims a verifier can consume.
- [Onboarding state machine](https://docs.sumvin.com/concepts/onboarding-state-machine.md): The states a user passes through from creation to fully onboarded.
- [Payment Links and x402](https://docs.sumvin.com/concepts/payment-links-x402.md): Shareable PINT-backed URLs and the HTTP 402 flow for machine-to-machine settlement.
- [Platform API vs SIS](https://docs.sumvin.com/concepts/platform-vs-sis.md): Where Sumvin splits the integrator surface — consumer-app calls vs credential verification.
- [Ramp sessions](https://docs.sumvin.com/concepts/ramp-sessions.md): The conceptual model behind on/off-ramp sessions for moving between fiat and crypto.
- [Realtime events](https://docs.sumvin.com/concepts/realtime-events.md): What partners use today for state that changes asynchronously, and what is not yet exposed.
- [Revocation](https://docs.sumvin.com/concepts/revocation.md): How a PINT and its issued JWTs are invalidated before their expiry.
- [Safe smart accounts and identity](https://docs.sumvin.com/concepts/safes-and-identity.md): How Safe multisig wallets anchor a user's on-chain identity.
- [Scopes and verification tiers](https://docs.sumvin.com/concepts/scopes-and-tiers.md): How the scopes on a PINT decide how deeply a verifier has to validate it.
- [Signing keys](https://docs.sumvin.com/concepts/signing-keys.md): The two key families Sumvin holds — agent signing keys and issuer keys — and how each rotates.
- [Sponsored UserOperations](https://docs.sumvin.com/concepts/sponsored-user-operations.md): How Sumvin sponsors gas for ERC-4337 UserOperations and the lifecycle states you can observe.
- [API Keys](https://docs.sumvin.com/dashboard/api-keys.md): Create and manage API keys for server-to-server calls to the SIS API.
- [Auth Provider Setup](https://docs.sumvin.com/dashboard/auth-providers.md): Connect Dynamic or Privy to your SIS environment.
- [Authentication Model](https://docs.sumvin.com/dashboard/authentication-model.md): How SIS validates user identity from your auth provider.
- [CORS Origins](https://docs.sumvin.com/dashboard/cors-origins.md): Allowlist the origins your app runs on to enable browser requests to SIS.
- [Environments](https://docs.sumvin.com/dashboard/environments.md): Environments let you isolate auth configuration and credentials across development, staging, and production.
- [Environment Features](https://docs.sumvin.com/dashboard/features.md): Toggle feature flags on a SIS environment to choose which Sumvin behaviors apply to your users.
- [SIS Dashboard](https://docs.sumvin.com/dashboard/introduction.md): The SIS Dashboard is the developer console for configuring your Sumvin Identity Service integration.
- [Team Members](https://docs.sumvin.com/dashboard/members.md): Invite and manage the team members who have access to your SIS Dashboard.
- [Organisations](https://docs.sumvin.com/dashboard/organisations.md): An organisation is the top-level account for a developer on Sumvin.
- [Quickstart](https://docs.sumvin.com/dashboard/quickstart.md): Set up your SIS organisation and run your first working verifier end-to-end.
- [Error Handling](https://docs.sumvin.com/error-handling.md): Common error scenarios and how to handle them across the Platform API
- [Glossary](https://docs.sumvin.com/glossary.md): Grouped index of Sumvin terms, each linking to its canonical reference.
- [Resetting Test Users](https://docs.sumvin.com/guides/dev-test-users.md): How to tear down a test account so you can replay onboarding end-to-end
- [Errands](https://docs.sumvin.com/guides/errand.md): Create, inspect, and drive an Errand through its lifecycle using the Platform API.
- [Identity Verification (KYC)](https://docs.sumvin.com/guides/kyc.md): Integrate identity verification into your platform using three verification modes — embedded SDK, hybrid API-plus-SDK, or document-only — with webhook-driven status updates.
- [Onboarding](https://docs.sumvin.com/guides/onboarding.md)
- [Issue Atomic Money Debit Cards](https://docs.sumvin.com/guides/quickstarts/issue-card.md): Quickstart for issuing a Sumvin debit card and funding it from a Safe wallet.
- [Use Sigil to instant on-ramp](https://docs.sumvin.com/guides/quickstarts/onramp-meld.md): Quote a buy, open a hosted ramp session, and settle crypto into a user's wallet.
- [Create an Atomic Money Payment Link](https://docs.sumvin.com/guides/quickstarts/payment-link.md): From a signed PurchaseIntent to a shareable URL an agent or a person can settle — end to end against the live contract.
- [Set up an Errand](https://docs.sumvin.com/guides/quickstarts/set-up-errand.md): Set up an Errand — created via an IPA that returns 202 Accepted with a preflight workflow — and observe its lifecycle from qualifying through to an approved state.
- [Create an identity Sigil for a user](https://docs.sumvin.com/guides/quickstarts/stand-up-account.md): Take a partner user from zero to a KYC-verified account with a deployed Safe wallet and a real balance call.
- [Submitting UserOperations](https://docs.sumvin.com/guides/safe-user-operations.md): End-to-end walkthrough: discover the Safe, build a UserOperation, submit for sponsorship, and poll for the on-chain outcome.
- [TanStack Query integration patterns](https://docs.sumvin.com/guides/tanstack-query-patterns.md): How Sumvin's own frontend integrates with the Platform API — recommended hooks, retry strategy, optimistic mutations, and cache invalidation patterns.
- [Wallets](https://docs.sumvin.com/guides/wallets.md): Manage EOA and Safe smart wallets across EVM chains
- [Agent signers](https://docs.sumvin.com/identity/agent-signers.md): How an agent-signed Stamped Mandate verifies as the user, and what it looks like to a verifier.
- [Attestation claims](https://docs.sumvin.com/identity/attestation-claims.md): The attestation claims Sumvin issues in identity JWTs and how to consume them.
- [SIS Authentication](https://docs.sumvin.com/identity/authentication.md): How to authenticate with the Sumvin Identity Service API
- [Getting User KYC Data](https://docs.sumvin.com/identity/getting-user-kyc-data.md): Access user identity verification details and document images via the SIS API with dual authentication
- [JWT Structure](https://docs.sumvin.com/identity/jwt.md): Claims and structure of SIS-issued JWTs for identity verification
- [Nonce Management](https://docs.sumvin.com/identity/nonces.md): How server-side nonces prevent replay attacks on Stamped Mandates
- [What is Sigil?](https://docs.sumvin.com/identity/overview.md): Sigil is Sumvin's portable, verifiable identity — Proof of Personhood a user (and their agent) carries across services.
- [EIP-712 & Purchase Intents](https://docs.sumvin.com/identity/pint.md): Canonical specification for the EIP-712 typed data structures used in Sumvin Purchase Intents
- [Stamped Mandate Lifecycle](https://docs.sumvin.com/identity/pint-lifecycle.md): Listing, inspecting, and revoking Stamped Mandates via the SIS API
- [Scopes Reference](https://docs.sumvin.com/identity/scopes.md): SRI-format scope catalog for Stamped Mandates (PINTs)
- [Signing a Stamped Mandate](https://docs.sumvin.com/identity/signing.md): How to sign a Stamped Mandate with user keys and agent keys
- [Sumvin Resource Identifiers (SRI)](https://docs.sumvin.com/identity/sri.md): Format and usage of SRI URIs for identifying users and resources
- [Token Exchange](https://docs.sumvin.com/identity/token-exchange.md): Exchange a signed Stamped Mandate for a SIS-signed JWT
- [Sumvin Platform API](https://docs.sumvin.com/introduction.md): What Sumvin is and what you can build with it
- [Error Reference](https://docs.sumvin.com/merchant/errors.md): Error codes and formats for SIS API responses
- [Header Reference](https://docs.sumvin.com/merchant/headers.md): HTTP headers used for Sumvin identity credential transmission
- [JWKS Endpoint](https://docs.sumvin.com/merchant/jwks.md): Public key discovery for verifying SIS-issued JWTs
- [Verifier Guide](https://docs.sumvin.com/merchant/overview.md): How merchants and service providers verify Sumvin identity credentials
- [Accept a Stamped Mandate at checkout](https://docs.sumvin.com/merchant/quickstarts/accept-pint-checkout.md): Quickstart for accepting a Sumvin Stamped Mandate at an x402-backed checkout.
- [Verify an enhanced-tier agent payment](https://docs.sumvin.com/merchant/quickstarts/verify-enhanced-pint.md): Quickstart for verifying an enhanced-tier Stamped Mandate, including the EIP-712 signature.
- [Verify a standard-tier Stamped Mandate](https://docs.sumvin.com/merchant/quickstarts/verify-standard-pint.md): Verify a Sumvin Stamped Mandate JWT end-to-end and print a decoded payload in five minutes.
- [Revocation Checking](https://docs.sumvin.com/merchant/revocation.md): How to check if a Stamped Mandate (and its JWTs) has been revoked
- [Verification Tiers](https://docs.sumvin.com/merchant/verification-tiers.md): Standard and Enhanced Sigil verification tiers for Sumvin identity credentials
- [Verifying a JWT](https://docs.sumvin.com/merchant/verify-jwt.md): Step-by-step guide to verifying SIS-issued JWTs
- [Verifying PINT Signatures](https://docs.sumvin.com/merchant/verify-pint-signature.md): Enhanced-tier verification of the original EIP-712 PINT signature
- [Building with Envoy](https://docs.sumvin.com/overview/personas/agent-flows.md): Routing page for partners building Envoy — the money agent that transacts on a user's behalf.
- [I'm an app developer](https://docs.sumvin.com/overview/personas/app-developer.md): Routing page for partners building on the Sumvin Platform API.
- [I'm a merchant or verifier](https://docs.sumvin.com/overview/personas/merchant-verifier.md): Routing page for merchants and service providers accepting Sumvin credentials.
- [Platform map](https://docs.sumvin.com/overview/platform-map.md): The four Sumvin products and the surfaces you reach them through.
- [Quickstart index](https://docs.sumvin.com/overview/quickstart-index.md): Every Sumvin quickstart in one place, grouped by persona.
- [Agentic commerce](https://docs.sumvin.com/overview/use-cases/agentic-commerce.md): Reference application for AI agents shopping and transacting on a user's behalf, built on Errands.
- [Crypto wallet card](https://docs.sumvin.com/overview/use-cases/crypto-wallet-card.md): Reference application for partners building a consumer crypto wallet card experience.
- [Identity-anchored login](https://docs.sumvin.com/overview/use-cases/identity-anchored-login.md): Reference application for apps that sign users in against their Sumvin Sigil — Proof of Personhood.
- [Verified checkout](https://docs.sumvin.com/overview/use-cases/verified-checkout.md): Reference application for merchants accepting Sumvin-verified purchase intents at checkout.
- [What is Sumvin?](https://docs.sumvin.com/overview/what-is-sumvin.md): A one-sentence positioning statement for Sumvin and the jobs it does for partners.
- [IPA lifecycle](https://docs.sumvin.com/products/agentic-commerce/ipa-lifecycle.md): State machine, transitions, and terminal states for an Intelligent Purchase Authorisation.
- [Agentic commerce overview](https://docs.sumvin.com/products/agentic-commerce/overview.md): How Abstract Commerce and Errands combine into Sumvin's agentic commerce surface.
- [Unified Shopping API](https://docs.sumvin.com/products/agentic-commerce/unified-shopping-api.md): The partner-facing shopping surface backed by Abstract Commerce.
- [Baanx issuance flow](https://docs.sumvin.com/products/card-issuing/baanx-issuance.md): End-to-end debit card issuance via Baanx.
- [Card management API](https://docs.sumvin.com/products/card-issuing/card-management-api.md): Lifecycle endpoints for an issued card: list, get, freeze, unfreeze, lost, stolen, activate — backed by an explicit state machine.
- [Funding wallets](https://docs.sumvin.com/products/card-issuing/funding-wallets.md): How a Safe smart account on the card's chain backs card spend, and how partners read its balance and configuration.
- [Card issuing overview](https://docs.sumvin.com/products/card-issuing/overview.md): Sumvin's card issuing surface: the partner-facing Card Management API, funding wallets, and the Baanx issuance rail.
- [Meld bank linking](https://docs.sumvin.com/products/meld/bank-linking.md): Link a user's bank account through the Meld widget — institution discovery, link initiation, account population, and processor token issuance.
- [Buy and sell](https://docs.sumvin.com/products/meld/buy-sell.md): Move a user between fiat and crypto with a hosted ramp session.
- [KYC passthrough](https://docs.sumvin.com/products/meld/kyc-passthrough.md): How a Sumvin user keeps their verified KYC state when they enter a Meld widget.
- [Off-ramp](https://docs.sumvin.com/products/meld/off-ramp.md): Settle a user's crypto to a linked fiat account via a hosted Meld session.
- [Meld overview](https://docs.sumvin.com/products/meld/overview.md): What the Meld integration covers, which slices ship today, and where to start.
- [Reference](https://docs.sumvin.com/products/meld/reference.md): Status codes, error codes, and provider routing notes for the Meld-backed endpoints.
- [Supported values](https://docs.sumvin.com/products/meld/supported-values.md): Assets, chains, countries, and payment methods accepted by the Meld-backed ramp endpoints.
- [Global x402 Acceptance](https://docs.sumvin.com/products/payment-links/global-x402-acceptance.md): A persistent, identity-keyed x402 acceptance endpoint for every Sumvin user.
- [Payment request links](https://docs.sumvin.com/products/payment-links/payment-request-links.md): User-originated, identity-anchored payment requests that any x402-capable wallet or agent can settle.
- [Quickstart](https://docs.sumvin.com/quickstart.md): Create a Sumvin user and query their first wallet balance in under five minutes.
- [Trust & Security](https://docs.sumvin.com/trust/overview.md): Where Sumvin stores and processes data, who we work with, and how we protect everything in between.
- [Subprocessors](https://docs.sumvin.com/trust/subprocessors.md): The vendors Sumvin uses to operate the platform, what each one does, and where they process data.

## OpenAPI Specs

- [sis-openapi](https://docs.sumvin.com/api-reference/sis-openapi.json)
- [openapi](https://docs.sumvin.com/api-reference/openapi.json)