Service API
This is a concise reference for the Kura Service API.
Full OpenAPI schemas, request / response schemas, and SDKs are provided separately when you adopt the product. Please reach out if interested.
The Service API is offered over HTTP and covers the following areas:
- Service status
- Account and receiving address management
- Balance and transferability checks
- Deposits
- Transfer / withdrawal preparation and execution
- Smart contract wallet integration
- History queries
Health / Deployment
| Method | Path | Purpose |
|---|---|---|
GET | /health | Check service liveness. |
GET | /api/deployment | Retrieve information about the connected chain and the Kura contract. |
Account and receiving address management
| Method | Path | Purpose |
|---|---|---|
POST | /api/wallets | Register a P-256, WebAuthn, or Ethereum EOA wallet account along with an initial receiving profile. |
GET | /api/wallets | List registered receiving profiles. |
GET | /api/wallets/{wallet_handle} | Fetch a summary of a wallet account. |
GET | /api/wallets/{wallet_handle}/profiles | List receiving profiles bound to a wallet account. |
POST | /api/wallets/{wallet_handle}/profiles | Add a receiving profile to an existing wallet account. |
GET | /api/viewing-profiles/{address_id} | Fetch a receiving profile. |
POST | /api/viewing-profiles/{address_id}/disable | Stop syncing a receiving profile. |
POST | /api/viewing-profiles/{address_id}/enable | Resume syncing a receiving profile. |
Balance and transferability checks
| Method | Path | Purpose |
|---|---|---|
GET | /api/viewing-profiles/{address_id}/status | Get sync status of a receiving profile. |
GET | /api/viewing-profiles/{address_id}/notes | Get assets and balances held under a receiving profile. |
Used to display balances and decide whether transfers are possible.
Deposits
| Method | Path | Purpose |
|---|---|---|
POST | /api/deposits/proof-requests | Generate a deposit proof for the given receiving address, token, and amount. |
GET | /api/proof-requests/{proof_request_id} | Check proof generation status. |
Once the proof is ready, the user's wallet can approve the ERC-20 spend and execute the deposit.
Transfer / withdrawal preparation and execution
| Method | Path | Purpose |
|---|---|---|
POST | /api/wallets/{wallet_handle}/transfer-preparations | Generate preparation data and the signing payload for a transfer or withdrawal. |
POST | /api/wallets/{wallet_handle}/transfers/execution-requests | Execute a signed transfer (proof generation, broadcast, and completion are handled asynchronously). |
POST | /api/wallets/{wallet_handle}/transfers/proof-requests | Generate only the proof. |
GET | /api/execution-requests/{execution_request_id} | Check transfer execution status. |
The primary inputs to transfer preparation are: source profile, destination (Kura address or regular address), token, and amount.
Smart contract wallet integration
| Method | Path | Purpose |
|---|---|---|
POST | /api/contract-wallets | Create a Kura-compatible contract wallet and receiving profile. |
PUT | /api/contract-wallets/{contract_wallet_address}/signers | Register signer information for a contract wallet. |
GET | /api/wallets/{wallet_handle}/contract-wallet-status | Check registration and transferability of a contract wallet. |
POST | /api/contract-wallets/{contract_wallet_address}/user-operations | Execute a signed wallet operation. |
Used when accounts are managed by smart contracts rather than EOAs.
History
| Method | Path | Purpose |
|---|---|---|
GET | /api/history/addresses/{address_id}/notes/received | Retrieve receiving history for a receiving profile. |
GET | /api/history/addresses/{address_id}/notes/spent | Retrieve sending history for a receiving profile. |
GET | /api/history/wallets/{wallet_handle}/notes/received | Retrieve receiving history across a wallet account. |
GET | /api/history/wallets/{wallet_handle}/notes/spent | Retrieve sending history across a wallet account. |
GET | /api/history/deposits | Retrieve deposit history. |
GET | /api/history/publications | Retrieve transaction history. |
Useful for activity views, reconciliation, and support workflows.