{
"openapi":"3.0.3",
"info":{
"title":"Universal Wallet Manager APIs",
"version":"2026.09.30",
"description":"Universal Wallet Manager APIs",
"x-summary":"Universal Wallet Manager APIs"
},
"security":[
{
"bearerAuth":[
]
}
],
"tags":[
{
"name":"Evaluate",
"description":"Evaluation endpoints."
},
{
"name":"Health",
"description":"Health and readiness endpoints."
},
{
"name":"Organization Networks",
"description":"Organization network management endpoints."
},
{
"name":"Organizations",
"description":"Organization management endpoints."
},
{
"name":"Roles",
"description":"Role management endpoints."
},
{
"name":"Rules",
"description":"Rules management endpoints."
},
{
"name":"Users",
"description":"Organization user management endpoints."
},
{
"name":"Wallets",
"description":"Wallet management endpoints."
}
],
"components":{
"schemas":{
"T_Number":{
"type":"number"
},
"T_String":{
"type":"string",
"minLength":1,
"maxLength":100
},
"T_StringLong":{
"type":"string",
"minLength":1,
"maxLength":255
},
"T_DateTime":{
"type":"string",
"format":"date-time"
},
"T_RecordStringAny":{
"type":"object",
"additionalProperties":true,
"description":"Construct a type with a set of arbitrary properties with any type"
},
"Tags":{
"type":"array",
"items":{
"type":"string"
},
"example":[
"jurisdiction:us"
]
},
"Scopelevels":{
"type":"array",
"minItems":1,
"uniqueItems":true,
"items":{
"type":"string",
"enum":[
"global",
"org",
"instance",
"wallet",
"asset"
]
},
"example":[
"org"
]
},
"Targets":{
"type":"object",
"properties":{
"orgIds":{
"type":"array",
"items":{
"type":"string"
},
"example":[
"red_bank",
"green_bank"
]
},
"instanceIds":{
"type":"array",
"items":{
"type":"string"
},
"example":[
"instance-1"
]
},
"walletIds":{
"type":"array",
"items":{
"type":"string"
}
},
"assetIds":{
"type":"array",
"items":{
"type":"string"
}
}
}
},
"RulesIdParam":{
"$ref":"#/components/schemas/T_Number"
},
"EvaluationResponse":{
"type":"object",
"properties":{
"type":{
"$ref":"#/components/schemas/EvaluationResponseTypeEnum"
},
"params":{
"$ref":"#/components/schemas/T_RecordStringAny"
}
},
"required":[
"type",
"params"
]
},
"EvaluationResponseTypeEnum":{
"type":"string",
"enum":[
"BLOCK",
"ALLOW"
]
},
"EvaluationResultEnum":{
"$ref":"#/components/schemas/EvaluationResponseTypeEnum"
},
"EvaluationOverallResult":{
"type":"object",
"properties":{
"evaluationResult":{
"$ref":"#/components/schemas/EvaluationResultEnum"
},
"responses":{
"type":"array",
"items":{
"$ref":"#/components/schemas/EvaluationResponse"
}
}
},
"required":[
"evaluationResult",
"responses"
]
},
"ConditionProperties":{
"properties":{
"fact":{
"type":"string"
},
"operator":{
"type":"string"
},
"value":{
"anyOf":[
{
"properties":{
"fact":{
"type":"string"
}
},
"required":[
"fact"
],
"type":"object"
},
{
}
]
},
"path":{
"type":"string"
},
"priority":{
"type":"number",
"format":"double"
},
"params":{
"$ref":"#/components/schemas/T_RecordStringAny"
},
"name":{
"type":"string"
}
},
"required":[
"fact",
"operator",
"value"
],
"type":"object",
"additionalProperties":false
},
"TopLevelCondition":{
"anyOf":[
{
"$ref":"#/components/schemas/AllConditions"
},
{
"$ref":"#/components/schemas/AnyConditions"
},
{
"$ref":"#/components/schemas/NotConditions"
},
{
"$ref":"#/components/schemas/ConditionReference"
}
]
},
"NestedCondition":{
"anyOf":[
{
"$ref":"#/components/schemas/ConditionProperties"
},
{
"$ref":"#/components/schemas/TopLevelCondition"
}
]
},
"AllConditions":{
"properties":{
"priority":{
"type":"number",
"format":"double"
},
"name":{
"type":"string"
},
"all":{
"items":{
"$ref":"#/components/schemas/NestedCondition"
},
"type":"array"
}
},
"required":[
"all"
],
"type":"object"
},
"AnyConditions":{
"properties":{
"priority":{
"type":"number",
"format":"double"
},
"name":{
"type":"string"
},
"any":{
"items":{
"$ref":"#/components/schemas/NestedCondition"
},
"type":"array"
}
},
"required":[
"any"
],
"type":"object"
},
"NotConditions":{
"properties":{
"priority":{
"type":"number",
"format":"double"
},
"name":{
"type":"string"
},
"not":{
"$ref":"#/components/schemas/NestedCondition"
}
},
"required":[
"not"
],
"type":"object"
},
"ConditionReference":{
"properties":{
"priority":{
"type":"number",
"format":"double"
},
"name":{
"type":"string"
},
"condition":{
"type":"string"
}
},
"required":[
"condition"
],
"type":"object"
},
"RuleBaseComponent":{
"type":"object",
"properties":{
"id":{
"$ref":"#/components/schemas/T_Number"
},
"name":{
"$ref":"#/components/schemas/T_String"
},
"description":{
"$ref":"#/components/schemas/T_StringLong"
},
"conditions":{
"$ref":"#/components/schemas/TopLevelCondition"
},
"response":{
"$ref":"#/components/schemas/EvaluationResponse"
},
"enabled":{
"type":"boolean"
},
"priority":{
"$ref":"#/components/schemas/T_Number"
},
"scopelevels":{
"$ref":"#/components/schemas/Scopelevels"
},
"targets":{
"$ref":"#/components/schemas/Targets"
},
"tags":{
"$ref":"#/components/schemas/Tags"
},
"category":{
"type":"string"
}
},
"additionalProperties":false
},
"RuleOutput":{
"allOf":[
{
"$ref":"#/components/schemas/RuleBaseComponent"
},
{
"type":"object",
"properties":{
"createdBy":{
"$ref":"#/components/schemas/T_String"
},
"updatedBy":{
"$ref":"#/components/schemas/T_String"
},
"createdAt":{
"$ref":"#/components/schemas/T_DateTime"
},
"updatedAt":{
"$ref":"#/components/schemas/T_DateTime"
}
},
"required":[
"id",
"name",
"description",
"conditions",
"response",
"enabled",
"priority",
"scopelevels",
"targets",
"tags",
"category",
"createdBy",
"updatedBy",
"createdAt",
"updatedAt"
]
}
]
},
"AppError":{
"type":"object",
"properties":{
"name":{
"type":"string"
},
"message":{
"type":"string"
},
"stack":{
"type":"string"
},
"statusCode":{
"type":"string"
},
"details":{
}
},
"required":[
"name",
"message",
"statusCode",
"details"
]
},
"ListRulesResponse":{
"type":"object",
"properties":{
"data":{
"type":"array",
"items":{
"$ref":"#/components/schemas/RuleOutput"
}
}
},
"required":[
"data"
]
},
"GetRuleResponse":{
"$ref":"#/components/schemas/RuleOutput"
},
"CreateRuleRequest":{
"allOf":[
{
"$ref":"#/components/schemas/RuleBaseComponent"
},
{
"type":"object",
"not":{
"required":[
"id"
]
},
"required":[
"name",
"conditions",
"response",
"scopelevels",
"description",
"enabled"
]
}
]
},
"CreateRuleResponse":{
"$ref":"#/components/schemas/RuleOutput"
},
"PatchRuleRequest":{
"allOf":[
{
"$ref":"#/components/schemas/RuleBaseComponent"
},
{
"type":"object",
"not":{
"required":[
"id",
"name"
]
}
}
]
},
"PatchRuleResponse":{
"$ref":"#/components/schemas/RuleOutput"
},
"EvaluateOnFilteredRulesRequest":{
"type":"object",
"properties":{
"facts":{
"$ref":"#/components/schemas/T_RecordStringAny"
},
"tags":{
"$ref":"#/components/schemas/Tags"
},
"targets":{
"$ref":"#/components/schemas/Targets"
}
},
"required":[
"facts"
]
},
"EvaluateOnFilteredRulesResponse":{
"$ref":"#/components/schemas/EvaluationOverallResult"
},
"EvaluateOnSingleRuleRequest":{
"type":"object",
"properties":{
"facts":{
"$ref":"#/components/schemas/T_RecordStringAny"
}
},
"required":[
"facts"
]
},
"EvaluateOnSingleRuleResponse":{
"$ref":"#/components/schemas/EvaluationOverallResult"
},
"Error":{
"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"
]
},
"Organization":{
"type":"object",
"properties":{
"orgId":{
"type":"string",
"readOnly":true,
"example":"org-founder-bank"
},
"organizationName":{
"type":"string",
"example":"Founder Bank"
},
"description":{
"type":"string",
"example":"Primary founding banking organization"
},
"status":{
"$ref":"#/components/schemas/OrganizationStatus"
},
"createdBy":{
"type":"string",
"readOnly":true,
"example":"system-admin"
},
"createdAt":{
"type":"string",
"format":"date-time",
"readOnly":true
},
"updatedAt":{
"type":"string",
"format":"date-time",
"readOnly":true
}
},
"required":[
"orgId",
"organizationName",
"createdBy",
"status",
"createdAt",
"updatedAt"
]
},
"CreateOrganizationRequest":{
"type":"object",
"properties":{
"orgId":{
"type":"string",
"example":"org-15b36ae3-20c6-4e68-9358-560d681d548b"
},
"organizationName":{
"type":"string",
"example":"Effertz Group"
},
"description":{
"type":"string",
"example":"This is a company."
},
"tags":{
"type":"array",
"description":"Optional tags to assign to the organization. Tags are normalized before persistence.",
"items":{
"type":"string",
"maxLength":255
},
"example":[
"jurisdiction:eu",
"jurisdiction:emea"
]
},
"status":{
"$ref":"#/components/schemas/OrganizationStatus"
}
},
"required":[
"orgId",
"organizationName",
"description",
"status"
]
},
"UpdateOrganizationRequest":{
"type":"object",
"properties":{
"orgId":{
"type":"string",
"example":"org-d304441f-9b69-420c-b0af-dc77e3bff16b"
},
"organizationName":{
"type":"string",
"example":"Schimmel Inc"
},
"description":{
"type":"string",
"example":"This is a company."
},
"tags":{
"type":"array",
"description":"Optional tags to assign to the organization. Tags are normalized before persistence.",
"items":{
"type":"string",
"maxLength":255
},
"example":[
"tier:gold"
]
},
"status":{
"$ref":"#/components/schemas/OrganizationStatus"
}
},
"required":[
"orgId",
"organizationName",
"description",
"status"
]
},
"OrganizationResponse":{
"type":"object",
"properties":{
"orgId":{
"type":"string",
"example":"org-99762dae-9962-4523-ad30-d2b51fd3b06c"
},
"organizationName":{
"type":"string",
"example":"Organization A"
},
"description":{
"type":"string",
"example":"This is a company."
},
"tags":{
"type":"array",
"items":{
"type":"string"
},
"example":[
"jurisdiction:emea",
"jurisdiction:eu"
]
},
"status":{
"$ref":"#/components/schemas/OrganizationStatus"
},
"isDeleted":{
"type":"boolean",
"example":false
},
"createdAt":{
"type":"string",
"format":"date-time",
"readOnly":true
},
"createdBy":{
"type":"string",
"readOnly":true,
"example":"08819d29-de56-48ea-a140-bc4ac73952ed"
},
"updatedAt":{
"type":"string",
"format":"date-time",
"readOnly":true
},
"updatedBy":{
"type":"string",
"readOnly":true,
"example":"08819d29-de56-48ea-a140-bc4ac73952ed"
}
},
"required":[
"orgId",
"organizationName",
"description",
"status",
"isDeleted",
"createdAt",
"createdBy",
"updatedAt"
]
},
"ListOrganizationsResponse":{
"type":"object",
"properties":{
"items":{
"type":"array",
"items":{
"$ref":"#/components/schemas/OrganizationResponse"
}
},
"nextPageToken":{
"type":"string",
"nullable":true,
"description":"Opaque cursor for the next page. Omitted or null when there are no more records."
}
},
"required":[
"items"
]
},
"OrganizationStatus":{
"type":"string",
"description":"Organization lifecycle status shown in Org Management.",
"enum":[
"ACTIVE",
"INACTIVE"
],
"example":"ACTIVE"
},
"NetworkEndpoint":{
"type":"object",
"properties":{
"type":{
"type":"string",
"example":"RPC"
},
"name":{
"type":"string",
"example":"RPC URL 1"
},
"url":{
"type":"string",
"format":"uri",
"example":"http://localhost:8545"
},
"isPublic":{
"type":"boolean",
"example":false
},
"createdAt":{
"type":"string",
"format":"date-time"
}
},
"required":[
"type",
"name",
"url",
"isPublic"
]
},
"User":{
"type":"object",
"description":"User response returned by get and list endpoints.",
"properties":{
"userId":{
"type":"string",
"format":"uuid",
"readOnly":true,
"description":"External identity-provider identifier for the user.",
"example":"3da1c611-c698-42e3-86db-4c9ded652618"
},
"displayName":{
"type":"string",
"example":"John Smith"
},
"orgId":{
"type":"string",
"readOnly":true,
"description":"External organization identifier from orgId.",
"example":"org-founder-bank"
},
"organizationName":{
"type":"string",
"readOnly":true,
"example":"Acme Corp"
},
"roleName":{
"type":"string",
"readOnly":true,
"example":"Org User"
},
"status":{
"$ref":"#/components/schemas/UserStatus"
},
"createdBy":{
"type":"string",
"readOnly":true,
"example":"system"
},
"roleId":{
"$ref":"#/components/schemas/RoleId"
}
},
"required":[
"userId",
"orgId",
"organizationName",
"roleName",
"roleId",
"status",
"createdBy"
]
},
"ListUsersResponse":{
"type":"object",
"properties":{
"items":{
"type":"array",
"items":{
"$ref":"#/components/schemas/User"
}
},
"nextPageToken":{
"type":"string",
"nullable":true,
"description":"Opaque cursor for the next page. Omitted or null when there are no more records."
}
},
"required":[
"items"
]
},
"CreateUserRequest":{
"type":"object",
"properties":{
"userId":{
"type":"string",
"format":"uuid",
"example":"3da1c611-c698-42e3-86db-4c9ded652618"
},
"displayName":{
"type":"string",
"example":"John Smith"
},
"email":{
"type":"string",
"format":"email",
"example":"john.smith@acme.com"
},
"roleId":{
"$ref":"#/components/schemas/RoleId"
},
"status":{
"$ref":"#/components/schemas/UserStatus"
}
},
"required":[
"userId",
"displayName",
"email",
"roleId",
"status"
]
},
"UpdateUserRequest":{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"example":"Nancy Yost PhD"
},
"roleId":{
"$ref":"#/components/schemas/RoleId"
},
"status":{
"$ref":"#/components/schemas/UserStatus"
}
},
"description":"Editable fields for updating a user: displayName, roleId, and status.",
"required":[
"displayName",
"roleId",
"status"
]
},
"CreateRoleRequest":{
"type":"object",
"properties":{
"roleCode":{
"type":"string",
"example":"COMPLIANCE_OFFICER"
},
"roleName":{
"type":"string",
"example":"Compliance Officer"
},
"description":{
"type":"string",
"nullable":true,
"example":"Reviews policy and compliance events."
},
"status":{
"$ref":"#/components/schemas/RoleStatus"
}
},
"required":[
"roleCode",
"roleName"
]
},
"UpdateRoleRequest":{
"type":"object",
"description":"Editable fields for updating a role. Omitted fields keep their current values.",
"properties":{
"roleCode":{
"type":"string",
"example":"ORG_ADMIN"
},
"roleName":{
"type":"string",
"example":"Organization Administrator"
},
"description":{
"type":"string",
"nullable":true,
"example":"Full access to organization administration features."
},
"status":{
"$ref":"#/components/schemas/RoleStatus"
}
}
},
"RoleResponse":{
"type":"object",
"properties":{
"id":{
"type":"integer",
"format":"int64",
"readOnly":true,
"example":1
},
"roleCode":{
"type":"string",
"example":"ORG_ADMIN"
},
"roleName":{
"type":"string",
"example":"Organization Admin"
},
"description":{
"type":"string",
"nullable":true,
"example":"Full access to organization administration features."
},
"status":{
"$ref":"#/components/schemas/RoleStatus"
},
"createdAt":{
"type":"string",
"format":"date-time",
"readOnly":true
},
"updatedAt":{
"type":"string",
"format":"date-time",
"readOnly":true
},
"createdBy":{
"type":"string",
"readOnly":true,
"example":"system"
},
"updatedBy":{
"type":"string",
"nullable":true,
"readOnly":true,
"example":"placeholder"
}
},
"required":[
"id",
"roleCode",
"roleName",
"status",
"createdAt",
"updatedAt",
"createdBy"
]
},
"RoleStatus":{
"type":"string",
"description":"Role lifecycle status.",
"enum":[
"ACTIVE",
"INACTIVE"
],
"example":"ACTIVE"
},
"PatchUserRequest":{
"type":"object",
"description":"Partial user update for editable fields.",
"properties":{
"displayName":{
"type":"string",
"example":"John Smith"
},
"roleId":{
"$ref":"#/components/schemas/RoleId"
},
"status":{
"$ref":"#/components/schemas/UserStatus"
}
}
},
"UserStatus":{
"type":"string",
"description":"User lifecycle status shown in User Management.",
"enum":[
"ACTIVE",
"INACTIVE"
],
"example":"ACTIVE"
},
"BlockchainType":{
"type":"string",
"description":"Blockchain family for wallet service mapping.",
"enum":[
"BESU",
"ERC-4337"
],
"example":"BESU"
},
"WalletServiceType":{
"type":"string",
"description":"Wallet service mapping type.",
"enum":[
"Instance-local",
"Global"
],
"example":"Instance-local"
},
"WalletServiceStatus":{
"type":"string",
"description":"Wallet service mapping status used to enable/disable availability.",
"enum":[
"Allowed",
"Blocked"
],
"example":"Allowed"
},
"WalletService":{
"type":"object",
"properties":{
"walletServiceId":{
"type":"string",
"readOnly":true,
"example":"wallet-service-uuid1",
"description":"Wallet service identifier."
},
"orgId":{
"type":"string",
"example":"org-founder-bank"
},
"instanceId":{
"type":"string",
"example":"instance-uuid1"
},
"walletServiceUrl":{
"type":"string",
"format":"uri",
"example":"https://wallet-service-instance1.example.com"
},
"rpcProxyUrl":{
"type":"string",
"format":"uri",
"example":"https://rpc-proxy-instance1.example.com"
},
"blockchain":{
"$ref":"#/components/schemas/BlockchainType"
},
"chainId":{
"type":"string",
"example":"1337"
},
"serviceType":{
"$ref":"#/components/schemas/WalletServiceType"
},
"status":{
"$ref":"#/components/schemas/WalletServiceStatus"
},
"createdAt":{
"type":"string",
"format":"date-time",
"readOnly":true
},
"updatedAt":{
"type":"string",
"format":"date-time",
"readOnly":true
}
},
"required":[
"walletServiceId",
"orgId",
"instanceId",
"walletServiceUrl",
"rpcProxyUrl",
"blockchain",
"chainId",
"serviceType",
"status",
"createdAt",
"updatedAt"
]
},
"OrganizationNetworkStatus":{
"type":"string",
"enum":[
"ACTIVE",
"INACTIVE"
],
"example":"ACTIVE"
},
"OrganizationNetworkAccessType":{
"type":"string",
"enum":[
"INSTANCE",
"GLOBAL"
],
"example":"INSTANCE"
},
"OrganizationNetworkResponse":{
"type":"object",
"properties":{
"organizationNetworkId":{
"type":"integer",
"format":"int64",
"example":1
},
"orgId":{
"type":"string",
"description":"External organization identifier from orgId.",
"example":"default_org"
},
"accessType":{
"$ref":"#/components/schemas/OrganizationNetworkAccessType"
},
"instanceId":{
"type":"string",
"example":"besu-instance-1"
},
"blockchainType":{
"type":"string",
"maxLength":64,
"example":"BESU"
},
"chainId":{
"type":"string",
"maxLength":128,
"example":"1337"
},
"rpcProxyUrl":{
"type":"string",
"maxLength":500,
"example":"http://rpc-proxy.default.svc:8545"
},
"walletServiceUrl":{
"type":"string",
"maxLength":500,
"example":"http://obp-besu-wallet-service.default.svc:8080"
},
"status":{
"$ref":"#/components/schemas/OrganizationNetworkStatus"
},
"createdBy":{
"type":"string",
"nullable":true,
"example":"system"
},
"updatedBy":{
"type":"string",
"nullable":true,
"example":"system"
},
"createdAt":{
"type":"string",
"format":"date-time",
"nullable":true
},
"updatedAt":{
"type":"string",
"format":"date-time",
"nullable":true
}
},
"required":[
"organizationNetworkId",
"orgId",
"accessType",
"instanceId",
"blockchainType",
"chainId",
"rpcProxyUrl",
"walletServiceUrl",
"status"
]
},
"OrganizationNetworkSummaryResponse":{
"allOf":[
{
"$ref":"#/components/schemas/OrganizationNetworkResponse"
}
]
},
"ListOrganizationNetworksResponse":{
"type":"object",
"properties":{
"items":{
"type":"array",
"items":{
"$ref":"#/components/schemas/OrganizationNetworkSummaryResponse"
}
},
"nextPageToken":{
"type":"string",
"nullable":true,
"example":"MjAyNi0wNy0xM1QxODozODowOXw3"
}
},
"required":[
"items"
]
},
"BulkCreateOrganizationNetworksResponse":{
"type":"object",
"properties":{
"items":{
"type":"array",
"items":{
"$ref":"#/components/schemas/OrganizationNetworkResponse"
}
}
},
"required":[
"items"
]
},
"BulkCreateOrganizationNetworksRequest":{
"type":"object",
"additionalProperties":false,
"properties":{
"items":{
"type":"array",
"minItems":1,
"maxItems":10,
"items":{
"$ref":"#/components/schemas/CreateOrganizationNetworkRequest"
}
}
},
"required":[
"items"
]
},
"CreateOrganizationNetworkRequest":{
"type":"object",
"additionalProperties":false,
"properties":{
"accessType":{
"$ref":"#/components/schemas/OrganizationNetworkAccessType"
},
"instanceId":{
"type":"string",
"maxLength":255,
"example":"4fb56966-7646-487b-9a5f-747162e919fd-org8"
},
"blockchainType":{
"type":"string",
"maxLength":64,
"example":"BESU"
},
"chainId":{
"type":"string",
"maxLength":128,
"example":"1500"
},
"status":{
"$ref":"#/components/schemas/OrganizationNetworkStatus"
}
},
"required":[
"accessType",
"instanceId",
"blockchainType",
"chainId",
"status"
]
},
"UpdateOrganizationNetworkRequest":{
"allOf":[
{
"$ref":"#/components/schemas/CreateOrganizationNetworkRequest"
}
]
},
"ListWalletsResponse":{
"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"
]
},
"ListedWallet":{
"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"
]
},
"Wallet":{
"type":"object",
"properties":{
"partitionWalletId":{
"type":"integer",
"format":"int64",
"readOnly":true,
"example":1001
},
"instanceId":{
"type":"integer",
"format":"int64",
"readOnly":true,
"example":10
},
"accountId":{
"type":"string",
"readOnly":true,
"example":"0f4f8849-2d79-45f8-b5f9-512bb7a3e1a1"
},
"orgNetworkId":{
"type":"integer",
"format":"int64",
"readOnly":true,
"example":20
},
"networkId":{
"type":"integer",
"format":"int64",
"readOnly":true,
"example":30
},
"walletServiceId":{
"type":"integer",
"format":"int64",
"readOnly":true,
"example":40
},
"blockchainType":{
"type":"string",
"readOnly":true,
"example":"BESU"
},
"walletId":{
"type":"string",
"readOnly":true,
"example":"62d00d4f-1851-4126-aa77-dcef4f816c78"
},
"orgId":{
"type":"string",
"example":"org-founder-bank"
},
"userId":{
"type":"string",
"example":"0f4f8849-2d79-45f8-b5f9-512bb7a3e1a1"
},
"label":{
"type":"string",
"example":"Trading"
},
"status":{
"$ref":"#/components/schemas/WalletStatus"
},
"type":{
"$ref":"#/components/schemas/WalletType"
},
"address":{
"type":"string",
"readOnly":true,
"example":"0x7d4a91c8b5e2f60a9d13c4b8e7f1a2c6d9e0f4a1"
},
"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",
"description":"Tags assigned to this wallet.",
"items":{
"type":"string"
},
"readOnly":true,
"example":[
"treasury",
"settlement"
]
},
"walletService":{
"type":"object",
"properties":{
"walletServiceId":{
"type":"string",
"example":"wallet-service-uuid1"
},
"walletServiceUrl":{
"type":"string",
"format":"uri",
"example":"https://wallet-service-instance1.example.com"
},
"rpcProxyUrl":{
"type":"string",
"format":"uri",
"example":"https://rpc-proxy-instance1.example.com"
},
"blockchain":{
"$ref":"#/components/schemas/BlockchainType"
},
"chainId":{
"type":"string",
"example":"1337"
},
"serviceType":{
"$ref":"#/components/schemas/WalletServiceType"
},
"status":{
"$ref":"#/components/schemas/WalletServiceStatus"
}
},
"required":[
"walletServiceId",
"walletServiceUrl",
"rpcProxyUrl",
"blockchain",
"chainId",
"serviceType",
"status"
]
}
},
"required":[
"walletId",
"orgId",
"userId",
"label",
"status",
"type",
"address",
"walletService"
]
},
"CreateWalletRequest":{
"type":"object",
"properties":{
"orgId":{
"type":"string",
"description":"External organization identifier from orgId.",
"example":"org-founder-bank"
},
"orgNetworkId":{
"type":"integer",
"format":"int64",
"example":1
},
"userId":{
"type":"string",
"format":"uuid",
"example":"3833bcfc-3b52-4705-b079-29947cf1cbe5"
},
"walletLabel":{
"type":"string",
"example":"Founder-mobile"
},
"status":{
"$ref":"#/components/schemas/CreateWalletStatus"
},
"walletType":{
"$ref":"#/components/schemas/WalletType"
},
"ownershipType":{
"$ref":"#/components/schemas/OwnershipType"
},
"walletTags":{
"type":"array",
"description":"Optional tags to assign to the wallet. Tags are normalized before persistence.",
"items":{
"type":"string"
},
"example":[
"internal",
"hot"
]
}
},
"required":[
"orgId",
"orgNetworkId",
"userId",
"walletLabel",
"status",
"walletType"
]
},
"CreateWalletResponse":{
"type":"object",
"properties":{
"walletId":{
"type":"string",
"example":"62d00d4f-1851-4126-aa77-dcef4f816c78"
},
"address":{
"type":"string",
"example":"0x599f59e794c88a108e0cc2072b7a52fa3576cea4"
},
"userId":{
"type":"string",
"example":"alice"
},
"label":{
"type":"string",
"example":"Founder-bluetooth"
},
"status":{
"$ref":"#/components/schemas/WalletStatus"
},
"walletType":{
"$ref":"#/components/schemas/WalletType"
},
"walletTypeLabel":{
"type":"string",
"example":"Custodial"
},
"ownershipType":{
"$ref":"#/components/schemas/OwnershipType"
},
"providerType":{
"type":"string",
"example":"ADAPTER_HTTP"
},
"providerWalletRef":{
"type":"string",
"example":"0x599f59e794c88a108e0cc2072b7a52fa3576cea4"
}
},
"required":[
"walletId",
"address",
"label",
"status",
"walletType",
"walletTypeLabel",
"providerType",
"providerWalletRef"
]
},
"UploadKeyRequest":{
"type":"object",
"properties":{
"orgId":{
"type":"string",
"example":"default_org"
},
"orgNetworkId":{
"type":"integer",
"format":"int64",
"example":1
},
"userId":{
"type":"string",
"format":"uuid",
"example":"41e38baa-aedf-4704-9633-923749cac6aa"
},
"walletLabel":{
"type":"string",
"example":"nitesh-approver-2"
},
"walletType":{
"$ref":"#/components/schemas/WalletType"
},
"ownershipType":{
"$ref":"#/components/schemas/OwnershipType"
},
"status":{
"$ref":"#/components/schemas/CreateWalletStatus"
},
"walletTags":{
"type":"array",
"description":"Optional tags to assign to the imported wallet.",
"items":{
"type":"string"
},
"example":[
"e:dev",
"a:erc20"
]
},
"privateKeyB64":{
"type":"string",
"description":"Base64-encoded private key.",
"example":"Yzg3NTA5YTFjMDY3YmJkZTc4YmViNzkzZTZmYTc2NTMwYjYzODJhNGMwMjQxZTVlNGE5ZWMwYTBmNDRkYzBkMw=="
}
},
"required":[
"orgId",
"orgNetworkId",
"userId",
"walletLabel",
"walletType",
"status",
"privateKeyB64"
]
},
"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"
]
},
"UpdateWalletRequest":{
"type":"object",
"properties":{
"label":{
"type":"string",
"example":"Trading Desk"
},
"type":{
"$ref":"#/components/schemas/WalletType"
},
"status":{
"$ref":"#/components/schemas/WalletStatus",
"description":"Optional for compatibility; lifecycle endpoints are preferred for status transitions."
},
"updatedBy":{
"type":"string",
"example":"alice"
}
}
},
"PutWalletUpdateRequest":{
"type":"object",
"additionalProperties":false,
"minProperties":1,
"description":"Mutable wallet fields for PUT /v1/uwaas/wallets/{walletId}. Omitted fields are not changed.",
"properties":{
"walletLabel":{
"type":"string",
"nullable":true,
"maxLength":255,
"description":"Trimmed before persistence. Null clears the label.",
"example":"UWaaS-neural"
},
"status":{
"type":"string",
"enum":[
"ACTIVE",
"INACTIVE",
"CLOSED"
],
"example":"ACTIVE"
},
"walletTags":{
"type":"array",
"description":"Replaces the entire tag set. Values are trimmed, lower-cased, deduplicated, and must not\nnormalize to empty strings.",
"items":{
"type":"string",
"maxLength":255
},
"example":[
"dev"
]
}
}
},
"CreateWalletStatus":{
"type":"string",
"description":"Wallet status values allowed at creation time.",
"enum":[
"ACTIVE",
"INACTIVE",
"CLOSED"
],
"example":"ACTIVE"
},
"WalletStatus":{
"type":"string",
"description":"Wallet lifecycle status.",
"enum":[
"ACTIVE",
"INACTIVE",
"CLOSED"
],
"example":"ACTIVE"
},
"WalletType":{
"type":"string",
"description":"Wallet type used by Wallet Admin UI. \"1\" = Custodial.",
"enum":[
"1"
],
"example":"1"
},
"OwnershipType":{
"type":"string",
"description":"Type of wallet ownership. Defaults to USER",
"default":"USER",
"enum":[
"USER",
"SERVICE"
]
},
"WalletLifecycleRequest":{
"type":"object",
"properties":{
"updatedBy":{
"type":"string",
"example":"alice"
}
},
"required":[
"updatedBy"
]
},
"HealthStatus":{
"type":"object",
"properties":{
"status":{
"type":"string",
"example":"ok"
},
"timestamp":{
"type":"string",
"format":"date-time"
},
"details":{
"type":"object",
"additionalProperties":true
}
}
},
"RoleId":{
"type":"integer",
"format":"int64",
"minimum":1,
"maximum":4,
"exclusiveMinimum":false,
"exclusiveMaximum":false,
"description":"Role identifier. Mapping:\n1 - WALLET_SUPER_ADMIN\n2 - ORG_ADMIN\n3 - ORG_USER\n4 - TOKEN_ADMIN\n",
"example":3
}
},
"examples":{
"ListRulesResponse":{
"summary":"Two rules",
"value":{
"items":[
{
"id":1,
"name":"TxnLimit20k",
"conditions":{
"all":[
{
"fact":"txn_value",
"value":20000,
"operator":"greaterThanInclusive"
}
]
},
"response":{
"type":"BLOCK",
"params":{
"message":"Transaction limit must not exceed 20000"
}
},
"category":"Transaction Limits",
"description":"Block transactions exceeding 20000 value.",
"scopelevels":[
"org"
],
"targets":[
{
"orgIds":[
"red_bank",
"green_bank"
]
}
],
"enabled":true,
"priority":1,
"createdBy":"user",
"updatedBy":"n/a",
"createdAt":"2026-07-01T18:12:43.000Z",
"updatedAt":"2026-07-01T18:12:43.000Z",
"tags":[
"jurisdiction:us",
"kind:transfer"
]
},
{
"id":2,
"name":"AllowList",
"conditions":{
"all":[
{
"fact":"currency_type",
"operator":"notIn",
"value":"[USDC, USDT]"
}
]
},
"response":{
"type":"BLOCK",
"params":{
"message":"Only allow-listed currencies are available for transfer."
}
},
"scopelevels":[
"instance"
],
"targets":{
"instanceIds":[
"Circle",
"Square"
]
},
"description":"Define allowlist for specific assets.",
"enabled":true,
"category":"Asset Control",
"priority":1,
"createdBy":"user",
"updatedBy":"n/a",
"createdAt":"2026-07-01T18:12:43.000Z",
"updatedAt":"2026-07-01T18:12:43.000Z",
"tags":[
]
}
]
}
},
"GetRuleResponse":{
"summary":"Basic Transaction Limit",
"value":{
"id":1,
"name":"TxnLimit20k",
"conditions":{
"all":[
{
"fact":"txn_value",
"value":20000,
"operator":"greaterThanInclusive"
}
]
},
"response":{
"type":"BLOCK",
"params":{
"message":"Transaction limit must not exceed 20000"
}
},
"category":"Transaction Limits",
"description":"Block transactions exceeding 20000 value.",
"scopelevels":[
"org"
],
"targets":[
{
"orgIds":[
"red_bank",
"green_bank"
]
}
],
"enabled":true,
"priority":1,
"createdBy":"user",
"updatedBy":"n/a",
"createdAt":"2026-07-01T18:12:43.000Z",
"updatedAt":"2026-07-01T18:12:43.000Z",
"tags":[
"jurisdiction:us",
"kind:transfer"
]
}
}
},
"parameters":{
"OrganizationId":{
"name":"organizationId",
"required":true,
"description":"Internal organization identifier.",
"schema":{
"type":"integer",
"format":"int64"
},
"example":1,
"in":"path"
},
"OrgId":{
"name":"orgId",
"required":true,
"description":"External organization identifier.",
"schema":{
"type":"string"
},
"example":"org-founder-bank",
"in":"path"
},
"OrgNetworkId":{
"name":"orgNetworkId",
"required":true,
"description":"Organization network identifier.",
"schema":{
"type":"string"
},
"example":"1",
"in":"path"
},
"OrganizationNetworkId":{
"name":"organizationNetworkId",
"required":true,
"description":"Organization network identifier.",
"schema":{
"type":"integer"
},
"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"
},
"RoleId":{
"name":"roleId",
"required":true,
"description":"Role identifier. Mapping:\n1 - WALLET_SUPER_ADMIN\n2 - ORG_ADMIN\n3 - ORG_USER\n4 - TOKEN_ADMIN\n",
"schema":{
"type":"integer",
"format":"int64"
},
"example":1,
"in":"path"
},
"WalletServiceId":{
"name":"walletServiceId",
"required":true,
"description":"Wallet service mapping identifier.",
"schema":{
"type":"string"
},
"example":"wallet-service-uuid1",
"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":"string",
"format":"uuid"
},
"example":"87f44061-737b-4f66-9f26-e0d8d0e2b495",
"in":"path"
},
"PartitionWalletId":{
"name":"partitionWalletId",
"required":true,
"description":"Partition wallet row identifier.",
"schema":{
"type":"integer",
"format":"int64"
},
"example":1001,
"in":"path"
},
"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":"0xabc123",
"in":"path"
},
"PartitionId":{
"name":"partitionId",
"required":true,
"description":"Partition identifier.",
"schema":{
"type":"string"
},
"example":"1",
"in":"path"
},
"SubmissionMode":{
"name":"submissionMode",
"required":false,
"description":"Submission behavior for wallet transfers.",
"schema":{
"type":"string",
"enum":[
"sync"
]
},
"example":"sync",
"in":"query"
}
},
"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":"Forbidden.",
"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"
}
}
}
}
},
"requestBodies":{
"CreateOrganizationRequest":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CreateOrganizationRequest"
},
"examples":{
"createOrg":{
"value":{
"orgId":"org-7e2c72cf-962f-42b3-8580-64bd7bd96eb6",
"organizationName":"McClure LLC",
"description":"This is a company.",
"tags":[
"jurisdiction:eu",
"jurisdiction:emea"
],
"status":"ACTIVE"
}
}
}
}
}
},
"UpdateOrganizationRequest":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/UpdateOrganizationRequest"
},
"examples":{
"updateOrg":{
"value":{
"orgId":"org-d304441f-9b69-420c-b0af-dc77e3bff16b",
"organizationName":"Organization A",
"description":"This is a company.",
"tags":[
"tier:gold"
],
"status":"INACTIVE"
}
}
}
}
}
},
"CreateWalletRequest":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CreateWalletRequest"
},
"example":{
"orgId":"org-founder-bank",
"orgNetworkId":1,
"userId":"3833bcfc-3b52-4705-b079-29947cf1cbe5",
"walletLabel":"Founder-mobile",
"walletType":"1",
"ownershipType":"USER",
"status":"ACTIVE",
"walletTags":[
"hot"
]
}
}
}
},
"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"
},
"examples":{
"UserUpload":{
"summary":"Standard user key upload",
"value":{
"orgId":"default_org",
"orgNetworkId":1,
"userId":"41e38baa-aedf-4704-9633-923749cac6aa",
"walletLabel":"nitesh-approver-2",
"walletType":"1",
"ownershipType":"USER",
"status":"ACTIVE",
"walletTags":[
"e:dev",
"a:erc20"
],
"privateKeyB64":"Yzg3NTA5YTFjMDY3YmJkZTc4YmViNzkzZTZmYTc2NTMwYjYzODJhNGMwMjQxZTVlNGE5ZWMwYTBmNDRkYzBkMw=="
}
},
"ServiceUpload":{
"summary":"Service key upload",
"value":{
"orgId":"default_org",
"orgNetworkId":1,
"userId":"7b5a1406-8521-4f75-a44a-168380b04b73",
"walletLabel":"service-wallet",
"walletType":"1",
"ownershipType":"SERVICE",
"status":"ACTIVE",
"walletTags":[
"e:dev",
"a:erc20"
],
"privateKeyB64":"Yzg3NTA5YTFjMDY3YmJkZTc4YmViNzkzZTZmYTc2NTMwYjYzODJhNGMwMjQxZTVlNGE5ZWMwYTBmNDRkYzBkMw=="
}
}
}
}
}
},
"UpdateWalletRequest":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/UpdateWalletRequest"
},
"example":{
"label":"Trading Desk",
"type":"1",
"updatedBy":"alice"
}
}
}
},
"PutWalletUpdateRequest":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PutWalletUpdateRequest"
},
"examples":{
"allFields":{
"value":{
"walletLabel":"Treasury Wallet",
"status":"ACTIVE",
"walletTags":[
"finance",
"treasury"
]
}
},
"clearLabelAndTags":{
"value":{
"walletLabel":null,
"walletTags":[
]
}
}
}
}
}
},
"CreateUserRequest":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CreateUserRequest"
},
"examples":{
"createUser":{
"value":{
"userId":"7b5a1406-8521-4f75-a44a-168380b04b73",
"displayName":"Mr. Stuart Leuschke",
"email":"Hubert_Swaniawski31@acme.com",
"roleId":1,
"status":"ACTIVE"
}
}
}
}
}
},
"UpdateUserRequest":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/UpdateUserRequest"
},
"examples":{
"updateUser":{
"value":{
"displayName":"Nancy Yost PhD",
"roleId":2,
"status":"ACTIVE"
}
}
}
}
}
},
"CreateRoleRequest":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CreateRoleRequest"
},
"example":{
"roleCode":"COMPLIANCE_OFFICER",
"roleName":"Compliance Officer",
"description":"Reviews policy and compliance events.",
"status":"ACTIVE"
}
}
}
},
"UpdateRoleRequest":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/UpdateRoleRequest"
},
"example":{
"roleCode":"ORG_ADMIN",
"roleName":"Organization Administrator",
"description":"Full access to organization administration features.",
"status":"ACTIVE"
}
}
}
},
"PatchUserRequest":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PatchUserRequest"
},
"examples":{
"suspendUser":{
"value":{
"status":"INACTIVE"
}
},
"activateUser":{
"value":{
"status":"ACTIVE"
}
}
}
}
}
},
"CreateOrganizationNetworkRequest":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CreateOrganizationNetworkRequest"
},
"example":{
"accessType":"INSTANCE",
"instanceId":"instance-uuid1",
"blockchainType":"BESU",
"chainId":"1500",
"status":"ACTIVE"
}
}
}
},
"BulkCreateOrganizationNetworksRequest":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/BulkCreateOrganizationNetworksRequest"
},
"example":{
"items":[
{
"accessType":"INSTANCE",
"instanceId":"instance-uuid1",
"blockchainType":"BESU",
"chainId":"1337",
"status":"ACTIVE"
},
{
"accessType":"INSTANCE",
"instanceId":"instance-uuid2",
"blockchainType":"BESU",
"chainId":"1338",
"status":"ACTIVE"
}
]
}
}
}
},
"UpdateOrganizationNetworkRequest":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/UpdateOrganizationNetworkRequest"
},
"example":{
"accessType":"INSTANCE",
"instanceId":"instance-uuid1",
"blockchainType":"BESU",
"chainId":"1500",
"status":"ACTIVE"
}
}
}
}
},
"securitySchemes":{
"bearerAuth":{
"type":"http",
"scheme":"bearer",
"bearerFormat":"JWT",
"description":"Use Authorization: Bearer {{jwt}} for all endpoints except /ready and /observe/health."
}
}
},
"paths":{
"/v1/uwaas/rules":{
"get":{
"tags":[
"Rules"
],
"operationId":"ListRules",
"summary":"List Rules",
"description":"Lists all rules.",
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ListRulesResponse"
},
"examples":{
"one":{
"$ref":"#/components/examples/ListRulesResponse"
}
}
}
}
}
},
"x-internal-id":"v1-uwaas-rules-get",
"x-filename-id":"v1-uwaas-rules-get"
},
"post":{
"tags":[
"Rules"
],
"operationId":"CreateRule",
"summary":"Create a Rule",
"description":"Creates a rule and refreshes the rules engine.",
"responses":{
"201":{
"description":"Rule created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CreateRuleResponse"
}
}
}
},
"400":{
"description":"Validation error",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/AppError"
}
}
}
}
},
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CreateRuleRequest"
},
"example":{
"name":"AllowList",
"conditions":{
"all":[
{
"fact":"currency_type",
"operator":"notIn",
"value":"[USDC, USDT]"
}
]
},
"response":{
"type":"BLOCK",
"params":{
"message":"Only allow-listed currencies are available for transfer."
}
},
"scopelevels":[
"instance"
],
"targets":{
"instanceIds":[
"Circle",
"Square"
]
},
"description":"Define allowlist for specific assets.",
"enabled":true,
"category":"Asset Control"
}
}
}
},
"x-internal-id":"v1-uwaas-rules-post",
"x-filename-id":"v1-uwaas-rules-post"
}
},
"/v1/uwaas/rules/{id}":{
"parameters":[
{
"in":"path",
"name":"id",
"required":true,
"schema":{
"$ref":"#/components/schemas/RulesIdParam"
}
}
],
"get":{
"tags":[
"Rules"
],
"operationId":"GetRule",
"summary":"Get a Rule",
"description":"Retrieve a rule by ID.",
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/GetRuleResponse"
},
"examples":{
"one":{
"$ref":"#/components/examples/GetRuleResponse"
}
}
}
}
},
"400":{
"description":"Validation error",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/AppError"
}
}
}
},
"404":{
"description":"Rule not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/AppError"
}
}
}
}
},
"x-internal-id":"v1-uwaas-rules-{id}-get",
"x-filename-id":"v1-uwaas-rules-id-get"
},
"patch":{
"tags":[
"Rules"
],
"operationId":"PatchRule",
"summary":"Patch Rules",
"description":"Updates a rule and refreshes the rules engine.",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PatchRuleRequest"
},
"example":{
"enabled":false
}
}
}
},
"responses":{
"200":{
"description":"Rule patched",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PatchRuleResponse"
}
}
}
},
"400":{
"description":"Validation error",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/AppError"
}
}
}
},
"404":{
"description":"Rule not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/AppError"
}
}
}
}
},
"x-internal-id":"v1-uwaas-rules-{id}-patch",
"x-filename-id":"v1-uwaas-rules-id-patch"
}
},
"/v1/uwaas/rules/evaluate":{
"post":{
"tags":[
"Evaluate"
],
"operationId":"EvaluateOnFilteredRules",
"summary":"Evaluate Filtered Rules",
"description":"Evaluate a data payload against all active rules filtered by scope and tags.",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/EvaluateOnFilteredRulesRequest"
},
"examples":{
"one":{
"summary":"No filters",
"value":{
"facts":{
"currency_type":"USDC",
"sky_color":"blue"
}
}
},
"two":{
"summary":"With filters",
"value":{
"facts":{
"currency_type":"USDC"
},
"tags":[
"jurisdiction:us"
],
"targets":{
"orgIds":[
"purple_bank"
]
}
}
}
}
}
}
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/EvaluateOnFilteredRulesResponse"
}
}
}
},
"500":{
"description":"Internal server error"
}
},
"x-internal-id":"v1-uwaas-rules-evaluate-post",
"x-filename-id":"v1-uwaas-rules-evaluate-post"
}
},
"/v1/uwaas/rules/evaluate/{id}":{
"parameters":[
{
"in":"path",
"name":"id",
"required":true,
"schema":{
"$ref":"#/components/schemas/RulesIdParam"
}
}
],
"post":{
"tags":[
"Evaluate"
],
"operationId":"EvaluateOnSingleRule",
"summary":"Evaluate a Rule",
"description":"Evaluate a data payload against one rule.",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/EvaluateOnSingleRuleRequest"
},
"example":{
"facts":{
"currency_type":"USDC",
"sky_color":"blue"
}
}
}
}
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/EvaluateOnSingleRuleResponse"
}
}
}
},
"404":{
"description":"Rule not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/AppError"
}
}
}
},
"500":{
"description":"Internal server error",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/AppError"
}
}
}
}
},
"x-internal-id":"v1-uwaas-rules-evaluate-{id}-post",
"x-filename-id":"v1-uwaas-rules-evaluate-id-post"
}
},
"/v1/uwaas/orgs":{
"get":{
"tags":[
"Organizations"
],
"summary":"List Organizations",
"description":"List organizations using cursor-based pagination.",
"operationId":"listOrgs",
"parameters":[
{
"name":"pageSize",
"in":"query",
"required":false,
"description":"Maximum number of organizations to return.",
"schema":{
"type":"integer",
"minimum":1,
"maximum":100,
"default":50
},
"example":5
},
{
"name":"nextPageToken",
"in":"query",
"required":false,
"description":"Opaque cursor returned by the previous page.",
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Organizations retrieved successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ListOrganizationsResponse"
},
"example":{
"items":[
{
"orgId":"org-99762dae-9962-4523-ad30-d2b51fd3b06c",
"organizationName":"Organization A",
"description":"This is a company.",
"tags":[
"jurisdiction:us"
],
"status":"ACTIVE",
"isDeleted":false,
"createdAt":"2026-07-13T17:55:07Z",
"createdBy":"08819d29-de56-48ea-a140-bc4ac73952ed",
"updatedAt":"2026-07-13T17:55:07Z"
},
{
"orgId":"orgA",
"organizationName":"Organization B",
"description":"This is a company.",
"tags":[
"jurisdiction:papss"
],
"status":"ACTIVE",
"isDeleted":false,
"createdAt":"2026-07-07T01:54:05Z",
"createdBy":"08819d29-de56-48ea-a140-bc4ac73952ed",
"updatedAt":"2026-07-13T17:38:33Z",
"updatedBy":"d19dc46e-dcca-4ebf-855e-98454e35f014"
},
{
"orgId":"orgB",
"organizationName":"Organization C",
"description":"This is a company.",
"tags":[
],
"status":"ACTIVE",
"isDeleted":false,
"createdAt":"2026-07-10T17:48:03Z",
"createdBy":"08819d29-de56-48ea-a140-bc4ac73952ed",
"updatedAt":"2026-07-13T17:38:08Z",
"updatedBy":"d19dc46e-dcca-4ebf-855e-98454e35f014"
},
{
"orgId":"org-aaf21420-b8aa-4e2c-af2d-f463856f7ed0",
"organizationName":"Organization D",
"description":"This is a company.",
"tags":[
],
"status":"ACTIVE",
"isDeleted":false,
"createdAt":"2026-07-09T11:03:33Z",
"createdBy":"2520db59-06eb-4aaf-9604-c473ebc358bb",
"updatedAt":"2026-07-09T11:03:33Z"
},
{
"orgId":"org-d304441f-9b69-420c-b0af-dc77e3bff16b",
"organizationName":"Organization E",
"description":"This is a company.",
"tags":[
],
"status":"ACTIVE",
"isDeleted":false,
"createdAt":"2026-07-13T17:57:44Z",
"createdBy":"08819d29-de56-48ea-a140-bc4ac73952ed",
"updatedAt":"2026-07-13T17:57:44Z"
}
],
"nextPageToken":"djF8VTJOb2FXMXRaV3dnU1c1anw4"
}
}
}
},
"400":{
"$ref":"#/components/responses/BadRequest"
},
"500":{
"$ref":"#/components/responses/InternalServerError"
}
},
"x-internal-id":"v1-uwaas-orgs-get",
"x-filename-id":"v1-uwaas-orgs-get"
},
"post":{
"tags":[
"Organizations"
],
"summary":"Create Organization",
"description":"Creates an organization.",
"operationId":"createOrg",
"requestBody":{
"$ref":"#/components/requestBodies/CreateOrganizationRequest"
},
"responses":{
"201":{
"description":"Organization created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/OrganizationResponse"
},
"example":{
"orgId":"org-99762dae-9962-4523-ad30-d2b51fd3b06c",
"organizationName":"Organization A",
"description":"This is a company.",
"tags":[
"jurisdiction:us"
],
"status":"ACTIVE",
"isDeleted":false,
"createdAt":"2026-07-13T17:55:06.936218622Z",
"createdBy":"08819d29-de56-48ea-a140-bc4ac73952ed",
"updatedAt":"2026-07-13T17:55:06.936218622Z"
}
}
}
},
"400":{
"$ref":"#/components/responses/BadRequest"
},
"409":{
"description":"Organization name already exists.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"500":{
"$ref":"#/components/responses/InternalServerError"
}
},
"x-internal-id":"v1-uwaas-orgs-post",
"x-filename-id":"v1-uwaas-orgs-post"
}
},
"/v1/uwaas/orgs/{orgId}":{
"get":{
"tags":[
"Organizations"
],
"summary":"Get Organization",
"description":"Get an organization by ID.",
"operationId":"getOrgByOrgId",
"parameters":[
{
"$ref":"#/components/parameters/OrgId"
}
],
"responses":{
"200":{
"description":"Organization retrieved successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/OrganizationResponse"
},
"example":{
"orgId":"founder",
"organizationName":"Founder-Org",
"description":"This is a company.",
"tags":[
"jurisdiction:papss"
],
"status":"ACTIVE",
"isDeleted":false,
"createdAt":"2026-07-07T01:54:05Z",
"createdBy":"08819d29-de56-48ea-a140-bc4ac73952ed",
"updatedAt":"2026-07-13T17:38:33Z",
"updatedBy":"d19dc46e-dcca-4ebf-855e-98454e35f014"
}
}
}
},
"400":{
"$ref":"#/components/responses/BadRequest"
},
"401":{
"$ref":"#/components/responses/Unauthorized"
},
"404":{
"$ref":"#/components/responses/NotFound"
},
"500":{
"$ref":"#/components/responses/InternalServerError"
}
},
"x-internal-id":"v1-uwaas-orgs-{orgId}-get",
"x-filename-id":"v1-uwaas-orgs-orgid-get"
},
"put":{
"tags":[
"Organizations"
],
"summary":"Update Organization",
"description":"Update an organization by ID.",
"operationId":"updateOrg",
"parameters":[
{
"$ref":"#/components/parameters/OrgId"
}
],
"requestBody":{
"$ref":"#/components/requestBodies/UpdateOrganizationRequest"
},
"responses":{
"200":{
"description":"Organization updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/OrganizationResponse"
},
"example":{
"orgId":"org-d304441f-9b69-420c-b0af-dc77e3bff16b",
"organizationName":"Organization A",
"description":"This is a company.",
"tags":[
"jurisdiction:asean"
],
"status":"INACTIVE",
"isDeleted":false,
"createdAt":"2026-07-13T17:57:44Z",
"createdBy":"08819d29-de56-48ea-a140-bc4ac73952ed",
"updatedAt":"2026-07-13T18:19:19Z",
"updatedBy":"d19dc46e-dcca-4ebf-855e-98454e35f014"
}
}
}
},
"400":{
"$ref":"#/components/responses/BadRequest"
},
"404":{
"$ref":"#/components/responses/NotFound"
},
"409":{
"description":"Organization name already exists.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"500":{
"$ref":"#/components/responses/InternalServerError"
}
},
"x-internal-id":"v1-uwaas-orgs-{orgId}-put",
"x-filename-id":"v1-uwaas-orgs-orgid-put"
}
},
"/v1/uwaas/organization-networks":{
"get":{
"tags":[
"Organization Networks"
],
"summary":"List Organization Networks",
"description":"Lists organization network configurations across all organizations. When `orgId` is provided, results are restricted to that organization.\n",
"operationId":"listOrganizationNetworks",
"parameters":[
{
"name":"orgId",
"in":"query",
"required":false,
"description":"Organization identifier.",
"schema":{
"type":"string"
},
"example":"default_org"
},
{
"name":"instanceId",
"in":"query",
"required":false,
"description":"Optional instance identifier used to filter organization networks.",
"schema":{
"type":"string"
}
},
{
"name":"pageSize",
"in":"query",
"required":false,
"description":"Maximum number of organization networks to return.",
"schema":{
"type":"integer",
"minimum":1,
"maximum":200,
"default":5
},
"example":5
},
{
"name":"nextPageToken",
"in":"query",
"required":false,
"description":"Opaque cursor returned by the previous page.",
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Organization networks retrieved successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ListOrganizationNetworksResponse"
},
"example":{
"items":[
{
"organizationNetworkId":11,
"orgId":"default_org",
"accessType":"INSTANCE",
"instanceId":"instance-uuid1",
"blockchainType":"BESU",
"chainId":"1500",
"rpcProxyUrl":"https://rpc-proxy.example.com:8443",
"walletServiceUrl":"http://wallet-service.example.com:58080/v1/",
"status":"ACTIVE",
"createdBy":"d19dc46e-dcca-4ebf-855e-98454e35f014",
"createdAt":"2026-07-13T18:38:14Z",
"updatedAt":"2026-07-13T18:38:14Z"
},
{
"organizationNetworkId":10,
"orgId":"default_org",
"accessType":"INSTANCE",
"instanceId":"instance-uuid2",
"blockchainType":"BESU",
"chainId":"1500",
"rpcProxyUrl":"https://rpc-proxy.example.com:8443",
"walletServiceUrl":"http://wallet-service.example.com:58080/v1/",
"status":"ACTIVE",
"createdBy":"d19dc46e-dcca-4ebf-855e-98454e35f014",
"createdAt":"2026-07-13T18:38:13Z",
"updatedAt":"2026-07-13T18:38:13Z"
},
{
"organizationNetworkId":9,
"orgId":"default_org",
"accessType":"INSTANCE",
"instanceId":"instance-uuid3",
"blockchainType":"BESU",
"chainId":"1500",
"rpcProxyUrl":"https://rpc-proxy.example.com:8443",
"walletServiceUrl":"http://wallet-service.example.com:58080/v1/",
"status":"ACTIVE",
"createdBy":"d19dc46e-dcca-4ebf-855e-98454e35f014",
"createdAt":"2026-07-13T18:38:12Z",
"updatedAt":"2026-07-13T18:38:12Z"
},
{
"organizationNetworkId":8,
"orgId":"default_org",
"accessType":"INSTANCE",
"instanceId":"instance-uuid4",
"blockchainType":"BESU",
"chainId":"1500",
"rpcProxyUrl":"https://rpc-proxy.example.com:8443",
"walletServiceUrl":"http://wallet-service.example.com:58080/v1/",
"status":"ACTIVE",
"createdBy":"d19dc46e-dcca-4ebf-855e-98454e35f014",
"createdAt":"2026-07-13T18:38:11Z",
"updatedAt":"2026-07-13T18:38:11Z"
},
{
"organizationNetworkId":7,
"orgId":"default_org",
"accessType":"INSTANCE",
"instanceId":"instance-uuid5",
"blockchainType":"BESU",
"chainId":"1500",
"rpcProxyUrl":"https://rpc-proxy.example.com:8443",
"walletServiceUrl":"http://wallet-service.example.com:58080/v1/",
"status":"ACTIVE",
"createdBy":"d19dc46e-dcca-4ebf-855e-98454e35f014",
"createdAt":"2026-07-13T18:38:09Z",
"updatedAt":"2026-07-13T18:38:09Z"
}
],
"nextPageToken":"MjAyNi0wNy0xM1QxODozODowOXw3"
}
}
}
},
"400":{
"$ref":"#/components/responses/BadRequest"
},
"500":{
"$ref":"#/components/responses/InternalServerError"
}
},
"x-internal-id":"v1-uwaas-organization-networks-get",
"x-filename-id":"v1-uwaas-organization-networks-get"
}
},
"/v1/uwaas/orgs/{orgId}/organization-networks":{
"get":{
"tags":[
"Organization Networks"
],
"summary":"List Organization Networks",
"description":"List organization network configurations for an organization identified by external `orgId`.",
"operationId":"listOrganizationNetworksByOrg",
"parameters":[
{
"$ref":"#/components/parameters/OrgId"
},
{
"name":"pageSize",
"in":"query",
"required":false,
"description":"Maximum number of organization networks to return.",
"schema":{
"type":"integer",
"minimum":1,
"maximum":200,
"default":50
},
"example":5
},
{
"name":"nextPageToken",
"in":"query",
"required":false,
"description":"Opaque cursor returned by the previous page.",
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Organization networks retrieved successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ListOrganizationNetworksResponse"
},
"example":{
"items":[
{
"organizationNetworkId":11,
"orgId":"org-founder-bank",
"accessType":"INSTANCE",
"instanceId":"instance-uuid1",
"blockchainType":"BESU",
"chainId":"1500",
"rpcProxyUrl":"https://rpc-proxy.example.com:8443",
"walletServiceUrl":"http://wallet-service.example.com:58080/v1/",
"status":"ACTIVE",
"createdBy":"d19dc46e-dcca-4ebf-855e-98454e35f014",
"createdAt":"2026-07-13T18:38:14Z",
"updatedAt":"2026-07-13T18:38:14Z"
},
{
"organizationNetworkId":10,
"orgId":"org-founder-bank",
"accessType":"INSTANCE",
"instanceId":"instance-uuid2",
"blockchainType":"BESU",
"chainId":"1500",
"rpcProxyUrl":"https://rpc-proxy.example.com:8443",
"walletServiceUrl":"http://wallet-service.example.com:58080/v1/",
"status":"ACTIVE",
"createdBy":"d19dc46e-dcca-4ebf-855e-98454e35f014",
"createdAt":"2026-07-13T18:38:13Z",
"updatedAt":"2026-07-13T18:38:13Z"
},
{
"organizationNetworkId":9,
"orgId":"org-founder-bank",
"accessType":"INSTANCE",
"instanceId":"instance-uuid3",
"blockchainType":"BESU",
"chainId":"1500",
"rpcProxyUrl":"https://rpc-proxy.example.com:8443",
"walletServiceUrl":"http://wallet-service.example.com:58080/v1/",
"status":"ACTIVE",
"createdBy":"d19dc46e-dcca-4ebf-855e-98454e35f014",
"createdAt":"2026-07-13T18:38:12Z",
"updatedAt":"2026-07-13T18:38:12Z"
},
{
"organizationNetworkId":8,
"orgId":"org-founder-bank",
"accessType":"INSTANCE",
"instanceId":"instance-uuid4",
"blockchainType":"BESU",
"chainId":"1500",
"rpcProxyUrl":"https://rpc-proxy.example.com:8443",
"walletServiceUrl":"http://wallet-service.example.com:58080/v1/",
"status":"ACTIVE",
"createdBy":"d19dc46e-dcca-4ebf-855e-98454e35f014",
"createdAt":"2026-07-13T18:38:11Z",
"updatedAt":"2026-07-13T18:38:11Z"
},
{
"organizationNetworkId":7,
"orgId":"org-founder-bank",
"accessType":"INSTANCE",
"instanceId":"instance-uuid5",
"blockchainType":"BESU",
"chainId":"1500",
"rpcProxyUrl":"https://rpc-proxy.example.com:8443",
"walletServiceUrl":"http://wallet-service.example.com:58080/v1/",
"status":"ACTIVE",
"createdBy":"d19dc46e-dcca-4ebf-855e-98454e35f014",
"createdAt":"2026-07-13T18:38:09Z",
"updatedAt":"2026-07-13T18:38:09Z"
}
],
"nextPageToken":"MjAyNi0wNy0xM1QxODozODowOXw3"
}
}
}
},
"400":{
"$ref":"#/components/responses/BadRequest"
},
"500":{
"$ref":"#/components/responses/InternalServerError"
}
},
"x-internal-id":"v1-uwaas-orgs-{orgId}-organization-networks-get",
"x-filename-id":"v1-uwaas-orgs-orgid-organization-networks-get"
},
"post":{
"tags":[
"Organization Networks"
],
"summary":"Bulk Create Organization Networks",
"description":"Create one to ten organization-network configurations synchronously for the organization identified by external `orgId`. For each organization-network, existing resources referenced by the configuration must already exist within the system.",
"operationId":"bulkCreateOrganizationNetworks",
"parameters":[
{
"$ref":"#/components/parameters/OrgId"
}
],
"requestBody":{
"$ref":"#/components/requestBodies/BulkCreateOrganizationNetworksRequest"
},
"responses":{
"201":{
"description":"Organization networks created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/BulkCreateOrganizationNetworksResponse"
},
"example":{
"items":[
{
"organizationNetworkId":4,
"orgId":"org-founder-bank",
"accessType":"INSTANCE",
"instanceId":"instance-uuid1",
"blockchainType":"BESU",
"chainId":"1500",
"rpcProxyUrl":"https://rpc-proxy.example.com:8443",
"walletServiceUrl":"http://wallet-service.example.com:58080/v1/",
"status":"ACTIVE",
"createdBy":"d19dc46e-dcca-4ebf-855e-98454e35f014",
"createdAt":"2026-07-13T18:36:54.951940001Z",
"updatedAt":"2026-07-13T18:36:54.951942106Z"
},
{
"organizationNetworkId":5,
"orgId":"org-founder-bank",
"accessType":"INSTANCE",
"instanceId":"instance-uuid2",
"blockchainType":"BESU",
"chainId":"1501",
"rpcProxyUrl":"https://rpc-proxy.example.com:8443",
"walletServiceUrl":"http://wallet-service.example.com:58080/v1/",
"status":"ACTIVE",
"createdBy":"d19dc46e-dcca-4ebf-855e-98454e35f014",
"createdAt":"2026-07-13T18:36:55.951940001Z",
"updatedAt":"2026-07-13T18:36:55.951942106Z"
}
]
}
}
}
},
"400":{
"$ref":"#/components/responses/BadRequest"
},
"403":{
"$ref":"#/components/responses/Forbidden"
},
"404":{
"$ref":"#/components/responses/NotFound"
},
"409":{
"description":"Organization network already exists.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"500":{
"$ref":"#/components/responses/InternalServerError"
}
},
"x-internal-id":"v1-uwaas-orgs-{orgId}-organization-networks-post",
"x-filename-id":"v1-uwaas-orgs-orgid-organization-networks-post"
}
},
"/v1/uwaas/orgs/{orgId}/organization-networks/{organizationNetworkId}":{
"get":{
"tags":[
"Organization Networks"
],
"summary":"Get Organization Network",
"description":"Get an organization-network configuration for the organization identified by external `orgId`.",
"operationId":"getOrganizationNetwork",
"parameters":[
{
"$ref":"#/components/parameters/OrgId"
},
{
"$ref":"#/components/parameters/OrganizationNetworkId"
}
],
"responses":{
"200":{
"description":"Organization network retrieved successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/OrganizationNetworkResponse"
},
"example":{
"organizationNetworkId":1,
"orgId":"org-founder-bank",
"accessType":"INSTANCE",
"instanceId":"instance-uuid1",
"blockchainType":"BESU",
"chainId":"1500",
"rpcProxyUrl":"https://rpc-proxy.example.com:8443",
"walletServiceUrl":"http://wallet-service.example.com:58080/v1/",
"status":"ACTIVE",
"createdBy":"d19dc46e-dcca-4ebf-855e-98454e35f014",
"updatedBy":"08819d29-de56-48ea-a140-bc4ac73952ed",
"createdAt":"2026-07-07T02:00:44Z",
"updatedAt":"2026-07-10T22:06:50Z"
}
}
}
},
"400":{
"$ref":"#/components/responses/BadRequest"
},
"403":{
"$ref":"#/components/responses/Forbidden"
},
"404":{
"$ref":"#/components/responses/NotFound"
},
"500":{
"$ref":"#/components/responses/InternalServerError"
}
},
"x-internal-id":"v1-uwaas-orgs-{orgId}-organization-networks-{organizationNetworkId}-get",
"x-filename-id":"v1-uwaas-orgs-orgid-organization-networks-organizationnetworkid-get"
},
"put":{
"tags":[
"Organization Networks"
],
"summary":"Update Organization Network",
"description":"Update an organization network configuration for the organization identified by external `orgId`.",
"operationId":"updateOrganizationNetwork",
"parameters":[
{
"$ref":"#/components/parameters/OrgId"
},
{
"$ref":"#/components/parameters/OrganizationNetworkId"
}
],
"requestBody":{
"$ref":"#/components/requestBodies/UpdateOrganizationNetworkRequest"
},
"responses":{
"200":{
"description":"Organization network updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/OrganizationNetworkResponse"
},
"example":{
"organizationNetworkId":11,
"orgId":"org-founder-bank",
"accessType":"INSTANCE",
"instanceId":"instance-uuid1",
"blockchainType":"BESU",
"chainId":"1500",
"rpcProxyUrl":"https://rpc-proxy.example.com:8443",
"walletServiceUrl":"http://wallet-service.example.com:58080/v1/",
"status":"ACTIVE",
"createdBy":"d19dc46e-dcca-4ebf-855e-98454e35f014",
"updatedBy":"08819d29-de56-48ea-a140-bc4ac73952ed",
"createdAt":"2026-07-13T18:38:14Z",
"updatedAt":"2026-07-13T18:39:27Z"
}
}
}
},
"400":{
"$ref":"#/components/responses/BadRequest"
},
"403":{
"$ref":"#/components/responses/Forbidden"
},
"404":{
"$ref":"#/components/responses/NotFound"
},
"500":{
"$ref":"#/components/responses/InternalServerError"
}
},
"x-internal-id":"v1-uwaas-orgs-{orgId}-organization-networks-{organizationNetworkId}-put",
"x-filename-id":"v1-uwaas-orgs-orgid-organization-networks-organizationnetworkid-put"
}
},
"/v1/uwaas/wallets":{
"get":{
"tags":[
"Wallets"
],
"summary":"List Wallets",
"description":"List wallet inventory across organizations or scoped to caller organization based on authorization.",
"operationId":"listWallets",
"parameters":[
{
"name":"orgId",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"example":"default_org"
},
{
"name":"userId",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"example":"user-7"
},
{
"name":"instanceId",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"example":"4fb56966-7646-487b-9a5f-747162e919fd"
},
{
"name":"pageSize",
"in":"query",
"required":false,
"schema":{
"type":"integer",
"minimum":1,
"maximum":100,
"default":5
},
"example":5
},
{
"name":"nextPageToken",
"in":"query",
"required":false,
"description":"Opaque cursor returned by the previous list response.",
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Wallets retrieved successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ListWalletsResponse"
},
"example":{
"items":[
{
"walletId":"ba73f0d0-93f7-483c-93df-1d46705bd379",
"orgId":"default_org",
"orgNetworkId":4,
"instanceId":"instance-uuid1",
"blockchainType":"BESU",
"userId":"8e7f524d-8169-4906-8935-e5cac5a7a12a",
"status":"ACTIVE",
"label":"UWaaS-auxiliary",
"type":"1",
"typeLabel":"Custodial",
"address":"0x9c57bbf0b4909350a9d9fecc533b6538e2e69ca9",
"createdDate":"2026-07-28T12:41:36Z",
"updatedDate":"2026-07-28T12:41:36Z",
"createdBy":"117eacd9-387e-4505-baa1-78782fb9c123",
"walletTags":[
"a:erc20",
"e:dev"
]
}
]
}
}
}
},
"400":{
"$ref":"#/components/responses/BadRequest"
},
"401":{
"$ref":"#/components/responses/Unauthorized"
},
"500":{
"$ref":"#/components/responses/InternalServerError"
}
},
"x-internal-id":"v1-uwaas-wallets-get",
"x-filename-id":"v1-uwaas-wallets-get"
},
"post":{
"tags":[
"Wallets"
],
"summary":"Create Wallet",
"description":"Create a wallet for a user in an organization network.",
"operationId":"createWalletAdmin",
"requestBody":{
"$ref":"#/components/requestBodies/CreateWalletRequest"
},
"responses":{
"201":{
"description":"Wallet created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CreateWalletResponse"
},
"example":{
"walletId":"62d00d4f-1851-4126-aa77-dcef4f816c78",
"address":"0x599f59e794c88a108e0cc2072b7a52fa3576cea4",
"label":"Founder-bluetooth",
"status":"ACTIVE",
"providerType":"ADAPTER_HTTP",
"providerWalletRef":"0x599f59e794c88a108e0cc2072b7a52fa3576cea4",
"walletType":"1",
"walletTypeLabel":"Custodial"
}
}
}
},
"400":{
"$ref":"#/components/responses/BadRequest"
},
"401":{
"$ref":"#/components/responses/Unauthorized"
},
"404":{
"$ref":"#/components/responses/NotFound"
},
"500":{
"$ref":"#/components/responses/InternalServerError"
}
},
"x-internal-id":"v1-uwaas-wallets-post",
"x-filename-id":"v1-uwaas-wallets-post"
}
},
"/v1/uwaas/wallets/resolve":{
"post":{
"tags":[
"Wallets"
],
"summary":"Resolve Wallet by Lookup Value",
"description":"Resolve wallet details for a supported lookup type. This endpoint currently supports `lookupType=iban`.",
"operationId":"resolveWallet",
"requestBody":{
"$ref":"#/components/requestBodies/WalletResolveRequest"
},
"responses":{
"200":{
"description":"Wallet resolved successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/WalletResolveResponse"
}
}
}
},
"400":{
"$ref":"#/components/responses/BadRequest"
},
"404":{
"$ref":"#/components/responses/NotFound"
},
"500":{
"$ref":"#/components/responses/InternalServerError"
}
},
"x-internal-id":"v1-uwaas-wallets-resolve-post",
"x-filename-id":"v1-uwaas-wallets-resolve-post"
}
},
"/v1/uwaas/wallets/{walletId}":{
"get":{
"tags":[
"Wallets"
],
"summary":"Get Wallet by ID",
"description":"Retrieve a wallet by ID using the same canonical item format as the wallet list.",
"operationId":"getWalletById",
"parameters":[
{
"$ref":"#/components/parameters/WalletId"
}
],
"responses":{
"200":{
"description":"Wallet retrieved successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ListedWallet"
},
"example":{
"walletId":"62d00d4f-1851-4126-aa77-dcef4f816c78",
"orgId":"default_org",
"orgNetworkId":1,
"instanceId":"instance-uuid1",
"blockchainType":"BESU",
"userId":"3833bcfc-3b52-4705-b079-29947cf1cbe5",
"status":"ACTIVE",
"label":"Founder-bluetooth",
"type":"1",
"typeLabel":"Custodial",
"address":"0x599f59e794c88a108e0cc2072b7a52fa3576cea4",
"createdDate":"2026-07-13T18:11:38Z",
"updatedDate":"2026-07-13T18:11:38Z",
"createdBy":"08819d29-de56-48ea-a140-bc4ac73952ed",
"walletTags":[
"hot",
"internal"
]
}
}
}
},
"400":{
"$ref":"#/components/responses/BadRequest"
},
"401":{
"$ref":"#/components/responses/Unauthorized"
},
"404":{
"$ref":"#/components/responses/NotFound"
},
"500":{
"$ref":"#/components/responses/InternalServerError"
}
},
"x-internal-id":"v1-uwaas-wallets-{walletId}-get",
"x-filename-id":"v1-uwaas-wallets-walletid-get"
},
"put":{
"tags":[
"Wallets"
],
"summary":"Update Wallet Mutable Fields",
"description":"Update only walletLabel, status, and walletTags for an existing wallet. Omitted fields are left unchanged. Unknown fields and empty request bodies are rejected. Repeated identical requests are idempotent and do not update audit fields.",
"operationId":"updateWalletById",
"parameters":[
{
"$ref":"#/components/parameters/WalletId"
}
],
"requestBody":{
"$ref":"#/components/requestBodies/PutWalletUpdateRequest"
},
"responses":{
"200":{
"description":"Wallet updated successfully. The response is the complete wallet resource after persistence.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Wallet"
},
"example":{
"partitionWalletId":14,
"walletId":"62d00d4f-1851-4126-aa77-dcef4f816c78",
"accountId":"3833bcfc-3b52-4705-b079-29947cf1cbe5",
"orgNetworkId":1,
"instanceId":1,
"networkId":1,
"walletServiceId":1,
"blockchainType":"BESU",
"userId":"3833bcfc-3b52-4705-b079-29947cf1cbe5",
"status":"ACTIVE",
"label":"UWaaS-neural",
"address":"0x599f59e794c88a108e0cc2072b7a52fa3576cea4",
"createdDate":"2026-07-13T18:11:38Z",
"updatedDate":"2026-07-13T19:02:27Z",
"createdBy":"08819d29-de56-48ea-a140-bc4ac73952ed",
"updatedBy":"d19dc46e-dcca-4ebf-855e-98454e35f014",
"walletTags":[
"dev"
]
}
}
}
},
"400":{
"$ref":"#/components/responses/BadRequest"
},
"401":{
"$ref":"#/components/responses/Unauthorized"
},
"404":{
"$ref":"#/components/responses/NotFound"
},
"422":{
"description":"Wallet update validation failed.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"500":{
"$ref":"#/components/responses/InternalServerError"
}
},
"x-internal-id":"v1-uwaas-wallets-{walletId}-put",
"x-filename-id":"v1-uwaas-wallets-walletid-put"
}
},
"/v1/uwaas/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"
}
}
}
},
"400":{
"$ref":"#/components/responses/BadRequest"
},
"401":{
"$ref":"#/components/responses/Unauthorized"
},
"404":{
"$ref":"#/components/responses/NotFound"
},
"500":{
"$ref":"#/components/responses/InternalServerError"
}
},
"x-internal-id":"v1-uwaas-wallets-uploadkey-post",
"x-filename-id":"v1-uwaas-wallets-uploadkey-post"
}
},
"/v1/uwaas/orgs/{orgId}/users":{
"get":{
"tags":[
"Users"
],
"summary":"List Users for Organization",
"description":"List non-deleted users for an organization identified by external `orgId`, using cursor-based pagination.",
"operationId":"listUsers",
"parameters":[
{
"$ref":"#/components/parameters/OrgId"
},
{
"name":"pageSize",
"in":"query",
"required":false,
"description":"Maximum number of users to return.",
"schema":{
"type":"integer",
"minimum":1,
"maximum":100,
"default":50
},
"example":5
},
{
"name":"nextPageToken",
"in":"query",
"required":false,
"description":"Opaque cursor returned by the previous page.",
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Users retrieved successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ListUsersResponse"
},
"examples":{
"page1":{
"summary":"First page of org users",
"value":{
"items":[
{
"userId":"3833bcfc-3b52-4705-b079-29947cf1cbe5",
"displayName":"Brandy Fahey",
"orgId":"org-founder-bank",
"organizationName":"Founder-Org",
"roleId":2,
"roleName":"Organization Admin",
"status":"ACTIVE",
"createdBy":"2520db59-06eb-4aaf-9604-c473ebc358bb"
},
{
"userId":"2c3afb76-506c-440e-93de-21441c822005",
"displayName":"Caroline Murazik",
"orgId":"org-founder-bank",
"organizationName":"Founder-Org",
"roleId":2,
"roleName":"Organization Admin",
"status":"ACTIVE",
"createdBy":"08819d29-de56-48ea-a140-bc4ac73952ed"
},
{
"userId":"7e0d372a-95c8-4836-b600-367054fc6b38",
"displayName":"Cassandra Walsh",
"orgId":"org-founder-bank",
"organizationName":"Founder-Org",
"roleId":2,
"roleName":"Organization Admin",
"status":"ACTIVE",
"createdBy":"08819d29-de56-48ea-a140-bc4ac73952ed"
},
{
"userId":"0f011127-e23f-4c75-a669-b949dbb9721c",
"displayName":"Dawn Wilkinson",
"orgId":"org-founder-bank",
"organizationName":"Founder-Org",
"roleId":2,
"roleName":"Organization Admin",
"status":"ACTIVE",
"createdBy":"08819d29-de56-48ea-a140-bc4ac73952ed"
},
{
"userId":"1413b7e1-7bb3-4cb9-8eb7-ac2f9acdbe34",
"displayName":"janesmith",
"orgId":"org-founder-bank",
"organizationName":"Founder-Org",
"roleId":2,
"roleName":"Organization Admin",
"status":"ACTIVE",
"createdBy":"08819d29-de56-48ea-a140-bc4ac73952ed"
}
],
"nextPageToken":"djF8YW1GdVpYTnRhWFJvfE1UUXhNMkkzWlRFdE4ySmlNeTAwWTJJNUxUaGxZamN0WVdNeVpqbGhZMlJpWlRNMA"
}
}
}
}
}
},
"400":{
"$ref":"#/components/responses/BadRequest"
},
"401":{
"$ref":"#/components/responses/Unauthorized"
},
"404":{
"$ref":"#/components/responses/NotFound"
},
"500":{
"$ref":"#/components/responses/InternalServerError"
}
},
"x-internal-id":"v1-uwaas-orgs-{orgId}-users-get",
"x-filename-id":"v1-uwaas-orgs-orgid-users-get"
},
"post":{
"tags":[
"Users"
],
"summary":"Create Organization User",
"description":"Create a user in an organization identified by external `orgId` and assign a role.",
"operationId":"createUser",
"parameters":[
{
"$ref":"#/components/parameters/OrgId"
}
],
"requestBody":{
"$ref":"#/components/requestBodies/CreateUserRequest"
},
"responses":{
"201":{
"description":"User created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/User"
},
"example":{
"userId":"ac50d7fd-fc48-4366-8fd8-5240df0b8eb4",
"displayName":"Lula Rogahn",
"orgId":"org-founder-bank",
"organizationName":"Organization A",
"roleId":2,
"roleName":"Organization Admin",
"status":"ACTIVE",
"createdBy":"08819d29-de56-48ea-a140-bc4ac73952ed"
}
}
}
},
"400":{
"$ref":"#/components/responses/BadRequest"
},
"401":{
"$ref":"#/components/responses/Unauthorized"
},
"404":{
"$ref":"#/components/responses/NotFound"
},
"409":{
"description":"Duplicate user.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"500":{
"$ref":"#/components/responses/InternalServerError"
}
},
"x-internal-id":"v1-uwaas-orgs-{orgId}-users-post",
"x-filename-id":"v1-uwaas-orgs-orgid-users-post"
}
},
"/v1/uwaas/users":{
"get":{
"tags":[
"Users"
],
"summary":"List Users Across Organizations",
"description":"List users across organizations. Authorization determines whether cross-organization results are returned or restricted to the caller's scoped organization.",
"operationId":"listUsersAcrossOrganizations",
"parameters":[
{
"name":"orgId",
"in":"query",
"required":false,
"description":"Optional external organization identifier from orgId. When provided, the service resolves it to organizations.organization_id before querying users.",
"schema":{
"type":"string"
},
"example":"org-founder-bank"
},
{
"name":"role",
"in":"query",
"required":false,
"description":"Optional role name filter.",
"schema":{
"type":"string"
},
"example":"Organization Admin"
},
{
"name":"status",
"in":"query",
"required":false,
"description":"Optional status filter.",
"schema":{
"$ref":"#/components/schemas/UserStatus"
},
"example":"ACTIVE"
},
{
"name":"search",
"in":"query",
"required":false,
"description":"Optional free-text search across user identifiers and display names.",
"schema":{
"type":"string"
},
"example":"Carol"
},
{
"name":"page",
"in":"query",
"required":false,
"schema":{
"type":"integer",
"minimum":0,
"default":0
}
},
{
"name":"size",
"in":"query",
"required":false,
"schema":{
"type":"integer",
"minimum":1,
"maximum":200,
"default":50
}
}
],
"responses":{
"200":{
"description":"Users retrieved successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/User"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/BadRequest"
},
"401":{
"$ref":"#/components/responses/Unauthorized"
},
"500":{
"$ref":"#/components/responses/InternalServerError"
}
},
"x-internal-id":"v1-uwaas-users-get",
"x-filename-id":"v1-uwaas-users-get"
}
},
"/v1/uwaas/orgs/{orgId}/users/{userId}":{
"get":{
"tags":[
"Users"
],
"summary":"Get User",
"description":"Retrieve a non-deleted user by user ID within the organization identified by external `orgId`.",
"operationId":"getUserById",
"parameters":[
{
"$ref":"#/components/parameters/OrgId"
},
{
"$ref":"#/components/parameters/UserId"
}
],
"responses":{
"200":{
"description":"User retrieved successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/User"
},
"example":{
"userId":"0f011127-e23f-4c75-a669-b949dbb9721c",
"displayName":"Dawn Wilkinson",
"orgId":"org-founder-bank",
"organizationName":"Founder-Org",
"roleId":2,
"roleName":"Organization Admin",
"status":"ACTIVE",
"createdBy":"08819d29-de56-48ea-a140-bc4ac73952ed"
}
}
}
},
"400":{
"$ref":"#/components/responses/BadRequest"
},
"401":{
"$ref":"#/components/responses/Unauthorized"
},
"404":{
"$ref":"#/components/responses/NotFound"
},
"500":{
"$ref":"#/components/responses/InternalServerError"
}
},
"x-internal-id":"v1-uwaas-orgs-{orgId}-users-{userId}-get",
"x-filename-id":"v1-uwaas-orgs-orgid-users-userid-get"
},
"put":{
"tags":[
"Users"
],
"summary":"Update User",
"description":"Update editable user fields in the organization identified by external `orgId`.",
"operationId":"updateUser",
"parameters":[
{
"$ref":"#/components/parameters/OrgId"
},
{
"$ref":"#/components/parameters/UserId"
}
],
"requestBody":{
"$ref":"#/components/requestBodies/UpdateUserRequest"
},
"responses":{
"200":{
"description":"User updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/User"
},
"example":{
"userId":"0f011127-e23f-4c75-a669-b949dbb9721c",
"displayName":"Dawn Wilkinson",
"orgId":"org-founder-bank",
"organizationName":"Founder-Org",
"roleId":3,
"roleName":"ORG_USER",
"status":"INACTIVE",
"createdBy":"08819d29-de56-48ea-a140-bc4ac73952ed"
}
}
}
},
"400":{
"$ref":"#/components/responses/BadRequest"
},
"401":{
"$ref":"#/components/responses/Unauthorized"
},
"404":{
"$ref":"#/components/responses/NotFound"
},
"500":{
"$ref":"#/components/responses/InternalServerError"
}
},
"x-internal-id":"v1-uwaas-orgs-{orgId}-users-{userId}-put",
"x-filename-id":"v1-uwaas-orgs-orgid-users-userid-put"
}
},
"/v1/uwaas/roles":{
"get":{
"tags":[
"Roles"
],
"summary":"List Roles",
"description":"List roles using page and size pagination.",
"operationId":"listRoles",
"parameters":[
{
"name":"page",
"in":"query",
"required":false,
"description":"Zero-based page index.",
"schema":{
"type":"integer",
"minimum":0,
"default":0
},
"example":0
},
{
"name":"size",
"in":"query",
"required":false,
"description":"Maximum number of roles to return. Values above 200 are capped by the service.",
"schema":{
"type":"integer",
"minimum":1,
"maximum":200,
"default":50
},
"example":50
}
],
"responses":{
"200":{
"description":"Roles retrieved successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/RoleResponse"
}
},
"example":[
{
"id":1,
"roleCode":"ORG_ADMIN",
"roleName":"Organization Admin",
"description":"Full access to organization administration features.",
"status":"ACTIVE",
"createdAt":"2026-07-20T15:30:00Z",
"updatedAt":"2026-07-20T15:30:00Z",
"createdBy":"system",
"updatedBy":null
},
{
"id":2,
"roleCode":"VIEWER",
"roleName":"Viewer",
"description":"Read-only role for organization resources.",
"status":"INACTIVE",
"createdAt":"2026-07-20T16:10:00Z",
"updatedAt":"2026-07-21T08:45:00Z",
"createdBy":"system",
"updatedBy":"placeholder"
}
]
}
}
},
"400":{
"$ref":"#/components/responses/BadRequest"
},
"500":{
"$ref":"#/components/responses/InternalServerError"
}
},
"x-internal-id":"v1-uwaas-roles-get",
"x-filename-id":"v1-uwaas-roles-get"
}
},
"/v1/uwaas/roles/{roleId}":{
"get":{
"tags":[
"Roles"
],
"summary":"Get Role",
"description":"Retrieve a role by its identifier.",
"operationId":"getRoleById",
"parameters":[
{
"$ref":"#/components/parameters/RoleId"
}
],
"responses":{
"200":{
"description":"Role retrieved successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/RoleResponse"
},
"example":{
"id":1,
"roleCode":"ORG_ADMIN",
"roleName":"Organization Admin",
"description":"Full access to organization administration features.",
"status":"ACTIVE",
"createdAt":"2026-07-20T15:30:00Z",
"updatedAt":"2026-07-20T15:30:00Z",
"createdBy":"system",
"updatedBy":null
}
}
}
},
"400":{
"$ref":"#/components/responses/BadRequest"
},
"404":{
"$ref":"#/components/responses/NotFound"
},
"500":{
"$ref":"#/components/responses/InternalServerError"
}
},
"x-internal-id":"v1-uwaas-roles-{roleId}-get",
"x-filename-id":"v1-uwaas-roles-roleid-get"
}
},
"/ready":{
"get":{
"tags":[
"Health"
],
"summary":"Readiness Check",
"description":"Basic uptime/readiness check.",
"operationId":"ready",
"responses":{
"200":{
"description":"Service is up.",
"content":{
"application/json":{
"schema":{
"type":"object",
"properties":{
"status":{
"type":"string",
"example":"OK"
}
},
"required":[
"status"
]
}
}
}
},
"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":"Health observation endpoint.",
"operationId":"observeHealth",
"responses":{
"200":{
"description":"Health status retrieved successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/HealthStatus"
}
}
}
},
"500":{
"$ref":"#/components/responses/InternalServerError"
}
},
"security":[
],
"x-internal-id":"observe-health-get",
"x-filename-id":"observe-health-get"
}
}
}
}