{"items":[{"type":"link","fsPath":"index.page.tsx","metadata":{},"label":"Home","link":"/","routeSlug":"/","icon":"home"},{"type":"link","fsPath":"products/customer-api/index.md","metadata":{"type":"markdown"},"label":"Index","link":"/products/customer-api","routeSlug":"/products/customer-api","icon":"file-circle-info"},{"type":"group","label":"Use Cases","items":[{"type":"link","fsPath":"products/customer-api/use-cases/manage-users.md","metadata":{"type":"markdown"},"label":"Manage Users and Access","link":"/products/customer-api/use-cases/manage-users","routeSlug":"/products/customer-api/use-cases/manage-users"},{"type":"link","fsPath":"products/customer-api/use-cases/manage-pockets-and-balances.md","metadata":{"type":"markdown"},"label":"Manage Pockets and Balances","link":"/products/customer-api/use-cases/manage-pockets-and-balances","routeSlug":"/products/customer-api/use-cases/manage-pockets-and-balances"},{"type":"link","fsPath":"products/customer-api/use-cases/same-entity-transfers.md","metadata":{"type":"markdown"},"label":"Same Entity Transfers","link":"/products/customer-api/use-cases/same-entity-transfers","routeSlug":"/products/customer-api/use-cases/same-entity-transfers"},{"type":"separator","separatorLine":true},{"type":"separator","label":"Pay Third-Parties","icon":"credit-card"},{"type":"link","fsPath":"products/customer-api/use-cases/jikonet-transfers.md","metadata":{"type":"markdown"},"label":"Jikonet Transfers","link":"/products/customer-api/use-cases/jikonet-transfers","routeSlug":"/products/customer-api/use-cases/jikonet-transfers"},{"type":"link","fsPath":"products/customer-api/use-cases/wires.md","metadata":{"type":"markdown"},"label":"Wires and Swift","link":"/products/customer-api/use-cases/wires","routeSlug":"/products/customer-api/use-cases/wires"},{"type":"link","fsPath":"products/customer-api/use-cases/ach.md","metadata":{"type":"markdown"},"label":"ACH","link":"/products/customer-api/use-cases/ach","routeSlug":"/products/customer-api/use-cases/ach"},{"type":"separator","separatorLine":true},{"type":"link","fsPath":"products/customer-api/use-cases/export-trades.md","metadata":{"type":"markdown"},"label":"Export Trades","link":"/products/customer-api/use-cases/export-trades","routeSlug":"/products/customer-api/use-cases/export-trades"},{"type":"link","fsPath":"products/customer-api/use-cases/export-reporting.md","metadata":{"type":"markdown"},"label":"Export Reporting","link":"/products/customer-api/use-cases/export-reporting","routeSlug":"/products/customer-api/use-cases/export-reporting"},{"type":"link","fsPath":"products/customer-api/use-cases/webhooks.md","metadata":{"type":"markdown"},"label":"Webhooks","link":"/products/customer-api/use-cases/webhooks","routeSlug":"/products/customer-api/use-cases/webhooks"}],"icon":"books"},{"type":"group","label":"Guides","items":[{"type":"separator","label":"Authentication","icon":"key-skeleton-left-right"},{"type":"link","fsPath":"products/customer-api/guides/oauth/getting-started.md","metadata":{"type":"markdown"},"label":"Getting Started","link":"/products/customer-api/guides/oauth/getting-started","routeSlug":"/products/customer-api/guides/oauth/getting-started"},{"type":"link","fsPath":"products/customer-api/guides/oauth/login-flow.md","metadata":{"type":"markdown"},"label":"Login Flow","link":"/products/customer-api/guides/oauth/login-flow","routeSlug":"/products/customer-api/guides/oauth/login-flow"},{"type":"link","fsPath":"products/customer-api/guides/oauth/authorization-code-flow.md","metadata":{"type":"markdown"},"label":"Authorization Code Flow","link":"/products/customer-api/guides/oauth/authorization-code-flow","routeSlug":"/products/customer-api/guides/oauth/authorization-code-flow"},{"type":"link","fsPath":"products/customer-api/guides/oauth/client-credentials.md","metadata":{"type":"markdown"},"label":"Client Credentials","link":"/products/customer-api/guides/oauth/client-credentials","routeSlug":"/products/customer-api/guides/oauth/client-credentials"},{"type":"link","fsPath":"products/customer-api/guides/oauth/private-key-jwt.md","metadata":{"type":"markdown"},"label":"Private Key JWT","link":"/products/customer-api/guides/oauth/private-key-jwt","routeSlug":"/products/customer-api/guides/oauth/private-key-jwt"},{"type":"link","fsPath":"products/customer-api/guides/oauth/refresh-tokens.md","metadata":{"type":"markdown"},"label":"Refresh Tokens","link":"/products/customer-api/guides/oauth/refresh-tokens","routeSlug":"/products/customer-api/guides/oauth/refresh-tokens"},{"type":"link","fsPath":"products/customer-api/guides/oauth/dpop.md","metadata":{"type":"markdown"},"label":"DPoP","link":"/products/customer-api/guides/oauth/dpop","routeSlug":"/products/customer-api/guides/oauth/dpop"},{"type":"link","fsPath":"products/customer-api/guides/oauth/pkce.md","metadata":{"type":"markdown"},"label":"PKCE","link":"/products/customer-api/guides/oauth/pkce","routeSlug":"/products/customer-api/guides/oauth/pkce"},{"type":"link","fsPath":"products/customer-api/guides/oauth/scopes.md","metadata":{"type":"markdown"},"label":"Scopes","link":"/products/customer-api/guides/oauth/scopes","routeSlug":"/products/customer-api/guides/oauth/scopes"},{"type":"separator","label":"Message Signing","icon":"key"},{"type":"link","fsPath":"products/customer-api/guides/message-signing/request-signing.md","metadata":{"type":"markdown"},"label":"Request Signing","link":"/products/customer-api/guides/message-signing/request-signing","routeSlug":"/products/customer-api/guides/message-signing/request-signing"},{"type":"separator","label":"Sandbox Access","icon":"seedling"},{"type":"link","fsPath":"products/customer-api/sandbox-access.md","metadata":{"type":"markdown"},"label":"Sandbox Access","link":"/products/customer-api/sandbox-access","routeSlug":"/products/customer-api/sandbox-access"},{"type":"separator","label":"Glossary","icon":"book-open-lines"},{"type":"link","fsPath":"products/customer-api/guides/introduction.md","metadata":{"type":"markdown"},"label":"Introduction","link":"/products/customer-api/guides/introduction","routeSlug":"/products/customer-api/guides/introduction"},{"type":"link","fsPath":"products/customer-api/guides/rate-limits.md","metadata":{"type":"markdown"},"label":"Rate limits","link":"/products/customer-api/guides/rate-limits","routeSlug":"/products/customer-api/guides/rate-limits"}],"icon":"book"},{"type":"group","label":"API Reference","items":[{"type":"link","label":"Jiko Customer API","link":"/products/customer-api/reference","routeSlug":"/products/customer-api/reference"},{"type":"link","label":"Introduction","link":"/products/customer-api/reference/section/introduction","routeSlug":"/products/customer-api/reference/section/introduction"},{"type":"separator","label":"Pockets"},{"type":"group","label":"Pockets","link":"/products/customer-api/reference/pockets","routeSlug":"/products/customer-api/reference/pockets","items":[{"label":"List Customer Pockets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/pockets/list_customer_pockets_api_v2_pockets__get","routeSlug":"/products/customer-api/reference/pockets/list_customer_pockets_api_v2_pockets__get","metadata":{"seo":{"title":"List Customer Pockets","description":"This endpoint lists all the pockets for a given customer. It returns a Pockets object which is a paginated list of Pocket objects."}},"httpPath":"/api/v2/pockets/"},{"label":"Create Customer Pocket","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/pockets/create_customer_pocket_api_v2_pockets__post","routeSlug":"/products/customer-api/reference/pockets/create_customer_pocket_api_v2_pockets__post","metadata":{"seo":{"title":"Create Customer Pocket","description":"This endpoint creates a new pocket for a customer."}},"httpPath":"/api/v2/pockets/"},{"label":"Get Customer Pocket","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/pockets/get_customer_pocket_api_v2_pockets__pocket_id___get","routeSlug":"/products/customer-api/reference/pockets/get_customer_pocket_api_v2_pockets__pocket_id___get","metadata":{"seo":{"title":"Get Customer Pocket","description":"This endpoint retrieves the details of a specific pocket, and returns a Pocket object with detailed portfolio information."}},"httpPath":"/api/v2/pockets/{pocket_id}/"},{"label":"Update Pocket","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/pockets/update_pocket_api_v2_pockets__pocket_id___patch","routeSlug":"/products/customer-api/reference/pockets/update_pocket_api_v2_pockets__pocket_id___patch","metadata":{"seo":{"title":"Update Pocket","description":"This endpoint updates a pocket's information, such as its name or status (e.g., closing a pocket).If the intent is to close a pocket, then there are two requirements: The pocket needs to be empty,and there has to be at least one other open pocket belonging to the customer. Additionally,when you close a pocket, you also need to pass a closure_reason along with the status update."}},"httpPath":"/api/v2/pockets/{pocket_id}/"},{"label":"Get Customer Earnings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/pockets/get-customer-earnings-v2","routeSlug":"/products/customer-api/reference/pockets/get-customer-earnings-v2","metadata":{"seo":{"title":"Get Customer Earnings","description":"This endpoint returns current-period earnings for the customer's pockets in a single call: one entry per pocket plus their exact aggregate."}},"httpPath":"/api/v2/earnings/"},{"label":"Get Single Pocket Earnings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/pockets/get_single_pocket_earnings_api_v2_pockets__pocket_id__earnings__get","routeSlug":"/products/customer-api/reference/pockets/get_single_pocket_earnings_api_v2_pockets__pocket_id__earnings__get","metadata":{"seo":{"title":"Get Single Pocket Earnings","description":"This endpoint returns pocket earnings for a single pocket for a specified datetime period."}},"httpPath":"/api/v2/pockets/{pocket_id}/earnings/"}]},{"type":"group","label":"Portals","link":"/products/customer-api/reference/portals","routeSlug":"/products/customer-api/reference/portals","items":[{"label":"List Pocket Portals","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/portals/list-pocket-portals-v2","routeSlug":"/products/customer-api/reference/portals/list-pocket-portals-v2","metadata":{"seo":{"title":"List Pocket Portals","description":"This endpoint lists the payment portals associated with a specific Jiko pocket ID."}},"httpPath":"/api/v2/pockets/{pocket_id}/portals/"},{"label":"Create Pocket Portal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/portals/create-pocket-portal","routeSlug":"/products/customer-api/reference/portals/create-pocket-portal","metadata":{"seo":{"title":"Create Pocket Portal","description":"This endpoint creates a new portal for a customer."}},"httpPath":"/api/v2/pockets/{pocket_id}/portals/"},{"label":"List Customer Portals","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/portals/list-customer-portals-v2","routeSlug":"/products/customer-api/reference/portals/list-customer-portals-v2","metadata":{"seo":{"title":"List Customer Portals","description":"This endpoint lists all portals for the customer. It returns a PortalListResponse object containing a list of Portal objects."}},"httpPath":"/api/v2/portals/"},{"label":"Get Funding Instructions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/portals/get-funding-instructions","routeSlug":"/products/customer-api/reference/portals/get-funding-instructions","metadata":{"seo":{"title":"Get Funding Instructions","description":"Get Funding Instructions"}},"httpPath":"/api/v2/pockets/{pocket_id}/portals/{portal_id}/funding-instructions/"},{"label":"Update Pocket Portal","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/portals/update-pocket-portal","routeSlug":"/products/customer-api/reference/portals/update-pocket-portal","metadata":{"seo":{"title":"Update Pocket Portal","description":"This endpoint updates a portal's name, or closes it by setting its status to CLOSED."}},"httpPath":"/api/v2/pockets/{pocket_id}/portals/{portal_id}/"}]},{"type":"separator","label":"Transactions"},{"type":"group","label":"Transactions","link":"/products/customer-api/reference/transactions","routeSlug":"/products/customer-api/reference/transactions","items":[{"label":"List Transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/transactions/list-transactions-v2","routeSlug":"/products/customer-api/reference/transactions/list-transactions-v2","metadata":{"seo":{"title":"List Transactions","description":"This endpoint lists all transactions for a customer's pockets. It provides a comprehensive view of all financial activities."}},"httpPath":"/api/v2/transactions/"},{"label":"Transactions As CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/transactions/transactions_as_csv_api_v2_transactions_csv_get","routeSlug":"/products/customer-api/reference/transactions/transactions_as_csv_api_v2_transactions_csv_get","metadata":{"seo":{"title":"Transactions As CSV","description":"This endpoint downloads a customer's transaction history in CSV format. This is useful for accounting and reconciliation purposes, and can be filtered by pocket, transaction type, and a time range."}},"httpPath":"/api/v2/transactions.csv"}]},{"type":"separator","label":"Trades"},{"type":"group","label":"Trading Strategies","link":"/products/customer-api/reference/trading-strategies","routeSlug":"/products/customer-api/reference/trading-strategies","items":[{"label":"List Trading Strategies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/trading-strategies/list_trading_strategies_api_v2_trading_strategies__get","routeSlug":"/products/customer-api/reference/trading-strategies/list_trading_strategies_api_v2_trading_strategies__get","metadata":{"seo":{"title":"List Trading Strategies","description":"This endpoint lists the available trading strategies that can be applied to a pocket. This is the modern replacement for \"pocket configurations.\""}},"httpPath":"/api/v2/trading-strategies/"}]},{"type":"group","label":"Trades","link":"/products/customer-api/reference/trades","routeSlug":"/products/customer-api/reference/trades","items":[{"label":"List Trades","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/trades/list_trades_api_v1_trades__get","routeSlug":"/products/customer-api/reference/trades/list_trades_api_v1_trades__get","metadata":{"seo":{"title":"List Trades","description":"This endpoint lists all buy, sell, and maturity events for securities (T-bills) within the customer's accounts."}},"httpPath":"/api/v1/trades/"},{"label":"Trades As CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/trades/trades_as_csv_api_v1_trades_csv_get","routeSlug":"/products/customer-api/reference/trades/trades_as_csv_api_v1_trades_csv_get","metadata":{"seo":{"title":"Trades As CSV","description":"This endpoint downloads the customer's complete trade history as a CSV file."}},"httpPath":"/api/v1/trades.csv"},{"label":"Download Trade Confirmation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/trades/download_trade_confirmation_api_v1_accounts__account_id__trades__trade_id__confirmation__get","routeSlug":"/products/customer-api/reference/trades/download_trade_confirmation_api_v1_accounts__account_id__trades__trade_id__confirmation__get","metadata":{"seo":{"title":"Download Trade Confirmation","description":"This endpoint downloads the confirmation for a specific trade, and returns a 307 Temporary Redirect to the trade confirmation PDF location."}},"httpPath":"/api/v1/accounts/{account_id}/trades/{trade_id}/confirmation/"},{"label":"List Trades","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/trades/list_trades_api_v2_trades__get","routeSlug":"/products/customer-api/reference/trades/list_trades_api_v2_trades__get","metadata":{"seo":{"title":"List Trades","description":"Returns a list of trades including standard trades (BUY, SELL, MATURITY), external security transfer trades, and same-entity security transfer trades. Optionally filter by pocket."}},"httpPath":"/api/v2/trades/"}]},{"type":"separator","label":"Transfers"},{"type":"group","label":"Counterparties","link":"/products/customer-api/reference/counterparties","routeSlug":"/products/customer-api/reference/counterparties","items":[{"label":"Get Counterparties","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/counterparties/list-counterparties-v2","routeSlug":"/products/customer-api/reference/counterparties/list-counterparties-v2","metadata":{"seo":{"title":"Get Counterparties","description":"This endpoint allows you to list all the counterparties associated with a customer's pocket. You can filter the results bycounterparty type (ach, wire, international_wire, on_us, etc.) and status (PENDING, LINKED, UNLINKED, etc.)."}},"httpPath":"/api/v2/counterparties/"},{"label":"Create Counterparty","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/counterparties/create-counterparty-v2","routeSlug":"/products/customer-api/reference/counterparties/create-counterparty-v2","metadata":{"seo":{"title":"Create Counterparty","description":"This endpoint is used to create a new counterparty for a customer. You can create different types of counterparties,including ach, on-us, wire, and international_wire, by providing the relevant details in the request body."}},"httpPath":"/api/v2/counterparties/"},{"label":"Get Counterparty","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/counterparties/get-counterparty-v2","routeSlug":"/products/customer-api/reference/counterparties/get-counterparty-v2","metadata":{"seo":{"title":"Get Counterparty","description":"This endpoint retrieves the details of a specific counterparty by its unique ID. It returns a single counterparty object corresponding to the provided counterparty_id."}},"httpPath":"/api/v2/counterparties/{counterparty_id}/"},{"label":"Update Counterparty","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/counterparties/update-counterparty-v2","routeSlug":"/products/customer-api/reference/counterparties/update-counterparty-v2","metadata":{"seo":{"title":"Update Counterparty","description":"This endpoint is used to update a counterparty. For example, you can use it to unlink a counterparty that is no longer needed, or to set or change its display_name."}},"httpPath":"/api/v2/counterparties/{counterparty_id}/"}]},{"type":"group","label":"Transfer Requests","link":"/products/customer-api/reference/transfer-requests","routeSlug":"/products/customer-api/reference/transfer-requests","items":[{"label":"Create Transfer Request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/transfer-requests/create_transfer_request_api_v1_transfer_requests__post","routeSlug":"/products/customer-api/reference/transfer-requests/create_transfer_request_api_v1_transfer_requests__post","metadata":{"seo":{"title":"Create Transfer Request","description":"This endpoint creates a new transfer request. This is the first step in a dual-control workflow for making transfers."}},"httpPath":"/api/v1/transfer-requests/"},{"label":"Get Transfer Requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/transfer-requests/get_transfer_requests_api_v1_transfer_requests__get","routeSlug":"/products/customer-api/reference/transfer-requests/get_transfer_requests_api_v1_transfer_requests__get","metadata":{"seo":{"title":"Get Transfer Requests","description":"This endpoint retrieves a list of transfer requests."}},"httpPath":"/api/v1/transfer-requests/"},{"label":"Get Transfer Request Reviewers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/transfer-requests/get_transfer_request_reviewers_api_v1_transfer_requests_reviewers__get","routeSlug":"/products/customer-api/reference/transfer-requests/get_transfer_request_reviewers_api_v1_transfer_requests_reviewers__get","metadata":{"seo":{"title":"Get Transfer Request Reviewers","description":"This endpoint retrieves a list of team members who are authorized to review transfer requests, and returns a list of DualAuthUser objects."}},"httpPath":"/api/v1/transfer-requests/reviewers/"},{"label":"Get Transfer Request","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/transfer-requests/get_transfer_request_api_v1_transfer_requests__transfer_id___get","routeSlug":"/products/customer-api/reference/transfer-requests/get_transfer_request_api_v1_transfer_requests__transfer_id___get","metadata":{"seo":{"title":"Get Transfer Request","description":"This endpoint retrieves the details of a specific transfer request, and returns a single TransferRequest object."}},"httpPath":"/api/v1/transfer-requests/{transfer_id}/"},{"label":"Cancel Transfer Request","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/transfer-requests/cancel_transfer_request_api_v1_transfer_requests__transfer_id___delete","routeSlug":"/products/customer-api/reference/transfer-requests/cancel_transfer_request_api_v1_transfer_requests__transfer_id___delete","metadata":{"seo":{"title":"Cancel Transfer Request","description":"This endpoint cancels a pending transfer request, and returns a 204 No Content response upon a successful cancellation."}},"httpPath":"/api/v1/transfer-requests/{transfer_id}/"},{"label":"Update Transfer Request Status","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/transfer-requests/update_transfer_request_status_api_v1_transfer_requests__transfer_id__status__patch","routeSlug":"/products/customer-api/reference/transfer-requests/update_transfer_request_status_api_v1_transfer_requests__transfer_id__status__patch","metadata":{"seo":{"title":"Update Transfer Request Status","description":"This endpoint is used to approve or deny a transfer request as part of a dual-control workflow."}},"httpPath":"/api/v1/transfer-requests/{transfer_id}/status/"}]},{"type":"group","label":"Wires","link":"/products/customer-api/reference/wires","routeSlug":"/products/customer-api/reference/wires","items":[{"label":"List Wires","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/wires/list-wires-v1","routeSlug":"/products/customer-api/reference/wires/list-wires-v1","metadata":{"seo":{"title":"List Wires","description":"List Wires"}},"httpPath":"/api/v1/wires/"},{"label":"Get Wire","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/wires/get-wire-v1","routeSlug":"/products/customer-api/reference/wires/get-wire-v1","metadata":{"seo":{"title":"Get Wire","description":"Get Wire"}},"httpPath":"/api/v1/wires/{wire_id}/"}]},{"type":"separator","label":"Webhooks & Event Notifications"},{"type":"group","label":"Subscriptions","link":"/products/customer-api/reference/subscriptions","routeSlug":"/products/customer-api/reference/subscriptions","items":[{"label":"Create Subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/subscriptions/create_subscription_api_v1_subscriptions__post","routeSlug":"/products/customer-api/reference/subscriptions/create_subscription_api_v1_subscriptions__post","metadata":{"seo":{"title":"Create Subscription","description":"This endpoint creates a new webhook subscription to receive real-time notifications for specified events."}},"httpPath":"/api/v1/subscriptions/"},{"label":"Get Subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/subscriptions/get_subscriptions_api_v1_subscriptions__get","routeSlug":"/products/customer-api/reference/subscriptions/get_subscriptions_api_v1_subscriptions__get","metadata":{"seo":{"title":"Get Subscriptions","description":"This endpoint lists all of your current webhook subscriptions, and returns a paginated list of Subscription objects."}},"httpPath":"/api/v1/subscriptions/"},{"label":"Update Subscription","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/subscriptions/update_subscription_api_v1_subscriptions__subscription_id___patch","routeSlug":"/products/customer-api/reference/subscriptions/update_subscription_api_v1_subscriptions__subscription_id___patch","metadata":{"seo":{"title":"Update Subscription","description":"This endpoint updates an existing webhook subscription. You can change the url, the subscribed events, or the status (enabled/disabled)."}},"httpPath":"/api/v1/subscriptions/{subscription_id}/"},{"label":"Get Subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/subscriptions/get_subscription_api_v1_subscriptions__subscription_id___get","routeSlug":"/products/customer-api/reference/subscriptions/get_subscription_api_v1_subscriptions__subscription_id___get","metadata":{"seo":{"title":"Get Subscription","description":"This endpoint retrieves the details of a specific webhook subscription, and returns a single Subscription object."}},"httpPath":"/api/v1/subscriptions/{subscription_id}/"},{"label":"Delete Subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/subscriptions/delete_subscription_api_v1_subscriptions__subscription_id___delete","routeSlug":"/products/customer-api/reference/subscriptions/delete_subscription_api_v1_subscriptions__subscription_id___delete","metadata":{"seo":{"title":"Delete Subscription","description":"This endpoint deletes a webhook subscription, and returns a 202 Accepted response upon successful deletion."}},"httpPath":"/api/v1/subscriptions/{subscription_id}/"}]},{"type":"group","label":"Events","link":"/products/customer-api/reference/events","routeSlug":"/products/customer-api/reference/events","items":[{"label":"Get Events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/events/get_events_api_v1_events__get","routeSlug":"/products/customer-api/reference/events/get_events_api_v1_events__get","metadata":{"seo":{"title":"Get Events","description":"This endpoint retrieves a list of events that have occurred for a customer's account, often related to webhook notifications. You can filter events by subscription_id and/or a time range query parameter (after)."}},"httpPath":"/api/v1/events/"}]},{"type":"group","label":"Notifications","link":"/products/customer-api/reference/notifications","routeSlug":"/products/customer-api/reference/notifications","items":[{"label":"List Notifications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/notifications/list_notifications_api_v1_notifications__get","routeSlug":"/products/customer-api/reference/notifications/list_notifications_api_v1_notifications__get","metadata":{"seo":{"title":"List Notifications","description":"This endpoint lists all notifications for a customer. You can filter by status (READ or UNREAD)."}},"httpPath":"/api/v1/notifications/"},{"label":"Get Notification","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/notifications/get_notification_api_v1_notifications__notification_id___get","routeSlug":"/products/customer-api/reference/notifications/get_notification_api_v1_notifications__notification_id___get","metadata":{"seo":{"title":"Get Notification","description":"This endpoint retrieves a single notification by its notification_id, and returns a CustomerNotification object."}},"httpPath":"/api/v1/notifications/{notification_id}/"},{"label":"Patch Notification","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/notifications/patch_notification_api_v1_notifications__notification_id___patch","routeSlug":"/products/customer-api/reference/notifications/patch_notification_api_v1_notifications__notification_id___patch","metadata":{"seo":{"title":"Patch Notification","description":"This endpoint allows you to update the status of a notification, for example, to mark it as read."}},"httpPath":"/api/v1/notifications/{notification_id}/"}]},{"type":"separator","label":"Statements & Reports"},{"type":"group","label":"Statements","link":"/products/customer-api/reference/statements","routeSlug":"/products/customer-api/reference/statements","items":[{"label":"List Customer Statements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/statements/list_customer_statements_api_v1_statements__get","routeSlug":"/products/customer-api/reference/statements/list_customer_statements_api_v1_statements__get","metadata":{"seo":{"title":"List Customer Statements","description":"This endpoint retrieves a list of all available account statements (e.g., BANK, BROKERAGE) and tax documents (1099-INT, 1099-B)."}},"httpPath":"/api/v1/statements/"}]},{"type":"group","label":"Reports","link":"/products/customer-api/reference/reports","routeSlug":"/products/customer-api/reference/reports","items":[{"label":"Create Customer Report Request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/reports/create_customer_report_request_api_v1_report_requests__post","routeSlug":"/products/customer-api/reference/reports/create_customer_report_request_api_v1_report_requests__post","metadata":{"seo":{"title":"Create Customer Report Request","description":"This endpoint triggers an asynchronous process to create a report request based on the provided parameters. Available report types are:"}},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"httpPath":"/api/v1/report-requests/"},{"label":"List Customer Report Requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/reports/list_customer_report_requests_api_v1_report_requests__get","routeSlug":"/products/customer-api/reference/reports/list_customer_report_requests_api_v1_report_requests__get","metadata":{"seo":{"title":"List Customer Report Requests","description":"This endpoint lists all report request for a customer. You can filter by date from and to"}},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"httpPath":"/api/v1/report-requests/"},{"label":"Get Customer Report Request","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/reports/get_customer_report_request_api_v1_report_requests__report_request_id___get","routeSlug":"/products/customer-api/reference/reports/get_customer_report_request_api_v1_report_requests__report_request_id___get","metadata":{"seo":{"title":"Get Customer Report Request","description":"This endpoint retrieves the details of a specific report request, and returns a single ReportRequest object."}},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"httpPath":"/api/v1/report-requests/{report_request_id}/"},{"label":"Get Customer Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/reports/get_customer_report_api_v1_reports__report_id___get","routeSlug":"/products/customer-api/reference/reports/get_customer_report_api_v1_reports__report_id___get","metadata":{"seo":{"title":"Get Customer Report","description":"This endpoint retrieves the details of a specific report, and returns a single Report object."}},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"httpPath":"/api/v1/reports/{report_id}/"},{"label":"Download Customer Report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/reports/download_customer_report_api_v1_reports__report_id__download__post","routeSlug":"/products/customer-api/reference/reports/download_customer_report_api_v1_reports__report_id__download__post","metadata":{"seo":{"title":"Download Customer Report","description":"This endpoint creates a temporary, time-limited URL for downloading the report corresponding to the given id, and returns a single ReportDownload object."}},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"httpPath":"/api/v1/reports/{report_id}/download/"}]},{"type":"separator","label":"Users & Team Members"},{"type":"group","label":"User","link":"/products/customer-api/reference/user","routeSlug":"/products/customer-api/reference/user","items":[{"label":"Get User Info","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/user/get_user_info_api_v1_user__get","routeSlug":"/products/customer-api/reference/user/get_user_info_api_v1_user__get","metadata":{"seo":{"title":"Get User Info","description":"This endpoint retrieves information about the currently authenticated user."}},"httpPath":"/api/v1/user/"},{"label":"Get Memberships","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/user/get-user-memberships","routeSlug":"/products/customer-api/reference/user/get-user-memberships","metadata":{"seo":{"title":"Get Memberships","description":"This endpoint retrieves all team memberships for the currently authenticated user."}},"httpPath":"/api/v1/user/memberships/"}]},{"type":"group","label":"Team","link":"/products/customer-api/reference/team","routeSlug":"/products/customer-api/reference/team","items":[{"label":"Get Team","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/team/get_team_api_v1_team__get","routeSlug":"/products/customer-api/reference/team/get_team_api_v1_team__get","metadata":{"seo":{"title":"Get Team","description":"This endpoint retrieves information about the team, including a list of all team members."}},"httpPath":"/api/v1/team/"},{"label":"Get Team Member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/team/get_team_member_api_v1_team__member_id___get","routeSlug":"/products/customer-api/reference/team/get_team_member_api_v1_team__member_id___get","metadata":{"seo":{"title":"Get Team Member","description":"This endpoint retrieves the details of a specific team member, and returns a TeamMemberResponse object."}},"httpPath":"/api/v1/team/{member_id}/"},{"label":"Edit Team Member","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/team/edit_team_member_api_v1_team__member_id___put","routeSlug":"/products/customer-api/reference/team/edit_team_member_api_v1_team__member_id___put","metadata":{"seo":{"title":"Edit Team Member","description":"This endpoint allows you to edit a team member's role or status."}},"httpPath":"/api/v1/team/{member_id}/"},{"label":"Deactivate Team Member","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/team/deactivate_team_member_api_v1_team__member_id___delete","routeSlug":"/products/customer-api/reference/team/deactivate_team_member_api_v1_team__member_id___delete","metadata":{"seo":{"title":"Deactivate Team Member","description":"This endpoint deactivates a team member from a team, and returns the TeamMemberResponse object for the deactivated member."}},"httpPath":"/api/v1/team/{member_id}/"},{"label":"Invite Team Member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/team/invite_team_member_api_v1_team_invite__post","routeSlug":"/products/customer-api/reference/team/invite_team_member_api_v1_team_invite__post","metadata":{"seo":{"title":"Invite Team Member","description":"This endpoint invites a new member to a team."}},"httpPath":"/api/v1/team/invite/"},{"label":"Resend Invite Team Member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/team/resend_invite_team_member_api_v1_team__member_id__invite__post","routeSlug":"/products/customer-api/reference/team/resend_invite_team_member_api_v1_team__member_id__invite__post","metadata":{"seo":{"title":"Resend Invite Team Member","description":"This endpoint resends an invitation to a team member, and returns a 200 OK response upon a successful request."}},"httpPath":"/api/v1/team/{member_id}/invite/"},{"label":"Cancel Invite Team Member","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/team/cancel_invite_team_member_api_v1_team__member_id__invite__delete","routeSlug":"/products/customer-api/reference/team/cancel_invite_team_member_api_v1_team__member_id__invite__delete","metadata":{"seo":{"title":"Cancel Invite Team Member","description":"This endpoint cancels an invitation that has been sent to a team member, and returns a 200 OK response upon a successful request."}},"httpPath":"/api/v1/team/{member_id}/invite/"},{"label":"Create Service User","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/team/create_service_user_api_v1_team_service_users__post","routeSlug":"/products/customer-api/reference/team/create_service_user_api_v1_team_service_users__post","metadata":{"seo":{"title":"Create Service User","description":"Create Service User"}},"httpPath":"/api/v1/team/service-users/"}]},{"type":"group","label":"Team Audits","link":"/products/customer-api/reference/team-audits","routeSlug":"/products/customer-api/reference/team-audits","items":[{"label":"Get Team Audit Logs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/team-audits/get_team_audit_logs_api_v1_team_audit_logs__get","routeSlug":"/products/customer-api/reference/team-audits/get_team_audit_logs_api_v1_team_audit_logs__get","metadata":{"seo":{"title":"Get Team Audit Logs","description":"This endpoint retrieves audit logs for the entire team. This is useful for tracking actions performed by team members."}},"httpPath":"/api/v1/team/audit-logs/"},{"label":"Get Team Member Audit Logs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/team-audits/get_team_member_audit_logs_api_v1_team_members__member_id__audit_logs__get","routeSlug":"/products/customer-api/reference/team-audits/get_team_member_audit_logs_api_v1_team_members__member_id__audit_logs__get","metadata":{"seo":{"title":"Get Team Member Audit Logs","description":"This endpoint retrieves audit logs for a specific team member, and returns a paginated list of CustomerAuditLogEntry objects."}},"httpPath":"/api/v1/team/members/{member_id}/audit-logs/"},{"label":"Team Audits As Csv","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/team-audits/team_audits_as_csv_api_v1_team_audit_logs_csv_get","routeSlug":"/products/customer-api/reference/team-audits/team_audits_as_csv_api_v1_team_audit_logs_csv_get","metadata":{"seo":{"title":"Team Audits As Csv","description":"This endpoint downloads team audit logs in CSV format for offline analysis and record-keeping, and can be filtered by member_id and a timestamp range."}},"httpPath":"/api/v1/team/audit-logs.csv"}]},{"type":"separator","label":"Customer"},{"type":"group","label":"Customer","link":"/products/customer-api/reference/customer","routeSlug":"/products/customer-api/reference/customer","items":[{"label":"Get Customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/customer/get_customer_api_v1_customer__get","routeSlug":"/products/customer-api/reference/customer/get_customer_api_v1_customer__get","metadata":{"seo":{"title":"Get Customer","description":"This endpoint retrieves the customer's profile information. This can be for an individual or a business."}},"httpPath":"/api/v1/customer/"},{"label":"Upload Document To Customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/customer/upload_document_to_customer_api_v1_documents__document_type___post","routeSlug":"/products/customer-api/reference/customer/upload_document_to_customer_api_v1_documents__document_type___post","metadata":{"seo":{"title":"Upload Document To Customer","description":"This endpoint uploads a verification document (e.g., passport, articles of incorporation) directly to the customer's profile."}},"httpPath":"/api/v1/documents/{document_type}/"},{"label":"Get Beneficial Owners","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/customer/get_beneficial_owners_api_v1_customer_beneficial_owners__get","routeSlug":"/products/customer-api/reference/customer/get_beneficial_owners_api_v1_customer_beneficial_owners__get","metadata":{"seo":{"title":"Get Beneficial Owners","description":"For business customers, this endpoint lists the beneficial owners who have been identified for the account."}},"httpPath":"/api/v1/customer/beneficial-owners/"}]},{"type":"group","label":"Agreements","link":"/products/customer-api/reference/agreements","routeSlug":"/products/customer-api/reference/agreements","items":[{"label":"List Agreements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/customer-api/reference/agreements/list_agreements_api_v1_agreements__get","routeSlug":"/products/customer-api/reference/agreements/list_agreements_api_v1_agreements__get","metadata":{"seo":{"title":"List Agreements","description":"This endpoint retrieves a list of legal agreements that a customer can acknowledge. These agreements could include terms of service, privacy policies, or other legal documents."}},"httpPath":"/api/v1/agreements/"}]}],"icon":"code"},{"type":"link","fsPath":"products/customer-api/changelog.md","metadata":{"type":"markdown"},"label":"Changelog","link":"/products/customer-api/changelog","routeSlug":"/products/customer-api/changelog","icon":"bars-sort"}]}