{"items":[{"type":"link","fsPath":"products/partner-api/index.md","metadata":{"type":"markdown"},"label":"What is the Partner API?","link":"/products/partner-api","routeSlug":"/products/partner-api","icon":"file-circle-info"},{"type":"link","fsPath":"products/partner-api/partner-obligation.md","metadata":{"type":"markdown"},"label":"Partner Obligations","link":"/products/partner-api/partner-obligation","routeSlug":"/products/partner-api/partner-obligation","icon":"circle-info"},{"type":"link","fsPath":"products/partner-api/authentication.md","metadata":{"type":"markdown"},"label":"Authentication","link":"/products/partner-api/authentication","routeSlug":"/products/partner-api/authentication","icon":"user-key"},{"type":"group","label":"Guides","items":[{"type":"separator","label":"Onboarding","icon":"file-text"},{"type":"link","fsPath":"products/partner-api/guides/onboarding/partner-onboarding.md","metadata":{"type":"markdown"},"label":"Partner Onboarding","link":"/products/partner-api/guides/onboarding/partner-onboarding","routeSlug":"/products/partner-api/guides/onboarding/partner-onboarding"},{"type":"separator","label":"Building","icon":"file-text"},{"type":"link","fsPath":"products/partner-api/guides/building/data-model.md","metadata":{"type":"markdown"},"label":"Jiko Data Model","link":"/products/partner-api/guides/building/data-model","routeSlug":"/products/partner-api/guides/building/data-model"},{"type":"link","fsPath":"products/partner-api/guides/building/auth.md","metadata":{"type":"markdown"},"label":"Auth","link":"/products/partner-api/guides/building/auth","routeSlug":"/products/partner-api/guides/building/auth"},{"type":"link","fsPath":"products/partner-api/guides/building/onboarding-individuals.md","metadata":{"type":"markdown"},"label":"Onboarding Individuals","link":"/products/partner-api/guides/building/onboarding-individuals","routeSlug":"/products/partner-api/guides/building/onboarding-individuals"},{"type":"link","fsPath":"products/partner-api/guides/building/onboarding-businesses.md","metadata":{"type":"markdown"},"label":"Onboarding Businesses","link":"/products/partner-api/guides/building/onboarding-businesses","routeSlug":"/products/partner-api/guides/building/onboarding-businesses"},{"type":"link","fsPath":"products/partner-api/guides/building/accounts.md","metadata":{"type":"markdown"},"label":"Accounts","link":"/products/partner-api/guides/building/accounts","routeSlug":"/products/partner-api/guides/building/accounts"},{"type":"link","fsPath":"products/partner-api/guides/building/pockets.md","metadata":{"type":"markdown"},"label":"Pockets","link":"/products/partner-api/guides/building/pockets","routeSlug":"/products/partner-api/guides/building/pockets"},{"type":"link","fsPath":"products/partner-api/guides/building/cards.md","metadata":{"type":"markdown"},"label":"Cards","link":"/products/partner-api/guides/building/cards","routeSlug":"/products/partner-api/guides/building/cards"},{"type":"link","fsPath":"products/partner-api/guides/building/webhooks.md","metadata":{"type":"markdown"},"label":"Webhooks","link":"/products/partner-api/guides/building/webhooks","routeSlug":"/products/partner-api/guides/building/webhooks"},{"type":"link","fsPath":"products/partner-api/guides/building/going-live.md","metadata":{"type":"markdown"},"label":"Going Live","link":"/products/partner-api/guides/building/going-live","routeSlug":"/products/partner-api/guides/building/going-live"},{"type":"separator","label":"Miscellaneous","icon":"file-text"},{"type":"link","fsPath":"products/partner-api/guides/ach-windows.md","metadata":{"type":"markdown"},"label":"Settlement Windows for ACH","link":"/products/partner-api/guides/ach-windows","routeSlug":"/products/partner-api/guides/ach-windows"}],"icon":"book-open-lines"},{"type":"group","label":"API Reference","items":[{"type":"link","label":"Jiko Partner API","link":"/products/partner-api/reference","routeSlug":"/products/partner-api/reference"},{"type":"link","label":"Introduction","link":"/products/partner-api/reference/section/introduction","routeSlug":"/products/partner-api/reference/section/introduction"},{"type":"separator","label":"Accounts"},{"type":"group","label":"Accounts","link":"/products/partner-api/reference/accounts","routeSlug":"/products/partner-api/reference/accounts","items":[{"label":"List Customer Accounts","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/accounts/list_customer_accounts_api_v1_customers__customer_id__jiko_accounts__get","routeSlug":"/products/partner-api/reference/accounts/list_customer_accounts_api_v1_customers__customer_id__jiko_accounts__get","metadata":{"seo":{"title":"List Customer Accounts","description":"Get a list of all accounts for a specified customer. Deprecated: Use List Pockets for Customer instead."}},"httpPath":"/api/v1/customers/{customer_id}/jiko-accounts/"},{"label":"Get Customer Account","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/accounts/get_customer_account_api_v1_jiko_accounts__account_id___get","routeSlug":"/products/partner-api/reference/accounts/get_customer_account_api_v1_jiko_accounts__account_id___get","metadata":{"seo":{"title":"Get Customer Account","description":"Get a specific account. Deprecated: Use Get Customer Pocket instead."}},"httpPath":"/api/v1/jiko-accounts/{account_id}/"}]},{"type":"group","label":"Customers","link":"/products/partner-api/reference/customers","routeSlug":"/products/partner-api/reference/customers","items":[{"label":"Get Customer Data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/customers/get_customer_data_api_v1_customers__customer_id___get","routeSlug":"/products/partner-api/reference/customers/get_customer_data_api_v1_customers__customer_id___get","metadata":{"seo":{"title":"Get Customer Data","description":"Retrieve customer details for the customer given by the customer ID."}},"httpPath":"/api/v1/customers/{customer_id}/"},{"label":"Update Customer Data","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/customers/update_customer_data_api_v1_customers__customer_id___patch","routeSlug":"/products/partner-api/reference/customers/update_customer_data_api_v1_customers__customer_id___patch","metadata":{"seo":{"title":"Update Customer Data","description":"Updates details for a given Customer, including contact information and Trusted Contact information. This endpoint can also be used to close customer accounts with the CloseCustomerAccount request body schema. Before closing a customer's account, all customer Pockets must have a zero balance."}},"httpPath":"/api/v1/customers/{customer_id}/"},{"label":"Get Beneficial Owners","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/customers/get_beneficial_owners_api_v1_customers__customer_id__beneficial_owners__get","routeSlug":"/products/partner-api/reference/customers/get_beneficial_owners_api_v1_customers__customer_id__beneficial_owners__get","metadata":{"seo":{"title":"Get Beneficial Owners","description":"Gets a list of beneficial owners for a given customer."}},"httpPath":"/api/v1/customers/{customer_id}/beneficial-owners/"},{"label":"Upload Document To Customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/customers/upload-customer-document","routeSlug":"/products/partner-api/reference/customers/upload-customer-document","metadata":{"seo":{"title":"Upload Document To Customer","description":"Upload files for an approved customer. Used to verify customer requests (e.g. Customer change request, close account request, ACH request). Refer to the Upload Document To Application for more detailed info."}},"httpPath":"/api/v1/customers/{customer_id}/documents/{document_type}/file/"}]},{"type":"group","label":"Transactions","link":"/products/partner-api/reference/transactions","routeSlug":"/products/partner-api/reference/transactions","items":[{"label":"List Customer Transactions","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/transactions/list_customer_transactions_api_v1_customers__customer_id__transactions__get","routeSlug":"/products/partner-api/reference/transactions/list_customer_transactions_api_v1_customers__customer_id__transactions__get","metadata":{"seo":{"title":"List Customer Transactions","description":"Returns a list of transactions from a customer's bank accounts. It does not include transactions between the bank account and brokerage account. Deprecated: Use List Customer Transactions instead."}},"httpPath":"/api/v1/customers/{customer_id}/transactions/"},{"label":"List Account Transactions","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/transactions/list_account_transactions_api_v1_jiko_accounts__account_id__transactions__get","routeSlug":"/products/partner-api/reference/transactions/list_account_transactions_api_v1_jiko_accounts__account_id__transactions__get","metadata":{"seo":{"title":"List Account Transactions","description":"Returns a list of bank account transactions. It does not include transactions between the bank account and brokerage account. Deprecated: Use List Pocket Transactions instead."}},"httpPath":"/api/v1/jiko-accounts/{account_id}/transactions/"},{"label":"Get Account Transaction","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/transactions/get_account_transaction_api_v1_jiko_accounts__account_id__transactions__transaction_id___get","routeSlug":"/products/partner-api/reference/transactions/get_account_transaction_api_v1_jiko_accounts__account_id__transactions__transaction_id___get","metadata":{"seo":{"title":"Get Account Transaction","description":"Returns a specific transaction for a specific account, based on the provided account_id and transaction_id in question. Deprecated: Use Get Transaction instead."}},"httpPath":"/api/v1/jiko-accounts/{account_id}/transactions/{transaction_id}/"}]},{"type":"group","label":"Trades","link":"/products/partner-api/reference/trades","routeSlug":"/products/partner-api/reference/trades","items":[{"label":"List Customer Trades","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/trades/list_customer_trades_api_v1_customers__customer_id__trades__get","routeSlug":"/products/partner-api/reference/trades/list_customer_trades_api_v1_customers__customer_id__trades__get","metadata":{"seo":{"title":"List Customer Trades","description":"Returns a list of trades from a customer's brokerage accounts."}},"httpPath":"/api/v1/customers/{customer_id}/trades/"},{"label":"List Account Trades","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/trades/list_account_trades_api_v1_jiko_accounts__account_id__trades__get","routeSlug":"/products/partner-api/reference/trades/list_account_trades_api_v1_jiko_accounts__account_id__trades__get","metadata":{"seo":{"title":"List Account Trades","description":"Get a list of trades. This is the equivalent of fetching transactions for the brokerage account."}},"httpPath":"/api/v1/jiko-accounts/{account_id}/trades/"},{"label":"Get Trade Confirmation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/trades/get_trade_confirmation_api_v1_jiko_accounts__account_id__trades__trade_id__confirmation__get","routeSlug":"/products/partner-api/reference/trades/get_trade_confirmation_api_v1_jiko_accounts__account_id__trades__trade_id__confirmation__get","metadata":{"seo":{"title":"Get Trade Confirmation","description":"Get a trade's trade confirmation."}},"httpPath":"/api/v1/jiko-accounts/{account_id}/trades/{trade_id}/confirmation/"}]},{"type":"group","label":"Statements","link":"/products/partner-api/reference/statements","routeSlug":"/products/partner-api/reference/statements","items":[{"label":"List Customer Statements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/statements/list_customer_statements_api_v1_customers__customer_id__statements__get","routeSlug":"/products/partner-api/reference/statements/list_customer_statements_api_v1_customers__customer_id__statements__get","metadata":{"seo":{"title":"List Customer Statements","description":"Get all statements for all accounts of a specific customer."}},"httpPath":"/api/v1/customers/{customer_id}/statements/"},{"label":"List Account Statements","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/statements/list_account_statements_api_v1_jiko_accounts__account_id__statements__get","routeSlug":"/products/partner-api/reference/statements/list_account_statements_api_v1_jiko_accounts__account_id__statements__get","metadata":{"seo":{"title":"List Account Statements","description":"Lists all statements for an account. Partners can expect monthly statements to be available by the 15th of every month."}},"httpPath":"/api/v1/jiko-accounts/{account_id}/statements/"}]},{"type":"separator","label":"Cards"},{"type":"group","label":"Manage Cards","link":"/products/partner-api/reference/manage-cards","routeSlug":"/products/partner-api/reference/manage-cards","items":[{"label":"List Account Cards","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/manage-cards/list_account_cards_api_v1_jiko_accounts__account_id__cards__get","routeSlug":"/products/partner-api/reference/manage-cards/list_account_cards_api_v1_jiko_accounts__account_id__cards__get","metadata":{"seo":{"title":"List Account Cards","description":"Get all cards for a specific account. Includes the card_id and metadata, but sensitive data like CVV's, expiration dates and card numbers are omitted."}},"httpPath":"/api/v1/jiko-accounts/{account_id}/cards/"},{"label":"List Customer Cards","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/manage-cards/list_customer_cards_api_v1_customers__customer_id__cards__get","routeSlug":"/products/partner-api/reference/manage-cards/list_customer_cards_api_v1_customers__customer_id__cards__get","metadata":{"seo":{"title":"List Customer Cards","description":"Get all cards for a specific account. Includes the card_id and metadata, but sensitive data like CVV's, expiration dates and card numbers are omitted."}},"httpPath":"/api/v1/customers/{customer_id}/cards/"},{"label":"Get Card Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/manage-cards/get_card_status_api_v1_jiko_accounts__account_id__cards__card_id__status__get","routeSlug":"/products/partner-api/reference/manage-cards/get_card_status_api_v1_jiko_accounts__account_id__cards__card_id__status__get","metadata":{"seo":{"title":"Get Card Status","description":"Get a card's current status."}},"httpPath":"/api/v1/jiko-accounts/{account_id}/cards/{card_id}/status/"},{"label":"Set Card Status","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/manage-cards/set_card_status_api_v1_jiko_accounts__account_id__cards__card_id__status__patch","routeSlug":"/products/partner-api/reference/manage-cards/set_card_status_api_v1_jiko_accounts__account_id__cards__card_id__status__patch","metadata":{"seo":{"title":"Set Card Status","description":"Set a primary card's status. Note that once a card's primary status is set to CLOSED, it can never be used again. Optionally include a magstripe status to enable or disable swipes. Magstripe updates affect only PHYSICAL cards and require the primary status to be set as OPENto take effect."}},"httpPath":"/api/v1/jiko-accounts/{account_id}/cards/{card_id}/status/"},{"label":"Set Card PIN","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/manage-cards/set_card_pin_api_v1_jiko_accounts__account_id__cards__card_id__pin__post","routeSlug":"/products/partner-api/reference/manage-cards/set_card_pin_api_v1_jiko_accounts__account_id__cards__card_id__pin__post","metadata":{"seo":{"title":"Set Card PIN","description":"Set PIN for physical cards (by card_id) before they are activated."}},"httpPath":"/api/v1/jiko-accounts/{account_id}/cards/{card_id}/pin/"},{"label":"Close Card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/manage-cards/close_card_api_v1_jiko_accounts__account_id__cards__card_id__close__post","routeSlug":"/products/partner-api/reference/manage-cards/close_card_api_v1_jiko_accounts__account_id__cards__card_id__close__post","metadata":{"seo":{"title":"Close Card","description":"Close a card, virtual or physical. Physical cards require a closure_reason. If the reason is STOLEN or LOST, a lost_stolen_date is required."}},"httpPath":"/api/v1/jiko-accounts/{account_id}/cards/{card_id}/close/"}]},{"type":"group","label":"Physical Cards","link":"/products/partner-api/reference/physical-cards","routeSlug":"/products/partner-api/reference/physical-cards","items":[{"label":"List Card Orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/physical-cards/list_card_orders_api_v1_jiko_accounts__account_id__card_orders__get","routeSlug":"/products/partner-api/reference/physical-cards/list_card_orders_api_v1_jiko_accounts__account_id__card_orders__get","metadata":{"seo":{"title":"List Card Orders","description":"List all card orders for this account."}},"httpPath":"/api/v1/jiko-accounts/{account_id}/card-orders/"},{"label":"Create Physical Card Order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/physical-cards/create_physical_card_order_api_v1_jiko_accounts__account_id__card_orders__post","routeSlug":"/products/partner-api/reference/physical-cards/create_physical_card_order_api_v1_jiko_accounts__account_id__card_orders__post","metadata":{"seo":{"title":"Create Physical Card Order","description":"Order a new, physical card for an account. It will be delivered to the specified address."}},"httpPath":"/api/v1/jiko-accounts/{account_id}/card-orders/"},{"label":"List Customer Card Orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/physical-cards/list_customer_card_orders_api_v1_customers__customer_id__card_orders__get","routeSlug":"/products/partner-api/reference/physical-cards/list_customer_card_orders_api_v1_customers__customer_id__card_orders__get","metadata":{"seo":{"title":"List Customer Card Orders","description":"List all card orders for the customer."}},"httpPath":"/api/v1/customers/{customer_id}/card-orders/"},{"label":"Get Card Order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/physical-cards/get_card_order_api_v1_jiko_accounts__account_id__card_orders__card_order_id___get","routeSlug":"/products/partner-api/reference/physical-cards/get_card_order_api_v1_jiko_accounts__account_id__card_orders__card_order_id___get","metadata":{"seo":{"title":"Get Card Order","description":"Retrieve card order information by provided card_order_id."}},"httpPath":"/api/v1/jiko-accounts/{account_id}/card-orders/{card_order_id}/"},{"label":"Get Physical Card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/physical-cards/get_physical_card_api_v1_jiko_accounts__account_id__physical_cards__card_id___post","routeSlug":"/products/partner-api/reference/physical-cards/get_physical_card_api_v1_jiko_accounts__account_id__physical_cards__card_id___post","metadata":{"seo":{"title":"Get Physical Card","description":"Retrieve physical card detail by given card_id. Generate a single-use 4096-bit RSA key-pair at the (end user) client side and pass the public key PEM encoded upstream in PKCS#1 or PKCS#1.5 format to ensure confidentiality and encryption of the card's PAN, CVV and expiration date."}},"httpPath":"/api/v1/jiko-accounts/{account_id}/physical-cards/{card_id}/"}]},{"type":"group","label":"Virtual Cards","link":"/products/partner-api/reference/virtual-cards","routeSlug":"/products/partner-api/reference/virtual-cards","items":[{"label":"Get Virtual Card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/virtual-cards/get_virtual_card_api_v1_jiko_accounts__account_id__virtual_cards__card_id___post","routeSlug":"/products/partner-api/reference/virtual-cards/get_virtual_card_api_v1_jiko_accounts__account_id__virtual_cards__card_id___post","metadata":{"seo":{"title":"Get Virtual Card","description":"Retrieve virtual card detail by given card_id. Generate a single-use 4096-bit RSA key-pair at the (end user) client side and pass the public key PEM encoded upstream in PKCS#1 or PKCS#1.5 format to ensure confidentiality and encryption of the card's PAN, CVV and expiration date."}},"httpPath":"/api/v1/jiko-accounts/{account_id}/virtual-cards/{card_id}/"},{"label":"Close Virtual Card","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/virtual-cards/close_virtual_card_api_v1_jiko_accounts__account_id__virtual_cards__card_id___delete","routeSlug":"/products/partner-api/reference/virtual-cards/close_virtual_card_api_v1_jiko_accounts__account_id__virtual_cards__card_id___delete","metadata":{"seo":{"title":"Close Virtual Card","description":"Close a virtual card. This is an irreversible action."}},"httpPath":"/api/v1/jiko-accounts/{account_id}/virtual-cards/{card_id}/"},{"label":"Create Virtual Card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/virtual-cards/create_virtual_card_api_v1_jiko_accounts__account_id__virtual_cards__post","routeSlug":"/products/partner-api/reference/virtual-cards/create_virtual_card_api_v1_jiko_accounts__account_id__virtual_cards__post","metadata":{"seo":{"title":"Create Virtual Card","description":"Create a virtual card for an account. Generate a single-use 4096-bit RSA key-pair at the (end user) client side and pass the public key PEM encoded upstream in PKCS#1 or PKCS#1.5 format to ensure confidentiality and encryption of the card's PAN, CVV and expiration date."}},"httpPath":"/api/v1/jiko-accounts/{account_id}/virtual-cards/"}]},{"type":"separator","label":"Onboarding"},{"type":"group","label":"Businesses","link":"/products/partner-api/reference/businesses","routeSlug":"/products/partner-api/reference/businesses","items":[{"label":"Create Application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/businesses/create-business-application","routeSlug":"/products/partner-api/reference/businesses/create-business-application","metadata":{"seo":{"title":"Create Application","description":"Create a Business Application. The Business Application object contains general information related to the business and the overall status of the application."}},"httpPath":"/api/v1/business-applications/"},{"label":"Get Application","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/businesses/get-business-application","routeSlug":"/products/partner-api/reference/businesses/get-business-application","metadata":{"seo":{"title":"Get Application","description":"Fetch a Business Application."}},"httpPath":"/api/v1/business-applications/{application_id}/"},{"label":"Update Application","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/businesses/update-business-application","routeSlug":"/products/partner-api/reference/businesses/update-business-application","metadata":{"seo":{"title":"Update Application","description":"Update Application"}},"httpPath":"/api/v1/business-applications/{application_id}/"},{"label":"Apply","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/businesses/business-application-apply","routeSlug":"/products/partner-api/reference/businesses/business-application-apply","metadata":{"seo":{"title":"Apply","description":"When the Business Application object has been completed, along with Related Party Applications and Document Requests (see the Onboarding Businesses Guide), call this endpoint to submit the business application for review."}},"httpPath":"/api/v1/business-applications/{application_id}/apply/"},{"label":"Create Related Party Application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/businesses/create-related-party-application","routeSlug":"/products/partner-api/reference/businesses/create-related-party-application","metadata":{"seo":{"title":"Create Related Party Application","description":"Create Related Party Application"}},"httpPath":"/api/v1/business-applications/{application_id}/related-party-applications/"},{"label":"List Related Party Application","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/businesses/list-related-party-application","routeSlug":"/products/partner-api/reference/businesses/list-related-party-application","metadata":{"seo":{"title":"List Related Party Application","description":"List Related Party Application"}},"httpPath":"/api/v1/business-applications/{application_id}/related-party-applications/"},{"label":"Update Related Party Application","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/businesses/update-related-party-application","routeSlug":"/products/partner-api/reference/businesses/update-related-party-application","metadata":{"seo":{"title":"Update Related Party Application","description":"Update Related Party Application"}},"httpPath":"/api/v1/business-applications/{application_id}/related-party-applications/{related_party_application_id}/"},{"label":"Delete Related Party Application","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/businesses/delete-related-party-application","routeSlug":"/products/partner-api/reference/businesses/delete-related-party-application","metadata":{"seo":{"title":"Delete Related Party Application","description":"Delete Related Party Application"}},"httpPath":"/api/v1/business-applications/{application_id}/related-party-applications/{related_party_application_id}/"},{"label":"List Related Party Document Requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/businesses/list-related-party-document-requests-businesses","routeSlug":"/products/partner-api/reference/businesses/list-related-party-document-requests-businesses","metadata":{"seo":{"title":"List Related Party Document Requests","description":"Fetch the list of outstanding Document Requests. Document Requests vary depending on the information provided in the Business Application and Related Party Application objects."}},"httpPath":"/api/v1/business-applications/{application_id}/related-party-applications/{related_party_application_id}/"},{"label":"List Document Requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/businesses/list-document-requests-businesses","routeSlug":"/products/partner-api/reference/businesses/list-document-requests-businesses","metadata":{"seo":{"title":"List Document Requests","description":"Fetch the list of outstanding Document Requests. Document Requests vary depending on the information provided in the Business Application and Related Party Application objects."}},"httpPath":"/api/v1/business-applications/{application_id}/documents/"},{"label":"Upload Document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/businesses/upload-application-document","routeSlug":"/products/partner-api/reference/businesses/upload-application-document","metadata":{"seo":{"title":"Upload Document","description":"Upload Document"}},"httpPath":"/api/v1/documents/{document_id}/"}]},{"type":"group","label":"Individuals","link":"/products/partner-api/reference/individuals","routeSlug":"/products/partner-api/reference/individuals","items":[{"label":"Create Application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/individuals/create_application_api_v1_applications__post","routeSlug":"/products/partner-api/reference/individuals/create_application_api_v1_applications__post","metadata":{"seo":{"title":"Create Application","description":"Create an application. You must apply to potentially create a customer using the application, assuming KYC is successful."}},"httpPath":"/api/v1/applications/"},{"label":"Get Application","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/individuals/get_application_api_v1_applications__application_id___get","routeSlug":"/products/partner-api/reference/individuals/get_application_api_v1_applications__application_id___get","metadata":{"seo":{"title":"Get Application","description":"Fetch and observe an existing application."}},"httpPath":"/api/v1/applications/{application_id}/"},{"label":"Apply","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/individuals/apply_api_v1_applications__application_id__apply__post","routeSlug":"/products/partner-api/reference/individuals/apply_api_v1_applications__application_id__apply__post","metadata":{"seo":{"title":"Apply","description":"Initiate automatic KYC. Transitions the application from CREATED status to SUBMITTED status. Once the async KYC process is completed, the application will move from SUBMITTED to another status."}},"httpPath":"/api/v1/applications/{application_id}/apply/"},{"label":"List Agreements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/individuals/list_agreements_api_v1_agreements__get","routeSlug":"/products/partner-api/reference/individuals/list_agreements_api_v1_agreements__get","metadata":{"seo":{"title":"List Agreements","description":"Partner agreements and disclosures are available through the API in a versioned bundle. The version of the fetched bundle must be attached to all incoming applications."}},"httpPath":"/api/v1/agreements/"},{"label":"Upload Document To Application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/individuals/upload_document_to_application_api_v1_applications__application_id__documents__document_type__file__post","routeSlug":"/products/partner-api/reference/individuals/upload_document_to_application_api_v1_applications__application_id__documents__document_type__file__post","metadata":{"seo":{"title":"Upload Document To Application","description":"Upload documents to the application for more detailed KYC or manual review."}},"httpPath":"/api/v1/applications/{application_id}/documents/{document_type}/file/"},{"label":"Upload Document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/individuals/upload-application-document","routeSlug":"/products/partner-api/reference/individuals/upload-application-document","metadata":{"seo":{"title":"Upload Document","description":"Upload Document"}},"httpPath":"/api/v1/documents/{document_id}/"}]},{"type":"separator","label":"Platform"},{"type":"group","label":"Events","link":"/products/partner-api/reference/events","routeSlug":"/products/partner-api/reference/events","items":[{"label":"List Event Types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/events/list_event_types_api_v1_events_types__get","routeSlug":"/products/partner-api/reference/events/list_event_types_api_v1_events_types__get","metadata":{"seo":{"title":"List Event Types","description":"List all event types."}},"httpPath":"/api/v1/events/types/"},{"label":"List Events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/events/list_events_api_v1_events__get","routeSlug":"/products/partner-api/reference/events/list_events_api_v1_events__get","metadata":{"seo":{"title":"List Events","description":"List all past events."}},"httpPath":"/api/v1/events/"}]},{"type":"group","label":"Health","link":"/products/partner-api/reference/health","routeSlug":"/products/partner-api/reference/health","items":[{"label":"Get Health Check","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/health/get-health-check","routeSlug":"/products/partner-api/reference/health/get-health-check","metadata":{"seo":{"title":"Get Health Check","description":"A health check endpoint, which returns \"OK\" if the Partner API is up and running."}},"httpPath":"/health"}]},{"type":"group","label":"Sandbox","link":"/products/partner-api/reference/sandbox","routeSlug":"/products/partner-api/reference/sandbox","items":[{"label":"Submit Card Swipe","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/sandbox/submit_card_swipe_api_v1_sandbox_card_swipe__post","routeSlug":"/products/partner-api/reference/sandbox/submit_card_swipe_api_v1_sandbox_card_swipe__post","metadata":{"seo":{"title":"Submit Card Swipe","description":"Simulate a card swipe with the given card_id for a given amount_usdc in USD cents. Note: Only for virtual cards at the moment."}},"httpPath":"/api/v1/sandbox/card-swipe/"},{"label":"Generate Physical Card From Order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/sandbox/generate_physical_card_from_order_api_v1_sandbox_generate_card__post","routeSlug":"/products/partner-api/reference/sandbox/generate_physical_card_from_order_api_v1_sandbox_generate_card__post","metadata":{"seo":{"title":"Generate Physical Card From Order","description":"Generate a physical card from a card order with a given card_order_id."}},"httpPath":"/api/v1/sandbox/generate-card/"},{"label":"Trigger Webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/sandbox/trigger-webhook","routeSlug":"/products/partner-api/reference/sandbox/trigger-webhook","metadata":{"seo":{"title":"Trigger Webhook","description":"Simulates a webhook event according to the payload. This will trigger requests to subscribed callback URLs, if any."}},"httpPath":"/api/v1/sandbox/webhook/"},{"label":"Fund Account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/sandbox/fund_account_api_v1_sandbox_fund__post","routeSlug":"/products/partner-api/reference/sandbox/fund_account_api_v1_sandbox_fund__post","metadata":{"seo":{"title":"Fund Account","description":"Simulates an ACH credit to the provided Jiko account. Requires a portal to use. A portal can be created using the Create Portal endpoint."}},"httpPath":"/api/v1/sandbox/fund/"}]},{"type":"group","label":"Security","link":"/products/partner-api/reference/security","routeSlug":"/products/partner-api/reference/security","items":[{"label":"Login","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/security/login_api_v1_login__post","routeSlug":"/products/partner-api/reference/security/login_api_v1_login__post","metadata":{"seo":{"title":"Login","description":"Provide the username and password in a request body to receive a bearer token to authenticate to the API's other endpoints."}},"httpPath":"/api/v1/login/"},{"label":"List Public Keys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/security/list_public_keys_api_v1_public_keys__get","routeSlug":"/products/partner-api/reference/security/list_public_keys_api_v1_public_keys__get","metadata":{"seo":{"title":"List Public Keys","description":"Returns all relevant asymmetric encryption keys."}},"httpPath":"/api/v1/public-keys/"}]},{"type":"group","label":"Subscriptions","link":"/products/partner-api/reference/subscriptions","routeSlug":"/products/partner-api/reference/subscriptions","items":[{"label":"List Subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/subscriptions/list_subscriptions_api_v1_subscriptions__get","routeSlug":"/products/partner-api/reference/subscriptions/list_subscriptions_api_v1_subscriptions__get","metadata":{"seo":{"title":"List Subscriptions","description":"List a partner's subscriptions."}},"httpPath":"/api/v1/subscriptions/"},{"label":"Create Subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/subscriptions/create_subscription_api_v1_subscriptions__post","routeSlug":"/products/partner-api/reference/subscriptions/create_subscription_api_v1_subscriptions__post","metadata":{"seo":{"title":"Create Subscription","description":"Creates a webhook subscription for the specified event types and the given URL."}},"httpPath":"/api/v1/subscriptions/"},{"label":"Get Subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/subscriptions/get_subscription_api_v1_subscriptions__subscription_id___get","routeSlug":"/products/partner-api/reference/subscriptions/get_subscription_api_v1_subscriptions__subscription_id___get","metadata":{"seo":{"title":"Get Subscription","description":"Retrieve a webhook subscription by given subscription_id."}},"httpPath":"/api/v1/subscriptions/{subscription_id}/"},{"label":"Update Subscription","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/subscriptions/update_subscription_api_v1_subscriptions__subscription_id___patch","routeSlug":"/products/partner-api/reference/subscriptions/update_subscription_api_v1_subscriptions__subscription_id___patch","metadata":{"seo":{"title":"Update Subscription","description":"Updates webhook subscription by specified subscription_id."}},"httpPath":"/api/v1/subscriptions/{subscription_id}/"},{"label":"Delete Subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/subscriptions/delete_subscription_api_v1_subscriptions__subscription_id___delete","routeSlug":"/products/partner-api/reference/subscriptions/delete_subscription_api_v1_subscriptions__subscription_id___delete","metadata":{"seo":{"title":"Delete Subscription","description":"Deletes a webhook subscription matching the given ID."}},"httpPath":"/api/v1/subscriptions/{subscription_id}/"}]},{"type":"group","label":"Webhooks","link":"/products/partner-api/reference/webhooks","routeSlug":"/products/partner-api/reference/webhooks","items":[{"label":"application.approved","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_application_approved_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_application_approved_post","metadata":{"seo":{"title":"application.approved","description":"Application - Approved Event"}},"httpPath":"application.approved"},{"label":"application.manual_review","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_application_manual_review_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_application_manual_review_post","metadata":{"seo":{"title":"application.manual_review","description":"Application - Manual Review Event"}},"httpPath":"application.manual_review"},{"label":"application.documents_needed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_application_documents_needed_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_application_documents_needed_post","metadata":{"seo":{"title":"application.documents_needed","description":"Application - Documents Needed Event"}},"httpPath":"application.documents_needed"},{"label":"application.rejected","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_application_rejected_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_application_rejected_post","metadata":{"seo":{"title":"application.rejected","description":"Application - Rejected Event"}},"httpPath":"application.rejected"},{"label":"transfers.ach.in.success","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_transfers_ach_in_success_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_transfers_ach_in_success_post","metadata":{"seo":{"title":"transfers.ach.in.success","description":"Incoming ACH Transfer - Success Event"}},"httpPath":"transfers.ach.in.success"},{"label":"transfers.ach.in.rejected","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_transfers_ach_in_rejected_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_transfers_ach_in_rejected_post","metadata":{"seo":{"title":"transfers.ach.in.rejected","description":"Incoming ACH Transfer - Rejected Event"}},"httpPath":"transfers.ach.in.rejected"},{"label":"transfers.ach.out.success","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_transfers_ach_out_success_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_transfers_ach_out_success_post","metadata":{"seo":{"title":"transfers.ach.out.success","description":"Outgoing ACH Transfer - Success Event"}},"httpPath":"transfers.ach.out.success"},{"label":"transfers.ach.out.rejected","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_transfers_ach_out_rejected_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_transfers_ach_out_rejected_post","metadata":{"seo":{"title":"transfers.ach.out.rejected","description":"Outgoing ACH Transfer - Rejected Event"}},"httpPath":"transfers.ach.out.rejected"},{"label":"transfers.ach.out.sent","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_transfers_ach_out_sent_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_transfers_ach_out_sent_post","metadata":{"seo":{"title":"transfers.ach.out.sent","description":"Outgoing ACH Transfer - Sent Event"}},"httpPath":"transfers.ach.out.sent"},{"label":"card.status.closed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_card_status_closed_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_card_status_closed_post","metadata":{"seo":{"title":"card.status.closed","description":"Card Status - Closed Event"}},"httpPath":"card.status.closed"},{"label":"card.status.open","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_card_status_open_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_card_status_open_post","metadata":{"seo":{"title":"card.status.open","description":"Card Status - Open Event"}},"httpPath":"card.status.open"},{"label":"card.status.frozen","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_card_status_frozen_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_card_status_frozen_post","metadata":{"seo":{"title":"card.status.frozen","description":"Card Status - Frozen Event"}},"httpPath":"card.status.frozen"},{"label":"card.status.locked","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_card_status_locked_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_card_status_locked_post","metadata":{"seo":{"title":"card.status.locked","description":"Card Status - Locked Event"}},"httpPath":"card.status.locked"},{"label":"card.transaction.approved","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_card_transaction_approved_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_card_transaction_approved_post","metadata":{"seo":{"title":"card.transaction.approved","description":"Card Transaction - Approved Event"}},"httpPath":"card.transaction.approved"},{"label":"card.transaction.on_hold","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_card_transaction_on_hold_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_card_transaction_on_hold_post","metadata":{"seo":{"title":"card.transaction.on_hold","description":"Card Transaction - On Hold Event"}},"httpPath":"card.transaction.on_hold"},{"label":"card.transaction.reversed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_card_transaction_reversed_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_card_transaction_reversed_post","metadata":{"seo":{"title":"card.transaction.reversed","description":"Card Transaction - Reversed Event"}},"httpPath":"card.transaction.reversed"},{"label":"card.transaction.rejected","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_card_transaction_rejected_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_card_transaction_rejected_post","metadata":{"seo":{"title":"card.transaction.rejected","description":"Card Transaction - Rejected Event"}},"httpPath":"card.transaction.rejected"},{"label":"transfers.wire.out.success","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_transfers_wire_out_success_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_transfers_wire_out_success_post","metadata":{"seo":{"title":"transfers.wire.out.success","description":"Outgoing Wire Transfer - Success Event"}},"httpPath":"transfers.wire.out.success"},{"label":"transfers.wire.out.processing","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_transfers_wire_out_processing_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_transfers_wire_out_processing_post","metadata":{"seo":{"title":"transfers.wire.out.processing","description":"Outgoing Wire Transfer - Processing Event"}},"httpPath":"transfers.wire.out.processing"},{"label":"transfers.wire.out.rejected","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_transfers_wire_out_rejected_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_transfers_wire_out_rejected_post","metadata":{"seo":{"title":"transfers.wire.out.rejected","description":"Outgoing Wire Transfer - Rejected Event"}},"httpPath":"transfers.wire.out.rejected"},{"label":"transfers.wire.in.success","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_transfers_wire_in_success_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_transfers_wire_in_success_post","metadata":{"seo":{"title":"transfers.wire.in.success","description":"Incoming Wire Transfer - Success Event"}},"httpPath":"transfers.wire.in.success"},{"label":"transfers.wire.in.rejected","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_transfers_wire_in_rejected_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_transfers_wire_in_rejected_post","metadata":{"seo":{"title":"transfers.wire.in.rejected","description":"Incoming Wire Transfer - Rejected Event"}},"httpPath":"transfers.wire.in.rejected"},{"label":"transfers.on-us.success","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_transfers_on_us_success_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_transfers_on_us_success_post","metadata":{"seo":{"title":"transfers.on-us.success","description":"Transfers On-Us Success Event"}},"httpPath":"transfers.on-us.success"},{"label":"transfers.on-us.processing","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_transfers_on_us_processing_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_transfers_on_us_processing_post","metadata":{"seo":{"title":"transfers.on-us.processing","description":"Transfers On-Us Processing Event"}},"httpPath":"transfers.on-us.processing"},{"label":"transfers.on-us.rejected","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_transfers_on_us_rejected_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_transfers_on_us_rejected_post","metadata":{"seo":{"title":"transfers.on-us.rejected","description":"Transfers On-Us Rejected Event"}},"httpPath":"transfers.on-us.rejected"},{"label":"transfers.on-us.received","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_transfers_on_us_received_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_transfers_on_us_received_post","metadata":{"seo":{"title":"transfers.on-us.received","description":"Transfers On-Us Received Event"}},"httpPath":"transfers.on-us.received"},{"label":"tradable.maturity","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_tradable_maturity_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_tradable_maturity_post","metadata":{"seo":{"title":"tradable.maturity","description":"Tradable - Maturity Event"}},"httpPath":"tradable.maturity"},{"label":"report.status.available","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_report_status_available_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_report_status_available_post","metadata":{"seo":{"title":"report.status.available","description":"Report - Download Available Event"}},"httpPath":"report.status.available"},{"label":"report.status.pending","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_report_status_pending_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_report_status_pending_post","metadata":{"seo":{"title":"report.status.pending","description":"Report - Pending Creation Event"}},"httpPath":"report.status.pending"},{"label":"report.status.failed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_report_status_failed_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_report_status_failed_post","metadata":{"seo":{"title":"report.status.failed","description":"Report Status Failed Event"}},"httpPath":"report.status.failed"},{"label":"counterparty.status.linked","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_counterparty_status_linked_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_counterparty_status_linked_post","metadata":{"seo":{"title":"counterparty.status.linked","description":"Counterparty Status - Linked Event"}},"httpPath":"counterparty.status.linked"},{"label":"counterparty.status.unlinked","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_counterparty_status_unlinked_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_counterparty_status_unlinked_post","metadata":{"seo":{"title":"counterparty.status.unlinked","description":"Counterparty Status - Unlinked Event"}},"httpPath":"counterparty.status.unlinked"},{"label":"counterparty.status.failed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_counterparty_status_failed_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_counterparty_status_failed_post","metadata":{"seo":{"title":"counterparty.status.failed","description":"Counterparty Status - Failed Event"}},"httpPath":"counterparty.status.failed"}]},{"type":"separator","label":"Reports"},{"type":"group","label":"Reports","link":"/products/partner-api/reference/reports","routeSlug":"/products/partner-api/reference/reports","items":[{"label":"List Report Requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/reports/list_report_requests_api_v1_report_requests__get","routeSlug":"/products/partner-api/reference/reports/list_report_requests_api_v1_report_requests__get","metadata":{"seo":{"title":"List Report Requests","description":"Returns a list of report requests"}},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"httpPath":"/api/v1/report-requests/"},{"label":"Create Report Request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/reports/create_report_request_api_v1_report_requests__post","routeSlug":"/products/partner-api/reference/reports/create_report_request_api_v1_report_requests__post","metadata":{"seo":{"title":"Create 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":"Get Report Request","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/reports/get_report_request_api_v1_report_requests__report_request_id___get","routeSlug":"/products/partner-api/reference/reports/get_report_request_api_v1_report_requests__report_request_id___get","metadata":{"seo":{"title":"Get Report Request","description":"Retrieves a single report request by ID"}},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"httpPath":"/api/v1/report-requests/{report_request_id}/"},{"label":"Get Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/reports/get_report_api_v1_reports__report_id___get","routeSlug":"/products/partner-api/reference/reports/get_report_api_v1_reports__report_id___get","metadata":{"seo":{"title":"Get Report","description":"Retrieves a single report by ID"}},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"httpPath":"/api/v1/reports/{report_id}/"},{"label":"Download Report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/reports/download_report_api_v1_reports__report_id__download__post","routeSlug":"/products/partner-api/reference/reports/download_report_api_v1_reports__report_id__download__post","metadata":{"seo":{"title":"Download Report","description":"Creates a temporary, time-limited URL for downloading the report corresponding to the given ID"}},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"httpPath":"/api/v1/reports/{report_id}/download/"},{"label":"Render Report Formats","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/reports/render_report_formats_api_v1_reports__report_id__formats__post","routeSlug":"/products/partner-api/reference/reports/render_report_formats_api_v1_reports__report_id__formats__post","metadata":{"seo":{"title":"Render Report Formats","description":"Triggers rendering of additional output formats for an existing report"}},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"httpPath":"/api/v1/reports/{report_id}/formats/"}]},{"type":"separator","label":"Transfers"},{"type":"group","label":"ACH","link":"/products/partner-api/reference/ach","routeSlug":"/products/partner-api/reference/ach","items":[{"label":"List ACH Originations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/ach/list_ach_originations_api_v1_jiko_accounts__account_id__ach_originating__get","routeSlug":"/products/partner-api/reference/ach/list_ach_originations_api_v1_jiko_accounts__account_id__ach_originating__get","metadata":{"seo":{"title":"List ACH Originations","description":"List all ACH transfer originations."}},"httpPath":"/api/v1/jiko-accounts/{account_id}/ach-originating/"},{"label":"Create ACH Origination","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/ach/create_ach_origination_api_v1_jiko_accounts__account_id__ach_originating__post","routeSlug":"/products/partner-api/reference/ach/create_ach_origination_api_v1_jiko_accounts__account_id__ach_originating__post","metadata":{"seo":{"title":"Create ACH Origination","description":"Originate an ACH transaction with the counterparty.This can only be done after creating a Counterparty for the account."}},"httpPath":"/api/v1/jiko-accounts/{account_id}/ach-originating/"},{"label":"Get ACH Origination","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/ach/get_ach_origination_api_v1_jiko_accounts__account_id__ach_originating__transfer_id___get","routeSlug":"/products/partner-api/reference/ach/get_ach_origination_api_v1_jiko_accounts__account_id__ach_originating__transfer_id___get","metadata":{"seo":{"title":"Get ACH Origination","description":"Get a specific ACH transfer origination."}},"httpPath":"/api/v1/jiko-accounts/{account_id}/ach-originating/{transfer_id}/"},{"label":"List Customer ACH Originations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/ach/list_customer_ach_originations_api_v1_customers__customer_id__ach_originating__get","routeSlug":"/products/partner-api/reference/ach/list_customer_ach_originations_api_v1_customers__customer_id__ach_originating__get","metadata":{"seo":{"title":"List Customer ACH Originations","description":"List all ACH transfer originations across a customer's accounts."}},"httpPath":"/api/v1/customers/{customer_id}/ach-originating/"}]},{"type":"group","label":"Counterparties","link":"/products/partner-api/reference/counterparties","routeSlug":"/products/partner-api/reference/counterparties","items":[{"label":"List Counterparties","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/counterparties/list_counterparties_api_v1_customers__customer_id__counterparties__get","routeSlug":"/products/partner-api/reference/counterparties/list_counterparties_api_v1_customers__customer_id__counterparties__get","metadata":{"seo":{"title":"List Counterparties","description":"List all counterparties for a customer. Deprecated: Use List Counterparties instead."}},"httpPath":"/api/v1/customers/{customer_id}/counterparties/"},{"label":"Get Counterparty","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/counterparties/get_counterparty_api_v1_customers__customer_id__counterparties__counterparty_id___get","routeSlug":"/products/partner-api/reference/counterparties/get_counterparty_api_v1_customers__customer_id__counterparties__counterparty_id___get","metadata":{"seo":{"title":"Get Counterparty","description":"Deprecated: Use Get Counterparty instead."}},"httpPath":"/api/v1/customers/{customer_id}/counterparties/{counterparty_id}/"}]},{"type":"group","label":"On-Us Transfers","link":"/products/partner-api/reference/on-us-transfers","routeSlug":"/products/partner-api/reference/on-us-transfers","items":[{"label":"Create On-Us Transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/on-us-transfers/create-on-us-transfer","routeSlug":"/products/partner-api/reference/on-us-transfers/create-on-us-transfer","metadata":{"seo":{"title":"Create On-Us Transfer","description":"Initiates an On-Us Transfer between two Pockets."}},"httpPath":"/api/v1/transfers/on-us/"},{"label":"Quote Same-Entity Security Transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/on-us-transfers/preview-on-us-transfer","routeSlug":"/products/partner-api/reference/on-us-transfers/preview-on-us-transfer","metadata":{"seo":{"title":"Quote Same-Entity Security Transfer","description":"Returns a dry-run quote for a same-entity on-us security transfer (an INTERNAL_REALLOCATION of type SECURITY_TRANSFER), running the same validation and ruleset evaluation as creating the transfer but booking no trades and persisting nothing. The quote reports whether the transfer would be allowed, its settlement type, and the eligible transfer amount. Only the security-transfer type is quotable; other on-us types are rejected. It is indicative only: a successful quote is not a guarantee that the transfer will book."}},"httpPath":"/api/v1/transfers/on-us/quotes/"},{"label":"Get On-Us Transfer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/on-us-transfers/get-on-us-transfer","routeSlug":"/products/partner-api/reference/on-us-transfers/get-on-us-transfer","metadata":{"seo":{"title":"Get On-Us Transfer","description":"Gets a single on-us transfer by ID."}},"httpPath":"/api/v1/transfers/on-us/{transfer_id}/"}]},{"type":"group","label":"Portals","link":"/products/partner-api/reference/portals","routeSlug":"/products/partner-api/reference/portals","items":[{"label":"List Portals","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/portals/list_account_portals_api_v1_jiko_accounts__account_id__portals__get","routeSlug":"/products/partner-api/reference/portals/list_account_portals_api_v1_jiko_accounts__account_id__portals__get","metadata":{"seo":{"title":"List Portals","description":"Get a list of portals associated with an account."}},"httpPath":"/api/v1/jiko-accounts/{account_id}/portals/"},{"label":"Create Portal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/portals/create_portal_api_v1_jiko_accounts__account_id__portals__post","routeSlug":"/products/partner-api/reference/portals/create_portal_api_v1_jiko_accounts__account_id__portals__post","metadata":{"seo":{"title":"Create Portal","description":"Create a portal for an account."}},"httpPath":"/api/v1/jiko-accounts/{account_id}/portals/"},{"label":"Get Account Portal","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/portals/get-account-portal","routeSlug":"/products/partner-api/reference/portals/get-account-portal","metadata":{"seo":{"title":"Get Account Portal","description":"Get a specific portal associated with an account."}},"httpPath":"/api/v1/jiko-accounts/{account_id}/portals/{portal_id}/"},{"label":"Update Portal","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/portals/update_portal_api_v1_jiko_accounts__account_id__portals__portal_id___patch","routeSlug":"/products/partner-api/reference/portals/update_portal_api_v1_jiko_accounts__account_id__portals__portal_id___patch","metadata":{"seo":{"title":"Update Portal","description":"Update a portal's name."}},"httpPath":"/api/v1/jiko-accounts/{account_id}/portals/{portal_id}/"},{"label":"Close Portal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/portals/close_portal_api_v1_jiko_accounts__account_id__portals__portal_id__close__post","routeSlug":"/products/partner-api/reference/portals/close_portal_api_v1_jiko_accounts__account_id__portals__portal_id__close__post","metadata":{"seo":{"title":"Close Portal","description":"Close a portal. This is an irreversible action."}},"httpPath":"/api/v1/jiko-accounts/{account_id}/portals/{portal_id}/close/"},{"label":"List Customer Portals","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/portals/list_customer_portals_api_v1_customers__customer_id__portals__get","routeSlug":"/products/partner-api/reference/portals/list_customer_portals_api_v1_customers__customer_id__portals__get","metadata":{"seo":{"title":"List Customer Portals","description":"Get a list of portals associated with customer's accounts."}},"httpPath":"/api/v1/customers/{customer_id}/portals/"}]},{"type":"group","label":"Wires","link":"/products/partner-api/reference/wires","routeSlug":"/products/partner-api/reference/wires","items":[{"label":"Create Wire","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/wires/create-wire","routeSlug":"/products/partner-api/reference/wires/create-wire","metadata":{"seo":{"title":"Create Wire","description":"Initiates a Wire Transfer. Wires can only be sent to accounts created and verified via Create Counterparty.Initiating outgoing wire transfers isn’t available by default and must be enabled — please contact your Jiko point of contact to learn more."}},"httpPath":"/api/v1/jiko-accounts/{account_id}/wires/"},{"label":"List Wires","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/wires/list-wires-v1","routeSlug":"/products/partner-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/partner-api/reference/wires/get-wire-v1","routeSlug":"/products/partner-api/reference/wires/get-wire-v1","metadata":{"seo":{"title":"Get Wire","description":"Get Wire"}},"httpPath":"/api/v1/wires/{wire_id}/"}]},{"type":"separator","label":"Pockets V2"},{"type":"group","label":"Pockets","link":"/products/partner-api/reference/pockets","routeSlug":"/products/partner-api/reference/pockets","items":[{"label":"Create Pocket","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/pockets/create_pocket_api_v2_customers__customer_id__pockets__post","routeSlug":"/products/partner-api/reference/pockets/create_pocket_api_v2_customers__customer_id__pockets__post","metadata":{"seo":{"title":"Create Pocket","description":"Creates a single Pocket for a customer. Trading strategy for the Pocket is specified with a Pocket Configuration."}},"httpPath":"/api/v2/customers/{customer_id}/pockets/"},{"label":"List Pockets For Customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/pockets/list-pockets-v2","routeSlug":"/products/partner-api/reference/pockets/list-pockets-v2","metadata":{"seo":{"title":"List Pockets For Customer","description":"Retrieve all Pockets for a single Customer."}},"httpPath":"/api/v2/customers/{customer_id}/pockets/"},{"label":"List Pockets For Customers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/pockets/list-all-pockets-v2","routeSlug":"/products/partner-api/reference/pockets/list-all-pockets-v2","metadata":{"seo":{"title":"List Pockets For Customers","description":"Retrieve all Pockets for a list of Customers."}},"httpPath":"/api/v2/pockets/"},{"label":"Get Customer Pocket","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/pockets/get-pocket-v2","routeSlug":"/products/partner-api/reference/pockets/get-pocket-v2","metadata":{"seo":{"title":"Get Customer Pocket","description":"Retrieve a single Pocket for a given pocket_id."}},"httpPath":"/api/v2/customers/{customer_id}/pockets/{pocket_id}/"},{"label":"Update Pocket","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/pockets/update-pocket-v2","routeSlug":"/products/partner-api/reference/pockets/update-pocket-v2","metadata":{"seo":{"title":"Update Pocket","description":"Update a Pocket's name, or update a Pocket's status. 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/customers/{customer_id}/pockets/{pocket_id}/"},{"label":"Get Pocket","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/pockets/get-single-pocket-v2","routeSlug":"/products/partner-api/reference/pockets/get-single-pocket-v2","metadata":{"seo":{"title":"Get Pocket","description":"Retrieve a single Pocket for a given pocket_id."}},"httpPath":"/api/v2/pockets/{pocket_id}/"},{"label":"Get Earnings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/pockets/get-earnings-v2","routeSlug":"/products/partner-api/reference/pockets/get-earnings-v2","metadata":{"seo":{"title":"Get Earnings","description":"Get Earnings"}},"httpPath":"/api/v2/pockets/{pocket_id}/earnings/"},{"label":"Get Customer Earnings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/pockets/get-customer-earnings-v2","routeSlug":"/products/partner-api/reference/pockets/get-customer-earnings-v2","metadata":{"seo":{"title":"Get Customer Earnings","description":"Returns current-period earnings for each of a customer's Pockets plus their exact aggregate, in a single call. The aggregate is the field-wise sum of the per-Pocket entries (sum of earnings, sum of appreciation_per_second, earliest pricing_timestamp), so it always matches the total of the individual rows. By default every Pocket that is not closed is covered; a closed Pocket's earnings can still be fetched by listing it explicitly in pocket_id[]. At most 30 Pockets can be covered per call — a request covering more is rejected with a 400 and should be narrowed with the pocket_id[] filter. Only the defined periods (wtd, mtd, ytd, all-time) are supported — for a custom date range, use the single-Pocket earnings endpoint."}},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"httpPath":"/api/v2/customers/{customer_id}/earnings/"}]},{"type":"group","label":"Portals V2","link":"/products/partner-api/reference/portals-v2","routeSlug":"/products/partner-api/reference/portals-v2","items":[{"label":"List Portals","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/portals-v2/list_pocket_portals_api_v2_pockets__pocket_id__portals__get","routeSlug":"/products/partner-api/reference/portals-v2/list_pocket_portals_api_v2_pockets__pocket_id__portals__get","metadata":{"seo":{"title":"List Portals","description":"Get a list of portals associated with a pocket."}},"httpPath":"/api/v2/pockets/{pocket_id}/portals/"},{"label":"Create Portal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/portals-v2/create_portal_api_v2_pockets__pocket_id__portals__post","routeSlug":"/products/partner-api/reference/portals-v2/create_portal_api_v2_pockets__pocket_id__portals__post","metadata":{"seo":{"title":"Create Portal","description":"Create a portal for an account."}},"httpPath":"/api/v2/pockets/{pocket_id}/portals/"},{"label":"List Customer Portals","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/portals-v2/list_customer_portals_api_v2_customers__customer_id__portals__get","routeSlug":"/products/partner-api/reference/portals-v2/list_customer_portals_api_v2_customers__customer_id__portals__get","metadata":{"seo":{"title":"List Customer Portals","description":"Get a list of portals associated with customer's pockets."}},"httpPath":"/api/v2/customers/{customer_id}/portals/"},{"label":"Get Account Portal","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/portals-v2/get-pocket-portal","routeSlug":"/products/partner-api/reference/portals-v2/get-pocket-portal","metadata":{"seo":{"title":"Get Account Portal","description":"Get a specific portal associated with an account."}},"httpPath":"/api/v2/pockets/{pocket_id}/portals/{portal_id}/"},{"label":"Update Portal","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/portals-v2/update_portal_api_v2_pockets__pocket_id__portals__portal_id___patch","routeSlug":"/products/partner-api/reference/portals-v2/update_portal_api_v2_pockets__pocket_id__portals__portal_id___patch","metadata":{"seo":{"title":"Update Portal","description":"Update a portal's name."}},"httpPath":"/api/v2/pockets/{pocket_id}/portals/{portal_id}/"},{"label":"Get Funding Instructions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/portals-v2/portal-list-funding-instructions","routeSlug":"/products/partner-api/reference/portals-v2/portal-list-funding-instructions","metadata":{"seo":{"title":"Get Funding Instructions","description":"Returns funding instructions for all payment rails supported by the portal."}},"httpPath":"/api/v2/pockets/{pocket_id}/portals/{portal_id}/funding-instructions/"}]},{"type":"group","label":"Trading Strategies","link":"/products/partner-api/reference/trading-strategies","routeSlug":"/products/partner-api/reference/trading-strategies","items":[{"label":"List Trading Strategies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/trading-strategies/list_trading_strategies_api_v2_trading_strategies__get","routeSlug":"/products/partner-api/reference/trading-strategies/list_trading_strategies_api_v2_trading_strategies__get","metadata":{"seo":{"title":"List Trading Strategies","description":"List Trading Strategies"}},"httpPath":"/api/v2/trading-strategies/"}]},{"type":"group","label":"Transactions V2","link":"/products/partner-api/reference/transactions-v2","routeSlug":"/products/partner-api/reference/transactions-v2","items":[{"label":"List Pocket Transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/transactions-v2/list-pocket-transactions-v2","routeSlug":"/products/partner-api/reference/transactions-v2/list-pocket-transactions-v2","metadata":{"seo":{"title":"List Pocket Transactions","description":"Returns a list of pocket transactions. It does not include transactions between the bank account and brokerage account."}},"httpPath":"/api/v2/pockets/{pocket_id}/transactions/"},{"label":"List Customer Transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/transactions-v2/list-customer-transactions-v2","routeSlug":"/products/partner-api/reference/transactions-v2/list-customer-transactions-v2","metadata":{"seo":{"title":"List Customer Transactions","description":"Returns a list of customer transactions. It does not include transactions between the bank account and brokerage account."}},"httpPath":"/api/v2/customers/{customer_id}/transactions/"},{"label":"List Partner Transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/transactions-v2/list-partner-transactions-v2","routeSlug":"/products/partner-api/reference/transactions-v2/list-partner-transactions-v2","metadata":{"seo":{"title":"List Partner Transactions","description":"Returns a list of pocket transactions. It does not include transactions between the bank account and brokerage account."}},"httpPath":"/api/v2/transactions/"},{"label":"Get Transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/transactions-v2/get-transaction-v2","routeSlug":"/products/partner-api/reference/transactions-v2/get-transaction-v2","metadata":{"seo":{"title":"Get Transaction","description":"Retrieves a single transaction activity by ID. A transaction activity represents a single side (debit/credit) of a transaction."}},"httpPath":"/api/v2/transactions/{transaction_activity_id}/"}]},{"type":"group","label":"Trades V2","link":"/products/partner-api/reference/trades-v2","routeSlug":"/products/partner-api/reference/trades-v2","items":[{"label":"List Customer Trades","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/trades-v2/list-customer-trades-v2","routeSlug":"/products/partner-api/reference/trades-v2/list-customer-trades-v2","metadata":{"seo":{"title":"List Customer Trades","description":"Returns a list of trades from a customer's brokerage accounts. Includes standard trades (BUY, SELL, MATURITY) and security transfer trades."}},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"httpPath":"/api/v2/customers/{customer_id}/trades/"}]},{"type":"separator","label":"Platform V2"},{"type":"group","label":"Health","link":"/products/partner-api/reference/health","routeSlug":"/products/partner-api/reference/health","items":[{"label":"Get Health Check","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/health/get-health-check","routeSlug":"/products/partner-api/reference/health/get-health-check","metadata":{"seo":{"title":"Get Health Check","description":"A health check endpoint, which returns \"OK\" if the Partner API is up and running."}},"httpPath":"/health"}]},{"type":"separator","label":"Transfers V2"},{"type":"group","label":"Counterparties V2","link":"/products/partner-api/reference/counterparties-v2","routeSlug":"/products/partner-api/reference/counterparties-v2","items":[{"label":"List Counterparties","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/counterparties-v2/list_counterparties_api_v2_customers__customer_id__counterparties__get","routeSlug":"/products/partner-api/reference/counterparties-v2/list_counterparties_api_v2_customers__customer_id__counterparties__get","metadata":{"seo":{"title":"List Counterparties","description":"Retrieve a list of counterparties for a given account."}},"httpPath":"/api/v2/customers/{customer_id}/counterparties/"},{"label":"Create Counterparty","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/counterparties-v2/create_counterparty_api_v2_customers__customer_id__counterparties__post","routeSlug":"/products/partner-api/reference/counterparties-v2/create_counterparty_api_v2_customers__customer_id__counterparties__post","metadata":{"seo":{"title":"Create Counterparty","description":"Creates a counterparty with the provided parameters. There are currently two types of verification available - verification with supporting documents, and with an incoming wire."}},"httpPath":"/api/v2/customers/{customer_id}/counterparties/"},{"label":"Get Counterparty","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/counterparties-v2/get_counterparty_api_v2_customers__customer_id__counterparties__counterparty_id___get","routeSlug":"/products/partner-api/reference/counterparties-v2/get_counterparty_api_v2_customers__customer_id__counterparties__counterparty_id___get","metadata":{"seo":{"title":"Get Counterparty","description":"Get Counterparty"}},"httpPath":"/api/v2/customers/{customer_id}/counterparties/{counterparty_id}/"},{"label":"Update Counterparty","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/counterparties-v2/update_counterparty_api_v2_customers__customer_id__counterparties__counterparty_id___patch","routeSlug":"/products/partner-api/reference/counterparties-v2/update_counterparty_api_v2_customers__customer_id__counterparties__counterparty_id___patch","metadata":{"seo":{"title":"Update Counterparty","description":"Update Counterparty"}},"httpPath":"/api/v2/customers/{customer_id}/counterparties/{counterparty_id}/"}]}],"icon":"code"},{"type":"link","fsPath":"products/partner-api/changelog.md","metadata":{"type":"markdown"},"label":"Changelog","link":"/products/partner-api/changelog","routeSlug":"/products/partner-api/changelog","icon":"bars-sort"}]}