> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Kaleido

> Kaleido is a full-stack platform for building and managing enterprise blockchain networks and applications.

![Kaleido logo](https://mintcdn.com/composio-preview/tIuAovF9-7pXq2wA/images/toolkits/kaleido.svg?fit=max\&auto=format\&n=tIuAovF9-7pXq2wA\&q=85\&s=22e8e6334c124bb9c8bf821b104c026e)

* **Category:** developer tools
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 29
* **Triggers:** 0
* **Slug:** `KALEIDO`
* **Version:** 20261101\_00

## Tools

> [accordion] Add Organization Identity Proof
>
> **Slug:** `KALEIDO_ADD_IDENTITY_PROOF`
>
> Add an X.509 identity proof to a Kaleido organization by submitting a named certificate chain. Identity proofs attest an asserted Kaleido identity and can be used with an organization-bound Ethereum address to establish an on-chain identity.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> A human-readable name for the identity proof, typically describing the certificate purpose (e.g., 'Root CA', 'Production Certificate')
>
> **type** `string`
>
> Type of the identity proof. Currently only 'x509' certificates are supported. Defaults to 'x509'.
>
> **org\_id** `string` *required*
>
> The Kaleido organization ID (e.g., 'u0cvzlsyw4'). Obtain this from the get\_organizations action.
>
> **payload** `string` *required*
>
> The Base64-encoded x509 certificate chain. This should be a valid PEM certificate converted to Base64 format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create API Key
>
> **Slug:** `KALEIDO_CREATE_API_KEY`
>
> Request an API key for a specified Kaleido organization, optionally providing a name. Kaleido states that its API key endpoints do not support generating new keys, so key generation is unavailable through this operation.
>
> #### Input Parameters
>
> **name** `string`
>
> Optional human-readable name for the API key to help identify its purpose
>
> **org\_id** `string` *required*
>
> The organization ID to create the API key for. Obtain this from the Get Organizations action
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete API Key
>
> **Slug:** `KALEIDO_DELETE_API_KEY`
>
> Permanently deletes an API key by its ID. First use 'Get API Keys' to retrieve the list of API keys and their IDs. The deletion is irreversible.
>
> #### Input Parameters
>
> **apikey\_id** `string` *required*
>
> The unique identifier of the API key to delete. You can find API key IDs by using the 'Get API Keys' action which returns a list of keys with their '\_id' field.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Organization Identity Proof
>
> **Slug:** `KALEIDO_DELETE_ORGANIZATION_IDENTITY_PROOF`
>
> Remove an x509 identity proof from a Kaleido organization. This permanently deletes the identity proof. The deletion is irreversible.
>
> #### Input Parameters
>
> **org\_id** `string` *required*
>
> The Kaleido organization ID (e.g., 'u0cvzlsyw4'). Obtain this from the get\_organizations action.
>
> **proof\_id** `string` *required*
>
> The unique identifier of the identity proof to delete. You can find proof IDs by listing identity proofs for an organization.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get API Key
>
> **Slug:** `KALEIDO_GET_API_KEY`
>
> Tool to retrieve details of a specific API key by its ID. Use when you need to get information about a particular API key after obtaining its ID from the Get API Keys action.
>
> #### Input Parameters
>
> **apikey\_id** `string` *required*
>
> The unique identifier of the API key to retrieve. You can find API key IDs by using the 'Get API Keys' action which returns a list of keys with their '\_id' field.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get API Keys
>
> **Slug:** `KALEIDO_GET_API_KEYS`
>
> Tool to retrieve all API keys associated with the organization. Use when you need an overview of existing API keys after authenticating.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Application Credentials
>
> **Slug:** `KALEIDO_GET_APPLICATION_CREDENTIALS`
>
> List application credential records for a specified Kaleido consortium environment. These credentials are bound to memberships and secure external access to nodes; use the listing to inspect credentials available in the environment. A missing environment or consortium can also result in an empty list.
>
> #### Input Parameters
>
> **consortia\_id** `string` *required*
>
> ID of the consortium
>
> **environment\_id** `string` *required*
>
> ID of the environment
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Billing Summary
>
> **Slug:** `KALEIDO_GET_BILLING_SUMMARY`
>
> Retrieve an organization's billing summary, with optional month and year, including costs for memberships, nodes, services, storage, and support.
>
> #### Input Parameters
>
> **year** `string`
>
> The year (e.g., 2024, 2025). Defaults to current year if not specified.
>
> **month** `string`
>
> The month name (e.g., january, february, etc.). Defaults to current month if not specified.
>
> **org\_id** `string` *required*
>
> Organization identifier
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Consortia
>
> **Slug:** `KALEIDO_GET_CONSORTIA`
>
> Retrieve consortia associated with the organization, with optional offset and limit for pagination.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of records to skip for pagination (offset-based)
>
> **limit** `integer`
>
> Maximum number of consortia to return per request
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Event Streams
>
> **Slug:** `KALEIDO_GET_EVENT_STREAMS`
>
> List event stream configurations on a Kaleido node's Ethconnect gateway. Event streams deliver Ethereum events to webhook endpoints or WebSocket connections. Supply a full gateway URL or the environment ID, node ID, and zone domain; the tool can fall back to the console endpoint.
>
> #### Input Parameters
>
> **node\_id** `string`
>
> Kaleido node ID exposing Ethconnect (used for URL composition)
>
> **full\_url** `string`
>
> Override base URL completely. If this already includes /eventstreams it will be used as-is.
>
> **zone\_domain** `string`
>
> Zone domain used to reach the Ethconnect gateway (e.g., us-east-1.connect.kaleido.io)
>
> **environment\_id** `string`
>
> Kaleido environment ID (used for Ethconnect URL composition)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization Identity Proof
>
> **Slug:** `KALEIDO_GET_IDENTITY_PROOF`
>
> Tool to retrieve a specific identity proof for a Kaleido organization. Use when you need details about a specific x509 certificate or identity proof that was previously added to an organization.
>
> #### Input Parameters
>
> **org\_id** `string` *required*
>
> The Kaleido organization ID (e.g., 'u0cvzlsyw4'). Obtain this from the get\_organizations action.
>
> **proof\_id** `string` *required*
>
> The unique identifier of the identity proof to retrieve (e.g., 'u0wpjdqkha').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Invitations
>
> **Slug:** `KALEIDO_GET_INVITATIONS`
>
> Tool to retrieve all invitations for the current user where they are the target. Use after authenticating to view pending invitations.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Memberships
>
> **Slug:** `KALEIDO_GET_MEMBERSHIPS`
>
> Tool to retrieve all memberships for the current user. Use after authenticating to list user memberships.
>
> #### Input Parameters
>
> **query** `string`
>
> Optional Mongo-style query string to filter memberships
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization
>
> **Slug:** `KALEIDO_GET_ORGANIZATION`
>
> Tool to retrieve details of a specific Kaleido organization by its ID. Use when you need to fetch information about a particular organization.
>
> #### Input Parameters
>
> **org\_id** `string` *required*
>
> Unique organization identifier
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization Plan
>
> **Slug:** `KALEIDO_GET_ORGANIZATION_PLAN`
>
> Retrieve the subscription plan details for a Kaleido organization. Returns plan name, waitlist status, and resource limits including allowed providers, nodes, services, configurations, and features. Use GET\_ORGANIZATIONS first to obtain valid org\_id values.
>
> #### Input Parameters
>
> **org\_id** `string` *required*
>
> The unique Kaleido organization ID (e.g., 'u0cvzlsyw4'). Obtain this from the GET\_ORGANIZATIONS action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organizations
>
> **Slug:** `KALEIDO_GET_ORGANIZATIONS`
>
> Retrieve Kaleido organizations accessible to the authenticated user, including available organization, subscription and billing details. Use the results to discover organizations for subsequent organization-specific operations.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization Billing Provider
>
> **Slug:** `KALEIDO_GET_ORG_BILLING_PROVIDER`
>
> Retrieves billing provider information for a specific organization in Kaleido. Returns the type of billing provider (AWS, Stripe, or other) and includes detailed payment information if the organization uses Stripe billing (card details, billing address).
>
> #### Input Parameters
>
> **org\_id** `string` *required*
>
> Unique organization identifier
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Plans
>
> **Slug:** `KALEIDO_GET_PLANS`
>
> Retrieve all available Kaleido subscription plans. Returns plan details including enabled status, tier level, and resource limits. Use this to discover available plans before creating or upgrading environments.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Regions
>
> **Slug:** `KALEIDO_GET_REGIONS`
>
> Retrieve all available Kaleido deployment regions and their deployment zones. Returns a dictionary of regions (keyed by region code like 'u0', 'e0', 'a0', 'k0', 'u1', 'e1') with each region containing its API console host URL and available deployment zones. Use this action to discover which geographic regions are available for deploying blockchain environments and whether they are currently accepting new deployments.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Releases
>
> **Slug:** `KALEIDO_GET_RELEASES`
>
> Retrieve all available blockchain node software releases from the Kaleido platform. Use this tool to: - List all runtime releases available for different blockchain providers (quorum, geth, besu, corda, fabric) - Check version information and release statuses (ga, beta, interim, deprecated) - Find container image tags associated with each release - Understand upgrade prerequisites via prereq\_eips and optional\_eips fields Returns a list of releases sorted by creation date, including current and historical versions. No input parameters are required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Role By ID
>
> **Slug:** `KALEIDO_GET_ROLE_BY_ID`
>
> Retrieve a specific user role assignment within a Kaleido organization. Returns detailed information about the role including user ID, email, role name (e.g., 'admin'), and associated metadata. Use GET\_ORGANIZATIONS to obtain org\_id and GET\_ROLES to obtain role\_id values.
>
> #### Input Parameters
>
> **org\_id** `string` *required*
>
> The unique Kaleido organization ID (e.g., 'u0cvzlsyw4'). Obtain this from the GET\_ORGANIZATIONS action.
>
> **role\_id** `string` *required*
>
> The unique role assignment ID (e.g., 'u0xvg2zbom'). Obtain this from the GET\_ROLES action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Roles
>
> **Slug:** `KALEIDO_GET_ROLES`
>
> Retrieve all user role assignments for a Kaleido organization. Returns each user's role (e.g., 'admin'), email, and associated metadata. Use GET\_ORGANIZATIONS first to obtain valid org\_id values.
>
> #### Input Parameters
>
> **org\_id** `string` *required*
>
> The unique Kaleido organization ID (e.g., 'u0cvzlsyw4'). Obtain this from the GET\_ORGANIZATIONS action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Services
>
> **Slug:** `KALEIDO_GET_SERVICES`
>
> Tool to retrieve all services the current user owns or can see. Use after authenticating to list available services.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Token Factory Tokens
>
> **Slug:** `KALEIDO_GET_TOKEN_FACTORY_TOKENS`
>
> List token contracts from a Kaleido Token Factory service, including their type, deployment details, and minting and burning capabilities. Supply the service API base URL to query the provisioned service; it manages ERC20 and ERC721 token contracts.
>
> #### Input Parameters
>
> **service\_api\_base\_url** `string`
>
> Base URL of the Token Factory service API. Get this from the 'urls' field of your Token Factory service using GET /services. Example: '[https://u0xxxx-u0xxxx-tokenfactory.kaleido.io/api/v1](https://u0xxxx-u0xxxx-tokenfactory.kaleido.io/api/v1)'. If not provided, uses the default console base URL (may return empty results if no global tokens exist).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Wallet Account Nonce
>
> **Slug:** `KALEIDO_GET_WALLET_ACCOUNT_NONCE`
>
> Retrieve the current nonce (transaction count) of a specific HD wallet account. The nonce is essential for signing Ethereum transactions - it ensures transactions are processed in order and prevents replay attacks. Call this before signing a transaction to get the correct nonce value. Prerequisites: - An HD Wallet service must be provisioned in your Kaleido environment - A wallet must exist (created via POST /wallets) - You need the service API base URL from GET /services endpoint
>
> #### Input Parameters
>
> **wallet\_id** `string` *required*
>
> The unique identifier of the HD wallet instance. Obtain this from the GET /wallets endpoint.
>
> **account\_index** `integer` *required*
>
> The derivation index of the account within the HD wallet (0 to 2,147,483,648). Each index represents a unique Ethereum account derived from the wallet's seed.
>
> **service\_api\_base\_url** `string` *required*
>
> The base URL of the HD Wallet service API. This is REQUIRED as the nonce endpoint is only available on HD Wallet service instances, not the console API. Obtain this URL from the service's 'urls' field via GET /services endpoint. Format: https\://\<service\_host>/api/v1
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Wallets
>
> **Slug:** `KALEIDO_GET_WALLETS`
>
> Retrieve HD wallet IDs hosted by a Kaleido HD Wallet service. Use the service API base URL to enumerate available wallets after creating or importing them.
>
> #### Input Parameters
>
> **service\_api\_base\_url** `string`
>
> Override the base URL for the HD Wallet service API, e.g., https\://\<service\_host>/api/v1. If provided, the wallets will be retrieved from this service instead of the console base URL.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Organization
>
> **Slug:** `KALEIDO_UPDATE_ORGANIZATION`
>
> Tool to update a specific organization in Kaleido. Use when you need to modify organization properties such as name, billing details, or authentication settings. First obtain the org\_id using the Get Organizations action.
>
> #### Input Parameters
>
> **name** `string`
>
> User-friendly organization name to update
>
> **plan** `string`
>
> Subscription plan name for the organization
>
> **org\_id** `string` *required*
>
> The unique identifier of the organization to update. Obtain this from the Get Organizations action
>
> **plan\_id** `string`
>
> Subscription plan identifier
>
> **delegate** `string`
>
> Email to be exposed on consortia memberships as contact info
>
> **trial\_ends** `string`
>
> Date when the organization's trial is expected to end (ISO8601 format)
>
> **waitlisted** `boolean`
>
> Whether the organization is waitlisted
>
> **support\_level** `integer`
>
> The level of support entitlement for the organization (100-300)
>
> **cognito\_domain** `string`
>
> The Cognito domain name such as 'mydomain.auth.us-east-1.amazoncognito.com' (only used for Enterprise logins)
>
> **cognito\_region** `string`
>
> The Cognito region (only used for Enterprise logins)
>
> **terms\_accepted** `integer`
>
> Timestamp of the last time terms and conditions were accepted for this org (Unix milliseconds)
>
> **billing\_account** `object`
>
> Billing account details for updating an organization.
>
> **cognito\_client\_id** `string`
>
> The client\_id of the App client created for Kaleido (only used for Enterprise logins)
>
> **cognito\_user\_pool\_id** `string`
>
> The Cognito user pool ID (only used for Enterprise logins)
>
> **cognito\_client\_secret** `string`
>
> The client\_secret of the App client created for Kaleido (only used for Enterprise logins)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Organization Role
>
> **Slug:** `KALEIDO_UPDATE_ORG_ROLE`
>
> Update a user's role assignment in a Kaleido organization to admin. Returns the updated role details, including revision token and update timestamp.
>
> #### Input Parameters
>
> **role** `string ("admin")` *required*
>
> The role to assign to the user within this organization
>
> **org\_id** `string` *required*
>
> The unique Kaleido organization ID (e.g., 'u0cvzlsyw4'). Obtain this from the GET\_ORGANIZATIONS action.
>
> **role\_id** `string` *required*
>
> The unique identifier for the role assignment to update. Obtain this from the GET\_ROLES action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upsert Organization Role
>
> **Slug:** `KALEIDO_UPSERT_ORGANIZATION_ROLE`
>
> Upsert an admin role assignment for a user in a Kaleido organization using the organization and role IDs. Returns the role assignment and its revision.
>
> #### Input Parameters
>
> **role** `string ("admin")` *required*
>
> The role to assign to the user within this organization. Currently only 'admin' is supported.
>
> **org\_id** `string` *required*
>
> The unique Kaleido organization ID (e.g., 'u0cvzlsyw4'). Obtain this from the GET\_ORGANIZATIONS action.
>
> **role\_id** `string` *required*
>
> The unique role assignment ID (e.g., 'u0test1234'). For new roles, use a unique identifier; for updates, use the existing role ID.
>
> **user\_id** `string` *required*
>
> The ID of the user to assign the role to. This is required when creating a new role assignment.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
