{ "openapi":"3.0.3", "info":{ "title":"Digital Assets Wallet and Transactions APIs", "version":"2026.09.30", "description":"Digital Assets Wallet and Transactions APIs", "x-summary":"Digital Assets Wallet and Transactions APIs" }, "tags":[ { "name":"Governance", "description":"Governance endpoints." }, { "name":"Health", "description":"Health and readiness endpoints." }, { "name":"Wallets", "description":"Wallet management, transfers, balances, and contract deployment endpoints." } ], "paths":{ "/walletservice/v1/wallets":{ "get":{ "tags":[ "Wallets" ], "summary":"List Wallets", "description":"Lists canonical UWaaS wallet records. The returned item format is also used by the wallet-by-address endpoint.\n", "operationId":"listWalletsV1", "parameters":[ { "name":"orgId", "in":"query", "required":false, "schema":{ "type":"integer", "format":"int64" } }, { "name":"walletServiceId", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"userId", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"instanceId", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"status", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"type", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"search", "in":"query", "required":false, "schema":{ "type":"string" } }, { "name":"pageSize", "in":"query", "required":false, "schema":{ "type":"integer", "minimum":1, "maximum":100, "default":50 } }, { "name":"nextPageToken", "in":"query", "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Wallets retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ListWalletsResponse" } } } }, "400":{ "$ref":"#/components/responses/BadRequest" }, "401":{ "$ref":"#/components/responses/Unauthorized" }, "500":{ "$ref":"#/components/responses/InternalServerError" } }, "security":[ { "bearerAuth":[ ] } ], "x-internal-id":"walletservice-v1-wallets-get", "x-filename-id":"walletservice-v1-wallets-get" } }, "/walletservice/v1/wallets/{address}":{ "get":{ "tags":[ "Wallets" ], "summary":"Get Wallet by Address", "description":"Retrieve the canonical wallet-list record by blockchain address.", "operationId":"getWalletByAddress", "parameters":[ { "$ref":"#/components/parameters/Address" } ], "responses":{ "200":{ "description":"Wallet retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ListedWallet" } } } }, "400":{ "$ref":"#/components/responses/BadRequest" }, "401":{ "$ref":"#/components/responses/Unauthorized" }, "404":{ "$ref":"#/components/responses/NotFound" }, "500":{ "$ref":"#/components/responses/InternalServerError" } }, "security":[ { "bearerAuth":[ ] } ], "x-internal-id":"walletservice-v1-wallets-{address}-get", "x-filename-id":"walletservice-v1-wallets-address-get" } }, "/walletservice/v1/wallets/{walletAddress}/assets/erc20/{contractAddress}/balance":{ "get":{ "tags":[ "Wallets" ], "summary":"Get ERC20 Balance", "description":"Retrieve the ERC-20 token balance for the specified wallet address and contract address.", "operationId":"getErc20Balance", "parameters":[ { "$ref":"#/components/parameters/WalletAddress" }, { "name":"contractAddress", "in":"path", "required":true, "schema":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" } } ], "responses":{ "200":{ "description":"Balance retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/WalletBalanceResponse" } } } }, "400":{ "$ref":"#/components/responses/BadRequest" }, "500":{ "$ref":"#/components/responses/InternalServerError" } }, "security":[ { "bearerAuth":[ ] } ], "x-internal-id":"walletservice-v1-wallets-{walletAddress}-assets-erc20-{contractAddress}-balance-get", "x-filename-id":"walletservice-v1-wallets-walletaddress-assets-erc20-contractaddress-balance-get" } }, "/walletservice/v1/wallets/{walletAddress}/balance/{contractAddress}":{ "get":{ "tags":[ "Wallets" ], "summary":"Get Wallet Balance by Contract", "description":"Retrieve balance for wallet address and contract address.", "operationId":"getBalanceByContract", "parameters":[ { "$ref":"#/components/parameters/WalletAddress" }, { "name":"contractAddress", "in":"path", "required":true, "schema":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" } } ], "responses":{ "200":{ "description":"Balance retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/WalletBalanceResponse" } } } }, "400":{ "$ref":"#/components/responses/BadRequest" }, "500":{ "$ref":"#/components/responses/InternalServerError" } }, "security":[ { "bearerAuth":[ ] } ], "x-internal-id":"walletservice-v1-wallets-{walletAddress}-balance-{contractAddress}-get", "x-filename-id":"walletservice-v1-wallets-walletaddress-balance-contractaddress-get" } }, "/walletservice/v1/wallets/{walletId}/deploy-contract":{ "post":{ "tags":[ "Wallets" ], "summary":"Deploy Contract", "description":"Deploy a smart contract from a wallet.", "operationId":"deployContract", "parameters":[ { "$ref":"#/components/parameters/WalletId" } ], "requestBody":{ "$ref":"#/components/requestBodies/DeployContractRequest" }, "responses":{ "200":{ "description":"Contract deployment submitted successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ContractDeploymentResponse" } } } }, "500":{ "$ref":"#/components/responses/InternalServerError" } }, "security":[ { "bearerAuth":[ ] } ], "x-internal-id":"walletservice-v1-wallets-{walletId}-deploy-contract-post", "x-filename-id":"walletservice-v1-wallets-walletid-deploy-contract-post" } }, "/walletservice/v1/wallets/{walletId}/sign":{ "post":{ "tags":[ "Wallets" ], "summary":"Sign Transaction or Typed Data", "description":"Sign EVM transaction payloads (and EIP-712 payloads via kind=eip712) with the specified wallet.", "operationId":"signWalletPayload", "parameters":[ { "$ref":"#/components/parameters/WalletId" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SignTransactionRequest" }, "examples":{ "transactionSign":{ "value":{ "blockchainKind":"evm", "kind":"transaction", "data":{ "from":"0xa537b178b12E40EC07c361Fa1D5bb1f6770f7262", "to":"0x2a58b1eb2f8821c3001eece71921ce977f6529ad", "data":"0x", "gas":21000, "gasPrice":0, "nonce":0, "value":0, "chainId":1337 }, "rpcUrl":"http://127.0.0.1:8545" } }, "eip712Sign":{ "value":{ "blockchainKind":"evm", "kind":"eip712", "data":{ "typed_data":{ "types":{ "EIP712Domain":[ { "name":"name", "type":"string" }, { "name":"version", "type":"string" }, { "name":"chainId", "type":"uint256" } ], "Mail":[ { "name":"contents", "type":"string" } ] }, "primaryType":"Mail", "domain":{ "name":"UWaaS", "version":"1", "chainId":1337 }, "message":{ "contents":"Hello from UWaaS" } } } } } } } } }, "responses":{ "200":{ "description":"Payload signed successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SignTransactionResponse" }, "examples":{ "transactionSignResponse":{ "value":{ "walletId":"5b018c64-bde8-4927-8183-93cda4422a23", "dateSigned":"2026-05-26T19:23:08.736547549Z", "signature":{ "r":null, "s":null, "v":null, "recid":null, "encoded":"0xf91f0..." } } }, "eip712SignResponse":{ "value":{ "walletId":"5b018c64-bde8-4927-8183-93cda4422a23", "dateSigned":"2026-05-26T19:25:08.736547549Z", "signature":{ "r":"0x1c3b...", "s":"0x5ad8...", "v":27, "recid":0, "encoded":"0x1c3b...5ad8...1b" } } } } } } }, "400":{ "$ref":"#/components/responses/BadRequest" }, "500":{ "$ref":"#/components/responses/InternalServerError" } }, "security":[ { "bearerAuth":[ ] } ], "x-internal-id":"walletservice-v1-wallets-{walletId}-sign-post", "x-filename-id":"walletservice-v1-wallets-walletid-sign-post" } }, "/walletservice/v1/wallets/{walletAddress}/transfers":{ "post":{ "tags":[ "Wallets" ], "summary":"Create Wallet Transfer", "description":"Submit a native or token transfer from the specified wallet.", "operationId":"createWalletTransfer", "parameters":[ { "$ref":"#/components/parameters/WalletAddress" }, { "$ref":"#/components/parameters/SubmissionMode" }, { "name":"rpcUrl", "in":"query", "required":false, "schema":{ "type":"string", "format":"uri" } }, { "name":"chainId", "in":"query", "required":false, "schema":{ "type":"string" } } ], "requestBody":{ "$ref":"#/components/requestBodies/WalletTransferRequest" }, "responses":{ "200":{ "description":"Transfer submitted successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TransferSubmissionResponse" } } } }, "400":{ "$ref":"#/components/responses/BadRequest" }, "500":{ "$ref":"#/components/responses/InternalServerError" } }, "security":[ { "bearerAuth":[ ] } ], "x-internal-id":"walletservice-v1-wallets-{walletAddress}-transfers-post", "x-filename-id":"walletservice-v1-wallets-walletaddress-transfers-post" } }, "/walletservice/v1/wallets/{walletAddress}/transfers/{transactionId}":{ "get":{ "tags":[ "Wallets" ], "summary":"Get Transfer by Transaction ID", "description":"Retrieve a transfer by wallet ID and transaction ID.", "operationId":"getWalletTransferById", "parameters":[ { "$ref":"#/components/parameters/WalletAddress" }, { "$ref":"#/components/parameters/TransactionId" } ], "responses":{ "200":{ "description":"Transfer retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TransferRecord" } } } }, "400":{ "$ref":"#/components/responses/BadRequest" }, "404":{ "$ref":"#/components/responses/NotFound" }, "500":{ "$ref":"#/components/responses/InternalServerError" } }, "security":[ { "bearerAuth":[ ] } ], "x-internal-id":"walletservice-v1-wallets-{walletAddress}-transfers-{transactionId}-get", "x-filename-id":"walletservice-v1-wallets-walletaddress-transfers-transactionid-get" } }, "/walletservice/v1/wallets/{walletAddress}/transfers/by-transaction-hash/{transactionHash}":{ "get":{ "tags":[ "Wallets" ], "summary":"Get Transfer by Transaction Hash", "description":"Retrieve a transfer by wallet ID and blockchain transaction hash.", "operationId":"getWalletTransferByHash", "parameters":[ { "$ref":"#/components/parameters/WalletAddress" }, { "$ref":"#/components/parameters/TransactionHash" } ], "responses":{ "200":{ "description":"Transfer retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TransferRecord" } } } }, "404":{ "$ref":"#/components/responses/NotFound" }, "500":{ "$ref":"#/components/responses/InternalServerError" } }, "security":[ { "bearerAuth":[ ] } ], "x-internal-id":"walletservice-v1-wallets-{walletAddress}-transfers-by-transaction-hash-{transactionHash}-get", "x-filename-id":"walletservice-v1-wallets-walletaddress-transfers-transaction-hash-transactionhash-get" } }, "/walletservice/v1/wallets/uploadkey":{ "post":{ "tags":[ "Wallets" ], "summary":"Upload Wallet Key", "description":"Create or import a wallet from an uploaded private key.", "operationId":"uploadWalletKey", "requestBody":{ "$ref":"#/components/requestBodies/UploadKeyRequest" }, "responses":{ "201":{ "description":"Wallet key uploaded successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CreateWalletResponse" }, "example":{ "walletServiceWalletId":"0x81e1336f565f431c3f276d16a53f4b10d79f2d06", "networkId":24155, "address":"0x81e1336f565f431c3f276d16a53f4b10d79f2d06", "publicKey":"47e26a1761d359db190a9e464e6fdd0b40ea9dfee42dd4ad4f1062c5d30ebe30dcbbee8045c8024432a53f14297125fff787c403606f9d495796a4d8472dace0", "label":"localWallet Key 1", "status":"ACTIVE", "providerType":"ASKAR", "providerWalletRef":"ae13bcb1-f3f4-4302-b97d-71e6c4529610" } } } }, "400":{ "$ref":"#/components/responses/BadRequest" }, "401":{ "$ref":"#/components/responses/Unauthorized" }, "404":{ "$ref":"#/components/responses/NotFound" }, "500":{ "$ref":"#/components/responses/InternalServerError" } }, "security":[ { "bearerAuth":[ ] } ], "x-internal-id":"walletservice-v1-wallets-uploadkey-post", "x-filename-id":"walletservice-v1-wallets-uploadkey-post" } }, "/ready":{ "get":{ "tags":[ "Health" ], "summary":"Readiness Check", "description":"Basic uptime/readiness check.", "operationId":"ready", "responses":{ "200":{ "description":"Service is up.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ReadyResponse" }, "example":{ "message":"OK" } } } }, "500":{ "$ref":"#/components/responses/InternalServerError" } }, "security":[ ], "x-internal-id":"ready-get", "x-filename-id":"ready-get" } }, "/observe/health":{ "get":{ "tags":[ "Health" ], "summary":"Observe Health", "description":"Returns the health status.", "operationId":"observeHealth", "responses":{ "204":{ "description":"Health observation completed successfully. No response body is returned." }, "500":{ "$ref":"#/components/responses/InternalServerError" } }, "security":[ ], "x-internal-id":"observe-health-get", "x-filename-id":"observe-health-get" } }, "/v1/governance/daadmin":{ "post":{ "tags":[ "Governance" ], "summary":"Add a DA Administrator", "description":"Adds a blockchain address to the network's governance configuration as a DA administrator.", "operationId":"addDaAdmin", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AddDaAdminRequest" } } } }, "responses":{ "200":{ "description":"Transaction receipt confirmed", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SyncGovernanceResponse" } } } }, "202":{ "description":"Transaction submitted or receipt not yet available", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AsyncGovernanceResponse" } } } }, "400":{ "$ref":"#/components/responses/BadRequest" }, "401":{ "$ref":"#/components/responses/Unauthorized" }, "403":{ "$ref":"#/components/responses/Forbidden" }, "404":{ "$ref":"#/components/responses/NotFound" }, "500":{ "$ref":"#/components/responses/InternalServerError" } }, "security":[ { "bearerAuth":[ ] } ], "x-internal-id":"v1-governance-daadmin-post", "x-filename-id":"v1-governance-daadmin-post" }, "delete":{ "tags":[ "Governance" ], "summary":"Remove a DA Administrator", "description":"Removes a DA administrator.", "operationId":"removeDaAdmin", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RemoveDaAdminRequest" } } } }, "responses":{ "200":{ "description":"Transaction receipt confirmed" }, "202":{ "description":"Transaction submitted or receipt not yet available" }, "400":{ "$ref":"#/components/responses/BadRequest" }, "404":{ "$ref":"#/components/responses/NotFound" }, "500":{ "$ref":"#/components/responses/InternalServerError" } }, "security":[ { "bearerAuth":[ ] } ], "x-internal-id":"v1-governance-daadmin-delete", "x-filename-id":"v1-governance-daadmin-delete" } }, "/v1/governance/approvers":{ "post":{ "tags":[ "Governance" ], "summary":"Add Policy Approvers", "description":"Adds one or more blockchain addresses as approvers for the policy identified by `uuid`, submitting the governance transaction from the specified `fromAddress`.", "operationId":"addApprovers", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AddApproversRequest" } } } }, "responses":{ "200":{ "description":"Transaction receipt confirmed", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SyncGovernanceResponse" } } } }, "202":{ "description":"Transaction submitted or receipt not yet available", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AsyncGovernanceResponse" } } } }, "400":{ "$ref":"#/components/responses/BadRequest" }, "401":{ "$ref":"#/components/responses/Unauthorized" }, "404":{ "$ref":"#/components/responses/NotFound" }, "500":{ "$ref":"#/components/responses/InternalServerError" } }, "security":[ { "bearerAuth":[ ] } ], "x-internal-id":"v1-governance-approvers-post", "x-filename-id":"v1-governance-approvers-post" }, "delete":{ "tags":[ "Governance" ], "summary":"Remove Policy Approvers", "description":"Remove policy approvers.", "operationId":"removeApprovers", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RemoveApproversRequest" } } } }, "responses":{ "200":{ "description":"Transaction receipt confirmed" }, "202":{ "description":"Transaction submitted or receipt not yet available" }, "400":{ "$ref":"#/components/responses/BadRequest" }, "404":{ "$ref":"#/components/responses/NotFound" }, "500":{ "$ref":"#/components/responses/InternalServerError" } }, "security":[ { "bearerAuth":[ ] } ], "x-internal-id":"v1-governance-approvers-delete", "x-filename-id":"v1-governance-approvers-delete" } }, "/v1/governance/policy":{ "get":{ "tags":[ "Governance" ], "summary":"Get Governance Policy", "description":"Returns the approval threshold and approver count for a policy UUID.", "operationId":"getPolicy", "parameters":[ { "name":"uuid", "in":"query", "required":true, "description":"UUID identifying the policy scope.", "schema":{ "type":"string", "format":"uuid" }, "example":"cafe0000-0000-4000-8000-000000000000" } ], "responses":{ "200":{ "description":"Policy retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GetPolicyResponse" }, "example":{ "threshold":3, "approverCount":0 } } } }, "400":{ "$ref":"#/components/responses/BadRequest" }, "401":{ "$ref":"#/components/responses/Unauthorized" }, "403":{ "$ref":"#/components/responses/Forbidden" }, "404":{ "description":"No policy exists for the specified UUID.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "$ref":"#/components/responses/InternalServerError" } }, "security":[ { "bearerAuth":[ ] } ], "x-internal-id":"v1-governance-policy-get", "x-filename-id":"v1-governance-policy-get" }, "put":{ "tags":[ "Governance" ], "summary":"Add or Update Policy", "description":"Creates or updates the governance policy identified by `uuid`, configuring its approval threshold and authorized deployer addresses through a transaction submitted by `fromAddress`.", "operationId":"addOrUpdatePolicy", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AddOrUpdatePolicyRequest" } } } }, "responses":{ "200":{ "description":"Transaction receipt confirmed", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SyncGovernanceResponse" } } } }, "202":{ "description":"Transaction submitted or receipt not yet available", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AsyncGovernanceResponse" } } } }, "400":{ "$ref":"#/components/responses/BadRequest" }, "401":{ "$ref":"#/components/responses/Unauthorized" }, "403":{ "$ref":"#/components/responses/Forbidden" }, "404":{ "$ref":"#/components/responses/NotFound" }, "500":{ "$ref":"#/components/responses/InternalServerError" } }, "security":[ { "bearerAuth":[ ] } ], "x-internal-id":"v1-governance-policy-put", "x-filename-id":"v1-governance-policy-put" } }, "/v1/governance/intents/approve":{ "post":{ "tags":[ "Governance" ], "summary":"Approve an Intent", "description":"Approves the governance intent identified by `intentId` by submitting an approval transaction from the specified `fromAddress`.", "operationId":"approveIntent", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApproveIntentRequest" } } } }, "responses":{ "200":{ "description":"Transaction receipt confirmed" }, "202":{ "description":"Transaction submitted or receipt not yet available" }, "400":{ "$ref":"#/components/responses/BadRequest" }, "404":{ "$ref":"#/components/responses/NotFound" }, "500":{ "$ref":"#/components/responses/InternalServerError" } }, "security":[ { "bearerAuth":[ ] } ], "x-internal-id":"v1-governance-intents-approve-post", "x-filename-id":"v1-governance-intents-approve-post" } }, "/v1/governance/intents/reject":{ "post":{ "tags":[ "Governance" ], "summary":"Reject an Intent", "description":"Rejects the governance intent identified by `intentId` by submitting an rejection transaction from the specified `fromAddress`.", "operationId":"rejectIntent", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RejectIntentRequest" } } } }, "responses":{ "200":{ "description":"Transaction receipt confirmed" }, "202":{ "description":"Transaction submitted or receipt not yet available" }, "400":{ "$ref":"#/components/responses/BadRequest" }, "401":{ "$ref":"#/components/responses/Unauthorized" }, "403":{ "$ref":"#/components/responses/Forbidden" }, "404":{ "$ref":"#/components/responses/NotFound" }, "500":{ "$ref":"#/components/responses/InternalServerError" } }, "security":[ { "bearerAuth":[ ] } ], "x-internal-id":"v1-governance-intents-reject-post", "x-filename-id":"v1-governance-intents-reject-post" } }, "/v1/governance/intents/deploy/latest":{ "get":{ "tags":[ "Governance" ], "summary":"Get Latest Deploy Intent", "description":"Retrieves the latest deploy governance intent for the policy scope identified by the required `uuid` query parameter, returning a `GovernanceIntent` object.", "operationId":"getLatestDeployIntent", "parameters":[ { "name":"uuid", "in":"query", "description":"uuid of policy scope", "required":true, "schema":{ "type":"string", "format":"uuid" } } ], "responses":{ "200":{ "$ref":"#/components/schemas/GovernanceIntent" } }, "x-internal-id":"v1-governance-intents-deploy-latest-get", "x-filename-id":"v1-governance-intents-deploy-latest-get" } }, "/v1/governance/intents/deploy":{ "post":{ "tags":[ "Governance" ], "summary":"Propose a Deploy Intent", "description":"Proposes a governance intent to deploy the specified components under the policy identified by `uuid`, with a defined deadline and transaction sender in `fromAddress`.", "operationId":"proposeDeployIntent", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ProposeDeployIntentRequest" } } } }, "responses":{ "200":{ "description":"Transaction receipt confirmed" }, "202":{ "description":"Transaction submitted or receipt not yet available" }, "400":{ "$ref":"#/components/responses/BadRequest" }, "404":{ "$ref":"#/components/responses/NotFound" }, "500":{ "$ref":"#/components/responses/InternalServerError" } }, "security":[ { "bearerAuth":[ ] } ], "x-internal-id":"v1-governance-intents-deploy-post", "x-filename-id":"v1-governance-intents-deploy-post" } }, "/v1/governance/intents/upgrade/latest":{ "get":{ "tags":[ "Governance" ], "summary":"Get Latest Upgrade Intent", "description":"Retrieves the latest upgrade governance intent for the policy scope identified by the required `uuid` query parameter, returning a `GovernanceIntent` object.", "operationId":"getLatestUpgradeIntent", "parameters":[ { "name":"uuid", "in":"query", "description":"uuid of policy scope", "required":true, "schema":{ "type":"string", "format":"uuid" } }, { "name":"proxy", "in":"query", "description":"EVM Address of proxied contract", "required":true, "schema":{ "type":"string" } }, { "name":"newImplementation", "in":"query", "description":"EVM Address of new implementation", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "$ref":"#/components/schemas/GovernanceIntent" } }, "x-internal-id":"v1-governance-intents-upgrade-latest-get", "x-filename-id":"v1-governance-intents-upgrade-latest-get" } }, "/v1/governance/intents/upgrade":{ "post":{ "tags":[ "Governance" ], "summary":"Propose an Upgrade Intent", "description":"Proposes a governance intent to upgrade the specified proxy to a new implementation, identified by its code hash and governed by a deadline under the policy `uuid`.", "operationId":"proposeUpgradeIntent", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ProposeUpgradeIntentRequest" } } } }, "responses":{ "200":{ "description":"Transaction receipt confirmed" }, "202":{ "description":"Transaction submitted or receipt not yet available" }, "400":{ "$ref":"#/components/responses/BadRequest" }, "404":{ "$ref":"#/components/responses/NotFound" }, "500":{ "$ref":"#/components/responses/InternalServerError" } }, "security":[ { "bearerAuth":[ ] } ], "x-internal-id":"v1-governance-intents-upgrade-post", "x-filename-id":"v1-governance-intents-upgrade-post" } }, "/v1/governance/uwaas-key":{ "post":{ "tags":[ "Governance" ], "summary":"Add a UWaaS Signing Key", "description":"Adds the specified blockchain address as a UWaaS signing key through a governance transaction submitted by `fromAddress`.", "operationId":"addUwaasKey", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AddUwaasKeyRequest" } } } }, "responses":{ "200":{ "description":"Transaction receipt confirmed", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SyncGovernanceResponse" } } } }, "202":{ "description":"Transaction submitted or receipt not yet available", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AsyncGovernanceResponse" } } } }, "400":{ "$ref":"#/components/responses/BadRequest" }, "401":{ "$ref":"#/components/responses/Unauthorized" }, "404":{ "$ref":"#/components/responses/NotFound" }, "500":{ "$ref":"#/components/responses/InternalServerError" } }, "security":[ { "bearerAuth":[ ] } ], "x-internal-id":"v1-governance-uwaas-key-post", "x-filename-id":"v1-governance-uwaas-key-post" }, "delete":{ "tags":[ "Governance" ], "summary":"Remove a UWaaS Key", "description":"Removes the specified blockchain address as a UWaaS signing key through a governance transaction submitted by `fromAddress`.", "operationId":"removeUwaasKey", "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RemoveUwaasKeyRequest" } } } }, "responses":{ "200":{ "description":"Transaction receipt confirmed" }, "202":{ "description":"Transaction submitted or receipt not yet available" }, "400":{ "$ref":"#/components/responses/BadRequest" }, "404":{ "$ref":"#/components/responses/NotFound" }, "500":{ "$ref":"#/components/responses/InternalServerError" } }, "security":[ { "bearerAuth":[ ] } ], "x-internal-id":"v1-governance-uwaas-key-delete", "x-filename-id":"v1-governance-uwaas-key-delete" } } }, "components":{ "securitySchemes":{ "bearerAuth":{ "type":"http", "scheme":"bearer", "bearerFormat":"JWT" } }, "parameters":{ "OrgId":{ "name":"orgId", "required":true, "description":"Organization identifier.", "schema":{ "type":"string" }, "example":"1", "in":"path" }, "NetworkId":{ "name":"networkId", "required":true, "description":"Network identifier.", "schema":{ "type":"string" }, "example":"1", "in":"path" }, "AssetId":{ "name":"assetId", "required":true, "description":"Asset identifier.", "schema":{ "type":"string" }, "example":"3", "in":"path" }, "UserId":{ "name":"userId", "required":true, "description":"User identifier.", "schema":{ "type":"string", "format":"uuid" }, "example":"be8b75d7-87dd-444e-973f-2f738deb44f8", "in":"path" }, "AccountId":{ "name":"accountId", "required":true, "description":"Account identifier.", "schema":{ "type":"string" }, "example":"5", "in":"path" }, "AccountPartitionId":{ "name":"accountPartitionId", "required":true, "description":"Account partition identifier.", "schema":{ "type":"string" }, "example":"1", "in":"path" }, "WalletId":{ "name":"walletId", "required":true, "description":"Wallet identifier.", "schema":{ "type":"integer", "format":"int64", "minimum":1 }, "example":101, "in":"path" }, "WalletAddress":{ "name":"walletAddress", "required":true, "description":"Wallet address in hex format (0x + 40 hex chars).", "schema":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" }, "example":"0xFE3B557E8Fb62b89F4916B721be55cEb828dBd73", "in":"path" }, "Address":{ "name":"address", "required":true, "description":"Wallet address in hex format (0x + 40 hex chars).", "schema":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" }, "example":"0xFE3B557E8Fb62b89F4916B721be55cEb828dBd73", "in":"path" }, "ContractAddress":{ "name":"contractAddress", "required":true, "description":"Smart contract address in hex format (0x + 40 hex chars).", "schema":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" }, "example":"0x9a626f29784501056687dc267966dae6414cc91f", "in":"path" }, "StartDate":{ "name":"startDate", "required":true, "description":"Inclusive range start timestamp in ISO-8601 format.", "schema":{ "type":"string", "format":"date-time" }, "example":"2026-05-01T00:00:00Z", "in":"query" }, "EndDate":{ "name":"endDate", "required":true, "description":"Inclusive range end timestamp in ISO-8601 format.", "schema":{ "type":"string", "format":"date-time" }, "example":"2026-05-31T23:59:59Z", "in":"query" }, "PageSize":{ "name":"pageSize", "required":false, "description":"Maximum number of records to return.", "schema":{ "type":"integer", "format":"int32", "minimum":1, "maximum":1000 }, "example":50, "in":"query" }, "PageToken":{ "name":"pageToken", "required":false, "description":"Opaque pagination token returned by a previous response.", "schema":{ "type":"string" }, "example":"eyJsYXN0QmxvY2siOjIyNzUxMjB9", "in":"query" }, "TransactionId":{ "name":"transactionId", "required":true, "description":"Transaction identifier as returned by the wallet transfer service.", "schema":{ "type":"string" }, "example":"3", "in":"path" }, "TransactionHash":{ "name":"transactionHash", "required":true, "description":"Blockchain transaction hash.", "schema":{ "type":"string" }, "example":"0x111122223333444455556666777788889999aaaabbbbccccddddeeeeffff0000", "in":"path" }, "PartitionId":{ "name":"partitionId", "required":true, "description":"Partition identifier.", "schema":{ "type":"string" }, "example":"1", "in":"path" }, "WebhookId":{ "name":"webhookId", "required":true, "description":"Webhook identifier.", "schema":{ "type":"string" }, "example":"wh_001", "in":"path" }, "SubmissionMode":{ "name":"submissionMode", "required":false, "description":"Submission behavior for wallet transfers.", "schema":{ "type":"string", "enum":[ "async", "sync", "callback" ], "default":"async" }, "example":"sync", "in":"query" } }, "requestBodies":{ "CreateAssetRequest":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CreateAssetRequest" }, "examples":{ "erc20":{ "value":{ "assetType":"erc20", "symbol":"AERC20", "assetName":"Acme ERC20", "contractAddress":"0x9a626f29784501056687dc267966dae6414cc91f", "decimals":2, "assetStatus":"active" } }, "native":{ "value":{ "assetType":"native", "symbol":"ETH", "assetName":"ETH", "contractAddress":"", "decimals":18, "assetStatus":"active" } } } } } }, "UpdateAssetRequest":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CreateAssetRequest" }, "examples":{ "updateAssetType":{ "value":{ "assetType":"erc721", "symbol":"AERC202", "assetName":"Acme ERC202", "contractAddress":"0xe9d99bca764fb874a67b9c844463822da8c8400a", "decimals":2, "assetStatus":"disabled" } }, "updateAssetStatus":{ "value":{ "assetType":"erc721", "symbol":"AER721", "assetName":"Acme ERC721", "contractAddress":"0xe9d99bca764fb874a67b9c844463822da8c8400a", "decimals":202, "assetStatus":"active" } } } } } }, "PatchAssetRequest":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PatchAssetRequest" }, "examples":{ "assetStatus":{ "value":{ "assetStatus":"bar" } }, "symbol":{ "value":{ "symbol":"AERC202" } }, "assetName":{ "value":{ "assetName":"Acme ERC202" } }, "contractAddress":{ "value":{ "contractAddress":"0xe9d99bca764fb874a67b9c844463822da8c8400a" } }, "decimals":{ "value":{ "decimals":2 } }, "networkId":{ "value":{ "networkId":1 } } } } } }, "CreateWalletRequest":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CreateWalletRequest" }, "example":{ "orgId":"1", "userId":"78d9a90e-a68f-4a36-864a-95525337d935", "email":"email@example.com", "status":"ACTIVE", "label":"UWM-{{$randomAdjective}}", "walletId":"optional-client-wallet-id", "idempotencyKey":"idem-123" } } } }, "WalletResolveRequest":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/WalletResolveRequest" }, "example":{ "lookupType":"iban", "iban":"DE89370400440532013000" } } } }, "UploadKeyRequest":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UploadKeyRequest" }, "example":{ "orgId":"1", "userId":"11939e00-5f3b-44fb-8076-fbbaf0085606", "label":"Preloaded account 1", "privateKeyB64":"OGYyYTU1OTQ5MDM4YTk2MTBmNTBmYjIzYjU4ODNhZjNiNGVjYjNjM2JiNzkyY2JjZWZiZDE1NDJjNjkyYmU2Mw==" } } } }, "WalletLabelUpdateRequest":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/WalletLabelUpdateRequest" }, "example":{ "label":"{{$randomAdjective}}-{{$randomSemver}}", "updatedBy":"alice" } } } }, "WalletLifecycleRequest":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/WalletLifecycleRequest" }, "example":{ "updatedBy":"alice" } } } }, "TransferRequest":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TransferRequest" }, "examples":{ "assetTransfer":{ "value":{ "to":"0xFE3B557E8Fb62b89F4916B721be55cEb828dBd73", "amount":"1", "memo":"{{$randomCatchPhrase}}", "priority":"Standard" } }, "assetTransferWithContractAddress":{ "value":{ "to":"0xeB710E5774436B6f8C9D050799881B4d3Be08A3A", "amount":"300", "memo":"{{$randomCatchPhrase}}", "priority":"Standard", "contractAddress":"0x6ba15e3dd966798b89c2c0bc859c86127b1a5195" } } } } } }, "WalletTransferRequest":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/WalletTransferRequest" }, "examples":{ "nativeTransfer":{ "value":{ "to":"0x14d5382e4c0D0707715822Bc0cfAF99d309D5584", "amount":"90000000000000", "memo":"{{$randomCatchPhrase}}", "priority":"Standard", "kind":"native" } }, "erc20Transfer":{ "value":{ "to":"0xFE3B557E8Fb62b89F4916B721be55cEb828dBd73", "amount":"1", "memo":"{{$randomCatchPhrase}}", "priority":"Standard", "kind":"erc20", "contractAddress":"0x9a626f29784501056687dc267966dae6414cc91f" } }, "erc20AlternativeContract":{ "value":{ "to":"0xFE3B557E8Fb62b89F4916B721be55cEb828dBd73", "amount":"1000", "memo":"{{$randomCatchPhrase}}", "priority":"Standard", "kind":"erc20", "contractAddress":"0xe9dfcd388c02b4cbcbc325393d9071d2f1cf78aa" } } } } } }, "NativeTransferRequest":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TransferRequest" }, "example":{ "to":"0xeB710E5774436B6f8C9D050799881B4d3Be08A3A", "amount":"90000000000000", "memo":"{{$randomCatchPhrase}}", "priority":"Standard", "externalId":"1" } } } }, "DeployContractRequest":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DeployContractRequest" }, "example":{ "abi":[ { "type":"constructor", "stateMutability":"nonpayable", "inputs":[ { "internalType":"address", "name":"deployer", "type":"address" }, { "internalType":"address", "name":"recipient", "type":"address" } ] }, { "type":"function", "name":"transfer", "stateMutability":"nonpayable", "inputs":[ { "internalType":"address", "name":"to", "type":"address" }, { "internalType":"uint256", "name":"value", "type":"uint256" } ], "outputs":[ { "internalType":"bool", "name":"", "type":"bool" } ] } ], "byteCode":"32837748172956153000000000000000000000000", "constructorArgs":[ "0xA677B9e1ac1f24773275C3ca9a4d9Bc0f6510d54", "0xA677B9e1ac1f24773275C3ca9a4d9Bc0f6510d54" ], "gasLimit":"3000000", "value":"0", "rpcUrl":"http://127.0.0.1:8545" } } } } }, "responses":{ "BadRequest":{ "description":"Bad request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "Unauthorized":{ "description":"Unauthorized.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "Forbidden":{ "description":"The authenticated user is not authorized to access the requested wallet or operation.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "NotFound":{ "description":"Requested resource was not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "InternalServerError":{ "description":"Internal server error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "schemas":{ "AddDaAdminRequest":{ "type":"object", "required":[ "daAdminAddress", "fromAddress" ], "properties":{ "daAdminAddress":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" }, "fromAddress":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" }, "async":{ "type":"boolean", "default":false } } }, "RemoveDaAdminRequest":{ "type":"object", "required":[ "daAdminAddress", "fromAddress" ], "properties":{ "daAdminAddress":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" }, "fromAddress":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" }, "async":{ "type":"boolean", "default":false } } }, "AddApproversRequest":{ "type":"object", "required":[ "uuid", "approvers", "fromAddress" ], "properties":{ "uuid":{ "type":"string" }, "approvers":{ "type":"array", "minItems":1, "items":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" } }, "fromAddress":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" }, "async":{ "type":"boolean", "default":false } } }, "RemoveApproversRequest":{ "type":"object", "required":[ "uuid", "approvers", "fromAddress" ], "properties":{ "uuid":{ "type":"string" }, "approvers":{ "type":"array", "minItems":1, "items":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" } }, "fromAddress":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" }, "async":{ "type":"boolean", "default":false } } }, "GetPolicyResponse":{ "type":"object", "required":[ "threshold", "approverCount" ], "properties":{ "threshold":{ "type":"integer", "minimum":0, "description":"Number of approvals required by the policy." }, "approverCount":{ "type":"integer", "minimum":0, "description":"Number of configured policy approvers." } } }, "AddOrUpdatePolicyRequest":{ "type":"object", "required":[ "uuid", "threshold", "deployers", "fromAddress" ], "properties":{ "uuid":{ "type":"string", "format":"uuid" }, "threshold":{ "type":"integer", "minimum":0 }, "deployers":{ "type":"array", "minItems":1, "items":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" } }, "fromAddress":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" }, "async":{ "type":"boolean", "default":false } }, "example":{ "uuid":"530aea52-fe27-45fa-8785-7da0d34378e3", "threshold":3, "deployers":[ "0x34dad2d9a0be504ab4eea2711d8c3da628b82b2c" ], "fromAddress":"0x34dad2d9a0be504ab4eea2711d8c3da628b82b2c", "async":false } }, "ApproveIntentRequest":{ "type":"object", "required":[ "intentId", "fromAddress" ], "properties":{ "intentId":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{64}$" }, "fromAddress":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" }, "async":{ "type":"boolean", "default":false } } }, "RejectIntentRequest":{ "type":"object", "required":[ "intentId", "reason", "fromAddress" ], "properties":{ "intentId":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{64}$" }, "reason":{ "type":"string", "minLength":1 }, "fromAddress":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" }, "async":{ "type":"boolean", "default":false } }, "example":{ "intentId":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef", "reason":"Lorem", "fromAddress":"0xfe3b557e8fb62b89f4916b721be55ceb828dbd73", "async":false } }, "ProposeDeployIntentRequest":{ "type":"object", "required":[ "uuid", "components", "deadline", "fromAddress" ], "properties":{ "uuid":{ "type":"string" }, "components":{ "type":"array", "minItems":1, "items":{ "$ref":"#/components/schemas/DeployIntentComponent" } }, "deadline":{ "type":"integer", "format":"int64", "description":"Future Unix epoch time in seconds." }, "fromAddress":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" }, "async":{ "type":"boolean", "default":false } } }, "DeployIntentComponent":{ "type":"object", "required":[ "target", "implementation", "implementationCodeHash" ], "properties":{ "target":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" }, "implementation":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" }, "implementationCodeHash":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{64}$" } } }, "ProposeUpgradeIntentRequest":{ "type":"object", "required":[ "uuid", "proxy", "newImplementation", "implementationCodeHash", "deadline", "fromAddress" ], "properties":{ "uuid":{ "type":"string", "format":"uuid" }, "proxy":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" }, "newImplementation":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" }, "implementationCodeHash":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{64}$" }, "deadline":{ "type":"integer", "format":"int64", "description":"Future Unix epoch time in seconds." }, "fromAddress":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" }, "async":{ "type":"boolean", "default":false } } }, "AddUwaasKeyRequest":{ "type":"object", "required":[ "key", "fromAddress" ], "properties":{ "key":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" }, "fromAddress":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" }, "async":{ "type":"boolean", "default":false } } }, "RemoveUwaasKeyRequest":{ "type":"object", "required":[ "key", "fromAddress" ], "properties":{ "key":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" }, "fromAddress":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$" }, "async":{ "type":"boolean", "default":false } } }, "AsyncGovernanceResponse":{ "type":"object", "required":[ "status", "txHash" ], "properties":{ "status":{ "type":"string", "enum":[ "submitted" ] }, "txHash":{ "type":"string" } } }, "SyncGovernanceResponse":{ "type":"object", "required":[ "status", "success", "txHash" ], "properties":{ "status":{ "type":"string", "enum":[ "confirmed" ] }, "success":{ "type":"boolean" }, "txHash":{ "type":"string" } } }, "GetTransactionHistoryResponse":{ "type":"array", "items":{ "$ref":"#/components/schemas/RichTransaction" } }, "TransactionHistory":{ "type":"array", "items":{ "$ref":"#/components/schemas/RichTransaction" } }, "RichTransaction":{ "type":"object", "properties":{ "blockNo":{ "type":"integer", "format":"int64" }, "blockHash":{ "type":"string", "maxLength":128 }, "txnNo":{ "type":"integer", "format":"int64" }, "txnHash":{ "type":"string", "maxLength":128 }, "blockTimestamp":{ "type":"string", "format":"date-time", "nullable":true }, "txnNonce":{ "type":"integer", "format":"int64" }, "fromAddress":{ "type":"string", "maxLength":64 }, "toAddress":{ "type":"string", "maxLength":64 }, "valueHex":{ "type":"string", "maxLength":128 }, "value":{ "type":"string", "nullable":true, "pattern":"^[0-9]+$" }, "valid":{ "type":"boolean" }, "contractAddress":{ "type":"string", "maxLength":64, "nullable":true }, "revertReason":{ "type":"string", "nullable":true }, "txnError":{ "type":"string", "nullable":true }, "gasUsed":{ "type":"integer", "format":"int64" }, "gasPrice":{ "type":"integer", "format":"int64", "nullable":true }, "gasLimit":{ "type":"integer", "format":"int64" }, "rawReceiptLogs":{ "nullable":true, "oneOf":[ { "type":"object", "additionalProperties":true }, { "type":"array", "items":{ } } ] }, "parsedReceiptLogs":{ "nullable":true, "oneOf":[ { "type":"object", "additionalProperties":true }, { "type":"array", "items":{ } } ] }, "functionSignature":{ "type":"string", "nullable":true }, "functionName":{ "type":"string", "nullable":true }, "functionInputs":{ "nullable":true, "oneOf":[ { "type":"object", "additionalProperties":true }, { "type":"array", "items":{ } } ] }, "actionType":{ "type":"string", "maxLength":128, "nullable":true }, "subCallsSummary":{ "type":"string", "nullable":true }, "versionNo":{ "type":"integer", "format":"int64" } } }, "ApiMessage":{ "type":"object", "description":"Generic success response used for operations without a defined response payload.", "properties":{ "message":{ "type":"string", "example":"Operation completed successfully." } } }, "Error":{ "type":"object", "properties":{ "code":{ "type":"string", "example":"bad_request" }, "message":{ "type":"string", "example":"The request could not be processed." }, "details":{ "type":"array", "items":{ "type":"string" } } }, "required":[ "message" ] }, "Asset":{ "type":"object", "properties":{ "assetId":{ "type":"string", "example":"3" }, "orgId":{ "type":"string", "example":"1" }, "networkId":{ "type":"string", "description":"Network scope.", "example":"1" }, "assetType":{ "type":"string", "example":"erc20" }, "symbol":{ "type":"string", "example":"AERC20" }, "assetName":{ "type":"string", "example":"Acme ERC20" }, "contractAddress":{ "type":"string", "nullable":true, "example":"0x9a626f29784501056687dc267966dae6414cc91f" }, "decimals":{ "type":"integer", "format":"int32", "example":2 }, "assetStatus":{ "type":"string", "example":"active" }, "createdAt":{ "type":"string", "format":"date-time" }, "updatedAt":{ "type":"string", "format":"date-time" } }, "required":[ "assetType", "symbol", "assetName", "decimals", "assetStatus" ] }, "CreateAssetRequest":{ "type":"object", "properties":{ "assetType":{ "type":"string", "example":"erc20" }, "symbol":{ "type":"string", "example":"AERC20" }, "assetName":{ "type":"string", "example":"Acme ERC20" }, "contractAddress":{ "type":"string", "nullable":true, "example":"0x9a626f29784501056687dc267966dae6414cc91f" }, "decimals":{ "type":"integer", "format":"int32", "example":2 }, "assetStatus":{ "type":"string", "example":"active" } }, "required":[ "assetType", "symbol", "assetName", "contractAddress", "decimals", "assetStatus" ] }, "PatchAssetRequest":{ "type":"object", "description":"Partial asset update", "properties":{ "assetType":{ "type":"string" }, "symbol":{ "type":"string" }, "assetName":{ "type":"string" }, "contractAddress":{ "type":"string", "nullable":true }, "decimals":{ "type":"integer", "format":"int32" }, "assetStatus":{ "type":"string" }, "networkId":{ "type":"integer", "format":"int32" } } }, "Wallet":{ "type":"object", "properties":{ "walletId":{ "type":"string", "format":"uuid", "example":"87f44061-737b-4f66-9f26-e0d8d0e2b495" }, "orgId":{ "type":"string", "example":"1" }, "userId":{ "type":"string", "format":"uuid", "example":"78d9a90e-a68f-4a36-864a-95525337d935" }, "accountId":{ "type":"string", "example":"1" }, "partitionId":{ "type":"string", "example":"1" }, "label":{ "type":"string", "example":"UWM-{{$randomAdjective}}" }, "status":{ "type":"string", "example":"ACTIVE" }, "address":{ "type":"string", "example":"0xFE3B557E8Fb62b89F4916B721be55cEb828dBd73" }, "createdAt":{ "type":"string", "format":"date-time" }, "updatedAt":{ "type":"string", "format":"date-time" } } }, "CreateWalletRequest":{ "type":"object", "properties":{ "orgId":{ "type":"string", "example":"1" }, "userId":{ "type":"string", "format":"uuid", "example":"78d9a90e-a68f-4a36-864a-95525337d935" }, "email":{ "type":"string", "format":"email", "example":"email@example.com" }, "label":{ "type":"string", "example":"UWM-{{$randomAdjective}}" }, "walletId":{ "type":"string", "nullable":true, "example":"optional-client-wallet-id" }, "idempotencyKey":{ "type":"string", "nullable":true, "example":"idem-123" }, "status":{ "type":"string", "nullable":true, "enum":[ "ACTIVE", "INACTIVE" ] } }, "required":[ "orgId", "userId", "email", "label" ] }, "UploadKeyRequest":{ "type":"object", "properties":{ "orgId":{ "type":"string", "example":"1" }, "userId":{ "type":"string", "format":"uuid", "example":"11939e00-5f3b-44fb-8076-fbbaf0085606" }, "label":{ "type":"string", "example":"Preloaded account 1" }, "privateKeyB64":{ "type":"string", "description":"Base64-encoded private key.", "example":"OGYyYTU1OTQ5MDM4YTk2MTBmNTBmYjIzYjU4ODNhZjNiNGVjYjNjM2JiNzkyY2JjZWZiZDE1NDJjNjkyYmU2Mw==" } }, "required":[ "orgId", "userId", "label", "privateKeyB64" ] }, "ListWalletsResponse":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/ListedWallet" } }, "nextPageToken":{ "type":"string", "nullable":true, "description":"Opaque cursor for the next page." } }, "required":[ "items" ] }, "ListedWallet":{ "type":"object", "description":"A canonical UWaaS wallet record, returned by wallet list and wallet-by-address lookups.", "properties":{ "walletId":{ "type":"string", "format":"uuid", "description":"UWaaS wallet identifier.", "example":"f3f0716b-2bb3-4be8-ad14-f5d3a7f472aa" }, "orgId":{ "type":"string" }, "orgNetworkId":{ "type":"integer", "format":"int64" }, "instanceId":{ "type":"string" }, "blockchainType":{ "type":"string", "example":"BESU" }, "userId":{ "type":"string" }, "status":{ "type":"string", "example":"ACTIVE" }, "label":{ "type":"string" }, "type":{ "type":"string" }, "typeLabel":{ "type":"string" }, "ownershipType":{ "type":"string", "enum":[ "USER", "SERVICE" ] }, "address":{ "type":"string", "example":"0x599f59e794c88a108e0cc2072b7a52fa3576cea4" }, "createdDate":{ "type":"string", "format":"date-time" }, "updatedDate":{ "type":"string", "format":"date-time", "nullable":true }, "createdBy":{ "type":"string" }, "updatedBy":{ "type":"string", "nullable":true }, "walletTags":{ "type":"array", "items":{ "type":"string" } } }, "required":[ "walletId", "ownershipType", "address" ] }, "WalletResponse":{ "type":"object", "properties":{ "besuWalletId":{ "type":"integer", "format":"int64", "example":101 }, "networkId":{ "type":"integer", "format":"int64", "example":1337 }, "address":{ "type":"string", "example":"0xFE3B557E8Fb62b89F4916B721be55cEb828dBd73" }, "publicKey":{ "type":"string", "nullable":true }, "status":{ "type":"string", "example":"ACTIVE" }, "providerType":{ "type":"string", "nullable":true }, "providerWalletRef":{ "type":"string", "nullable":true } } }, "CreateWalletResponse":{ "type":"object", "properties":{ "walletServiceWalletId":{ "type":"string", "nullable":true }, "networkId":{ "type":"integer", "format":"int64", "example":1337 }, "address":{ "type":"string", "nullable":true }, "publicKey":{ "type":"string", "nullable":true }, "label":{ "type":"string", "nullable":true }, "status":{ "type":"string", "nullable":true }, "providerType":{ "type":"string", "nullable":true }, "providerWalletRef":{ "type":"string", "nullable":true }, "providerTxnId":{ "type":"string", "nullable":true } } }, "WalletLifecycleResponse":{ "type":"object", "additionalProperties":true, "description":"Provider lifecycle action response payload." }, "WalletBalanceResponse":{ "type":"object", "properties":{ "balance":{ "type":"string", "example":"1000000000000000000" }, "assetType":{ "type":"string", "example":"native" }, "assetContract":{ "type":"string", "nullable":true, "example":"0x9a626f29784501056687dc267966dae6414cc91f" }, "updatedAt":{ "type":"string", "nullable":true } }, "required":[ "balance", "assetType" ] }, "WalletResolveRequest":{ "type":"object", "properties":{ "lookupType":{ "type":"string", "example":"iban" }, "iban":{ "type":"string", "example":"DE89370400440532013000" } }, "required":[ "lookupType", "iban" ] }, "WalletResolveResponse":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"wlt_123456789" }, "walletAddress":{ "type":"string", "example":"0xaaaa111122223333444455554444333322221111" } }, "required":[ "walletId", "walletAddress" ] }, "WalletLabelUpdateRequest":{ "type":"object", "properties":{ "label":{ "type":"string", "example":"{{$randomAdjective}}-{{$randomSemver}}" }, "updatedBy":{ "type":"string", "example":"alice" } }, "required":[ "label", "updatedBy" ] }, "WalletLifecycleRequest":{ "type":"object", "properties":{ "updatedBy":{ "type":"string", "example":"alice" } }, "required":[ "updatedBy" ] }, "SignTransactionRequest":{ "type":"object", "description":"Unified sign request. Preferred shape is { blockchainKind, kind, data }. Backward-compatible legacy transaction and JSON-RPC shapes are also accepted.", "properties":{ "blockchainKind":{ "type":"string", "description":"Blockchain family selector. Defaults to evm when omitted.", "example":"evm" }, "kind":{ "type":"string", "description":"Signing kind. Defaults to transaction when omitted.", "enum":[ "transaction", "evm", "eip712" ], "example":"transaction" }, "data":{ "type":"object", "description":"Payload object. For transaction kinds this is tx data. For eip712 this may contain typed_data.", "additionalProperties":true }, "jsonrpc":{ "type":"string", "example":"2.0" }, "method":{ "type":"string", "example":"eth_signTransaction" }, "params":{ "type":"array", "items":{ "type":"object" }, "example":[ { "from":"0xa537b178b12E40EC07c361Fa1D5bb1f6770f7262", "to":"0x2a58b1eb2f8821c3001eece71921ce977f6529ad", "data":"0x", "gas":21000, "gasPrice":0, "nonce":0, "value":0, "chainId":1337 } ] }, "id":{ "oneOf":[ { "type":"integer", "format":"int64" }, { "type":"string" } ], "example":1 }, "chainId":{ "oneOf":[ { "type":"integer", "format":"int64" }, { "type":"string" } ], "example":1337 }, "rpcUrl":{ "type":"string", "format":"uri", "description":"Optional RPC endpoint used for nonce, gas, and transaction type resolution before returning the signed transaction.", "example":"http://127.0.0.1:8545" }, "jsonRpcMethod":{ "type":"string", "description":"Legacy JSON-RPC method field accepted for backward compatibility.", "example":"eth_signTransaction" } } }, "SignTransactionResponse":{ "type":"object", "properties":{ "walletId":{ "type":"string", "example":"5b018c64-bde8-4927-8183-93cda4422a23" }, "dateSigned":{ "type":"string", "format":"date-time", "example":"2026-05-26T19:23:08.736547549Z" }, "signature":{ "type":"object", "properties":{ "r":{ "type":"string", "nullable":true, "example":null }, "s":{ "type":"string", "nullable":true, "example":null }, "v":{ "type":"integer", "nullable":true, "example":null }, "recid":{ "type":"integer", "nullable":true, "example":null }, "encoded":{ "type":"string", "description":"Signed payload hex.", "example":"0xf91f0..." } }, "required":[ "encoded" ] } }, "required":[ "walletId", "dateSigned", "signature" ] }, "TransferRequest":{ "type":"object", "properties":{ "to":{ "type":"string", "example":"0xFE3B557E8Fb62b89F4916B721be55cEb828dBd73" }, "amount":{ "type":"string", "example":"1" }, "memo":{ "type":"string", "example":"{{$randomCatchPhrase}}" }, "priority":{ "type":"string", "example":"Standard" }, "contractAddress":{ "type":"string", "description":"Optional contract address for token transfers.", "example":"0x6ba15e3dd966798b89c2c0bc859c86127b1a5195" }, "externalId":{ "type":"string", "description":"Optional external identifier.", "example":"1" } }, "required":[ "to", "amount", "memo", "priority" ] }, "WalletTransferRequest":{ "type":"object", "properties":{ "to":{ "type":"string", "example":"0x14d5382e4c0D0707715822Bc0cfAF99d309D5584" }, "amount":{ "type":"string", "example":"90000000000000" }, "memo":{ "type":"string", "example":"{{$randomCatchPhrase}}" }, "priority":{ "type":"string", "example":"Standard" }, "kind":{ "type":"string", "enum":[ "native", "erc20" ], "example":"native" }, "contractAddress":{ "type":"string", "description":"Optional contract address (used for token transfers).", "example":"0x9a626f29784501056687dc267966dae6414cc91f" } }, "required":[ "to", "amount" ] }, "TransferSubmissionResponse":{ "type":"object", "description":"Transfer submission response returned by wallet service provider.", "additionalProperties":true }, "TransferRecord":{ "type":"object", "properties":{ "transactionId":{ "type":"string", "example":"3" }, "transactionHash":{ "type":"string", "example":"0x111122223333444455556666777788889999aaaabbbbccccddddeeeeffff0000" }, "walletId":{ "type":"string", "format":"uuid", "example":"d8efa760-3353-45f6-a7c3-1cfd18af782c" }, "partitionId":{ "type":"string", "example":"1" }, "assetId":{ "type":"string", "example":"2" }, "kind":{ "type":"string", "example":"erc20" }, "to":{ "type":"string", "example":"0xFE3B557E8Fb62b89F4916B721be55cEb828dBd73" }, "amount":{ "type":"string", "example":"1" }, "memo":{ "type":"string", "example":"{{$randomCatchPhrase}}" }, "priority":{ "type":"string", "example":"Standard" }, "contractAddress":{ "type":"string", "example":"0x9a626f29784501056687dc267966dae6414cc91f" }, "externalId":{ "type":"string", "example":"1" }, "status":{ "type":"string", "example":"submitted" }, "submittedAt":{ "type":"string", "format":"date-time" } } }, "TransactionAsset":{ "type":"object", "properties":{ "type":{ "type":"string", "enum":[ "NATIVE", "ERC20", "ERC721", "ERC1155" ] }, "contractAddress":{ "type":"string", "nullable":true, "description":"Contract address for token assets. Null for native assets.", "example":"0x9a626f29784501056687dc267966dae6414cc91f" }, "symbol":{ "type":"string", "example":"ETH" }, "decimals":{ "type":"integer", "format":"int32", "example":18 }, "tokenId":{ "type":"string", "nullable":true, "description":"Optional token identifier for ERC721/ERC1155 assets.", "example":"1001" } }, "required":[ "type", "symbol", "decimals" ] }, "TransactionRecord":{ "type":"object", "properties":{ "transactionId":{ "type":"string", "example":"0x7df1f7df8f0a97f8128aa594f167f6a2f73cbf42a23f2ce8e35d4a5af8722c91" }, "blockNumber":{ "type":"integer", "format":"int64", "example":2273456 }, "blockTimestamp":{ "type":"string", "format":"date-time", "example":"2026-05-11T14:22:03Z" }, "status":{ "type":"string", "enum":[ "SUCCESS", "FAILED", "PENDING" ] }, "transactionType":{ "type":"string", "enum":[ "NATIVE_TRANSFER", "ERC20_TRANSFER", "ERC721_TRANSFER", "ERC1155_TRANSFER", "CONTRACT_CALL", "TOKEN_APPROVAL", "CONTRACT_DEPLOYMENT" ] }, "direction":{ "type":"string", "enum":[ "INCOMING", "OUTGOING", "SELF" ] }, "fromAddress":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$", "example":"0xFE3B557E8Fb62b89F4916B721be55cEb828dBd73" }, "toAddress":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$", "example":"0x14d5382e4c0D0707715822Bc0cfAF99d309D5584" }, "asset":{ "$ref":"#/components/schemas/TransactionAsset" }, "amount":{ "type":"string", "example":"1250000" } }, "required":[ "transactionId", "blockNumber", "blockTimestamp", "status", "transactionType", "direction", "fromAddress", "toAddress", "asset", "amount" ] }, "WalletTransactionsResponse":{ "type":"object", "properties":{ "walletAddress":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$", "example":"0xFE3B557E8Fb62b89F4916B721be55cEb828dBd73" }, "startDate":{ "type":"string", "format":"date-time", "example":"2026-05-01T00:00:00Z" }, "endDate":{ "type":"string", "format":"date-time", "example":"2026-05-31T23:59:59Z" }, "transactions":{ "type":"array", "items":{ "$ref":"#/components/schemas/TransactionRecord" } }, "nextPageToken":{ "type":"string", "nullable":true, "example":"eyJsYXN0QmxvY2siOjIyNzUxMjB9" } }, "required":[ "walletAddress", "startDate", "endDate", "transactions" ] }, "WalletStatementPeriod":{ "type":"object", "properties":{ "startDate":{ "type":"string", "format":"date-time", "example":"2026-05-01T00:00:00Z" }, "endDate":{ "type":"string", "format":"date-time", "example":"2026-05-31T23:59:59Z" } }, "required":[ "startDate", "endDate" ] }, "WalletStatementTokenIdBalance":{ "type":"object", "properties":{ "tokenId":{ "type":"string", "example":"5" }, "openingBalance":{ "type":"string", "example":"10" }, "credits":{ "type":"string", "example":"3" }, "debits":{ "type":"string", "example":"1" }, "closingBalance":{ "type":"string", "example":"12" } }, "required":[ "tokenId", "openingBalance", "credits", "debits", "closingBalance" ] }, "WalletStatementAsset":{ "type":"object", "properties":{ "type":{ "type":"string", "enum":[ "NATIVE", "ERC20", "ERC721", "ERC1155" ] }, "contractAddress":{ "type":"string", "nullable":true, "description":"Contract address for token assets. Null for native assets.", "example":"0x9a626f29784501056687dc267966dae6414cc91f" }, "symbol":{ "type":"string", "example":"ETH" }, "decimals":{ "type":"integer", "format":"int32", "example":18 }, "openingBalance":{ "type":"string", "example":"1200000000000000000" }, "credits":{ "type":"string", "example":"500000000000000000" }, "debits":{ "type":"string", "example":"300000000000000000" }, "closingBalance":{ "type":"string", "example":"1400000000000000000" }, "tokenIds":{ "type":"array", "description":"Optional token IDs for ERC721 assets.", "items":{ "type":"string" }, "example":[ "1001", "1002" ] }, "tokenIdBalances":{ "type":"array", "description":"Optional token ID level balances for ERC1155 assets.", "items":{ "$ref":"#/components/schemas/WalletStatementTokenIdBalance" } } }, "required":[ "type", "symbol", "decimals", "openingBalance", "credits", "debits", "closingBalance" ] }, "WalletStatement":{ "type":"object", "properties":{ "walletAddress":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$", "example":"0xFE3B557E8Fb62b89F4916B721be55cEb828dBd73" }, "statementPeriod":{ "$ref":"#/components/schemas/WalletStatementPeriod" }, "assets":{ "type":"array", "items":{ "$ref":"#/components/schemas/WalletStatementAsset" } } }, "required":[ "walletAddress", "statementPeriod", "assets" ] }, "Erc20ContractTransactionsResponse":{ "type":"object", "properties":{ "contractAddress":{ "type":"string", "pattern":"^0x[a-fA-F0-9]{40}$", "example":"0x9a626f29784501056687dc267966dae6414cc91f" }, "symbol":{ "type":"string", "example":"USDC" }, "startDate":{ "type":"string", "format":"date-time", "example":"2026-05-01T00:00:00Z" }, "endDate":{ "type":"string", "format":"date-time", "example":"2026-05-31T23:59:59Z" }, "transactions":{ "type":"array", "items":{ "$ref":"#/components/schemas/TransactionRecord" } }, "nextPageToken":{ "type":"string", "nullable":true, "example":"eyJsYXN0QmxvY2siOjIyNzUxMjB9" } }, "required":[ "contractAddress", "symbol", "startDate", "endDate", "transactions" ] }, "BalanceResponse":{ "type":"object", "properties":{ "walletId":{ "type":"string", "format":"uuid", "example":"d8efa760-3353-45f6-a7c3-1cfd18af782c" }, "partitionId":{ "type":"string", "example":"1" }, "assetId":{ "type":"string", "example":"4" }, "balance":{ "type":"string", "example":"1000000000000000000" }, "assetType":{ "type":"string", "example":"native" }, "symbol":{ "type":"string", "example":"ETH" } }, "required":[ "walletId", "partitionId", "assetId", "balance" ] }, "ContractAbiEntry":{ "type":"object", "description":"ABI entry.", "additionalProperties":true }, "DeployContractRequest":{ "type":"object", "properties":{ "abi":{ "type":"array", "items":{ "$ref":"#/components/schemas/ContractAbiEntry" } }, "byteCode":{ "type":"string", "description":"Compiled contract bytecode.", "example":1619025984 }, "constructorArgs":{ "type":"array", "items":{ "type":"string" }, "example":[ "0xA677B9e1ac1f24773275C3ca9a4d9Bc0f6510d54", "0xA677B9e1ac1f24773275C3ca9a4d9Bc0f6510d54" ] }, "gasLimit":{ "type":"string", "nullable":true, "example":"3000000" }, "value":{ "type":"string", "nullable":true, "example":"0" }, "rpcUrl":{ "type":"string", "format":"uri", "nullable":true, "example":"http://127.0.0.1:8545" } }, "required":[ "abi", "byteCode" ] }, "ContractDeploymentResponse":{ "type":"object", "properties":{ "txHash":{ "type":"string", "example":"0x111122223333444455556666777788889999aaaabbbbccccddddeeeeffff0000" }, "walletId":{ "type":"string", "example":"101" }, "partitionId":{ "type":"string", "example":"1" }, "from":{ "type":"string", "example":"0xFE3B557E8Fb62b89F4916B721be55cEb828dBd73" }, "nonce":{ "type":"string", "example":"12" }, "gasLimit":{ "type":"string", "example":"3000000" }, "value":{ "type":"string", "example":"0" }, "submittedAt":{ "type":"string", "example":"2026-05-27T14:00:00Z" }, "contractAddress":{ "type":"string", "example":"0x9a626f29784501056687dc267966dae6414cc91f" } } }, "GovernanceIntent":{ "type":"object", "properties":{ "intentType":{ "type":"integer" }, "uuid":{ "type":"string" }, "target":{ "type":"string" }, "implementation":{ "type":"string" }, "implementationCodeHash":{ "type":"string" }, "componentsHash":{ "type":"string" }, "nonce":{ "type":"integer" }, "deadline":{ "type":"integer" } }, "required":[ "intentType", "uuid", "target", "implementation", "implementationCodeHash", "componentsHash", "nonce", "deadline" ] }, "HealthStatus":{ "type":"object", "properties":{ "status":{ "type":"string", "example":"ok" }, "timestamp":{ "type":"string", "format":"date-time" }, "details":{ "type":"object", "additionalProperties":true } } }, "ReadyResponse":{ "type":"object", "required":[ "message" ], "properties":{ "message":{ "type":"string", "example":"OK" } } } } } }