Jump to

• Request
• Response

List Wallets

get

/v1/uwaas/wallets

List wallet inventory across organizations or scoped to caller organization based on authorization.

Request

Query Parameters

• instanceId: string
  Example:

  4fb56966-7646-487b-9a5f-747162e919fd

• nextPageToken: string
  Opaque cursor returned by the previous list response.
• orgId: string
  Example:

  default_org

• pageSize: integer
  Minimum Value: 1

  Maximum Value: 100

  Default Value: 5

  Example:

  5

• userId: string
  Example:

  user-7

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Wallets retrieved successfully.

Body ()

Root Schema : ListWalletsResponse

Type: object

Show Source

• items(required): array items
• nextPageToken: string
  Opaque cursor for the next page. Omitted or null when there are no more records.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ListedWallet"
            }
        },
        "nextPageToken":{
            "type":"string",
            "nullable":true,
            "description":"Opaque cursor for the next page. Omitted or null when there are no more records."
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object ListedWallet

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ListedWallet"
    }
}

Nested Schema : ListedWallet

Type: object

Show Source

• address(required): string
  Read Only: true
• blockchainType(required): string
  Read Only: true

  Example: BESU
• createdBy(required): string
  Read Only: true
• createdDate(required): string (date-time)
  Read Only: true

  RFC 3339 timestamp in UTC (for example, `2026-07-30T06:56:08Z`).
• instanceId(required): string
  Read Only: true

  External infrastructure instance identifier
• label(required): string
• orgId(required): string
  Read Only: true

  External organization identifier
• orgNetworkId(required): integer (int64)
  Read Only: true
• ownershipType: string
  Default Value: USER

  Allowed Values: [ "USER", "SERVICE" ]

  Type of wallet ownership. Defaults to USER
• status(required): string
  Allowed Values: [ "ACTIVE", "INACTIVE", "CLOSED" ]

  Wallet lifecycle status.

  Example: ACTIVE
• type(required): string
  Allowed Values: [ "1" ]

  Wallet type used by Wallet Admin UI. "1" = Custodial.

  Example: 1
• typeLabel(required): string
  Read Only: true

  Example: Governed
• updatedBy: string
  Read Only: true
• updatedDate: string (date-time)
  Read Only: true

  RFC 3339 timestamp in UTC (for example, `2026-07-30T06:56:08Z`).
• userId(required): string
  Read Only: true
• walletId(required): string
  Read Only: true
• walletTags(required): array walletTags
  Read Only: true

{
    "type":"object",
    "properties":{
        "walletId":{
            "type":"string",
            "readOnly":true
        },
        "orgId":{
            "type":"string",
            "description":"External organization identifier",
            "readOnly":true
        },
        "orgNetworkId":{
            "type":"integer",
            "format":"int64",
            "readOnly":true
        },
        "instanceId":{
            "type":"string",
            "description":"External infrastructure instance identifier",
            "readOnly":true
        },
        "blockchainType":{
            "type":"string",
            "readOnly":true,
            "example":"BESU"
        },
        "userId":{
            "type":"string",
            "readOnly":true
        },
        "status":{
            "$ref":"#/components/schemas/WalletStatus"
        },
        "label":{
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/WalletType"
        },
        "typeLabel":{
            "type":"string",
            "readOnly":true,
            "example":"Governed"
        },
        "ownershipType":{
            "$ref":"#/components/schemas/OwnershipType"
        },
        "address":{
            "type":"string",
            "readOnly":true
        },
        "createdDate":{
            "type":"string",
            "format":"date-time",
            "description":"RFC 3339 timestamp in UTC (for example, `2026-07-30T06:56:08Z`).",
            "readOnly":true
        },
        "updatedDate":{
            "type":"string",
            "format":"date-time",
            "description":"RFC 3339 timestamp in UTC (for example, `2026-07-30T06:56:08Z`).",
            "nullable":true,
            "readOnly":true
        },
        "createdBy":{
            "type":"string",
            "readOnly":true
        },
        "updatedBy":{
            "type":"string",
            "nullable":true,
            "readOnly":true
        },
        "walletTags":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "readOnly":true
        }
    },
    "required":[
        "walletId",
        "orgId",
        "orgNetworkId",
        "instanceId",
        "blockchainType",
        "userId",
        "status",
        "label",
        "type",
        "typeLabel",
        "address",
        "createdDate",
        "createdBy",
        "walletTags"
    ]
}

Nested Schema : walletTags

Type: array

Read Only: true

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "readOnly":true
}

400 Response

Bad request.

Body ()

Root Schema : Error

Type: object

Show Source

• details(required): array details
• error(required): string
  Example: Wallet Not Found
• errorCode(required): string
  Example: WALLET_NOT_FOUND
• message(required): string
  Example: Wallet with id 123 was not found.
• path(required): string
  Example: /v1/uwaas/wallets/123
• status(required): integer
  Example: 404
• timestamp(required): string (date-time)
  Example: 2026-07-16T14:23:11.123Z

{
    "type":"object",
    "properties":{
        "timestamp":{
            "type":"string",
            "format":"date-time",
            "example":"2026-07-16T14:23:11.123Z"
        },
        "status":{
            "type":"integer",
            "example":404
        },
        "error":{
            "type":"string",
            "example":"Wallet Not Found"
        },
        "path":{
            "type":"string",
            "example":"/v1/uwaas/wallets/123"
        },
        "errorCode":{
            "type":"string",
            "example":"WALLET_NOT_FOUND"
        },
        "message":{
            "type":"string",
            "example":"Wallet with id 123 was not found."
        },
        "details":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "timestamp",
        "status",
        "error",
        "path",
        "errorCode",
        "message",
        "details"
    ]
}

Nested Schema : details

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

401 Response

Unauthorized.

Body ()

Root Schema : Error

Type: object

Show Source

• details(required): array details
• error(required): string
  Example: Wallet Not Found
• errorCode(required): string
  Example: WALLET_NOT_FOUND
• message(required): string
  Example: Wallet with id 123 was not found.
• path(required): string
  Example: /v1/uwaas/wallets/123
• status(required): integer
  Example: 404
• timestamp(required): string (date-time)
  Example: 2026-07-16T14:23:11.123Z

{
    "type":"object",
    "properties":{
        "timestamp":{
            "type":"string",
            "format":"date-time",
            "example":"2026-07-16T14:23:11.123Z"
        },
        "status":{
            "type":"integer",
            "example":404
        },
        "error":{
            "type":"string",
            "example":"Wallet Not Found"
        },
        "path":{
            "type":"string",
            "example":"/v1/uwaas/wallets/123"
        },
        "errorCode":{
            "type":"string",
            "example":"WALLET_NOT_FOUND"
        },
        "message":{
            "type":"string",
            "example":"Wallet with id 123 was not found."
        },
        "details":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "timestamp",
        "status",
        "error",
        "path",
        "errorCode",
        "message",
        "details"
    ]
}

Nested Schema : details

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

500 Response

Internal server error.

Body ()

Root Schema : Error

Type: object

Show Source

• details(required): array details
• error(required): string
  Example: Wallet Not Found
• errorCode(required): string
  Example: WALLET_NOT_FOUND
• message(required): string
  Example: Wallet with id 123 was not found.
• path(required): string
  Example: /v1/uwaas/wallets/123
• status(required): integer
  Example: 404
• timestamp(required): string (date-time)
  Example: 2026-07-16T14:23:11.123Z

{
    "type":"object",
    "properties":{
        "timestamp":{
            "type":"string",
            "format":"date-time",
            "example":"2026-07-16T14:23:11.123Z"
        },
        "status":{
            "type":"integer",
            "example":404
        },
        "error":{
            "type":"string",
            "example":"Wallet Not Found"
        },
        "path":{
            "type":"string",
            "example":"/v1/uwaas/wallets/123"
        },
        "errorCode":{
            "type":"string",
            "example":"WALLET_NOT_FOUND"
        },
        "message":{
            "type":"string",
            "example":"Wallet with id 123 was not found."
        },
        "details":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "timestamp",
        "status",
        "error",
        "path",
        "errorCode",
        "message",
        "details"
    ]
}

Nested Schema : details

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top