{ "openapi": "3.0.0", "info": { "title": "Palisade API", "description": "The Palisade API enables programmatic interaction with the various features of the Palisade platform", "version": "2.0" }, "tags": [ { "name": "Addresses", "description": "Used to manage addresses" }, { "name": "API Credentials", "description": "Used to manage credentials" }, { "name": "Approvals", "description": "Used to manage approvals" }, { "name": "Approvers", "description": "Used to manage approvers" }, { "name": "Audit", "description": "Used to manage configuration for audit" }, { "name": "Backup", "description": "Used to manage backups" }, { "name": "Balances", "description": "Used to view balances" }, { "name": "Compliance", "description": "Used to manage compliance" }, { "name": "Counterparties", "description": "Used to manage counterparties" }, { "name": "Devices", "description": "Used to manage devices" }, { "name": "Information", "description": "Used to view information about the platform" }, { "name": "MPC - Memberships", "description": "Used to manage MPC memberships" }, { "name": "MPC - Quorums", "description": "Used to manage MPC quorums" }, { "name": "MPC - Sessions", "description": "Used to manage MPC sessions" }, { "name": "Organizations", "description": "Used to manage organizations" }, { "name": "Policies", "description": "Used to manage connections policies" }, { "name": "Rates", "description": "Used to retrieve rates" }, { "name": "Sweep Configurations", "description": "Used to manage sweep configurations" }, { "name": "Tags", "description": "Used to manage organization tags" }, { "name": "Transactions", "description": "Used to manage transactions" }, { "name": "Transactions - XRP", "description": "Used to manage XRP specific transactions" }, { "name": "Users", "description": "Used to manage users" }, { "name": "Vaults", "description": "Used to manage vaults" }, { "name": "Vault Tags", "description": "Used to manage vault tags" }, { "name": "Wallets", "description": "Used to manage wallets" }, { "name": "Wallet Tags", "description": "Used to manage wallet tags" }, { "name": "Wallet Connect", "description": "Used to manage connections" }, { "name": "Webhooks", "description": "Used to manage webhooks" } ], "paths": { "/v2/addresses": { "get": { "summary": "List organization addresses", "description": "List all addresses within the organization", "operationId": "CounterpartyService_ListGlobalAddresses", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListGlobalAddressesResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "pageSize", "description": "The number of results to return per page (default 50, max 1000)", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageToken", "description": "The token to retrieve the next page of results", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "address", "description": "The on-chain address to search for", "in": "query", "required": false, "schema": { "type": "string" } } ], "tags": [ "Addresses" ] } }, "/v2/approvals": { "get": { "summary": "List approval summaries", "description": "Returns the list of approval summaries for the current user", "operationId": "ApprovalService_ListApprovalSummaries", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/approvalv2ApprovalSummary" }, "required": [ "approvalSummaries" ] } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "status", "description": "The approval status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "PROCESSING", "APPROVED", "REJECTED" ] } } ], "tags": [ "Approvals" ] } }, "/v2/approvals/{id}": { "get": { "summary": "Get approval summary", "description": "Returns a specific approval summary for the current user", "operationId": "ApprovalService_GetApprovalSummary", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/approvalv2ApprovalSummary" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The approval summary ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Approvals" ] }, "put": { "summary": "Update approval summary", "description": "Update the approval summary to either approve or reject the request", "operationId": "ApprovalService_UpdateApproval", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/approvalv2ApprovalSummary" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The approval ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "signature": { "type": "string", "format": "byte", "description": "The approval signature" }, "reasons": { "type": "array", "example": [ "the transaction was not previously discussed" ], "items": { "type": "string" }, "description": "The reasons for an approval or rejection" }, "status": { "$ref": "#/components/schemas/approvalv2ApprovalStatus" } }, "required": [ "reasons", "status" ] } } }, "required": true }, "tags": [ "Approvals" ] } }, "/v2/approvers": { "get": { "summary": "List organization approvers", "description": "Returns the list of approvers within the approval set configured for the organization and optionally source type", "operationId": "ApprovalService_GetOrgApprovers", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2GetOrgApproversResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "sourceType", "description": "The source type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "TRANSACTION", "DEVICE", "API_CREDENTIAL", "ALLOW_LIST_ENTRY", "POLICY", "USER", "APPROVAL_GROUP", "ADDRESS" ] } } ], "tags": [ "Approvers" ] }, "put": { "summary": "Update organization approvers", "description": "Updates the list of approvers within the approval set configured for the organization and source type", "operationId": "ApprovalService_UpdateOrgApprovers", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ApprovalGroup" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "requestBody": { "$ref": "#/components/requestBodies/v2ApprovalGroup" }, "tags": [ "Approvers" ] } }, "/v2/approvers/eligible": { "get": { "summary": "List eligible approvers", "description": "Returns the list of eligible approvers", "operationId": "ApprovalService_ListEligibleApprovers", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v2EligibleApprover" } } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "tags": [ "Approvers" ] } }, "/v2/approvers/{id}": { "get": { "summary": "List wallet approvers", "description": "Returns the list of approvers within the approval set configured for the wallet and optionally source type", "operationId": "ApprovalService_GetKeyApprovers", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2GetKeyApproversResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sourceType", "description": "The source type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "TRANSACTION", "DEVICE", "API_CREDENTIAL", "ALLOW_LIST_ENTRY", "POLICY", "USER", "APPROVAL_GROUP", "ADDRESS" ] } } ], "tags": [ "Approvers" ] }, "put": { "summary": "Update wallet approvers", "description": "Updates the list of approvers within the approval set configured for the wallet and source type", "operationId": "ApprovalService_UpdateKeyApprovers", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ApprovalGroup" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/v2ApprovalGroup" }, "tags": [ "Approvers" ] } }, "/v2/assets": { "get": { "summary": "List assets", "description": "List assets with advanced filtering and search. Supports both GET (bookmarkable) and POST (complex filters).", "operationId": "RegistryService_ListAssets2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListAssetsResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "filter.blockchain.eq", "description": "Equals", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter.blockchain.notEq", "description": "Not equal to", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter.blockchain.in", "description": "Value is in the list", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "filter.blockchain.notIn", "description": "Value is not in the list", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "filter.blockchain.isNull", "description": "Check if field is null", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "filter.blockchain.gt", "description": "Greater than", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter.blockchain.gte", "description": "Greater than or equal to", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter.blockchain.lt", "description": "Less than", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter.blockchain.lte", "description": "Less than or equal to", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter.enabled.eq", "description": "Equals", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "filter.enabled.isNull", "description": "Check if field is null", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "filter.isVetted.eq", "description": "Equals", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "filter.isVetted.isNull", "description": "Check if field is null", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "filter.standard.eq", "description": "Equals", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter.standard.notEq", "description": "Not equal to", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter.standard.in", "description": "Value is in the list", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "filter.standard.notIn", "description": "Value is not in the list", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "filter.standard.isNull", "description": "Check if field is null", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "filter.standard.gt", "description": "Greater than", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter.standard.gte", "description": "Greater than or equal to", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter.standard.lt", "description": "Less than", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter.standard.lte", "description": "Less than or equal to", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter.organizationId.eq", "description": "Exact match", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.organizationId.notEq", "description": "Not equal to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.organizationId.contains", "description": "Contains substring (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.organizationId.startsWith", "description": "Starts with prefix (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.organizationId.endsWith", "description": "Ends with suffix (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.organizationId.in", "description": "Value is in the list", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filter.organizationId.notIn", "description": "Value is not in the list", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filter.organizationId.regex", "description": "Regular expression match", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.organizationId.isNull", "description": "Check if field is null", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "filter.organizationId.fuzzy.value", "description": "Value to match against", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.organizationId.fuzzy.minSimilarity", "description": "Minimum similarity threshold (0.0-1.0)", "in": "query", "required": false, "schema": { "type": "number", "format": "float" } }, { "name": "filter.symbol.eq", "description": "Exact match", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.symbol.notEq", "description": "Not equal to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.symbol.contains", "description": "Contains substring (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.symbol.startsWith", "description": "Starts with prefix (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.symbol.endsWith", "description": "Ends with suffix (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.symbol.in", "description": "Value is in the list", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filter.symbol.notIn", "description": "Value is not in the list", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filter.symbol.regex", "description": "Regular expression match", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.symbol.isNull", "description": "Check if field is null", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "filter.symbol.fuzzy.value", "description": "Value to match against", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.symbol.fuzzy.minSimilarity", "description": "Minimum similarity threshold (0.0-1.0)", "in": "query", "required": false, "schema": { "type": "number", "format": "float" } }, { "name": "filter.name.eq", "description": "Exact match", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.name.notEq", "description": "Not equal to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.name.contains", "description": "Contains substring (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.name.startsWith", "description": "Starts with prefix (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.name.endsWith", "description": "Ends with suffix (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.name.in", "description": "Value is in the list", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filter.name.notIn", "description": "Value is not in the list", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filter.name.regex", "description": "Regular expression match", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.name.isNull", "description": "Check if field is null", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "filter.name.fuzzy.value", "description": "Value to match against", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.name.fuzzy.minSimilarity", "description": "Minimum similarity threshold (0.0-1.0)", "in": "query", "required": false, "schema": { "type": "number", "format": "float" } }, { "name": "filter.contractAddress.eq", "description": "Exact match", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.contractAddress.notEq", "description": "Not equal to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.contractAddress.contains", "description": "Contains substring (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.contractAddress.startsWith", "description": "Starts with prefix (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.contractAddress.endsWith", "description": "Ends with suffix (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.contractAddress.in", "description": "Value is in the list", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filter.contractAddress.notIn", "description": "Value is not in the list", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filter.contractAddress.regex", "description": "Regular expression match", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.contractAddress.isNull", "description": "Check if field is null", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "filter.contractAddress.fuzzy.value", "description": "Value to match against", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.contractAddress.fuzzy.minSimilarity", "description": "Minimum similarity threshold (0.0-1.0)", "in": "query", "required": false, "schema": { "type": "number", "format": "float" } }, { "name": "filter.source.eq", "description": "Exact match", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.source.notEq", "description": "Not equal to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.source.contains", "description": "Contains substring (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.source.startsWith", "description": "Starts with prefix (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.source.endsWith", "description": "Ends with suffix (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.source.in", "description": "Value is in the list", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filter.source.notIn", "description": "Value is not in the list", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filter.source.regex", "description": "Regular expression match", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.source.isNull", "description": "Check if field is null", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "filter.source.fuzzy.value", "description": "Value to match against", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.source.fuzzy.minSimilarity", "description": "Minimum similarity threshold (0.0-1.0)", "in": "query", "required": false, "schema": { "type": "number", "format": "float" } }, { "name": "filter.lastSyncedAt.eq", "description": "Exact timestamp match", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "filter.lastSyncedAt.notEq", "description": "Not equal to timestamp", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "filter.lastSyncedAt.before", "description": "Before this timestamp", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "filter.lastSyncedAt.after", "description": "After this timestamp", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "filter.lastSyncedAt.gte", "description": "Greater than or equal to timestamp", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "filter.lastSyncedAt.lte", "description": "Less than or equal to timestamp", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "filter.lastSyncedAt.between.start", "description": "Start of time range (inclusive)", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "filter.lastSyncedAt.between.end", "description": "End of time range (inclusive)", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "filter.lastSyncedAt.isNull", "description": "Check if field is null", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "filter.lastSyncedAt.relativeDays", "description": "Relative days from now (negative for past, positive for future)", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter.hasChecksum.eq", "description": "Equals", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "filter.hasChecksum.isNull", "description": "Check if field is null", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "search.term", "description": "Search term", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search.fields", "description": "Fields to search in", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "search.type", "description": "Type of search to perform\n\n - SEARCH_TYPE_CONTAINS: Default substring search\n - SEARCH_TYPE_STARTS_WITH: Prefix search\n - SEARCH_TYPE_EXACT: Exact match\n - SEARCH_TYPE_FUZZY: Fuzzy/similarity search\n - SEARCH_TYPE_FULLTEXT: Full-text search (future)", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "SEARCH_TYPE_CONTAINS", "SEARCH_TYPE_STARTS_WITH", "SEARCH_TYPE_EXACT", "SEARCH_TYPE_FUZZY", "SEARCH_TYPE_FULLTEXT" ] } }, { "name": "search.minScore", "description": "Minimum relevance score for fuzzy/fulltext search", "in": "query", "required": false, "schema": { "type": "number", "format": "float" } }, { "name": "search.options.caseSensitive", "description": "Enable case-sensitive search (default: false)", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "search.options.minTermLength", "description": "Minimum search term length", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "search.options.maxResults", "description": "Maximum number of results to return", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "search.options.multiTermAnd", "description": "Use AND logic for multiple terms (default: false for OR)", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "pagination.pageSize", "description": "Number of results per page (default 50, max 1000)", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pagination.pageToken", "description": "Token for pagination from previous response", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pagination.orderBy", "description": "Field to order results by", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pagination.order", "description": "Sort order (ASC or DESC)", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "SORT_ORDER_ASC", "SORT_ORDER_DESC" ] } } ], "tags": [ "Registry" ] }, "post": { "summary": "Create a new asset", "description": "Create a new asset in the registry", "operationId": "RegistryService_CreateAsset", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/commonv2Asset" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2CreateAssetRequest" } } }, "required": true }, "tags": [ "Registry" ] } }, "/v2/assets/{id}": { "get": { "summary": "Get an asset", "description": "Get asset configuration by ID", "operationId": "RegistryService_GetAsset", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/commonv2Asset" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "Asset ID in format blockchain:contract:symbol", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Registry" ] }, "delete": { "summary": "Delete an asset", "description": "Soft delete an asset from the registry", "operationId": "RegistryManagementService_ManagementDeleteAsset", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ManagementDeleteAssetResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "Asset ID to delete", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Registry" ] }, "patch": { "summary": "Update an asset", "description": "Update an existing asset in the registry", "operationId": "RegistryManagementService_ManagementUpdateAsset", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/commonv2Asset" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "Asset ID to update", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "USD Coin", "description": "Updated asset name" }, "decimals": { "type": "integer", "format": "int32", "example": 6, "description": "Updated decimal places" }, "coingeckoId": { "type": "string", "example": "usd-coin", "description": "Updated CoinGecko identifier" }, "enabled": { "type": "boolean", "example": true, "description": "Updated enabled status" }, "vetted": { "type": "boolean", "example": true, "description": "Updated vetted status" } } } } }, "required": true }, "tags": [ "Registry" ] } }, "/v2/assets:list": { "post": { "summary": "List assets", "description": "List assets with advanced filtering and search. Supports both GET (bookmarkable) and POST (complex filters).", "operationId": "RegistryService_ListAssets", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListAssetsResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListAssetsRequest" } } }, "required": true }, "tags": [ "Registry" ] } }, "/v2/audit/firehose/configuration": { "get": { "summary": "Get the Firehose configuration for streaming audit events", "description": "Get the Firehose configuration for streaming audit events", "operationId": "AuditService_GetFirehoseConfiguration", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2FirehoseConfiguration" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "tags": [ "Audit" ] }, "put": { "summary": "Set the Firehose configuration for streaming audit events", "description": "Set the Firehose configuration for streaming audit events", "operationId": "AuditService_SetFirehoseConfiguration", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2FirehoseConfiguration" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2SetFirehoseConfigurationRequest" } } }, "required": true }, "tags": [ "Audit" ] } }, "/v2/backup/strategies": { "get": { "summary": "List all backup strategies", "description": "Retrieves all backup strategies for the authenticated organization", "operationId": "BackupService_ListBackupStrategies", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListBackupStrategiesResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "tags": [ "Backup" ] }, "post": { "summary": "Create a new backup strategy", "description": "Creates a new backup strategy with the provided name and backup keys", "operationId": "BackupService_CreateBackupStrategy", "responses": { "200": { "description": "The created backup strategy", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2BackupStrategy" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2CreateBackupStrategyRequest" } } }, "required": true }, "tags": [ "Backup" ] } }, "/v2/backup/strategies/{id}": { "get": { "summary": "Get a backup strategy by ID", "description": "Retrieves a specific backup strategy using its unique identifier", "operationId": "BackupService_GetBackupStrategy", "responses": { "200": { "description": "The requested backup strategy", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2BackupStrategy" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "ID of the backup strategy to retrieve", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Backup" ] } }, "/v2/balances": { "get": { "summary": "Get Organization Balances", "description": "Get the balance of an organization", "operationId": "BalanceService_GetOrgBalances", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2GetOrgBalancesResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "currencyCode", "description": "The currency code to be used for the fiat value. When omitted, 'USD' will be used.", "in": "query", "required": false, "schema": { "type": "string" } } ], "tags": [ "Balances" ] } }, "/v2/blockchains": { "get": { "summary": "List blockchains", "description": "List blockchains with advanced filtering. Supports both GET (bookmarkable) and POST (complex filters).", "operationId": "RegistryService_ListBlockchains2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListBlockchainsResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "filter.status.eq", "description": "Equals", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter.status.notEq", "description": "Not equal to", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter.status.in", "description": "Value is in the list", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "filter.status.notIn", "description": "Value is not in the list", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "filter.status.isNull", "description": "Check if field is null", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "filter.status.gt", "description": "Greater than", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter.status.gte", "description": "Greater than or equal to", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter.status.lt", "description": "Less than", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter.status.lte", "description": "Less than or equal to", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter.name.eq", "description": "Exact match", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.name.notEq", "description": "Not equal to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.name.contains", "description": "Contains substring (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.name.startsWith", "description": "Starts with prefix (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.name.endsWith", "description": "Ends with suffix (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.name.in", "description": "Value is in the list", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filter.name.notIn", "description": "Value is not in the list", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filter.name.regex", "description": "Regular expression match", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.name.isNull", "description": "Check if field is null", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "filter.name.fuzzy.value", "description": "Value to match against", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.name.fuzzy.minSimilarity", "description": "Minimum similarity threshold (0.0-1.0)", "in": "query", "required": false, "schema": { "type": "number", "format": "float" } }, { "name": "filter.chainId.eq", "description": "Exact match", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.chainId.notEq", "description": "Not equal to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.chainId.contains", "description": "Contains substring (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.chainId.startsWith", "description": "Starts with prefix (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.chainId.endsWith", "description": "Ends with suffix (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.chainId.in", "description": "Value is in the list", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filter.chainId.notIn", "description": "Value is not in the list", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filter.chainId.regex", "description": "Regular expression match", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.chainId.isNull", "description": "Check if field is null", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "filter.chainId.fuzzy.value", "description": "Value to match against", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.chainId.fuzzy.minSimilarity", "description": "Minimum similarity threshold (0.0-1.0)", "in": "query", "required": false, "schema": { "type": "number", "format": "float" } }, { "name": "filter.checksumType.eq", "description": "Equals", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter.checksumType.notEq", "description": "Not equal to", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter.checksumType.in", "description": "Value is in the list", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "filter.checksumType.notIn", "description": "Value is not in the list", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "filter.checksumType.isNull", "description": "Check if field is null", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "filter.checksumType.gt", "description": "Greater than", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter.checksumType.gte", "description": "Greater than or equal to", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter.checksumType.lt", "description": "Less than", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter.checksumType.lte", "description": "Less than or equal to", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter.chain.eq", "description": "Exact match", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.chain.notEq", "description": "Not equal to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.chain.contains", "description": "Contains substring (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.chain.startsWith", "description": "Starts with prefix (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.chain.endsWith", "description": "Ends with suffix (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.chain.in", "description": "Value is in the list", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filter.chain.notIn", "description": "Value is not in the list", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filter.chain.regex", "description": "Regular expression match", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.chain.isNull", "description": "Check if field is null", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "filter.chain.fuzzy.value", "description": "Value to match against", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.chain.fuzzy.minSimilarity", "description": "Minimum similarity threshold (0.0-1.0)", "in": "query", "required": false, "schema": { "type": "number", "format": "float" } }, { "name": "search.term", "description": "Search term", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search.fields", "description": "Fields to search in", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "search.type", "description": "Type of search to perform\n\n - SEARCH_TYPE_CONTAINS: Default substring search\n - SEARCH_TYPE_STARTS_WITH: Prefix search\n - SEARCH_TYPE_EXACT: Exact match\n - SEARCH_TYPE_FUZZY: Fuzzy/similarity search\n - SEARCH_TYPE_FULLTEXT: Full-text search (future)", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "SEARCH_TYPE_CONTAINS", "SEARCH_TYPE_STARTS_WITH", "SEARCH_TYPE_EXACT", "SEARCH_TYPE_FUZZY", "SEARCH_TYPE_FULLTEXT" ] } }, { "name": "search.minScore", "description": "Minimum relevance score for fuzzy/fulltext search", "in": "query", "required": false, "schema": { "type": "number", "format": "float" } }, { "name": "search.options.caseSensitive", "description": "Enable case-sensitive search (default: false)", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "search.options.minTermLength", "description": "Minimum search term length", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "search.options.maxResults", "description": "Maximum number of results to return", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "search.options.multiTermAnd", "description": "Use AND logic for multiple terms (default: false for OR)", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "pagination.pageSize", "description": "Number of results per page (default 50, max 1000)", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pagination.pageToken", "description": "Token for pagination from previous response", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pagination.orderBy", "description": "Field to order results by", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pagination.order", "description": "Sort order (ASC or DESC)", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "SORT_ORDER_ASC", "SORT_ORDER_DESC" ] } } ], "tags": [ "Registry" ] }, "post": { "summary": "Create a new blockchain", "description": "Create a new blockchain configuration in the registry", "operationId": "RegistryManagementService_ManagementCreateBlockchain", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2BlockchainInfo" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ManagementCreateBlockchainRequest" } } }, "required": true }, "tags": [ "Registry" ] } }, "/v2/blockchains/{id}": { "get": { "summary": "Get a blockchain", "description": "Get blockchain configuration by ID", "operationId": "RegistryService_GetBlockchain", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2BlockchainInfo" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The blockchain ID to retrieve", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "AVALANCHE", "ETHEREUM", "XRP_LEDGER", "POLYGON", "BNBCHAIN", "BASE", "HEDERA", "ARBITRUM", "ONE_MONEY", "SOLANA", "TRON", "BITCOIN" ] } } ], "tags": [ "Registry" ] }, "delete": { "summary": "Delete a blockchain", "description": "Soft delete a blockchain from the registry", "operationId": "RegistryManagementService_ManagementDeleteBlockchain", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ManagementDeleteBlockchainResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The blockchain ID to delete", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "AVALANCHE", "ETHEREUM", "XRP_LEDGER", "POLYGON", "BNBCHAIN", "BASE", "HEDERA", "ARBITRUM", "ONE_MONEY", "SOLANA", "TRON", "BITCOIN" ] } } ], "tags": [ "Registry" ] }, "patch": { "summary": "Update a blockchain", "description": "Update an existing blockchain configuration", "operationId": "RegistryManagementService_ManagementUpdateBlockchain", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2BlockchainInfo" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The blockchain ID to update", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "AVALANCHE", "ETHEREUM", "XRP_LEDGER", "POLYGON", "BNBCHAIN", "BASE", "HEDERA", "ARBITRUM", "ONE_MONEY", "SOLANA", "TRON", "BITCOIN" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Ethereum Mainnet", "description": "Updated blockchain name" }, "namespace": { "type": "string", "example": "ethereum", "description": "Updated namespace" }, "chain": { "type": "string", "example": "mainnet", "description": "Updated chain identifier" }, "chainId": { "type": "string", "example": "1", "description": "Updated chain ID" }, "routing": { "type": "string", "example": "primary", "description": "Updated routing configuration" }, "status": { "$ref": "#/components/schemas/v2BlockchainStatus" }, "supportsWalletConnect": { "type": "boolean", "example": true, "description": "Updated WalletConnect support" } } } } }, "required": true }, "tags": [ "Registry" ] } }, "/v2/blockchains:list": { "post": { "summary": "List blockchains", "description": "List blockchains with advanced filtering. Supports both GET (bookmarkable) and POST (complex filters).", "operationId": "RegistryService_ListBlockchains", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListBlockchainsResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListBlockchainsRequest" } } }, "required": true }, "tags": [ "Registry" ] } }, "/v2/connections": { "get": { "summary": "List connections for the organization", "description": "List all wallet connect connections for the organization", "operationId": "WalletConnectService_ListGlobalConnections", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v2Connection" } } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "status", "description": "The connection status", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "CREATED", "PROPOSING", "PROPOSED", "CONNECTED", "DISCONNECTED", "REJECTED", "UNSUPPORTED", "EXPIRED", "ERROR" ] } } ], "tags": [ "Wallet Connect" ] } }, "/v2/counterparties": { "get": { "summary": "List counterparties", "description": "List counterparties", "operationId": "CounterpartyService_ListCounterparties", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListCounterpartiesResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "pageSize", "description": "The number of results to return per page (default 50, max 1000)", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageToken", "description": "The token to retrieve the next page of results", "in": "query", "required": false, "schema": { "type": "string" } } ], "tags": [ "Counterparties" ] }, "post": { "summary": "Create counterparties", "description": "Create a new counterparty", "operationId": "CounterpartyService_CreateCounterparty", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Counterparty" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2CreateCounterpartyRequest" } } }, "required": true }, "tags": [ "Counterparties" ] } }, "/v2/counterparties/{counterpartyId}/addresses": { "get": { "summary": "List counterparty addresses", "description": "List all addresses within a counterparty", "operationId": "CounterpartyService_ListAddresses", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListAddressesResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "counterpartyId", "description": "The counterparty ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "description": "The number of results to return per page (default 50, max 100)", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageToken", "description": "The token to retrieve the next page of results", "in": "query", "required": false, "schema": { "type": "string" } } ], "tags": [ "Addresses" ] }, "post": { "summary": "Create addresses", "description": "Create a new address", "operationId": "CounterpartyService_CreateAddress", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/counterpartyv2Address" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "counterpartyId", "description": "The counterparty ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "custodian": { "$ref": "#/components/schemas/v2Custodian" }, "termsAndConditionsAccepted": { "type": "boolean", "example": true, "description": "Whether the user has accepted the terms and conditions" }, "details": { "$ref": "#/components/schemas/v2AddressDetails" } }, "required": [ "termsAndConditionsAccepted", "details" ] } } }, "required": true }, "tags": [ "Addresses" ] } }, "/v2/counterparties/{counterpartyId}/addresses/{addressId}": { "get": { "summary": "Get addresses", "description": "Get an address", "operationId": "CounterpartyService_GetAddress", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/counterpartyv2Address" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "counterpartyId", "description": "The counterparty ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "addressId", "description": "The address ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Addresses" ] }, "delete": { "summary": "Delete addresses", "description": "Delete an address", "operationId": "CounterpartyService_DeleteAddress", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2DeleteAddressResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "counterpartyId", "description": "The counterparty ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "addressId", "description": "The address ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Addresses" ] } }, "/v2/counterparties/{id}": { "get": { "summary": "Get counterparties", "description": "Get a counterparty", "operationId": "CounterpartyService_GetCounterparty", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Counterparty" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The counterparty ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Counterparties" ] }, "delete": { "summary": "Delete counterparties", "description": "Delete a counterparty", "operationId": "CounterpartyService_DeleteCounterparty", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2DeleteCounterpartyResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The counterparty ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Counterparties" ] }, "put": { "summary": "Update counterparties", "description": "Update a counterparty", "operationId": "CounterpartyService_UpdateCounterparty", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Counterparty" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The counterparty ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Palisade", "description": "The counterparty name" }, "description": { "type": "string", "example": "A counterparty used by the treasury department", "description": "The counterparty description" } }, "required": [ "name" ] } } }, "required": true }, "tags": [ "Counterparties" ] } }, "/v2/credentials": { "get": { "summary": "List all credentials", "description": "List all credentials", "operationId": "CredentialService_ListCredentials", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v2Credential" }, "required": [ "credentials" ] } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "tags": [ "API Credentials" ] }, "post": { "summary": "Create credentials", "description": "Create a set of API credentials", "operationId": "CredentialService_CreateCredential", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Credential" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2CreateCredentialRequest" } } }, "required": true }, "tags": [ "API Credentials" ] } }, "/v2/credentials/info": { "get": { "summary": "List all credential info", "description": "List all credential info", "operationId": "CredentialService_ListCredentialInfo", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v2CredentialInfo" }, "required": [ "credentials" ] } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "tags": [ "API Credentials" ] } }, "/v2/credentials/oauth/token": { "post": { "summary": "Client credentials exchange", "description": "OAuth client credentials exchange for access token", "operationId": "CredentialService_ExchangeCredential", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ExchangeCredentialResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ExchangeCredentialRequest" } } }, "required": true }, "tags": [ "API Credentials" ], "security": [] } }, "/v2/credentials/permissions": { "get": { "summary": "List available permissions", "description": "List available permissions for the use with API credentials", "operationId": "CredentialService_ListVariants", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListVariantsResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "tags": [ "API Credentials" ] } }, "/v2/credentials/{id}": { "get": { "summary": "Get credentials", "description": "Get a set of API credentials by ID", "operationId": "CredentialService_GetCredential", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Credential" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The credential ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "API Credentials" ] }, "delete": { "summary": "Delete credential", "description": "Delete a specific set of API credentials", "operationId": "CredentialService_DeleteCredential", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2DeleteCredentialResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The credential ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "API Credentials" ] } }, "/v2/credentials/{id}/active": { "put": { "summary": "Update credential active status", "description": "Update the active status on a specific set of API credentials", "operationId": "CredentialService_UpdateCredentialActiveStatus", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Credential" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The credential ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "active": { "type": "boolean", "example": true, "description": "The credential enabled status" } }, "required": [ "active" ] } } }, "required": true }, "tags": [ "API Credentials" ] } }, "/v2/credentials/{id}/info": { "get": { "summary": "Get credential info ", "description": "Get a set of API credential info by ID", "operationId": "CredentialService_GetCredentialInfo", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2CredentialInfo" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The credential ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "API Credentials" ] } }, "/v2/credentials/{id}/permissions": { "put": { "summary": "Update credential permissions", "description": "Update the permissions set on a specific set of API credentials", "operationId": "CredentialService_UpdateCredentialPermissions", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Credential" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The credential ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "permissions": { "type": "array", "example": [ "vault:read:org:id=ce4918bf-a199-4ce2-85a3-d0d296855384:*" ], "items": { "type": "string" }, "description": "The permissions that the credential will have" } }, "required": [ "permissions" ] } } }, "required": true }, "tags": [ "API Credentials" ] } }, "/v2/currencies": { "get": { "summary": "List currencies", "description": "List currencies with advanced filtering. Supports both GET (bookmarkable) and POST (complex filters).", "operationId": "RegistryService_ListCurrencies2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListCurrenciesResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "filter.enabled.eq", "description": "Equals", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "filter.enabled.isNull", "description": "Check if field is null", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "filter.name.eq", "description": "Exact match", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.name.notEq", "description": "Not equal to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.name.contains", "description": "Contains substring (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.name.startsWith", "description": "Starts with prefix (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.name.endsWith", "description": "Ends with suffix (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.name.in", "description": "Value is in the list", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filter.name.notIn", "description": "Value is not in the list", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filter.name.regex", "description": "Regular expression match", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.name.isNull", "description": "Check if field is null", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "filter.name.fuzzy.value", "description": "Value to match against", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.name.fuzzy.minSimilarity", "description": "Minimum similarity threshold (0.0-1.0)", "in": "query", "required": false, "schema": { "type": "number", "format": "float" } }, { "name": "filter.code.eq", "description": "Exact match", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.code.notEq", "description": "Not equal to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.code.contains", "description": "Contains substring (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.code.startsWith", "description": "Starts with prefix (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.code.endsWith", "description": "Ends with suffix (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.code.in", "description": "Value is in the list", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filter.code.notIn", "description": "Value is not in the list", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filter.code.regex", "description": "Regular expression match", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.code.isNull", "description": "Check if field is null", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "filter.code.fuzzy.value", "description": "Value to match against", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.code.fuzzy.minSimilarity", "description": "Minimum similarity threshold (0.0-1.0)", "in": "query", "required": false, "schema": { "type": "number", "format": "float" } }, { "name": "filter.symbol.eq", "description": "Exact match", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.symbol.notEq", "description": "Not equal to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.symbol.contains", "description": "Contains substring (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.symbol.startsWith", "description": "Starts with prefix (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.symbol.endsWith", "description": "Ends with suffix (case-insensitive)", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.symbol.in", "description": "Value is in the list", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filter.symbol.notIn", "description": "Value is not in the list", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filter.symbol.regex", "description": "Regular expression match", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.symbol.isNull", "description": "Check if field is null", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "filter.symbol.fuzzy.value", "description": "Value to match against", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter.symbol.fuzzy.minSimilarity", "description": "Minimum similarity threshold (0.0-1.0)", "in": "query", "required": false, "schema": { "type": "number", "format": "float" } }, { "name": "search.term", "description": "Search term", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search.fields", "description": "Fields to search in", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "search.type", "description": "Type of search to perform\n\n - SEARCH_TYPE_CONTAINS: Default substring search\n - SEARCH_TYPE_STARTS_WITH: Prefix search\n - SEARCH_TYPE_EXACT: Exact match\n - SEARCH_TYPE_FUZZY: Fuzzy/similarity search\n - SEARCH_TYPE_FULLTEXT: Full-text search (future)", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "SEARCH_TYPE_CONTAINS", "SEARCH_TYPE_STARTS_WITH", "SEARCH_TYPE_EXACT", "SEARCH_TYPE_FUZZY", "SEARCH_TYPE_FULLTEXT" ] } }, { "name": "search.minScore", "description": "Minimum relevance score for fuzzy/fulltext search", "in": "query", "required": false, "schema": { "type": "number", "format": "float" } }, { "name": "search.options.caseSensitive", "description": "Enable case-sensitive search (default: false)", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "search.options.minTermLength", "description": "Minimum search term length", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "search.options.maxResults", "description": "Maximum number of results to return", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "search.options.multiTermAnd", "description": "Use AND logic for multiple terms (default: false for OR)", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "pagination.pageSize", "description": "Number of results per page (default 50, max 1000)", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pagination.pageToken", "description": "Token for pagination from previous response", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pagination.orderBy", "description": "Field to order results by", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pagination.order", "description": "Sort order (ASC or DESC)", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "SORT_ORDER_ASC", "SORT_ORDER_DESC" ] } } ], "tags": [ "Registry" ] }, "post": { "summary": "Create a new currency", "description": "Create a new currency in the registry", "operationId": "RegistryManagementService_ManagementCreateCurrency", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Currency" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ManagementCreateCurrencyRequest" } } }, "required": true }, "tags": [ "Registry" ] } }, "/v2/currencies/{code}": { "get": { "summary": "Get a currency", "description": "Get currency configuration by code", "operationId": "RegistryService_GetCurrency", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Currency" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "code", "description": "ISO 4217 currency code", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Registry" ] }, "delete": { "summary": "Delete a currency", "description": "Soft delete a currency from the registry", "operationId": "RegistryManagementService_ManagementDeleteCurrency", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ManagementDeleteCurrencyResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "code", "description": "Currency code to delete", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Registry" ] }, "patch": { "summary": "Update a currency", "description": "Update an existing currency in the registry", "operationId": "RegistryManagementService_ManagementUpdateCurrency", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Currency" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "code", "description": "Currency code to update", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "United States Dollar", "description": "Updated currency name" }, "symbol": { "type": "string", "example": "$", "description": "Updated currency symbol" }, "decimals": { "type": "integer", "format": "int32", "example": 2, "description": "Updated decimal places" }, "enabled": { "type": "boolean", "example": true, "description": "Updated enabled status" } } } } }, "required": true }, "tags": [ "Registry" ] } }, "/v2/currencies:list": { "post": { "summary": "List currencies", "description": "List currencies with advanced filtering. Supports both GET (bookmarkable) and POST (complex filters).", "operationId": "RegistryService_ListCurrencies", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListCurrenciesResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListCurrenciesRequest" } } }, "required": true }, "tags": [ "Registry" ] } }, "/v2/devices": { "get": { "summary": "List all devices", "description": "List all devices associated with a user or organization", "operationId": "DeviceService_ListDevices", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v2Device" } } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "deviceType", "description": "The device type", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "MOBILE", "CLOUD" ] } }, { "name": "deviceOwner", "description": "The device owner", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "THIS_ORGANIZATION", "TRUSTED_ORGANIZATION" ] } } ], "tags": [ "Devices" ] }, "post": { "summary": "Create a new device", "description": "Create a new device in your organization ready to pair with a physical device", "operationId": "DeviceService_CreateDevice", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Device" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2CreateDeviceRequest" } } }, "required": true }, "tags": [ "Devices" ] } }, "/v2/devices/credentials": { "get": { "summary": "Get device credentials", "description": "Get device credentials for the device specified in the JWT", "operationId": "DeviceService_GetDeviceCredentials", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2GetDeviceCredentialsResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "tags": [ "Devices" ] } }, "/v2/devices/metadata": { "post": { "summary": "Add device metadata", "description": "Add key/value metadata to the device specified in the JWT", "operationId": "DeviceService_AddDeviceMetadata", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AddDeviceMetadataResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AddDeviceMetadataRequest" } } }, "required": true }, "tags": [ "Devices" ] } }, "/v2/devices/pair-with-credential": { "post": { "summary": "Pair a device with an organization", "description": "Pair the device specified in the JWT", "operationId": "DeviceService_PairDeviceWithCredential", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Device" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2PairDeviceWithCredentialRequest" } } }, "required": true }, "tags": [ "Devices" ] } }, "/v2/devices/push-token": { "get": { "summary": "Get push notification token", "description": "Get a new push notification token for the device specified in the JWT", "operationId": "DeviceService_GetPushToken", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2GetPushTokenResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "tags": [ "Devices" ] } }, "/v2/devices/self": { "get": { "summary": "Get device", "description": "Get the device specified in the JWT", "operationId": "DeviceService_GetSelf", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Device" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "tags": [ "Devices" ] } }, "/v2/devices/version": { "post": { "summary": "Set device version", "description": "Set the version of the device specified in the JWT", "operationId": "DeviceService_SetDeviceVersion", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2SetDeviceVersionResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2SetDeviceVersionRequest" } } }, "required": true }, "tags": [ "Devices" ] } }, "/v2/devices/{id}": { "get": { "summary": "Get a device", "description": "Get a specific device by ID", "operationId": "DeviceService_GetDevice", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Device" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The device ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Devices" ] }, "delete": { "summary": "Delete a device", "description": "Delete a specific device by ID. This action can only be performed for unapproved devices at this time.", "operationId": "DeviceService_DeleteDevice", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Device" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The device ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Devices" ] } }, "/v2/devices/{id}/approval-status": { "put": { "summary": "Update device approval status", "description": "Update the approval status of a device by ID", "operationId": "DeviceService_UpdateDeviceApprovalStatus", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Device" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The device ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "approvalStatus": { "$ref": "#/components/schemas/devicev2ApprovalStatus" } }, "required": [ "approvalStatus" ] } } }, "required": true }, "tags": [ "Devices" ] } }, "/v2/devices/{id}/display-name": { "put": { "summary": "Update device display name", "description": "Update the display name of a device by ID", "operationId": "DeviceService_UpdateDeviceDisplayName", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Device" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The device ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "displayName": { "type": "string", "example": "Treasury vault", "description": "The name of the device" } }, "required": [ "displayName" ] } } }, "required": true }, "tags": [ "Devices" ] } }, "/v2/devices/{id}/enabled-status": { "put": { "summary": "Update device enabled status", "description": "Update the enabled status of a device by ID", "operationId": "DeviceService_UpdateDeviceEnabledStatus", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Device" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The device ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "enabledStatus": { "$ref": "#/components/schemas/v2EnabledStatus" } }, "required": [ "enabledStatus" ] } } }, "required": true }, "tags": [ "Devices" ] } }, "/v2/devices/{id}/pairing-credentials": { "get": { "summary": "Get device pairing credentials", "description": "Get a new set of pairing credentials for a device by ID", "operationId": "DeviceService_GetDevicePairingCredentials", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2PairingCredentials" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The device ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Devices" ] } }, "/v2/devices/{id}/trust-organization": { "post": { "summary": "Trust organization", "description": "Trust a new organization to use this device in it's controls", "operationId": "DeviceService_TrustOrganization", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2TrustedOrganization" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The device ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "trustedOrganizationId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The trusted organization ID" }, "trustedOrganizationName": { "type": "string", "example": "Mega Corp", "description": "The name of the trusted organization" } }, "required": [ "trustedOrganizationId", "trustedOrganizationName" ] } } }, "required": true }, "tags": [ "Devices" ] } }, "/v2/info/supported-assets": { "get": { "summary": "List Supported Assets", "description": "Get the list of supported assets", "operationId": "BalanceService_ListSupportedAssets", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/commonv2Asset" } } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "blockchain", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "AVALANCHE", "ETHEREUM", "XRP_LEDGER", "POLYGON", "BNBCHAIN", "BASE", "HEDERA", "ARBITRUM", "ONE_MONEY", "SOLANA", "TRON", "BITCOIN" ] } } ], "tags": [ "Information" ] } }, "/v2/info/supported-currencies": { "get": { "summary": "List Supported Currencies", "description": "Get the list of supported currencies", "operationId": "BalanceService_ListSupportedCurrencies", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v2Currency" } } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "tags": [ "Information" ] } }, "/v2/mpc/device/memberships": { "get": { "summary": "List memberships for device", "description": "List memberships for device", "operationId": "MpcService_ListMembershipsForDevice", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v2Membership" } } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "tags": [ "MPC - Memberships" ] } }, "/v2/mpc/device/sessions": { "get": { "summary": "List sessions for device", "description": "List sessions for device", "operationId": "MpcService_ListSessionsForDevice", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v2Session" } } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "stateFilter", "description": " - SESSION_STATE_SUBMITTED: Session has completed & submitted data from this device\n - SESSION_STATE_COMPLETED: Session has completed but this device did not submit data\n - SESSION_STATE_SUPER: FSM USE ONLY: Super state\n - SESSION_STATE_INITIAL: FSM USE ONLY: Initial state", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "SESSION_STATE_CREATED", "SESSION_STATE_PENDING", "SESSION_STATE_SUBMITTED", "SESSION_STATE_COMPLETED", "SESSION_STATE_TIMED_OUT", "SESSION_STATE_FAILED", "SESSION_STATE_PROCESSED", "SESSION_STATE_SUPER", "SESSION_STATE_INITIAL" ] } } ], "tags": [ "MPC - Sessions" ] } }, "/v2/mpc/device/sessions/{sessionId}": { "get": { "summary": "Get session", "description": "Get session", "operationId": "MpcService_GetSession", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Session" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "MPC - Sessions" ] } }, "/v2/mpc/device/sessions/{sessionId}/data": { "get": { "summary": "Get device session data", "description": "Get device session data", "operationId": "MpcService_GetDeviceSessionData", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2GetDeviceSessionDataResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "MPC - Sessions" ] } }, "/v2/mpc/device/{sessionId}": { "patch": { "summary": "Submit session", "description": "Submit session", "operationId": "MpcService_SubmitSession", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Session" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "accepted": { "type": "boolean" }, "devicePayload": { "type": "string" } }, "required": [ "accepted" ] } } }, "required": true }, "tags": [ "MPC - Sessions" ] } }, "/v2/mpc/eligible": { "get": { "summary": "List eligible devices", "description": "List eligible devices", "operationId": "MpcService_ListEligibleDevices", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v2EligibleDevice" } } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "deviceType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "MOBILE", "CLOUD" ] } } ], "tags": [ "MPC - Quorums" ] } }, "/v2/mpc/memberships/{quorumId}": { "get": { "summary": "List memberships for quorum", "description": "List memberships for quorum", "operationId": "MpcService_ListMembershipsForQuorum", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v2Membership" } } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "quorumId", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "MPC - Memberships" ] } }, "/v2/mpc/quorums": { "get": { "summary": "List quorums", "description": "List quorums with the client JWT", "operationId": "MpcService_ListQuorums", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v2Quorum" } } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "tags": [ "MPC - Quorums" ] }, "post": { "summary": "Create a new quorum", "description": "Create a new quorum", "operationId": "MpcService_CreateQuorum", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Quorum" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2CreateQuorumRequest" } } }, "required": true }, "tags": [ "MPC - Quorums" ] } }, "/v2/mpc/quorums/self": { "get": { "summary": "List quorums", "description": "List quorums with the device JWT", "operationId": "MpcService_ListQuorumsByDevice", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v2Quorum" } } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "tags": [ "MPC - Quorums" ] } }, "/v2/mpc/quorums/{quorumId}": { "get": { "summary": "Get a quorum", "description": "Get a quorum", "operationId": "MpcService_GetQuorum", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Quorum" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "quorumId", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "MPC - Quorums" ] }, "delete": { "summary": "Delete a quorum", "description": "Delete a quorum", "operationId": "MpcService_DeleteQuorum", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Quorum" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "quorumId", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "MPC - Quorums" ] }, "patch": { "summary": "Modify an existing quorum", "description": "Modify an existing quorum", "operationId": "MpcService_ModifyQuorum", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Quorum" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "quorumId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "deviceIds" ] } } }, "required": true }, "tags": [ "MPC - Quorums" ] } }, "/v2/mpc/quorums/{quorumId}/status": { "get": { "summary": "Poll quorum status", "description": "Poll quorum status", "operationId": "MpcService_PollQuorumStatus", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2QuorumStatus" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "quorumId", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "MPC - Quorums" ] } }, "/v2/mpc/sessions/{quorumId}": { "get": { "summary": "List session sets", "description": "List session sets", "operationId": "MpcService_ListSessionSets", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v2SessionSet" } } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "quorumId", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "MPC - Sessions" ] } }, "/v2/mpc/sessions/{sessionSetId}/status": { "get": { "summary": "Poll session set status", "description": "Poll session set status", "operationId": "MpcService_PollSessionSetStatus", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2SessionSetStatus" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "sessionSetId", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "MPC - Sessions" ] } }, "/v2/notabene/search": { "get": { "summary": "Search for VASPs", "description": "Search for VASPs using the notabene search endpoint", "operationId": "ComplianceService_GetNotabeneVASPSearch", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2GetNotabeneVASPSearchResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "emailDomain", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "chainalysisName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "hasAdmin", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "badge", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "jurisdictions", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "perPage", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "all", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "listingType", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "includeUncheckedVasps", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "includeActiveSendersOnly", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "includeActiveReceiversOnly", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "regulatoryStatus", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "networkStatus", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "asset", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "reviewedByVaspDid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "showJurisdictionStatus", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "reviewValue", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "reviewIncludeInWidget", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filterByJurisdictionStatus", "in": "query", "required": false, "schema": { "type": "string" } } ], "tags": [ "Compliance" ] } }, "/v2/notabene/token": { "get": { "summary": "Create customer tokens", "description": "Create a new notabene customer token", "operationId": "ComplianceService_GetNotabeneCustomerToken", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2GetNotabeneCustomerTokenResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "tags": [ "Compliance" ] } }, "/v2/organizations": { "get": { "summary": "Get organization", "description": "Get an organization", "operationId": "AccountService_GetOrganization", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accountv2Organization" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "tags": [ "Organizations" ] } }, "/v2/organizations/auth-methods": { "get": { "summary": "List authentication methods", "description": "List an organizations authentication methods", "operationId": "AccountService_ListOrganizationAuthMethods", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v2OrganizationAuthMethod" } } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "tags": [ "Organizations" ] } }, "/v2/organizations/auth-methods/{id}": { "get": { "summary": "Get an authentication method", "description": "Get a specific organization authentication method", "operationId": "AccountService_GetOrganizationAuthMethod", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2OrganizationAuthMethod" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The auth method ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Organizations" ] }, "delete": { "summary": "Delete an authentication method", "description": "Delete a specific organization authentication method", "operationId": "AccountService_DeleteOrganizationAuthMethod", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2DeleteOrganizationAuthMethodResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The auth method ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Organizations" ] } }, "/v2/organizations/auth-methods/{id}/default": { "put": { "summary": "Set default authentication method", "description": "Set the default authentication method for an organization", "operationId": "AccountService_SetDefaultOrganizationAuthMethod", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2OrganizationAuthMethod" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The auth method ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Organizations" ] } }, "/v2/organizations/auth-methods/{id}/idp": { "put": { "summary": "Update authentication method IDP settings", "description": "Update the IDP settings for an authentication method", "operationId": "AccountService_UpdateOrganizationAuthMethodIdpSettings", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2OrganizationAuthMethodIdpSettings" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The auth method ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2OrganizationAuthMethodIdpSettings" } } }, "required": true }, "tags": [ "Organizations" ] } }, "/v2/organizations/self-service-sso-ticket": { "post": { "summary": "Generate a self service SSO ticket", "description": "Generate a self service ticket to setup SSO", "operationId": "AccountService_GenerateSelfServiceSSOTicket", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2GenerateSelfServiceSSOTicketResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "tags": [ "Organizations" ] } }, "/v2/policy-rules/limits": { "get": { "summary": "List organization wallet limits", "description": "List all wallet limits within the organization", "operationId": "PolicyService_ListGlobalWalletLimits", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListGlobalWalletLimitsResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "pageSize", "description": "The number of results to return per page (default 50, max 1000)", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageToken", "description": "The token to retrieve the next page of results", "in": "query", "required": false, "schema": { "type": "string" } } ], "tags": [ "Policies" ] } }, "/v2/rates": { "get": { "summary": "Get rates", "description": "Get the rate of a currency pair", "operationId": "BalanceService_GetRate", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2GetRateResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "blockchain", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "AVALANCHE", "ETHEREUM", "XRP_LEDGER", "POLYGON", "BNBCHAIN", "BASE", "HEDERA", "ARBITRUM", "ONE_MONEY", "SOLANA", "TRON", "BITCOIN" ] } }, { "name": "contract", "description": "The contract/issuing address", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "symbol", "description": "The asset symbol", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "currency", "description": "The currency (must be USD)", "in": "query", "required": true, "schema": { "type": "string" } } ], "tags": [ "Rates" ] } }, "/v2/sync/imports": { "get": { "summary": "Get import history", "description": "Get the history of sync import operations", "operationId": "RegistryManagementService_ManagementGetImportHistory", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ManagementGetImportHistoryResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "pagination.pageSize", "description": "Number of results per page (default 50, max 1000)", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pagination.pageToken", "description": "Token for pagination from previous response", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pagination.orderBy", "description": "Field to order results by", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pagination.order", "description": "Sort order (ASC or DESC)", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "SORT_ORDER_ASC", "SORT_ORDER_DESC" ] } }, { "name": "source", "description": "Filter by import source", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "description": "Filter by import status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startedAt.eq", "description": "Exact timestamp match", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "startedAt.notEq", "description": "Not equal to timestamp", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "startedAt.before", "description": "Before this timestamp", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "startedAt.after", "description": "After this timestamp", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "startedAt.gte", "description": "Greater than or equal to timestamp", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "startedAt.lte", "description": "Less than or equal to timestamp", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "startedAt.between.start", "description": "Start of time range (inclusive)", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "startedAt.between.end", "description": "End of time range (inclusive)", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "startedAt.isNull", "description": "Check if field is null", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "startedAt.relativeDays", "description": "Relative days from now (negative for past, positive for future)", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "completedAt.eq", "description": "Exact timestamp match", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "completedAt.notEq", "description": "Not equal to timestamp", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "completedAt.before", "description": "Before this timestamp", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "completedAt.after", "description": "After this timestamp", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "completedAt.gte", "description": "Greater than or equal to timestamp", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "completedAt.lte", "description": "Less than or equal to timestamp", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "completedAt.between.start", "description": "Start of time range (inclusive)", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "completedAt.between.end", "description": "End of time range (inclusive)", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "completedAt.isNull", "description": "Check if field is null", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "completedAt.relativeDays", "description": "Relative days from now (negative for past, positive for future)", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "tags": [ "Registry" ] } }, "/v2/sync/imports/{importId}": { "get": { "summary": "Get import details", "description": "Get details of a specific import operation", "operationId": "RegistryManagementService_ManagementGetImport", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Import" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "importId", "description": "Import ID to retrieve", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Registry" ] } }, "/v2/sync/status": { "get": { "summary": "Get sync status", "description": "Get the current status of the sync scheduler", "operationId": "RegistryManagementService_ManagementGetSyncStatus", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ManagementGetSyncStatusResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "tags": [ "Registry" ] } }, "/v2/sync:trigger": { "post": { "summary": "Trigger asset sync", "description": "Manually trigger a synchronization of assets from CoinGecko", "operationId": "RegistryManagementService_ManagementTriggerSync", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ManagementTriggerSyncResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ManagementTriggerSyncRequest" } } }, "required": true }, "tags": [ "Registry" ] } }, "/v2/tags": { "get": { "summary": "List all tags for the organization", "description": "List all wallet and vault tags for the organization", "operationId": "VaultService_ListGlobalTags", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListGlobalTagsResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "tags": [ "Tags" ] } }, "/v2/transactions/sweep/{sweepId}": { "get": { "summary": "List transactions for a sweep instance", "description": "List all transactions for a given sweep instance", "operationId": "TransactionsService_ListSweepInstanceTransactions", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListSweepInstanceTransactionsResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "sweepId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "correlationId", "description": "Correlation ID for this request, used to correlate multiple actions", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pageSize", "description": "The number of results to return per page (default 50, max 1000)", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageToken", "description": "The token to retrieve the next page of results", "in": "query", "required": false, "schema": { "type": "string" } } ], "tags": [ "Transactions - Sweep" ] } }, "/v2/transactions/transfer/estimate-fee": { "post": { "summary": "Estimate the fee for a transfer transaction", "description": "Estimate the fee for a transfer transaction", "operationId": "TransactionsService_EstimateTransferFee", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2FeeEstimate" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2EstimateTransferFeeRequest" } } }, "required": true }, "tags": [ "Transactions" ] } }, "/v2/users": { "get": { "summary": "List users", "description": "List users", "operationId": "AccountService_ListUsers", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListUsersResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "role", "description": "The role to filter by", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ADMINISTRATOR", "APPROVER", "AUDITOR", "OWNER", "PROPOSER", "VIEWER" ] } } ], "tags": [ "Users" ] }, "post": { "summary": "Create a user", "description": "Create a new user", "operationId": "AccountService_CreateUser", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2User" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2CreateUserRequest" } } }, "required": true }, "tags": [ "Users" ] } }, "/v2/users/info": { "get": { "summary": "List user info", "description": "List user info", "operationId": "AccountService_ListUserInfo", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListUserInfoResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "tags": [ "Users" ] } }, "/v2/users/{id}": { "get": { "summary": "Get user", "description": "Get a user", "operationId": "AccountService_GetUser", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2User" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The user ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Users" ] }, "delete": { "summary": "Delete users", "description": "Delete a user", "operationId": "AccountService_DeleteUser", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2DeleteUserResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The user ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Users" ] }, "put": { "summary": "Update users", "description": "Update a user", "operationId": "AccountService_UpdateUser", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2User" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The user ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "firstName": { "type": "string", "example": "Joe", "description": "The users first name" }, "lastName": { "type": "string", "example": "Bloggs", "description": "The users last name" } }, "required": [ "firstName", "lastName" ] } } }, "required": true }, "tags": [ "Users" ] } }, "/v2/users/{id}/info": { "get": { "summary": "Get user info", "description": "Get a users info", "operationId": "AccountService_GetUserInfo", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2UserInfo" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The user ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Users" ] } }, "/v2/users/{id}/mfa": { "get": { "summary": "List authentication methods", "description": "List a users authentication methods", "operationId": "AccountService_ListUserAuthMethods", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v2UserAuthMethod" } } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The user ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Users" ] }, "delete": { "summary": "Delete authentication methods", "description": "Delete all authentication methods for a user", "operationId": "AccountService_DeleteUserAuthMethods", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2DeleteUserAuthMethodsResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The user ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Users" ] } }, "/v2/users/{id}/password": { "post": { "summary": "Trigger password reset", "description": "Triggers a password reset and sends an email to the user", "operationId": "AccountService_TriggerPasswordReset", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2TriggerPasswordResetResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The user ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Users" ] } }, "/v2/users/{id}/role": { "put": { "summary": "Update user role", "description": "Update a users role", "operationId": "AccountService_UpdateUserRole", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2User" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The user ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "roles": { "type": "array", "example": [ "ADMINISTRATOR" ], "items": { "$ref": "#/components/schemas/v2Role" }, "description": "The roles that the user has" } }, "required": [ "roles" ] } } }, "required": true }, "tags": [ "Users" ] } }, "/v2/users/{id}/status": { "put": { "summary": "Update user status", "description": "Update a users status", "operationId": "AccountService_UpdateUserStatus", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2User" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The user ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/v2UserStatus" }, "reason": { "type": "string", "example": "The user lost their device", "description": "The reason for the status change" } }, "required": [ "status" ] } } }, "required": true }, "tags": [ "Users" ] } }, "/v2/vaults": { "get": { "summary": "List vaults", "description": "List all vaults within the organization", "operationId": "VaultService_ListVaults", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListVaultsResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "pageSize", "description": "The number of results to return per page (default 50, max 1000)", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageToken", "description": "The token to retrieve the next page of results", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "correlationId", "description": "Correlation ID for tracking various actions on the vault", "in": "query", "required": false, "schema": { "type": "string" } } ], "tags": [ "Vaults" ] }, "post": { "summary": "Create a vault", "description": "Create a new vault", "operationId": "VaultService_CreateVault", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Vault" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2CreateVaultRequest" } } }, "required": true }, "tags": [ "Vaults" ] } }, "/v2/vaults/tags": { "get": { "summary": "List all vault tags for the organization", "description": "List all vault tags for the organization", "operationId": "VaultService_ListGlobalVaultTags", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v2VaultTag" } } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "tags": [ "Vault Tags" ] } }, "/v2/vaults/{id}": { "get": { "summary": "Get a vault", "description": "Get a vault by ID", "operationId": "VaultService_GetVault", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Vault" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Vaults" ] }, "put": { "summary": "Update a vault", "description": "Update a vault's name and description by ID", "operationId": "VaultService_UpdateVault", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Vault" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Treasury vault", "description": "The name of the vault" }, "description": { "type": "string", "example": "A vault used by the treasury department", "description": "The description of the vault" }, "correlationId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "Correlation ID for tracking various actions on the vault" } }, "required": [ "name" ] } } }, "required": true }, "tags": [ "Vaults" ] } }, "/v2/vaults/{vaultId}/balances": { "get": { "summary": "Get Vault Balances", "description": "Get the balances of a vault", "operationId": "BalanceService_GetVaultBalances", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2GetVaultBalancesResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID that the connection is associated with", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "currencyCode", "description": "The currency code to be used for the fiat value. When omitted, 'USD' will be used.", "in": "query", "required": false, "schema": { "type": "string" } } ], "tags": [ "Balances" ] } }, "/v2/vaults/{vaultId}/tags": { "get": { "summary": "List tags for the vault", "description": "List all tags for the vault", "operationId": "VaultService_ListVaultTags", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v2VaultTag" } } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Vault Tags" ] }, "delete": { "summary": "Delete a vault tag", "description": "Delete a vault tag from a vault", "operationId": "VaultService_DeleteVaultTag", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2DeleteVaultTagResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tag", "description": "The tag", "in": "query", "required": true, "schema": { "type": "string" } } ], "tags": [ "Vault Tags" ] }, "post": { "summary": "Add a new vault tag", "description": "Add a new vault tag to a vault", "operationId": "VaultService_AddVaultTag", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v2VaultTag" } } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "tag": { "type": "string", "example": "Treasury vault", "description": "The tag" } }, "required": [ "tag" ] } } }, "required": true }, "tags": [ "Vault Tags" ] } }, "/v2/vaults/{vaultId}/wallets": { "get": { "summary": "List vault wallets", "description": "List all wallets within a vault", "operationId": "VaultService_ListVaultWallets", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListVaultWalletsResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "description": "The number of results to return per page (default 50, max 1000)", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageToken", "description": "The token to retrieve the next page of results", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "blockchain", "description": "The blockchain of the wallet", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "AVALANCHE", "ETHEREUM", "XRP_LEDGER", "POLYGON", "BNBCHAIN", "BASE", "HEDERA", "ARBITRUM", "ONE_MONEY", "SOLANA", "TRON", "BITCOIN" ] } } ], "tags": [ "Wallets" ] }, "post": { "summary": "Create a wallet", "description": "Create a new HSM or MPC wallet within a vault", "operationId": "VaultService_CreateWallet", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vaultv2Wallet" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "USD Issuing wallet", "description": "The name of the wallet" }, "description": { "type": "string", "example": "Main USD issuing account used internally", "description": "The description of the wallet" }, "quorumId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The quorum ID" }, "blockchain": { "$ref": "#/components/schemas/v2Blockchain" }, "keystore": { "$ref": "#/components/schemas/v2Keystore" }, "recoveryPublicKey": { "type": "string", "example": "30820221300d06092a864886f70d01010105000382020e0030820209028202007b985c289e76fa4d25a72649d9b3381c12ec63e05cee00173e91f94a371a1fc0b95e98ffa0c435a651db17924d9089951f844d00e52fb5ddf3ac0843ea2cdf6ddf54c6926147229722e1cbd8d50a4a62e2d8ae1ffa466e67d23e9de8293dd9698a992a2eb00f9d5588dfacdd86f65c9c2d429da830bfb5b93568159cdece5c1f6424aabbb6058d83261322660ec8acdbe03060ad9fd547aa647fdc96b0b64a56a60070fa64ede58c5c8eb0e3779512e977170c2b7a3e32e375754d5e6e92d65e96d5e3095b455485d70f1ea76a392ff8488a9b93344a440c11e1943fe8dbd6cc98501cd0bac1408e0b47041adfc07b648e6e7feb55ebc1a62ae0cea93adbfd56eee20ffc75395773354927f1d9857050c0aa6a468620885c72a2c46d8274b2e780186743cfae2c04f7f5618df90c1bf31b54634c1b33fa80a68311d7ceb9d392a666bae1a059055a0e26ed1143e21b0ade10f4ef6e5dc8fa653da67f1317fb6f6755ae558f7f198fa1bb0db20e065720fe64f1b7eef91e744bd53df2830ae12960c11e68940f7e7915ff5d46af5e4b65d32f7196ed095a52764c585f75b81d568f101721a18123304b006730fcfb715d53853904995da7e1302a1273ac2559f789bf331dc54c1cd2a523fc665100d6cfad4e4446ff5b239517e577aaf5be1d8a2ed72087432f58d2fdffad377a01c0980efe9e5673ac93d882c64914a2111a9f0203010001", "description": "Optional, hex encoded PKCS1 formatted public key of a 4096-bit RSA private key" }, "externalId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "External ID of this wallet, unique to the organization" }, "correlationId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "Correlation ID for tracking correlations with the wallet" } }, "required": [ "name", "blockchain", "keystore" ] } } }, "required": true }, "tags": [ "Wallets" ] } }, "/v2/vaults/{vaultId}/wallets/tags": { "get": { "summary": "List all wallet tags in vault", "description": "List all tags from all wallets in the vault", "operationId": "VaultService_ListWalletTagsInVault", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v2WalletTag" } } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Wallet Tags" ] } }, "/v2/vaults/{vaultId}/wallets/{walletId}": { "get": { "summary": "Get a wallet", "description": "Get a wallet by ID", "operationId": "VaultService_GetWallet", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vaultv2Wallet" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Wallets" ] }, "delete": { "summary": "Delete a wallet", "description": "Delete a wallet by ID (A wallet can only be deleted if it is in PROVISIONING_FAILED status)", "operationId": "VaultService_DeleteWallet", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2DeleteWalletResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Wallets" ] }, "put": { "summary": "Update a wallet", "description": "Update a wallet's name and description by ID", "operationId": "VaultService_UpdateWallet", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vaultv2Wallet" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "USD Issuing wallet", "description": "The name of the wallet" }, "description": { "type": "string", "example": "Main USD issuing account used internally", "description": "The description of the wallet" }, "correlationId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "Correlation ID for tracking correlated actions on the wallet" } }, "required": [ "name" ] } } }, "required": true }, "tags": [ "Wallets" ] } }, "/v2/vaults/{vaultId}/wallets/{walletId}/balances": { "get": { "summary": "Get Wallet Balances", "description": "Get the balances of a wallet", "operationId": "BalanceService_GetWalletBalances", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2GetWalletBalancesResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "currencyCode", "description": "The currency code to be used for the fiat value. When omitted, 'USD' will be used.", "in": "query", "required": false, "schema": { "type": "string" } } ], "tags": [ "Balances" ] } }, "/v2/vaults/{vaultId}/wallets/{walletId}/balances/sync": { "post": { "summary": "Sync Wallet Balances", "description": "Trigger a refresh of the balances for a wallet. Note: This only syncs balances for assets already known to the system. It will not discover new tokens that were received but not yet tracked.", "operationId": "BalanceService_SyncWalletBalances", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2SyncWalletBalancesResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Balances" ] } }, "/v2/vaults/{vaultId}/wallets/{walletId}/connections": { "get": { "summary": "List connections for the wallet", "description": "List all wallet connect connections for the wallet", "operationId": "WalletConnectService_ListConnections", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v2Connection" } } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID that the connection is associated with", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID that the connection is associated with", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "status", "description": "The connection status", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "CREATED", "PROPOSING", "PROPOSED", "CONNECTED", "DISCONNECTED", "REJECTED", "UNSUPPORTED", "EXPIRED", "ERROR" ] } } ], "tags": [ "Wallet Connect" ] }, "post": { "summary": "Propose a new wallet connect connection", "description": "Proposes a new wallet connect connection using the provided URI", "operationId": "WalletConnectService_CreateConnection", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Connection" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID that the connection is associated with", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID that the connection is associated with", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "uri": { "type": "string", "example": "wc:7f6e504bfad60b485450578e05678ed3e8e8c4751d3c6160be17160d63ec90f9@2?symKey=587d5484ce2a2a6ee3ba1962fdd7e8588e06200c46823bd18fbd67def96ad303&methods=[wc_ConnectionPropose],[wc_authRequest,wc_authBatchRequest]&relay-protocol=irn&expiryTimestamp=1705667684", "description": "The URI used to create the connection" } }, "required": [ "uri" ] } } }, "required": true }, "tags": [ "Wallet Connect" ] } }, "/v2/vaults/{vaultId}/wallets/{walletId}/connections/{id}": { "get": { "summary": "Get a wallet connect connection", "description": "Get a wallet connect connection by ID", "operationId": "WalletConnectService_GetConnection", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Connection" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID that the connection is associated with", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID that the connection is associated with", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "description": "The connection ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Wallet Connect" ] } }, "/v2/vaults/{vaultId}/wallets/{walletId}/connections/{id}/accept": { "put": { "summary": "Accept a wallet connect connection", "description": "Accept a wallet connect connection by ID", "operationId": "WalletConnectService_AcceptConnection", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Connection" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID that the connection is associated with", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID that the connection is associated with", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "description": "The connection ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Wallet Connect" ] } }, "/v2/vaults/{vaultId}/wallets/{walletId}/connections/{id}/disconnect": { "put": { "summary": "Disconnects a wallet connect connection", "description": "Disconnects a wallet connect connection by ID", "operationId": "WalletConnectService_DisconnectConnection", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Connection" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID that the connection is associated with", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID that the connection is associated with", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "description": "The connection ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Wallet Connect" ] } }, "/v2/vaults/{vaultId}/wallets/{walletId}/connections/{id}/reject": { "put": { "summary": "Reject a wallet connect connection", "description": "Reject a wallet connect connection by ID", "operationId": "WalletConnectService_RejectConnection", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Connection" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID that the connection is associated with", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID that the connection is associated with", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "description": "The connection ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Wallet Connect" ] } }, "/v2/vaults/{vaultId}/wallets/{walletId}/policy-rules/limits": { "get": { "summary": "List wallet limit policies", "description": "List wallet limit policies for the specified wallet", "operationId": "PolicyService_ListWalletLimits", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListWalletLimitsResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "description": "The number of results to return per page (default 50, max 1000)", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageToken", "description": "The token to retrieve the next page of results", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "blockchain", "description": "Optional filter by blockchain. If not specified, returns policies for all blockchains.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "AVALANCHE", "ETHEREUM", "XRP_LEDGER", "POLYGON", "BNBCHAIN", "BASE", "HEDERA", "ARBITRUM", "ONE_MONEY", "SOLANA", "TRON", "BITCOIN" ] } } ], "tags": [ "Policies" ] }, "put": { "summary": "Create a wallet limit policy", "description": "Create a wallet limit policy for the specified wallet", "operationId": "PolicyService_CreateWalletLimit", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2WalletLimit" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limitQty": { "type": "string", "example": "200.00", "description": "The limit quantity" }, "duration": { "type": "string", "example": "200s", "description": "The limit duration" }, "limitType": { "$ref": "#/components/schemas/v2LimitType" }, "contract": { "type": "string", "example": "0xdAC17F958D2ee523a2206206994597C13D831ec7", "description": "The contract/issuing address" }, "symbol": { "type": "string", "example": "USD", "description": "The asset symbol" }, "matchers": { "type": "array", "items": { "$ref": "#/components/schemas/v2Matcher" } }, "blockchain": { "$ref": "#/components/schemas/v2Blockchain" } }, "required": [ "limitQty", "limitType", "symbol" ] } } }, "required": true }, "tags": [ "Policies" ] } }, "/v2/vaults/{vaultId}/wallets/{walletId}/policy-rules/limits/{id}": { "get": { "summary": "Get a wallet limit policy", "description": "Get the specified wallet limit policy", "operationId": "PolicyService_GetWalletLimit", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2WalletLimit" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "description": "The wallet limit policy ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Policies" ] }, "delete": { "summary": "Delete a wallet limit policy", "description": "Delete the specified wallet limit policy", "operationId": "PolicyService_DeleteWalletLimit", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2DeleteWalletLimitResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "description": "The wallet limit policy ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Policies" ] } }, "/v2/vaults/{vaultId}/wallets/{walletId}/policy-rules/permitted-destinations": { "get": { "summary": "List permitted destinations", "description": "List all permitted destinations for this wallet", "operationId": "PolicyService_ListPermittedDestinations", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListPermittedDestinationsResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "description": "The number of results to return per page (default 50, max 1000)", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageToken", "description": "The token to retrieve the next page of results", "in": "query", "required": false, "schema": { "type": "string" } } ], "tags": [ "Policies" ] } }, "/v2/vaults/{vaultId}/wallets/{walletId}/sequence": { "get": { "summary": "Get a wallet nonce/sequence", "description": "Get blockchain nonce/sequence of a specific wallet by ID", "operationId": "VaultService_GetWalletSequence", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2GetWalletSequenceResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Wallets" ] } }, "/v2/vaults/{vaultId}/wallets/{walletId}/settings": { "put": { "summary": "Update a wallet's settings", "description": "Update a wallet's settings by ID", "operationId": "VaultService_UpdateWalletSettings", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vaultv2Wallet" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "settings": { "$ref": "#/components/schemas/v2WalletSettings" } }, "required": [ "settings" ] } } }, "required": true }, "tags": [ "Wallets" ] } }, "/v2/vaults/{vaultId}/wallets/{walletId}/tags": { "get": { "summary": "List wallet tags for the wallet", "description": "List all wallet tags for the wallet", "operationId": "VaultService_ListWalletTags", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v2WalletTag" } } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Wallet Tags" ] }, "delete": { "summary": "Delete a wallet tag", "description": "Delete a wallet tag from a wallet", "operationId": "VaultService_DeleteWalletTag", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2DeleteWalletTagResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tag", "description": "The tag", "in": "query", "required": true, "schema": { "type": "string" } } ], "tags": [ "Wallet Tags" ] }, "post": { "summary": "Add a new wallet tag", "description": "Add a new wallet tag to a wallet", "operationId": "VaultService_AddWalletTag", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v2WalletTag" } } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "tag": { "type": "string", "example": "Issuing wallet", "description": "The tag" } }, "required": [ "tag" ] } } }, "required": true }, "tags": [ "Wallet Tags" ] } }, "/v2/vaults/{vaultId}/wallets/{walletId}/transactions": { "get": { "summary": "List wallet transactions", "description": "List all transactions for a given wallet", "operationId": "TransactionsService_ListWalletTransactions", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListWalletTransactionsResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "description": "The number of results to return per page (default 50, max 1000)", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageToken", "description": "The token to retrieve the next page of results", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "correlationId", "description": "Correlation ID for this request, used to correlate multiple actions", "in": "query", "required": false, "schema": { "type": "string" } } ], "tags": [ "Transactions" ] } }, "/v2/vaults/{vaultId}/wallets/{walletId}/transactions/raw": { "post": { "summary": "Create a new raw transaction", "description": "Create a new raw transaction, and optionally publish it to the blockchain", "operationId": "TransactionsService_RawTransaction", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transactionsv2Transaction" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "encodedTransaction": { "type": "string", "example": "ed408505d21dba00825208942352d20fc81225c8ecd8f6faa1b37f24fed450c98089736f6d657468696e67808080", "description": "The encoded transaction. Note that this must be encoded in the relevant blockchain format. RLP encoded for EVM chains. Binary codec encoding for XRP. Maximum size is 200KB." }, "signOnly": { "type": "boolean", "example": "true", "description": "Whether to only sign the transaction, or also publish it to the blockchain" }, "blockchain": { "$ref": "#/components/schemas/v2Blockchain" }, "externalId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "External ID of this transaction, unique to the organization" } }, "required": [ "encodedTransaction", "signOnly" ] } } }, "required": true }, "tags": [ "Transactions" ] } }, "/v2/vaults/{vaultId}/wallets/{walletId}/transactions/sign-plaintext": { "post": { "summary": "(BETA) Create a new sign plaintext transaction", "description": "(BETA) Create a new sign plaintext transaction", "operationId": "TransactionsService_SignPlaintext", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transactionsv2Transaction" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Sign: 1234", "description": "The plaintext message to sign." } }, "required": [ "message" ] } } }, "required": true }, "tags": [ "Transactions" ] } }, "/v2/vaults/{vaultId}/wallets/{walletId}/transactions/transfer": { "post": { "summary": "Create a new transfer transaction", "description": "Create a new transfer transaction", "operationId": "TransactionsService_TransferTransaction", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transactionsv2Transaction" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "destinationAddress": { "type": "string", "example": "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4", "description": "The destination address" }, "contract": { "type": "string", "example": "0xdAC17F958D2ee523a2206206994597C13D831ec7", "description": "The contract/issuing address" }, "symbol": { "type": "string", "example": "USD", "description": "The asset symbol" }, "qty": { "type": "string", "example": "155.672", "description": "The quantity of the asset to transfer" }, "sequence": { "type": "string", "format": "uint64", "example": "2", "description": "The blockchain nonce/sequence to use" }, "externalId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "External ID of this transaction, unique to the organization" }, "networkFee": { "type": "string", "example": "155.672", "description": "The maximum network fee to pay for this transaction in base asset units (eg ETH for Ethereum)" }, "config": { "$ref": "#/components/schemas/v2XRPTransactionConfig" }, "correlationId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "Correlation ID for this transaction, used to correlate multiple actions" }, "blockchain": { "$ref": "#/components/schemas/v2Blockchain" } }, "required": [ "destinationAddress", "symbol", "qty" ] } } }, "required": true }, "tags": [ "Transactions" ] } }, "/v2/vaults/{vaultId}/wallets/{walletId}/transactions/xrp/account-set": { "post": { "summary": "Create a new XRP Account Set transaction", "description": "Create a new XRP Account Set transaction", "operationId": "TransactionsService_SubmitAccountSet", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transactionsv2Transaction" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "setFlag": { "$ref": "#/components/schemas/transactionsv2AccountSetFlag" }, "clearFlag": { "$ref": "#/components/schemas/transactionsv2AccountSetFlag" }, "domain": { "type": "string", "example": "6578616d706c652e636f6d", "description": "Hex encoded string representing domain that owns this account in ASCII, less than 256 chars. Set empty to unset." }, "emailHash": { "type": "string", "example": "7e0ded033511a87ad8d04d5dfae1fcad", "description": "Hex encoded 128-bit hash bytes of the email address representing this account. Set empty to unset." }, "messageKey": { "type": "string", "example": "032CC3AFAD020F8E69DFEC08A45D303CE9E1693EB89DE0E268ADB6D7E93F19B7DF", "description": "33-byte public key for sending encrypted messages to this account. First byte must be one of (0x02, 0x03, 0xED). Set empty to unset." }, "nfTokenMinter": { "type": "string", "example": "rGgKM3hTn8MBMGgiiPMbz73VEkSBocqab6", "description": "Address of another account that can mint NFTokens for this account" }, "transferRate": { "type": "integer", "format": "int64", "example": 1800000000, "description": "Fee to charge when users transfer tokens issued by this account, represented as billionths of a unit between 1000000000 and 2000000000 or 0." }, "tickSize": { "type": "integer", "format": "int64", "example": 4, "description": "Tick size to use for offers involving a currency issued by this address, must be 3 to 15 (inclusive) or 0" }, "walletLocator": { "type": "string", "example": "678e749011f8a911f011e105c618db898a71f8759929cc9a9ebcfe7b125870ee", "description": "An arbitrary 256-bit hash value to associate with this account" }, "walletSize": { "type": "integer", "format": "int64", "example": 3, "description": "Unused field to associate on the account" }, "sequence": { "type": "string", "format": "uint64", "example": "2", "description": "The blockchain nonce/sequence to use" }, "lastLedgerSequence": { "type": "string", "format": "uint64", "example": "123456", "description": "Highest ledger index this transaction can appear in." }, "sourceTag": { "type": "string", "format": "uint64", "example": "123456", "description": "Source tag to use for this transaction" } } } } }, "required": true }, "tags": [ "Transactions - XRP" ] } }, "/v2/vaults/{vaultId}/wallets/{walletId}/transactions/xrp/amm-create": { "post": { "summary": "Create a new XRP AMM Create transaction", "description": "Create a new XRP AMM Create transaction", "operationId": "TransactionsService_SubmitAMMCreate", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transactionsv2Transaction" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/transactionsv2CurrencyAmount" }, "amount2": { "$ref": "#/components/schemas/transactionsv2CurrencyAmount" }, "tradingFee": { "type": "integer", "format": "int64", "example": 1000, "description": "The fee to charge for trades against this AMM instance, in units of 1/100,000" }, "sequence": { "type": "string", "format": "uint64", "example": "2", "description": "The blockchain nonce/sequence to use" }, "lastLedgerSequence": { "type": "string", "format": "uint64", "example": "123456", "description": "Highest ledger index this transaction can appear in." }, "sourceTag": { "type": "string", "format": "uint64", "example": "123456", "description": "Source tag to use for this transaction" } }, "required": [ "amount", "amount2", "tradingFee" ] } } }, "required": true }, "tags": [ "Transactions - XRP" ] } }, "/v2/vaults/{vaultId}/wallets/{walletId}/transactions/xrp/amm-deposit": { "post": { "summary": "Create a new XRP AMM Deposit transaction", "description": "Create a new XRP AMM Deposit transaction", "operationId": "TransactionsService_SubmitAMMDeposit", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transactionsv2Transaction" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "asset": { "$ref": "#/components/schemas/transactionsv2Asset" }, "amount": { "$ref": "#/components/schemas/transactionsv2CurrencyAmount" }, "asset2": { "$ref": "#/components/schemas/transactionsv2Asset" }, "amount2": { "$ref": "#/components/schemas/transactionsv2CurrencyAmount" }, "ePrice": { "$ref": "#/components/schemas/transactionsv2CurrencyAmount" }, "lpTokenOut": { "$ref": "#/components/schemas/transactionsv2CurrencyAmount" }, "tradingFee": { "type": "integer", "format": "int64", "example": 1000, "description": "Submit a vote for the AMM's trading fee, in units of 1/100,000" }, "flags": { "$ref": "#/components/schemas/transactionsv2AMMDepositFlag" }, "sequence": { "type": "string", "format": "uint64", "example": "2", "description": "The blockchain nonce/sequence to use" }, "lastLedgerSequence": { "type": "string", "format": "uint64", "example": "123456", "description": "Highest ledger index this transaction can appear in." }, "sourceTag": { "type": "string", "format": "uint64", "example": "123456", "description": "Source tag to use for this transaction" } }, "required": [ "asset", "asset2" ] } } }, "required": true }, "tags": [ "Transactions - XRP" ] } }, "/v2/vaults/{vaultId}/wallets/{walletId}/transactions/xrp/amm-withdraw": { "post": { "summary": "Create a new XRP AMM Withdraw transaction", "description": "Create a new XRP AMM Withdraw transaction", "operationId": "TransactionsService_SubmitAMMWithdraw", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transactionsv2Transaction" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "asset": { "$ref": "#/components/schemas/transactionsv2Asset" }, "amount": { "$ref": "#/components/schemas/transactionsv2CurrencyAmount" }, "asset2": { "$ref": "#/components/schemas/transactionsv2Asset" }, "amount2": { "$ref": "#/components/schemas/transactionsv2CurrencyAmount" }, "ePrice": { "$ref": "#/components/schemas/transactionsv2CurrencyAmount" }, "lpTokenIn": { "$ref": "#/components/schemas/transactionsv2CurrencyAmount" }, "flags": { "$ref": "#/components/schemas/transactionsv2AMMWithdrawFlag" }, "sequence": { "type": "string", "format": "uint64", "example": "2", "description": "The blockchain nonce/sequence to use" }, "lastLedgerSequence": { "type": "string", "format": "uint64", "example": "123456", "description": "Highest ledger index this transaction can appear in." }, "sourceTag": { "type": "string", "format": "uint64", "example": "123456", "description": "Source tag to use for this transaction" } }, "required": [ "asset", "asset2" ] } } }, "required": true }, "tags": [ "Transactions - XRP" ] } }, "/v2/vaults/{vaultId}/wallets/{walletId}/transactions/xrp/clawback": { "post": { "summary": "Create a new XRP Clawback transaction", "description": "Create a new XRP Clawback transaction to recover issued tokens", "operationId": "TransactionsService_SubmitClawback", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transactionsv2Transaction" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/transactionsv2CurrencyAmount" }, "holder": { "type": "string", "example": "rGgKM3hTn8MBMGgiiPMbz73VEkSBocqab6", "description": "Optional holder address for MPTokens" }, "sequence": { "type": "string", "format": "uint64", "example": "2", "description": "The blockchain nonce/sequence to use" }, "lastLedgerSequence": { "type": "string", "format": "uint64", "example": "123456", "description": "Highest ledger index this transaction can appear in." }, "sourceTag": { "type": "string", "format": "uint64", "example": "123456", "description": "Source tag to use for this transaction" } }, "required": [ "amount" ] } } }, "required": true }, "tags": [ "Transactions - XRP" ] } }, "/v2/vaults/{vaultId}/wallets/{walletId}/transactions/xrp/offer-cancel": { "post": { "summary": "Create a new XRP Offer Cancel transaction", "description": "Create a new XRP Offer Cancel transaction", "operationId": "TransactionsService_SubmitOfferCancel", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transactionsv2Transaction" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "offerSequence": { "type": "string", "format": "uint64", "example": "2", "description": "Sequence of offer to cancel" }, "sequence": { "type": "string", "format": "uint64", "example": "2", "description": "The blockchain nonce/sequence to use" }, "lastLedgerSequence": { "type": "string", "format": "uint64", "example": "123456", "description": "Highest ledger index this transaction can appear in." }, "sourceTag": { "type": "string", "format": "uint64", "example": "123456", "description": "Source tag to use for this transaction" } }, "required": [ "offerSequence" ] } } }, "required": true }, "tags": [ "Transactions - XRP" ] } }, "/v2/vaults/{vaultId}/wallets/{walletId}/transactions/xrp/offer-create": { "post": { "summary": "Create a new XRP Offer Create transaction", "description": "Create a new XRP Offer Create transaction", "operationId": "TransactionsService_SubmitOfferCreate", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transactionsv2Transaction" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "expiration": { "type": "string", "format": "uint64", "example": "1885634315", "description": "Unix timestamp after which this offer is no longer active" }, "offerSequence": { "type": "string", "format": "uint64", "example": "2", "description": "Sequence of offer to delete first, specified in the same way as OfferCancel" }, "takerGets": { "$ref": "#/components/schemas/transactionsv2CurrencyAmount" }, "takerPays": { "$ref": "#/components/schemas/transactionsv2CurrencyAmount" }, "flags": { "type": "array", "items": { "$ref": "#/components/schemas/transactionsv2OfferCreateFlags" }, "description": "Configuration flags" }, "sequence": { "type": "string", "format": "uint64", "example": "2", "description": "The blockchain nonce/sequence to use" }, "lastLedgerSequence": { "type": "string", "format": "uint64", "example": "123456", "description": "Highest ledger index this transaction can appear in." }, "sourceTag": { "type": "string", "format": "uint64", "example": "123456", "description": "Source tag to use for this transaction" } }, "required": [ "takerGets", "takerPays" ] } } }, "required": true }, "tags": [ "Transactions - XRP" ] } }, "/v2/vaults/{vaultId}/wallets/{walletId}/transactions/xrp/signer-list-set": { "post": { "summary": "Create a new XRP SignerList Set transaction", "description": "Create a new XRP SignerList Set transaction", "operationId": "TransactionsService_SubmitSignerListSet", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transactionsv2Transaction" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "signerQuorum": { "type": "integer", "format": "int64", "example": 3, "description": "Minimum sum of weights required in order to authorise a transaction. Sum of all weights of individual signers must be greater than or equal to this value." }, "signerEntries": { "type": "array", "items": { "$ref": "#/components/schemas/transactionsv2SignerEntry" }, "description": "List of signers. Leave empty with `signerQuorum` set to 0 to disable." }, "sequence": { "type": "string", "format": "uint64", "example": "2", "description": "The blockchain nonce/sequence to use" }, "lastLedgerSequence": { "type": "string", "format": "uint64", "example": "123456", "description": "Highest ledger index this transaction can appear in." }, "sourceTag": { "type": "string", "format": "uint64", "example": "123456", "description": "Source tag to use for this transaction" } }, "required": [ "signerQuorum" ] } } }, "required": true }, "tags": [ "Transactions - XRP" ] } }, "/v2/vaults/{vaultId}/wallets/{walletId}/transactions/xrp/trust-set": { "post": { "summary": "Create a new XRP Trust Set transaction", "description": "Create a new XRP Trust Set transaction", "operationId": "TransactionsService_SubmitTrustSet", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transactionsv2Transaction" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limitAmount": { "$ref": "#/components/schemas/transactionsv2CurrencyAmount" }, "qualityIn": { "type": "integer", "format": "int64", "example": 0, "description": "Value incoming balances on this trust line at the ratio of this number per 1,000,000,000 units. A value of 0 is shorthand for treating balances at face value." }, "qualityOut": { "type": "integer", "format": "int64", "example": 0, "description": "Value outgoing balances on this trust line at the ratio of this number per 1,000,000,000 units. A value of 0 is shorthand for treating balances at face value." }, "flags": { "type": "array", "items": { "$ref": "#/components/schemas/transactionsv2TrustSetFlag" }, "description": "Configuration flags" }, "sequence": { "type": "string", "format": "uint64", "example": "2", "description": "The blockchain nonce/sequence to use" }, "lastLedgerSequence": { "type": "string", "format": "uint64", "example": "123456", "description": "Highest ledger index this transaction can appear in." }, "sourceTag": { "type": "string", "format": "uint64", "example": "123456", "description": "Source tag to use for this transaction" } }, "required": [ "limitAmount" ] } } }, "required": true }, "tags": [ "Transactions - XRP" ] } }, "/v2/vaults/{vaultId}/wallets/{walletId}/transactions/{transactionId}": { "get": { "summary": "Get a transaction", "description": "Get a transaction by ID", "operationId": "TransactionsService_GetTransaction", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transactionsv2Transaction" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "transactionId", "description": "The transaction ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Transactions" ] } }, "/v2/vaults/{vaultId}/wallets/{walletId}/transactions/{transactionId}/freeze": { "put": { "summary": "Freeze a transaction", "description": "Freeze a transaction by ID", "operationId": "TransactionsService_FreezeTransaction", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transactionsv2Transaction" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "transactionId", "description": "The transaction ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "reason", "description": "Reason for freezing the transaction", "in": "query", "required": true, "schema": { "type": "string" } } ], "tags": [ "Transactions" ] } }, "/v2/vaults/{vaultId}/wallets/{walletId}/transactions/{transactionId}/unfreeze": { "put": { "summary": "Unfreeze a transaction", "description": "Unfreeze a transaction by ID", "operationId": "TransactionsService_UnfreezeTransaction", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transactionsv2Transaction" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "vaultId", "description": "The vault ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "transactionId", "description": "The transaction ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "reason", "description": "Reason for unfreezing the transaction", "in": "query", "required": true, "schema": { "type": "string" } } ], "tags": [ "Transactions" ] } }, "/v2/wallets": { "get": { "summary": "List organization wallets", "description": "List all wallets within the organization", "operationId": "VaultService_ListGlobalWallets", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListGlobalWalletsResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "pageSize", "description": "The number of results to return per page (default 50, max 1000)", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageToken", "description": "The token to retrieve the next page of results", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "blockchain", "description": "The blockchain of the wallet", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "AVALANCHE", "ETHEREUM", "XRP_LEDGER", "POLYGON", "BNBCHAIN", "BASE", "HEDERA", "ARBITRUM", "ONE_MONEY", "SOLANA", "TRON", "BITCOIN" ] } }, { "name": "correlationId", "description": "Correlation ID for tracking various actions on the wallet", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "address", "description": "The wallet address to filter by", "in": "query", "required": false, "schema": { "type": "string" } } ], "tags": [ "Wallets" ] } }, "/v2/wallets/{id}": { "get": { "summary": "Get a wallet by ID", "description": "Get a wallet by its unique ID", "operationId": "VaultService_GetWalletByID", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vaultv2Wallet" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The wallet ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Wallets" ] } }, "/v2/webhooks": { "get": { "summary": "List webhooks", "description": "List webhooks", "operationId": "WebhookService_ListWebhooks", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListWebhooksResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "pageSize", "description": "The number of results to return per page (default 50, max 100)", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageToken", "description": "The token to retrieve the next page of results", "in": "query", "required": false, "schema": { "type": "string" } } ], "tags": [ "Webhooks" ] }, "post": { "summary": "Create webhooks", "description": "Create a new webhook", "operationId": "WebhookService_CreateWebhook", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Webhook" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2CreateWebhookRequest" } } }, "required": true }, "tags": [ "Webhooks" ] } }, "/v2/webhooks/{id}": { "get": { "summary": "Get webhooks", "description": "Get a single webhook based on its ID", "operationId": "WebhookService_GetWebhook", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Webhook" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The webhook ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Webhooks" ] }, "delete": { "summary": "Delete webhooks", "description": "Delete a single webhook based on its ID", "operationId": "WebhookService_DeleteWebhook", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2DeleteWebhookResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The webhook ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Webhooks" ] } }, "/v2/webhooks/{webhookId}/subscriptions": { "get": { "summary": "List subscriptions", "description": "List subscriptions", "operationId": "WebhookService_ListSubscriptions", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListSubscriptionsResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "webhookId", "description": "The webhook ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "description": "The number of results to return per page (default 50, max 100)", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageToken", "description": "The token to retrieve the next page of results", "in": "query", "required": false, "schema": { "type": "string" } } ], "tags": [ "Webhooks" ] }, "post": { "summary": "Create webhook subscriptions", "description": "Create one or more new webhook subscription", "operationId": "WebhookService_CreateSubscriptions", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v2Subscription" } } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "webhookId", "description": "The webhook ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "example": [ { "domain": "TRANSACTION", "scope": "ORG" } ], "items": { "$ref": "#/components/schemas/v2SubscriptionConfig" }, "description": "The subscription domains and scopes", "required": [ "subscriptions" ] } } }, "required": true }, "tags": [ "Webhooks" ] } }, "/v2/webhooks/{webhookId}/subscriptions/{subscriptionId}": { "get": { "summary": "Get subscriptions", "description": "Get a single subscription based on its ID", "operationId": "WebhookService_GetSubscription", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2Subscription" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "webhookId", "description": "The webhook ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "description": "The subscription ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Webhooks" ] }, "delete": { "summary": "Delete subscriptions", "description": "Delete a single subscription based on its ID", "operationId": "WebhookService_DeleteSubscription", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2DeleteSubscriptionResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "webhookId", "description": "The webhook ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "description": "The subscription ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Webhooks" ] } }, "/v2/workflows/sweep": { "get": { "summary": "List sweep configurations", "description": "List sweep configurations", "operationId": "SweepService_ListSweepConfigurations", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListSweepConfigurationsResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "pageSize", "description": "The number of results to return per page (default 50, max 100)", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageToken", "description": "The token to retrieve the next page of results", "in": "query", "required": false, "schema": { "type": "string" } } ], "tags": [ "Sweep Configurations" ] }, "post": { "summary": "Create sweep configuration", "description": "Create a new sweep configuration", "operationId": "SweepService_CreateSweepConfiguration", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2SweepConfiguration" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2CreateSweepConfigurationRequest" } } }, "required": true }, "tags": [ "Sweep Configurations" ] } }, "/v2/workflows/sweep/instances/{id}": { "get": { "summary": "Get sweep instance by ID", "description": "Get a single sweep instance by its ID", "operationId": "SweepService_SweepInstanceByID", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2SweepInstance" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The ID of the sweep instance", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Sweep Instances" ] } }, "/v2/workflows/sweep/{id}": { "get": { "summary": "Get sweep configuration", "description": "Get a single sweep configuration based on its ID", "operationId": "SweepService_GetSweepConfiguration", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2SweepConfiguration" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The ID of the sweep configuration", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Sweep Configurations" ] }, "delete": { "summary": "Delete sweep configuration", "description": "Delete a single sweep configuration based on its ID", "operationId": "SweepService_DeleteSweepConfiguration", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2DeleteSweepConfigurationResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The ID of the sweep configuration", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Sweep Configurations" ] }, "put": { "summary": "Update sweep configuration", "description": "Update an existing sweep configuration", "operationId": "SweepService_UpdateSweepConfiguration", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2SweepConfiguration" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The ID of the sweep configuration to update", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Updated customer deposit sweep", "description": "The sweep configuration name" }, "description": { "type": "string", "example": "An updated sweep configuration used to sweep customer deposits", "description": "The sweep configuration description" }, "feeWallet": { "$ref": "#/components/schemas/v2VaultWalletIdentifier" }, "destinationWallet": { "$ref": "#/components/schemas/v2VaultWalletIdentifier" }, "sweepFrequency": { "$ref": "#/components/schemas/v2SweepFrequency" }, "assets": { "type": "array", "items": { "$ref": "#/components/schemas/v2SweepAsset" }, "description": "The assets to sweep" } }, "required": [ "name", "feeWallet", "destinationWallet", "sweepFrequency", "assets" ] } } }, "required": true }, "tags": [ "Sweep Configurations" ] } }, "/v2/workflows/sweep/{id}/disable": { "post": { "summary": "Disable sweep configuration", "description": "Disable a single sweep configuration based on its ID", "operationId": "SweepService_DisableSweepConfiguration", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2SweepConfiguration" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The ID of the sweep configuration", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Sweep Configurations" ] } }, "/v2/workflows/sweep/{id}/enable": { "post": { "summary": "Enable sweep configuration", "description": "Enable a single sweep configuration based on its ID", "operationId": "SweepService_EnableSweepConfiguration", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2SweepConfiguration" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The ID of the sweep configuration", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Sweep Configurations" ] } }, "/v2/workflows/sweep/{id}/trigger": { "post": { "summary": "Trigger a sweep configuration", "description": "Manually trigger a single sweep configuration based on its ID", "operationId": "SweepService_TriggerSweepConfiguration", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2TriggerSweepConfigurationResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "id", "description": "The ID of the sweep configuration", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "Sweep Configurations" ] } }, "/v2/workflows/sweep/{sweepConfigurationId}/instances": { "get": { "summary": "List sweep instances", "description": "List sweep instances for a sweep configuration", "operationId": "SweepService_ListSweepInstances", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListSweepInstancesResponse" } } } }, "400": { "description": "Returned when the request is malformed or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "validation error: - name: value length must be at least 1 characters [string.min_len].", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "401": { "description": "Returned when the request was unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authorization requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "403": { "description": "Returned when the request was forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The access token provided does not meet the authentication requirements.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "404": { "description": "Returned when the resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" }, "examples": { "response": { "value": { "code": 123, "message": "The resource does not exist.", "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "PAL000.000", "domain": "app.development.palisade.co/api", "metadata": {} }, { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "c817569e-b765-4e6e-a3af-bdb1d07e7517", "servingData": "" } ] } } } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "sweepConfigurationId", "description": "The ID of the sweep configuration to list instances for", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "description": "The number of results to return per page (default 50, max 100)", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageToken", "description": "The token to retrieve the next page of results", "in": "query", "required": false, "schema": { "type": "string" } } ], "tags": [ "Sweep Instances" ] } } }, "security": [ { "TokenAuth": [] } ], "externalDocs": { "description": "Click here for the API docs", "url": "https://palisade.readme.io" }, "components": { "requestBodies": { "v2ApprovalGroup": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ApprovalGroup" } } }, "required": true } }, "securitySchemes": { "TokenAuth": { "type": "apiKey", "name": "Authorization", "in": "header" } }, "schemas": { "TimestampFilterTimestampRange": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "example": "2024-08-01T00:00:00Z", "description": "Start of time range (inclusive)" }, "end": { "type": "string", "format": "date-time", "example": "2024-08-31T23:59:59Z", "description": "End of time range (inclusive)" } } }, "accountv2Organization": { "type": "object", "properties": { "id": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The organization ID" }, "name": { "type": "string", "example": "Palisade", "description": "The organization name" }, "createdBy": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The ID of the user who created this organization" }, "createdAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the organization was created" }, "updatedBy": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The ID of the user who updated this organization" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the organization was updated" }, "settings": { "$ref": "#/components/schemas/v2OrganizationSettings" }, "address": { "$ref": "#/components/schemas/commonv2Address" } }, "required": [ "id", "name", "createdBy", "createdAt", "updatedBy", "updatedAt", "settings", "address" ] }, "approvalv2Approval": { "type": "object", "properties": { "id": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The approval ID" }, "approvalSetId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The approval set ID" }, "userId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The user ID" }, "organizationId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The organization ID" }, "createdAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the approval was created" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the approval was updated" }, "signature": { "type": "string", "format": "byte", "description": "The signed approval" }, "reasons": { "type": "array", "example": [ "the transaction was not previously discussed" ], "items": { "type": "string" }, "description": "The reasons for an approval or rejection" }, "status": { "$ref": "#/components/schemas/approvalv2ApprovalStatus" } }, "required": [ "id", "approvalSetId", "userId", "organizationId", "createdAt", "updatedAt", "reasons", "status" ] }, "approvalv2ApprovalSetStatus": { "type": "string", "enum": [ "PENDING", "MET", "NOT_MET", "EXPIRED", "FAILED" ] }, "approvalv2ApprovalStatus": { "type": "string", "enum": [ "PROCESSING", "APPROVED", "REJECTED" ] }, "approvalv2ApprovalSummary": { "type": "object", "properties": { "approval": { "$ref": "#/components/schemas/approvalv2Approval" }, "summary": { "$ref": "#/components/schemas/approvalv2Summary" } }, "required": [ "approval", "summary" ] }, "approvalv2GetApprovalSummaryResponse": { "type": "object", "properties": { "approvalSummary": { "$ref": "#/components/schemas/approvalv2ApprovalSummary" } } }, "approvalv2ListApprovalSummariesResponse": { "type": "object", "properties": { "approvalSummaries": { "type": "array", "items": { "$ref": "#/components/schemas/approvalv2ApprovalSummary" } } }, "required": [ "approvalSummaries" ] }, "approvalv2Summary": { "type": "object", "properties": { "sourceId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The summary ID" }, "sourceType": { "$ref": "#/components/schemas/v2SourceType" }, "sourceRaw": { "type": "string", "format": "byte", "description": "The raw source containing the item to be approved" }, "expiresAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the approval set expires" }, "metAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the approval set was met" }, "currentApprovedCount": { "type": "integer", "format": "int32", "example": 1, "description": "The current number of approvals" }, "requiredApproverCount": { "type": "integer", "format": "int32", "example": 3, "description": "The required number of approvals" }, "status": { "$ref": "#/components/schemas/approvalv2ApprovalSetStatus" }, "requestedBy": { "type": "string" }, "action": { "$ref": "#/components/schemas/v2Action" } }, "required": [ "sourceId", "sourceType", "sourceRaw", "expiresAt", "currentApprovedCount", "requiredApproverCount", "status" ] }, "approvalv2UpdateApprovalResponse": { "type": "object", "properties": { "approvalSummary": { "$ref": "#/components/schemas/approvalv2ApprovalSummary" } } }, "commonv2Address": { "type": "object", "properties": { "address1": { "type": "string", "example": "Flat B", "description": "The first line of the address" }, "address2": { "type": "string", "example": "10 Mayo Road", "description": "The second line of the address" }, "city": { "type": "string", "example": "London", "description": "The city of the address" }, "state": { "type": "string", "example": "Greater London", "description": "The state of the address" }, "postCode": { "type": "string", "example": "W1 1AA", "description": "The postal code of the address" }, "country": { "type": "string", "example": "United Kingdom", "description": "The country of the address" } }, "required": [ "address1", "city", "state", "postCode", "country" ] }, "commonv2Asset": { "type": "object", "properties": { "id": { "type": "string", "example": "5:0xbehbehfb:USDC", "description": "ID is unique across all blockchains and created by combining the blockchain ID, contract address, and symbol" }, "standard": { "$ref": "#/components/schemas/v2Standard" }, "symbol": { "type": "string", "example": "LINK", "description": "The currency symbol of the asset" }, "name": { "type": "string", "example": "Chainlink", "description": "The human readable name of the asset" }, "blockchain": { "$ref": "#/components/schemas/v2Blockchain" }, "decimals": { "type": "integer", "format": "int32", "example": 18, "description": "Count of decimal places for the asset" }, "vetted": { "type": "boolean", "example": true, "description": "Whether the asset is vetted on the regulated platform" }, "enabled": { "type": "boolean", "example": true, "description": "Whether the asset is currently enabled on the platform" }, "contract": { "type": "string", "example": "0x0b9d5D9136855f6FEc3c0993feE6E9CE8a297846e", "description": "The token contract address. This field will be empty if the asset is the native coin of the blockchain" }, "createdAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the asset was created" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the asset was last updated" }, "organizationId": { "type": "string", "description": "Organization ID for custom assets" }, "coingeckoId": { "type": "string", "example": "ethereum", "description": "CoinGecko identifier for price data (optional for testnet assets)" }, "source": { "$ref": "#/components/schemas/v2AssetSource" }, "sourceMetadata": { "$ref": "#/components/schemas/protobufAny" }, "lastSyncedAt": { "type": "string", "format": "date-time", "example": "2024-08-08T10:22:22.420Z", "description": "When this asset was last synchronized" }, "syncVersion": { "type": "integer", "format": "int32", "example": 1, "description": "Version counter for sync updates" }, "contractAddressChecksummed": { "type": "string", "example": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "description": "Checksummed version of the contract address" } }, "required": [ "id", "standard", "symbol", "blockchain", "createdAt" ] }, "counterpartyv2Address": { "type": "object", "properties": { "addressId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The address ID" }, "counterpartyId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The counterparty ID" }, "organizationId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The organization ID" }, "createdBy": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The ID of the user who created this address" }, "createdAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the address was created" }, "updatedBy": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The ID of the user who updated this address" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the address was updated" }, "custodian": { "$ref": "#/components/schemas/v2Custodian" }, "termsAndConditionsAccepted": { "type": "boolean", "example": true, "description": "Whether the user has accepted the terms and conditions" }, "details": { "$ref": "#/components/schemas/v2AddressDetails" }, "status": { "$ref": "#/components/schemas/v2AddressStatus" }, "active": { "type": "boolean", "example": true, "description": "Whether the address is active" } }, "required": [ "addressId", "counterpartyId", "organizationId", "createdBy", "createdAt", "updatedBy", "updatedAt", "termsAndConditionsAccepted", "details", "status", "active" ] }, "counterpartyv2AddressType": { "type": "string", "enum": [ "EXTERNAL" ] }, "counterpartyv2Organization": { "type": "object", "properties": { "legalName": { "type": "string", "example": "Palisade Financial", "description": "The full legal name of the organization" }, "address": { "$ref": "#/components/schemas/commonv2Address" } }, "required": [ "legalName" ] }, "devicev2ApprovalStatus": { "type": "string", "enum": [ "PENDING", "APPROVED", "REJECTED" ] }, "identityv1Approval": { "type": "object", "properties": { "id": { "type": "string" }, "approvalSetId": { "type": "string" }, "userId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "signature": { "type": "string", "format": "byte" }, "reasons": { "type": "array", "items": { "type": "string" } }, "status": { "$ref": "#/components/schemas/identityv1ApprovalStatus" } } }, "identityv1ApprovalSetStatus": { "type": "string", "enum": [ "PENDING", "MET", "NOT_MET", "EXPIRED", "FAILED" ] }, "identityv1ApprovalStatus": { "type": "string", "enum": [ "PROCESSING", "APPROVED", "REJECTED" ] }, "identityv1ApprovalSummary": { "type": "object", "properties": { "approval": { "$ref": "#/components/schemas/identityv1Approval" }, "summary": { "$ref": "#/components/schemas/identityv1Summary" } } }, "identityv1GetApprovalSummaryResponse": { "type": "object", "properties": { "approvalSummary": { "$ref": "#/components/schemas/identityv1ApprovalSummary" } } }, "identityv1GetTransactionResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/identityv1Transaction" } } }, "identityv1GetWalletResponse": { "type": "object", "properties": { "wallet": { "$ref": "#/components/schemas/identityv1Wallet" } } }, "identityv1ListApprovalSummariesResponse": { "type": "object", "properties": { "approvalSummaries": { "type": "array", "items": { "$ref": "#/components/schemas/identityv1ApprovalSummary" } } } }, "identityv1Summary": { "type": "object", "properties": { "sourceId": { "type": "string" }, "sourceType": { "$ref": "#/components/schemas/v1SummarySourceType" }, "sourceRaw": { "type": "string", "format": "byte" }, "expiresAt": { "type": "string", "format": "date-time" }, "metAt": { "type": "string", "format": "date-time" }, "currentApprovedCount": { "type": "integer", "format": "int32" }, "requiredApproverCount": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/identityv1ApprovalSetStatus" } } }, "identityv1Transaction": { "type": "object", "properties": { "id": { "type": "string" }, "attributes": { "type": "object", "additionalProperties": { "type": "string" } }, "status": { "$ref": "#/components/schemas/identityv1TransactionStatus" }, "action": { "$ref": "#/components/schemas/identityv1TransactionAction" }, "encodedTransaction": { "type": "string" }, "signature": { "type": "string" }, "canonicalSignature": { "type": "string" }, "signedTransaction": { "type": "string" }, "signOnly": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } } }, "identityv1TransactionAction": { "type": "string", "enum": [ "PASSKEY_RAW", "PASSKEY_SIGN" ] }, "identityv1TransactionStatus": { "type": "string", "enum": [ "TRANSACTION_CREATED", "TRANSACTION_APPROVED", "TRANSACTION_SIGNED", "TRANSACTION_PUBLISHED", "TRANSACTION_CONFIRMED", "TRANSACTION_FAILED" ] }, "identityv1UpdateApprovalResponse": { "type": "object", "properties": { "approvalSummary": { "$ref": "#/components/schemas/identityv1ApprovalSummary" } } }, "identityv1Wallet": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "$ref": "#/components/schemas/identityv1WalletStatus" }, "blockchain": { "$ref": "#/components/schemas/v2Blockchain" }, "address": { "type": "string" }, "publicKey": { "type": "string" } } }, "identityv1WalletStatus": { "type": "string", "enum": [ "CREATED", "PROVISIONING", "PROVISIONED", "PROVISIONING_FAILED" ] }, "protobufAny": { "type": "object", "properties": { "@type": { "type": "string" } }, "additionalProperties": {} }, "protobufNullValue": { "type": "string" }, "rpcStatus": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/protobufAny" } } } }, "transactionsv2AMMDepositFlag": { "type": "string", "enum": [ "DEPOSIT_LP_TOKEN", "DEPOSIT_SINGLE_ASSET", "DEPOSIT_TWO_ASSET", "DEPOSIT_ONE_ASSET_LP_TOKEN", "DEPOSIT_LIMIT_LP_TOKEN", "DEPOSIT_TWO_ASSET_IF_EMPTY" ] }, "transactionsv2AMMWithdrawFlag": { "type": "string", "enum": [ "WITHDRAW_LP_TOKEN", "WITHDRAW_WITHDRAW_ALL", "WITHDRAW_ONE_ASSET_WITHDRAW_ALL", "WITHDRAW_SINGLE_ASSET", "WITHDRAW_TWO_ASSET", "WITHDRAW_ONE_ASSET_LP_TOKEN", "WITHDRAW_LIMIT_LP_TOKEN" ] }, "transactionsv2AccountSetFlag": { "type": "string", "enum": [ "ACCOUNT_TXN_ID", "ALLOW_TRUSTLINE_CLAWBACK", "AUTHZ_NFTOKEN_MINTER", "DEFAULT_RIPPLE", "DEPOSIT_AUTH", "DISABLE_MASTER", "DISALLOW_INCOMING_CHECK", "DISALLOW_INCOMING_PAY_CHAN", "DISALLOW_INCOMING_TRUSTLINE", "DISALLOW_XRP", "GLOBAL_FREEZE", "NO_FREEZE", "REQUIRE_AUTH", "REQUIRE_DEST" ] }, "transactionsv2Address": { "type": "object", "properties": { "id": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "Either addressID or walletID, or allowAddressID, or not set when the address does not exist within palisade e.g. a deposit from outside of Palisade" }, "organizationId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The organization ID" }, "counterpartyId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The counterparty ID" }, "vaultId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The vault ID" }, "type": { "$ref": "#/components/schemas/transactionsv2AddressType" }, "address": { "type": "string", "example": "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4", "description": "The address" } }, "required": [ "type", "address" ] }, "transactionsv2AddressType": { "type": "string", "enum": [ "COUNTERPARTY", "WALLET", "EXTERNAL", "ALLOW_ADDRESS" ] }, "transactionsv2Asset": { "type": "object", "properties": { "asset": { "type": "string", "example": "USD", "description": "The asset symbol" }, "issuer": { "type": "string", "example": "0xdAC17F958D2ee523a2206206994597C13D831ec7", "description": "The contract/issuing address. Optional if asset is XRP." } }, "required": [ "asset" ] }, "transactionsv2CurrencyAmount": { "type": "object", "properties": { "value": { "type": "string", "example": "155.672", "description": "The quantity of the asset" }, "asset": { "type": "string", "example": "USD", "description": "The asset symbol" }, "issuer": { "type": "string", "example": "0xdAC17F958D2ee523a2206206994597C13D831ec7", "description": "The contract/issuing address. Optional if asset is XRP." } }, "required": [ "value", "asset" ] }, "transactionsv2GetTransactionResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "transactionsv2OfferCreateFlags": { "type": "string", "enum": [ "PASSIVE", "IMMEDIATE_OR_CANCEL", "FILL_OR_KILL", "SELL" ] }, "transactionsv2SignerEntry": { "type": "object", "properties": { "account": { "type": "string", "example": "rGgKM3hTn8MBMGgiiPMbz73VEkSBocqab6", "description": "Wallet address of the signer. The wallet does not need to exist." }, "signerWeight": { "type": "integer", "format": "int64", "example": 2, "description": "Weight of the signature produced by this signer." } }, "required": [ "account", "signerWeight" ] }, "transactionsv2Transaction": { "type": "object", "properties": { "id": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The transaction ID" }, "walletId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The wallet ID" }, "vaultId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The vault ID" }, "organizationId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The organization ID" }, "createdBy": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The ID of the user that created the transaction" }, "createdAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the transaction was created" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the transaction was updated" }, "attributes": { "type": "object", "additionalProperties": { "type": "string" } }, "status": { "$ref": "#/components/schemas/transactionsv2TransactionStatus" }, "action": { "$ref": "#/components/schemas/transactionsv2TransactionAction" }, "externalId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "External ID of this transaction, unique to the organization" }, "correlationId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The correlation ID of the transaction, used to link related transactions" }, "asset": { "$ref": "#/components/schemas/commonv2Asset" }, "feeAsset": { "$ref": "#/components/schemas/commonv2Asset" }, "blockchain": { "$ref": "#/components/schemas/v2Blockchain" }, "destinationAddress": { "type": "string", "example": "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4", "description": "The destination address" }, "destination": { "$ref": "#/components/schemas/transactionsv2Address" }, "originAddress": { "type": "string", "example": "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4", "description": "The origin address" }, "origin": { "$ref": "#/components/schemas/transactionsv2Address" }, "qty": { "type": "string", "example": "155.672", "description": "The quantity of the asset to transfer" }, "feeQtyLimit": { "type": "string", "example": "155.672", "description": "The maximum network fee to pay for this transaction in base asset units (eg ETH for Ethereum)" }, "sequence": { "type": "string", "format": "uint64", "example": "2", "description": "The blockchain nonce/sequence to use" }, "encodedTransaction": { "type": "string", "example": "ed408505d21dba00825208942352d20fc81225c8ecd8f6faa1b37f24fed450c98089736f6d657468696e67808080", "description": "The encoded transaction. Maximum size is 200KB." }, "signOnly": { "type": "boolean", "example": "true", "description": "Whether to only sign the transaction, or also publish it to the blockchain" }, "config": { "$ref": "#/components/schemas/v2XRPTransactionConfig" }, "freezeInfo": { "$ref": "#/components/schemas/v2FreezeInfo" }, "feeQty": { "type": "string", "example": "155.672", "description": "The actual network fee for this transaction in base asset units (eg ETH for Ethereum)" }, "hash": { "type": "string", "example": "0x30674cddb3025f9681839c63d20357f54e914bd7a9ddfe53a6691f4a530a5671", "description": "The transaction hash" }, "signingHash": { "type": "string", "example": "30674cddb3025f9681839c63d20357f54e914bd7a9ddfe53a6691f4a530a5671", "description": "The transaction signing hash" }, "signature": { "type": "string", "example": "3046022100c60dc1337d69261e7c7e92e4dac78e0c317d444d4690be2b86cc53b1989d1b0602210090c63e3a5cf692c9387292451fada038a0e4d85a2f5c91ee1e7a635df0440b43", "description": "The transaction signature" }, "transactionType": { "type": "string", "example": "Payment", "description": "The transaction type" }, "reasons": { "type": "array", "example": [ "unfunded" ], "items": { "type": "string" }, "description": "The reasons for transaction failure" }, "canonicalSignature": { "type": "string", "example": "3045022100C60DC1337D69261E7C7E92E4DAC78E0C317D444D4690BE2B86CC53B1989D1B0602206F39C1C5A3096D36C78D6DBAE0525FC619CA048C7FEC0E4DA157FB2EDFF235FE", "description": "The canonical transaction signature" }, "signedTransaction": { "type": "string", "example": "12000024002A8F37201B002A8F5561400000000098968068400000000000000A732103E0C61B861ADE7AC58D27D65ABCEF4C22FA874DD13D809E02A99609A8CA31892C74473045022100C60DC1337D69261E7C7E92E4DAC78E0C317D444D4690BE2B86CC53B1989D1B0602206F39C1C5A3096D36C78D6DBAE0525FC619CA048C7FEC0E4DA157FB2EDFF235FE8114EC8E7F9FF5C9B157D55890956376D15740FAE943831451FE87A95FA6CAC3EBEF33387DE8225F7D0352CB", "description": "The signed transaction (multi-sign is not supported). Maximum size is 200KB." }, "proposedAssetChanges": { "type": "array", "items": { "$ref": "#/components/schemas/v2AssetChange" }, "description": "Proposed asset changes" }, "confirmedAssetChanges": { "type": "array", "items": { "$ref": "#/components/schemas/v2AssetChange" }, "description": "Confirmed asset changes" }, "signingPayloads": { "type": "array", "items": { "$ref": "#/components/schemas/v2SigningPayload" }, "description": "Multiple signing payloads for UTXO-based transactions, one per input" } }, "required": [ "id", "walletId", "vaultId", "organizationId", "createdBy", "createdAt", "updatedAt", "status", "action", "asset", "feeAsset", "blockchain", "originAddress", "origin", "qty", "signOnly", "freezeInfo" ] }, "transactionsv2TransactionAction": { "type": "string", "enum": [ "DEPOSIT", "WITHDRAWAL", "WEB3_RAW", "WEB3_SIGN", "PASSKEY_RAW", "PASSKEY_SIGN", "PALISADE_TRANSFER", "PALISADE_RAW", "PALISADE_MANAGED", "PALISADE_SIGN_PLAINTEXT", "PALISADE_SWEEP" ] }, "transactionsv2TransactionStatus": { "type": "string", "enum": [ "REQUESTED", "POLICY_CHECK_PENDING", "POLICY_CHECK_PASSED", "APPROVAL_CHECK_PENDING", "APPROVAL_CHECK_PASSED", "COMPILATION_PENDING", "COMPILED", "SIGNATURE_PENDING", "SIGNED", "PUBLISH_PENDING", "PUBLISHED", "CONFIRMATION_PENDING", "CONFIRMED", "REJECTED", "FAILED" ] }, "transactionsv2TrustSetFlag": { "type": "string", "enum": [ "SETF_AUTH", "SET_NORIPPLE", "UNSET_NORIPPLE", "SET_FREEZE", "UNSET_FREEZE", "SET_DEEP_FREEZE", "UNSET_DEEP_FREEZE" ] }, "v1DAppConfig": { "type": "object", "properties": { "appId": { "type": "string" }, "clientId": { "type": "string" }, "name": { "type": "string" }, "displayName": { "type": "string" }, "origins": { "type": "array", "items": { "type": "string" } } } }, "v1GetDAppConfigResponse": { "type": "object", "properties": { "dappConfig": { "$ref": "#/components/schemas/v1DAppConfig" } } }, "v1GetIdentityResponse": { "type": "object", "properties": { "identity": { "$ref": "#/components/schemas/v1Identity" } } }, "v1GetOrProvisionIdentityResponse": { "type": "object", "properties": { "identity": { "$ref": "#/components/schemas/v1Identity" } } }, "v1GetOrProvisionWalletResponse": { "type": "object", "properties": { "wallet": { "$ref": "#/components/schemas/identityv1Wallet" } } }, "v1Identity": { "type": "object", "properties": { "userId": { "type": "string" }, "publicKey": { "type": "string", "format": "byte" }, "credentialId": { "type": "string", "format": "byte" }, "credential": { "type": "string", "format": "byte" }, "walletId": { "type": "string" } } }, "v1ListIdentitiesResponse": { "type": "object", "properties": { "identities": { "type": "array", "items": { "$ref": "#/components/schemas/v1Identity" } } } }, "v1ProvisionIdentityResponse": { "type": "object", "properties": { "identity": { "$ref": "#/components/schemas/v1Identity" } } }, "v1SubmitTransactionResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/identityv1Transaction" } } }, "v1SummarySourceType": { "type": "string", "enum": [ "TRANSACTION", "DEVICE" ] }, "v1ValidateDAppConfigResponse": { "type": "object" }, "v2AcceptConnectionResponse": { "type": "object", "properties": { "connection": { "$ref": "#/components/schemas/v2Connection" } } }, "v2Action": { "type": "string", "enum": [ "CREATE", "READ", "UPDATE", "DELETE", "ENABLE", "DISABLE" ] }, "v2AddDeviceMetadataRequest": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "v2AddDeviceMetadataResponse": { "type": "object" }, "v2AddVaultTagResponse": { "type": "object", "properties": { "tags": { "type": "array", "items": { "$ref": "#/components/schemas/v2VaultTag" } } } }, "v2AddWalletTagResponse": { "type": "object", "properties": { "tags": { "type": "array", "items": { "$ref": "#/components/schemas/v2WalletTag" } } } }, "v2AddressDetails": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/counterpartyv2AddressType" }, "externalAddress": { "$ref": "#/components/schemas/v2ExternalAddress" } }, "required": [ "type" ] }, "v2AddressStatus": { "type": "string", "enum": [ "CREATED", "ENABLED", "REJECTED", "DELETED", "ERROR", "COMPLIANCE_PENDING", "COMPLIANCE_COMPLETE", "CREATION_APPROVAL_PENDING", "CREATION_APPROVAL_COMPLETE", "DELETION_APPROVAL_PENDING", "DELETION_APPROVAL_COMPLETE" ] }, "v2AddressUpdate": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/counterpartyv2Address" } } }, "v2AddressUpdatedResponse": { "type": "object", "properties": { "update": { "$ref": "#/components/schemas/v2AddressUpdate" } } }, "v2Alert": { "type": "object", "properties": { "title": { "type": "string" }, "body": { "type": "string" } } }, "v2ApprovalGroup": { "type": "object", "properties": { "approvers": { "type": "array", "example": [ "ce4918bf-a199-4ce2-85a3-d0d296855384", "ce4918bf-a199-4ce2-85a3-d0d296855384" ], "items": { "type": "string" }, "description": "A list of users in the approval group" }, "requiredApproverCount": { "type": "integer", "format": "int32", "example": 1, "description": "The required approver count" }, "sourceType": { "$ref": "#/components/schemas/v2SourceType" }, "timeoutDuration": { "type": "string", "example": "3600s", "description": "Approval timeout duration. Defaults to 1 hour (3600s) if not specified. Minimum 5 minutes, maximum 24 hours." } }, "required": [ "approvers", "requiredApproverCount", "sourceType" ] }, "v2ApprovalSummaryStatusUpdate": { "type": "object", "properties": { "approvalSummary": { "$ref": "#/components/schemas/approvalv2ApprovalSummary" } } }, "v2ApprovalSummaryUpdatedResponse": { "type": "object", "properties": { "update": { "$ref": "#/components/schemas/v2ApprovalSummaryStatusUpdate" } } }, "v2AssetChange": { "type": "object", "properties": { "purpose": { "$ref": "#/components/schemas/v2AssetChangePurpose" }, "asset": { "$ref": "#/components/schemas/commonv2Asset" }, "qty": { "type": "string", "example": "155.672", "description": "The quantity of the asset to transfer" }, "source": { "$ref": "#/components/schemas/v2AssetChangeWallet" }, "destination": { "$ref": "#/components/schemas/v2AssetChangeWallet" } }, "required": [ "purpose", "asset", "qty" ] }, "v2AssetChangePurpose": { "type": "string", "enum": [ "FEE", "TRANSFER" ] }, "v2AssetChangeWallet": { "type": "object", "properties": { "address": { "type": "string", "example": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045", "description": "The blockchain address of the wallet" }, "walletId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The wallet ID that is part of this change, populated only if it belongs to the same organization that is party to the transaction" }, "subAccountAddress": { "type": "string", "example": "CaVHtunHxQfGYVKJ4WzUe1217UTCrREh3hg2RW8cS2Gk", "description": "The Rosetta SubAccount address (e.g., SPL token account address for Solana, contract-specific state address for other chains). This represents the actual on-chain address where the asset resides, while 'address' contains the owner wallet address." } }, "required": [ "address" ] }, "v2AssetFilter": { "type": "object", "properties": { "blockchain": { "$ref": "#/components/schemas/v2IntFilter" }, "enabled": { "$ref": "#/components/schemas/v2BoolFilter" }, "isVetted": { "$ref": "#/components/schemas/v2BoolFilter" }, "standard": { "$ref": "#/components/schemas/v2IntFilter" }, "organizationId": { "$ref": "#/components/schemas/v2StringFilter" }, "symbol": { "$ref": "#/components/schemas/v2StringFilter" }, "name": { "$ref": "#/components/schemas/v2StringFilter" }, "contractAddress": { "$ref": "#/components/schemas/v2StringFilter" }, "source": { "$ref": "#/components/schemas/v2StringFilter" }, "lastSyncedAt": { "$ref": "#/components/schemas/v2TimestampFilter" }, "hasChecksum": { "$ref": "#/components/schemas/v2BoolFilter" } } }, "v2AssetSource": { "type": "string", "enum": [ "ASSET_SOURCE_LEGACY", "ASSET_SOURCE_AUTO", "ASSET_SOURCE_COINGECKO", "ASSET_SOURCE_PALISADE", "ASSET_SOURCE_CUSTOMER" ] }, "v2BackupStrategy": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the backup strategy (UUID v7)" }, "orgId": { "type": "string", "description": "Organization ID this backup strategy belongs to" }, "name": { "type": "string", "description": "Name of the backup strategy (2-64 characters)" }, "recoveryPublicKeys": { "type": "array", "items": { "$ref": "#/components/schemas/v2RecoveryPublicKey" }, "description": "List of backup keys - DER formatted, hex encoded RSA public keys (min 4096 bits)" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp" }, "createdBy": { "type": "string", "description": "User who created the backup strategy" }, "s3Config": { "$ref": "#/components/schemas/v2S3Config" } } }, "v2Balance": { "type": "object", "properties": { "asset": { "$ref": "#/components/schemas/commonv2Asset" }, "balance": { "type": "string", "example": "200.00", "description": "The total balance of the asset on the blockchain. When breakdown fields are present, this equals available_balance + pending_balance + frozen_balance" }, "rate": { "type": "string", "example": "0.50", "description": "The exchange rate between the asset and 'currencyCode'" }, "fiatValue": { "type": "string", "example": "100.00", "description": "The aggregated fiat value of an asset for a wallet" }, "availableBalance": { "type": "string", "example": "150.00", "description": "The available balance that can be spent" }, "pendingBalance": { "type": "string", "example": "30.00", "description": "The balance tied up in pending transactions" }, "frozenBalance": { "type": "string", "example": "20.00", "description": "The balance frozen by policy actions" } } }, "v2BalanceUpdate": { "type": "object", "properties": { "organizationId": { "type": "string" }, "vaultId": { "type": "string" }, "walletId": { "type": "string" }, "currencyCode": { "type": "string" }, "aggregatedFiatValue": { "type": "string" }, "assetBalances": { "type": "array", "items": { "$ref": "#/components/schemas/v2Balance" } }, "walletBalances": { "type": "array", "items": { "$ref": "#/components/schemas/v2WalletBalance" } }, "vaultBalances": { "type": "array", "items": { "$ref": "#/components/schemas/v2VaultBalance" } } } }, "v2BalanceUpdatedResponse": { "type": "object", "properties": { "update": { "$ref": "#/components/schemas/v2BalanceUpdate" } } }, "v2Blockchain": { "type": "string", "enum": [ "AVALANCHE", "ETHEREUM", "XRP_LEDGER", "POLYGON", "BNBCHAIN", "BASE", "HEDERA", "ARBITRUM", "ONE_MONEY", "SOLANA", "TRON", "BITCOIN" ] }, "v2BlockchainFilter": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/v2IntFilter" }, "name": { "$ref": "#/components/schemas/v2StringFilter" }, "chainId": { "$ref": "#/components/schemas/v2StringFilter" }, "checksumType": { "$ref": "#/components/schemas/v2IntFilter" }, "chain": { "$ref": "#/components/schemas/v2StringFilter" } } }, "v2BlockchainInfo": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/v2Blockchain" }, "name": { "type": "string", "example": "Ethereum", "description": "Human-readable name of the blockchain" }, "namespace": { "type": "string", "example": "eip155", "description": "The CAIP-2 namespace identifier" }, "chainId": { "type": "string", "example": "1", "description": "The chain ID (supports large numbers)" }, "rpcEndpoints": { "type": "array", "items": { "$ref": "#/components/schemas/v2RPCEndpoint" }, "description": "RPC endpoints for blockchain connectivity" }, "supportedEvents": { "type": "array", "items": { "type": "string" }, "description": "WalletConnect event types supported by this blockchain" }, "supportedMethods": { "type": "array", "items": { "type": "string" }, "description": "WalletConnect methods supported by this blockchain" }, "keystoreTypes": { "type": "array", "items": { "$ref": "#/components/schemas/v2Keystore" }, "description": "Supported keystore types (HSM, MPC)" }, "keyAlgorithms": { "type": "array", "items": { "$ref": "#/components/schemas/v2KeyAlgorithm" }, "description": "Supported key algorithms" }, "routing": { "type": "string", "example": "ethereum", "description": "Message queue routing key base" }, "status": { "$ref": "#/components/schemas/v2BlockchainStatus" }, "supportsWalletConnect": { "type": "boolean", "description": "Whether this blockchain supports WalletConnect" }, "explorers": { "type": "array", "items": { "$ref": "#/components/schemas/v2Explorer" }, "description": "Blockchain explorers for viewing transactions and addresses" }, "createdAt": { "type": "string", "format": "date-time", "description": "When the blockchain was created", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "description": "When the blockchain was last updated", "readOnly": true }, "chain": { "type": "string", "example": "ethereum-mainnet", "description": "Chain identifier (e.g., 'ethereum-mainnet', 'ethereum-goerli')" }, "coingeckoPlatformId": { "type": "string", "example": "ethereum", "description": "CoinGecko platform identifier for sync (optional for testnets)" }, "checksumType": { "$ref": "#/components/schemas/v2ChecksumType" }, "blockTime": { "type": "integer", "format": "int32", "example": 12, "description": "Average block time in seconds" }, "confirmationBlocks": { "type": "integer", "format": "int32", "example": 6, "description": "Recommended number of confirmations for finality" } }, "required": [ "id", "name", "namespace", "chainId", "routing", "status" ] }, "v2BlockchainStatus": { "type": "string", "enum": [ "RPC_ENDPOINT_TYPE_ENABLED", "RPC_ENDPOINT_TYPE_DISABLED" ] }, "v2BoolFilter": { "type": "object", "properties": { "eq": { "type": "boolean", "description": "Equals" }, "isNull": { "type": "boolean", "description": "Check if field is null" } } }, "v2Category": { "type": "string", "enum": [ "CONTROLS", "WALLETS", "TRANSACTIONS", "AUDIT" ] }, "v2ChecksumType": { "type": "string", "enum": [ "CHECKSUM_TYPE_NONE", "CHECKSUM_TYPE_EIP55", "CHECKSUM_TYPE_BASE58CHECK", "CHECKSUM_TYPE_XRP" ] }, "v2ComplianceIntegration": { "type": "string", "enum": [ "COMPLY", "ELLIPTIC", "NOTABENE" ] }, "v2ConflictReport": { "type": "object", "properties": { "assetId": { "type": "string", "example": "usd-coin_ethereum", "description": "ID of the asset with conflict" }, "existingSource": { "type": "string", "example": "customer", "description": "Source of existing asset data" }, "newSource": { "type": "string", "example": "coingecko", "description": "Source of new asset data" }, "resolution": { "type": "string", "example": "skipped", "description": "How the conflict was resolved" }, "reason": { "type": "string", "example": "Customer entries have highest priority", "description": "Reason for the resolution" } } }, "v2Connection": { "type": "object", "properties": { "id": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The connection ID" }, "walletId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The wallet ID that the connection is associated with" }, "vaultId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The vault ID that the connection is associated with" }, "organizationId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The organization ID that the connection is associated with" }, "createdBy": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The user ID that the connection is associated with" }, "createdAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the connection was created" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the connection was updated" }, "status": { "$ref": "#/components/schemas/v2ConnectionStatus" }, "proposer": { "$ref": "#/components/schemas/v2Proposer" } }, "required": [ "id", "walletId", "vaultId", "organizationId", "createdBy", "createdAt", "updatedAt", "status" ] }, "v2ConnectionStatus": { "type": "string", "enum": [ "CREATED", "PROPOSING", "PROPOSED", "CONNECTED", "DISCONNECTED", "REJECTED", "UNSUPPORTED", "EXPIRED", "ERROR" ] }, "v2ConnectionStatusUpdate": { "type": "object", "properties": { "connection": { "$ref": "#/components/schemas/v2Connection" } } }, "v2ConnectionUpdatedResponse": { "type": "object", "properties": { "update": { "$ref": "#/components/schemas/v2ConnectionStatusUpdate" } } }, "v2Counterparty": { "type": "object", "properties": { "id": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The counterparty ID" }, "organizationId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The organization ID" }, "createdBy": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The ID of the user who created this counterparty" }, "createdAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the counterparty was created" }, "updatedBy": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The ID of the user who updated this counterparty" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the counterparty was updated" }, "name": { "type": "string", "example": "Palisade", "description": "The counterparty name" }, "description": { "type": "string", "example": "A counterparty used by the treasury department", "description": "The counterparty description" }, "details": { "$ref": "#/components/schemas/v2CounterpartyDetails" }, "addressCount": { "type": "integer", "format": "int32", "example": 5, "description": "The number of addresses associated with the counterparty" } }, "required": [ "id", "organizationId", "createdBy", "createdAt", "updatedBy", "updatedAt", "name", "details", "addressCount" ] }, "v2CounterpartyDetails": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/v2CounterpartyType" }, "individual": { "$ref": "#/components/schemas/v2Individual" }, "organization": { "$ref": "#/components/schemas/counterpartyv2Organization" }, "dApp": { "$ref": "#/components/schemas/v2DApp" } }, "required": [ "type" ] }, "v2CounterpartyType": { "type": "string", "enum": [ "ORGANIZATION", "INDIVIDUAL", "DAPP" ] }, "v2CreateAddressResponse": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/counterpartyv2Address" } } }, "v2CreateAssetRequest": { "type": "object", "properties": { "blockchainId": { "$ref": "#/components/schemas/v2Blockchain" }, "contractAddress": { "type": "string", "example": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", "description": "Contract address (empty for native assets)" }, "symbol": { "type": "string", "example": "USDC", "description": "Asset symbol" }, "name": { "type": "string", "example": "USD Coin", "description": "Asset name" }, "decimals": { "type": "integer", "format": "int32", "example": 6, "description": "Number of decimal places" }, "coingeckoId": { "type": "string", "example": "usd-coin", "description": "CoinGecko identifier for price data" }, "enabled": { "type": "boolean", "example": true, "description": "Whether the asset is enabled (default: true)" } }, "required": [ "blockchainId", "symbol" ] }, "v2CreateAssetResponse": { "type": "object", "properties": { "asset": { "$ref": "#/components/schemas/commonv2Asset" } } }, "v2CreateBackupStrategyRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the backup strategy (2-64 characters)" }, "recoveryPublicKeys": { "type": "array", "items": { "$ref": "#/components/schemas/v2CreateRecoveryPublicKeyRequest" }, "description": "List of backup keys - DER formatted, hex encoded RSA public keys (min 4096 bits)" }, "s3Config": { "$ref": "#/components/schemas/v2S3Config" } } }, "v2CreateBackupStrategyResponse": { "type": "object", "properties": { "strategy": { "$ref": "#/components/schemas/v2BackupStrategy" } } }, "v2CreateConnectionResponse": { "type": "object", "properties": { "connection": { "$ref": "#/components/schemas/v2Connection" } } }, "v2CreateCounterpartyRequest": { "type": "object", "properties": { "name": { "type": "string", "example": "Palisade", "description": "The counterparty name" }, "description": { "type": "string", "example": "A counterparty used by the treasury department", "description": "The counterparty description" }, "details": { "$ref": "#/components/schemas/v2CounterpartyDetails" } }, "required": [ "name", "details" ] }, "v2CreateCounterpartyResponse": { "type": "object", "properties": { "counterparty": { "$ref": "#/components/schemas/v2Counterparty" } } }, "v2CreateCredentialRequest": { "type": "object", "properties": { "name": { "type": "string", "example": "Treasury", "description": "A helpful name to help identify the credentials" }, "description": { "type": "string", "example": "Credentials that belong to trading desk #1", "description": "A helpful description to help identify the credentials" }, "category": { "$ref": "#/components/schemas/v2Category" }, "permissions": { "type": "array", "example": [ "vault:read:org:id=ce4918bf-a199-4ce2-85a3-d0d296855384:*" ], "items": { "type": "string" }, "description": "The permissions that the credential will have" }, "allowedIps": { "type": "array", "example": [ "88.9.2.1", "88.10.2.1/0" ], "items": { "type": "string" }, "description": "List of IP addresses (in IP address or CIDR notation) that the credential is allowed to use" } }, "required": [ "name", "category", "permissions" ] }, "v2CreateCredentialResponse": { "type": "object", "properties": { "credential": { "$ref": "#/components/schemas/v2Credential" } }, "required": [ "credential" ] }, "v2CreateDeviceRequest": { "type": "object", "properties": { "displayName": { "type": "string", "example": "Treasury vault", "description": "The name of the device" }, "deviceType": { "$ref": "#/components/schemas/v2DeviceType" } }, "required": [ "displayName", "deviceType" ] }, "v2CreateDeviceResponse": { "type": "object", "properties": { "device": { "$ref": "#/components/schemas/v2Device" } } }, "v2CreateOrProvisionPasskeyWalletResponse": { "type": "object", "properties": { "wallet": { "$ref": "#/components/schemas/vaultv2Wallet" } } }, "v2CreateQuorumRequest": { "type": "object", "properties": { "deviceIds": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "requiredSigners": { "type": "integer", "format": "int64" }, "description": { "type": "string" }, "quorumType": { "$ref": "#/components/schemas/v2QuorumType" }, "backupStrategyId": { "type": "string" } }, "required": [ "deviceIds", "name", "requiredSigners", "quorumType" ] }, "v2CreateQuorumResponse": { "type": "object", "properties": { "quorum": { "$ref": "#/components/schemas/v2Quorum" } } }, "v2CreateRecoveryPublicKeyRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the recovery public key" }, "publicKey": { "type": "string", "description": "The DER formatted RSA public key. Accepts both binary DER and hex-encoded formats (with optional 0x prefix). Will be normalized to hex for storage." } } }, "v2CreateSubscriptionsResponse": { "type": "object", "properties": { "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/v2Subscription" } } } }, "v2CreateSweepConfigurationRequest": { "type": "object", "properties": { "name": { "type": "string", "example": "Customer deposit sweep", "description": "The sweep configuration name" }, "description": { "type": "string", "example": "A sweep configuration used to sweep customer deposits", "description": "The sweep configuration description" }, "blockchain": { "$ref": "#/components/schemas/v2Blockchain" }, "feeWallet": { "$ref": "#/components/schemas/v2VaultWalletIdentifier" }, "destinationWallet": { "$ref": "#/components/schemas/v2VaultWalletIdentifier" }, "sweepFrequency": { "$ref": "#/components/schemas/v2SweepFrequency" }, "assets": { "type": "array", "items": { "$ref": "#/components/schemas/v2SweepAsset" }, "description": "The assets to sweep" } }, "required": [ "name", "blockchain", "feeWallet", "destinationWallet", "sweepFrequency", "assets" ] }, "v2CreateSweepConfigurationResponse": { "type": "object", "properties": { "sweepConfiguration": { "$ref": "#/components/schemas/v2SweepConfiguration" } }, "required": [ "sweepConfiguration" ] }, "v2CreateUserRequest": { "type": "object", "properties": { "firstName": { "type": "string", "example": "Joe", "description": "The users first name" }, "lastName": { "type": "string", "example": "Bloggs", "description": "The users last name" }, "email": { "type": "string", "example": "jbloggs@gmail.com", "description": "The users email" }, "roles": { "type": "array", "example": [ "ADMINISTRATOR" ], "items": { "$ref": "#/components/schemas/v2Role" }, "description": "The roles that the user has" } }, "required": [ "firstName", "lastName", "email", "roles" ] }, "v2CreateUserResponse": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/v2User" } } }, "v2CreateVaultRequest": { "type": "object", "properties": { "name": { "type": "string", "example": "Treasury vault", "description": "The name of the vault" }, "description": { "type": "string", "example": "A vault used by the treasury department", "description": "The description of the vault" }, "externalId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "External ID of this vault, unique to the organization" }, "correlationId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "Correlation ID for tracking correlating actions with this vault creation" } }, "required": [ "name" ] }, "v2CreateVaultResponse": { "type": "object", "properties": { "vault": { "$ref": "#/components/schemas/v2Vault" } } }, "v2CreateWalletLimitResponse": { "type": "object", "properties": { "walletLimit": { "$ref": "#/components/schemas/v2WalletLimit" } } }, "v2CreateWalletResponse": { "type": "object", "properties": { "wallet": { "$ref": "#/components/schemas/vaultv2Wallet" } } }, "v2CreateWebhookRequest": { "type": "object", "properties": { "name": { "type": "string", "example": "Palisade Transactions", "description": "The webhook name." }, "description": { "type": "string", "example": "A webhook used to monitor transactions", "description": "The webhook description." }, "endpoint": { "type": "string", "example": "https://palisade.co/webhook", "description": "The webhook endpoint to send data to" } }, "required": [ "name", "endpoint" ] }, "v2CreateWebhookResponse": { "type": "object", "properties": { "webhook": { "$ref": "#/components/schemas/v2Webhook" } } }, "v2Credential": { "type": "object", "properties": { "id": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The credential ID" }, "name": { "type": "string", "example": "Treasury", "description": "The credential name" }, "description": { "type": "string", "example": "Credentials that belong to trading desk #1", "description": "The credential description" }, "category": { "$ref": "#/components/schemas/v2Category" }, "permissions": { "type": "array", "example": [ "vault:read:org:id=ce4918bf-a199-4ce2-85a3-d0d296855384:*" ], "items": { "type": "string" }, "description": "The credential permissions" }, "createdBy": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The ID of the user who created the credential" }, "organizationId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The ID of the organization who created the credential" }, "createdAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the credential was created" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the credential was updated" }, "clientId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The credential client ID" }, "clientSecret": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The credential client secret" }, "active": { "type": "boolean", "example": true, "description": "The credential active status" }, "status": { "$ref": "#/components/schemas/v2CredentialStatus" }, "proposedPermissions": { "type": "array", "example": [ "vault:read:org:id=ce4918bf-a199-4ce2-85a3-d0d296855384:*" ], "items": { "type": "string" }, "description": "The proposed credential permissions" }, "allowedIps": { "type": "array", "example": [ "88.9.2.1", "88.10.2.1/0" ], "items": { "type": "string" }, "description": "List of IP addresses (in IP address or CIDR notation) that the credential is allowed to use" } }, "required": [ "id", "name", "category", "permissions", "createdBy", "organizationId", "createdAt", "updatedAt", "clientId", "active", "status", "proposedPermissions" ] }, "v2CredentialInfo": { "type": "object", "properties": { "id": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The credential ID" }, "organizationId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The ID of the organization who created the credential" }, "name": { "type": "string", "example": "Treasury", "description": "The credential name" } }, "required": [ "id", "organizationId", "name" ] }, "v2CredentialStatus": { "type": "string", "enum": [ "CREATED", "ENABLED", "DISABLED", "REJECTED", "DELETED", "ERROR", "CREATION_APPROVAL_PENDING", "CREATION_APPROVAL_COMPLETE", "DELETION_APPROVAL_PENDING", "DELETION_APPROVAL_COMPLETE", "ENABLE_APPROVAL_PENDING", "ENABLE_APPROVAL_COMPLETE", "DISABLE_APPROVAL_PENDING", "DISABLE_APPROVAL_COMPLETE", "MODIFICATION_APPROVAL_PENDING", "MODIFICATION_APPROVAL_COMPLETE" ] }, "v2CredentialUpdate": { "type": "object", "properties": { "credential": { "$ref": "#/components/schemas/v2Credential" } } }, "v2CredentialUpdatedResponse": { "type": "object", "properties": { "update": { "$ref": "#/components/schemas/v2CredentialUpdate" } } }, "v2Currency": { "type": "object", "properties": { "name": { "type": "string", "example": "United States Dollar", "description": "The human readable name of the currency" }, "code": { "type": "string", "example": "USD", "description": "The unique currency code" }, "symbol": { "type": "string", "example": "$", "description": "The currency symbol" }, "decimals": { "type": "integer", "format": "int32", "example": 2, "description": "The number of decimal places for the currency", "readOnly": true }, "enabled": { "type": "boolean", "example": true, "description": "Whether the currency is enabled for use", "readOnly": true } }, "required": [ "name", "code", "symbol" ] }, "v2CurrencyFilter": { "type": "object", "properties": { "enabled": { "$ref": "#/components/schemas/v2BoolFilter" }, "name": { "$ref": "#/components/schemas/v2StringFilter" }, "code": { "$ref": "#/components/schemas/v2StringFilter" }, "symbol": { "$ref": "#/components/schemas/v2StringFilter" } } }, "v2Custodian": { "type": "object", "properties": { "name": { "type": "string", "example": "Palisade Financial", "description": "The Virtual Asset Service Provider's name" }, "dId": { "type": "string", "example": "did:example:123456789abcdefghi", "description": "The Virtual Asset Service Provider's Decentralized Identifier" } }, "required": [ "name", "dId" ] }, "v2DApp": { "type": "object" }, "v2DeleteAddressResponse": { "type": "object" }, "v2DeleteCounterpartyResponse": { "type": "object" }, "v2DeleteCredentialResponse": { "type": "object" }, "v2DeleteDeviceResponse": { "type": "object", "properties": { "device": { "$ref": "#/components/schemas/v2Device" } } }, "v2DeleteOrganizationAuthMethodResponse": { "type": "object" }, "v2DeleteQuorumResponse": { "type": "object", "properties": { "quorum": { "$ref": "#/components/schemas/v2Quorum" } } }, "v2DeleteSubscriptionResponse": { "type": "object" }, "v2DeleteSweepConfigurationResponse": { "type": "object" }, "v2DeleteUserAuthMethodsResponse": { "type": "object" }, "v2DeleteUserResponse": { "type": "object" }, "v2DeleteVaultTagResponse": { "type": "object" }, "v2DeleteWalletLimitResponse": { "type": "object" }, "v2DeleteWalletResponse": { "type": "object" }, "v2DeleteWalletTagResponse": { "type": "object" }, "v2DeleteWebhookResponse": { "type": "object" }, "v2Destination": { "type": "object", "properties": { "id": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The destination ID" }, "matcherType": { "$ref": "#/components/schemas/v2MatcherType" } }, "required": [ "id", "matcherType" ] }, "v2Device": { "type": "object", "properties": { "id": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The device ID" }, "organizationId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The organization ID" }, "createdBy": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The user ID that created the device" }, "createdAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the device was created" }, "pairedAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the device was paired" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the device was updated" }, "clientId": { "type": "string", "example": "muDigc2N34HnKJh28l9pK6d0lBOFAe", "description": "The client ID" }, "displayName": { "type": "string", "example": "Treasury vault", "description": "The name of the device" }, "approvalStatus": { "$ref": "#/components/schemas/devicev2ApprovalStatus" }, "enabledStatus": { "$ref": "#/components/schemas/v2EnabledStatus" }, "publicKeyHash": { "type": "string", "example": "muDigc2N34HnKJh28l9pK6d0lBOFAe", "description": "The hash of the devices public key" }, "deleted": { "type": "boolean", "example": "false", "description": "Whether the device has been deleted" }, "deviceType": { "$ref": "#/components/schemas/v2DeviceType" }, "playerId": { "type": "integer", "format": "int64", "example": 123456, "description": "The player ID" }, "version": { "type": "string", "example": "1.0.0", "description": "The version of the device" } }, "required": [ "id", "organizationId", "createdBy", "createdAt", "pairedAt", "updatedAt", "displayName", "approvalStatus", "enabledStatus", "publicKeyHash", "deleted", "deviceType" ] }, "v2DeviceOwner": { "type": "string", "enum": [ "THIS_ORGANIZATION", "TRUSTED_ORGANIZATION" ] }, "v2DeviceType": { "type": "string", "enum": [ "MOBILE", "CLOUD" ] }, "v2DeviceUpdate": { "type": "object", "properties": { "device": { "$ref": "#/components/schemas/v2Device" } } }, "v2DeviceUpdatedResponse": { "type": "object", "properties": { "update": { "$ref": "#/components/schemas/v2DeviceUpdate" } } }, "v2DisableSweepConfigurationResponse": { "type": "object", "properties": { "sweepConfiguration": { "$ref": "#/components/schemas/v2SweepConfiguration" } }, "required": [ "sweepConfiguration" ] }, "v2DisconnectConnectionResponse": { "type": "object", "properties": { "connection": { "$ref": "#/components/schemas/v2Connection" } } }, "v2EligibleApprover": { "type": "object", "properties": { "userId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The user ID" }, "deviceIds": { "type": "array", "example": [ "ce4918bf-a199-4ce2-85a3-d0d296855384", "ce4918bf-a199-4ce2-85a3-d0d296855384" ], "items": { "type": "string" }, "description": "The device IDs" } }, "required": [ "userId", "deviceIds" ] }, "v2EligibleDevice": { "type": "object", "properties": { "deviceId": { "type": "string" }, "userId": { "type": "string" } }, "required": [ "deviceId", "userId" ] }, "v2EnableSweepConfigurationResponse": { "type": "object", "properties": { "sweepConfiguration": { "$ref": "#/components/schemas/v2SweepConfiguration" } }, "required": [ "sweepConfiguration" ] }, "v2EnabledStatus": { "type": "string", "enum": [ "ENABLED_STATUS_PENDING", "ENABLED", "DISABLED" ] }, "v2EstimateTransferFeeRequest": { "type": "object", "properties": { "blockchain": { "$ref": "#/components/schemas/v2Blockchain" }, "contract": { "type": "string", "example": "0xdAC17F958D2ee523a2206206994597C13D831ec7", "description": "The contract/issuing address" }, "symbol": { "type": "string", "example": "USD", "description": "The asset symbol" }, "originAddress": { "type": "string", "example": "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4", "description": "The origin address" }, "destinationAddress": { "type": "string", "example": "TLsV52sRDL79HXGGm9yzwKibb6BeruhUzy", "description": "Optional destination address. When provided, allows for more accurate fee estimation on chains where transfer costs vary based on recipient state (e.g., TRON, Solana)." } }, "required": [ "blockchain", "symbol", "originAddress" ] }, "v2EstimateTransferFeeResponse": { "type": "object", "properties": { "feeEstimate": { "$ref": "#/components/schemas/v2FeeEstimate" } } }, "v2Event": { "type": "object", "properties": { "trigger": { "type": "string" }, "id": { "type": "string" } } }, "v2EvmFeeEstimate": { "type": "object", "properties": { "gasPrice": { "type": "string", "format": "uint64", "example": "155", "description": "Gas price in wei (base_fee + priority_fee)" }, "baseFee": { "type": "string", "format": "uint64", "example": "155", "description": "Base Fee in wei" }, "priorityFee": { "type": "string", "format": "uint64", "example": "155", "description": "Average priority Fee in wei" }, "gasLimit": { "type": "string", "format": "uint64", "example": "21000", "description": "Gas limit" } }, "required": [ "gasPrice", "baseFee", "priorityFee", "gasLimit" ] }, "v2ExchangeCredentialRequest": { "type": "object", "properties": { "clientId": { "type": "string", "example": "jhYMYU4opaGhdsXuebOwQXqV0pZcGuph", "description": "The client ID" }, "clientSecret": { "type": "string", "example": "zjI4XChsnwMh8wvKQG2tVBLUI4k9JittZQGerUfHv0CiqZZ_5MofAfRQ15pnKY-B", "description": "The client ID" } }, "required": [ "clientId", "clientSecret" ] }, "v2ExchangeCredentialResponse": { "type": "object", "properties": { "accessToken": { "type": "string", "example": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImxBMmpQWDd5NWZTR0tMWDFtMkpucyJ9.eyJodHRwczovL3BhbGlzYWRlLmNvIjp7ImRldmljZUlkIjpudWxsLCJvcmdhbml6YXRpb25JZCI6ImNlNDkxOGJmLWExOTktNGNlMi04NWEzLWQwZDI5Njg1NTM4NCIsInNpZ25hdHVyZVZlcmlmaWNhdGlvbktleSI6bnVsbCwidXNlcklkIjoiYTdkNzI2YTUtZjZlMC00ZmE2LWJiOGUtM2Q5OTNhZjY0MzUxIn0sImlzcyI6Imh0dHBzOi8vcGFsaXNhZGUtZGV2ZWxvcG1lbnQuZXUuYXV0aDAuY29tLyIsInN1YiI6IlVNbWZ5RWNPcnN3Szl4ODJvQWw0ZnpLRjlCTmRheW5KQGNsaWVudHMiLCJhdWQiOiJodHRwczovL2FwaS5wYWxpc2FkZS5jby8iLCJpYXQiOjE3MDQ5ODg0NDQsImV4cCI6MTcwNDk5MjA0NCwiYXpwIjoiVU1tZnlFY09yc3dLOXg4Mm9BbDRmektGOUJOZGF5bkoiLCJzY29wZSI6ImJhbGFuY2VzOnJlYWQ6b3JnOmlkPWNlNDkxOGJmLWExOTktNGNlMi04NWEzLWQwZDI5Njg1NTM4NDoqIiwiZ3R5IjoiY2xpZW50LWNyZWRlbnRpYWxzIiwicGVybWlzc2lvbnMiOlsiYmFsYW5jZXM6cmVhZDpvcmc6aWQ9Y2U0OTE4YmYtYTE5OS00Y2UyLTg1YTMtZDBkMjk2ODU1Mzg0OioiXX0.RdKm2CvCAJYDno4dCdQ-G8k4ia7oHnVFW7O9mrcPhxnBayKPa2kLPcDJbFineU2s_AIlCjp6-1Bx6gOTytNVI4hWpS8ho_QSkQVipDAltq06Lg0N__NYZG11ZaDwlC0MLC2zcTYwIZcHY2_cC5kwOQ5Dc4no_IFCPtU_UbepqXZuj9uJda-9vrLv0zFoKD7bKUQkSaDam7Qvq6J7Q-sKwu_8wZ3tfSLqk53ECLZn4d9sJnsWaXixoQd1s0w5qKDSwjRMLeB8rm2ATAR4r4FayCKrSYgAuaK0heoYS158x69ThtTWZJFi0gPf1yD2DpshiEAFWyv4mMkH7YVs-fi6_x", "description": "The access token" }, "scope": { "type": "string", "example": "balances:read:org:id=ce4918bf-a199-4ce2-85a3-d0d296855384:*", "description": "The scope" }, "expiresIn": { "type": "integer", "format": "int64", "example": 3600, "description": "The expiration time in seconds" }, "tokenType": { "type": "string", "example": "Bearer", "description": "The token type" } }, "required": [ "accessToken", "scope", "expiresIn", "tokenType" ] }, "v2Explorer": { "type": "object", "properties": { "name": { "type": "string", "example": "Etherscan", "description": "Name of the explorer" }, "url": { "type": "string", "example": "https://etherscan.io", "description": "Base URL of the explorer" }, "transactionFormat": { "type": "string", "example": "/tx/{txHash}", "description": "URL format for transaction links (use {txHash} as placeholder)" }, "addressFormat": { "type": "string", "example": "/address/{address}", "description": "URL format for address links (use {address} as placeholder)" } }, "required": [ "name", "url", "transactionFormat", "addressFormat" ] }, "v2ExternalAddress": { "type": "object", "properties": { "address": { "type": "string", "example": "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4", "description": "The address" }, "name": { "type": "string", "example": "Treasury", "description": "The address name" }, "description": { "type": "string", "example": "Wallet used to store treasury funds", "description": "The address description" }, "blockchains": { "type": "array", "example": [ "ETHEREUM" ], "items": { "$ref": "#/components/schemas/v2Blockchain" }, "description": "The blockchains supported by the address" } }, "required": [ "address", "name", "blockchains" ] }, "v2FeeEstimate": { "type": "object", "properties": { "evm": { "$ref": "#/components/schemas/v2EvmFeeEstimate" }, "networkFees": { "type": "object", "example": { "slowest": "0.00001", "slow": "0.00005", "medium": "0.00010", "fast": "0.00015", "fastest": "0.0002" }, "additionalProperties": { "type": "string" }, "description": "Map of fee options where keys are fee types (slowest, slow, medium, fast, fastest) and values are the fee amounts in base asset units" } }, "required": [ "networkFees" ] }, "v2FilterResponse": { "type": "object", "properties": { "previousPageToken": { "type": "string", "example": "cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA=", "description": "The token to retrieve the previous page of results" }, "nextPageToken": { "type": "string", "example": "cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA=", "description": "The token to retrieve the next page of results" }, "total": { "type": "integer", "format": "int32", "example": 100, "description": "The total number of results" } }, "required": [ "total" ] }, "v2FirehoseConfiguration": { "type": "object", "properties": { "streamName": { "type": "string", "example": "audit-logs-stream", "description": "Firehose stream name" }, "region": { "type": "string", "example": "eu-west-2", "description": "Firehose region" }, "assumeRoleArn": { "type": "string", "example": "arn:aws:iam::123456789012:role/my-audit-logs-role", "description": "ARN of the role for the Palisade auditor to assume for Firehose access. Must have `firehose:PutRecordBatch` permissions on the stream." }, "status": { "$ref": "#/components/schemas/v2FirehoseConfigurationStatus" } }, "required": [ "streamName", "region", "assumeRoleArn", "status" ] }, "v2FirehoseConfigurationState": { "type": "string", "enum": [ "FIREHOSE_CONFIG_STATE_PENDING", "FIREHOSE_CONFIG_STATE_ENABLED", "FIREHOSE_CONFIG_STATE_DISABLED" ] }, "v2FirehoseConfigurationStatus": { "type": "object", "properties": { "state": { "$ref": "#/components/schemas/v2FirehoseConfigurationState" }, "lastError": { "type": "string", "example": "User: arn:aws:iam::663932549156:user/audit-service is not authorized to perform: sts:AssumeRole", "description": "Last error message if any" }, "lastErrorAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "Timestamp of the last error" }, "consecutiveFailures": { "type": "integer", "format": "int32", "example": 3, "description": "Number of consecutive failures" }, "successfulUploads": { "type": "integer", "format": "int32", "example": 120, "description": "Total number of successful uploads" }, "failedUploads": { "type": "integer", "format": "int32", "example": 30, "description": "Total number of failed uploads" } }, "required": [ "state", "consecutiveFailures", "successfulUploads", "failedUploads" ] }, "v2FreezeAction": { "type": "string", "enum": [ "FREEZE_ACTION_FREEZE", "FREEZE_ACTION_UNFREEZE" ] }, "v2FreezeHistoryEntry": { "type": "object", "properties": { "id": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "Unique identifier for this history entry" }, "action": { "$ref": "#/components/schemas/v2FreezeAction" }, "reason": { "type": "string", "example": "Transaction frozen due to suspicious activity pattern", "description": "Reason for the freeze or unfreeze action" }, "userId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "User who performed the action (empty for automatic actions)" }, "organizationId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "Organization of the user who performed the action (empty for automatic actions)" }, "performedAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "Timestamp when the action was performed" }, "freezeType": { "$ref": "#/components/schemas/v2FreezeType" }, "riskScore": { "type": "number", "format": "double", "example": 85.5, "description": "Risk score that triggered auto-freeze (0-100)" } } }, "v2FreezeInfo": { "type": "object", "properties": { "isFrozen": { "type": "boolean", "example": false, "description": "Whether the transaction is currently frozen" }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/v2FreezeHistoryEntry" }, "description": "History of all freeze/unfreeze actions. Latest entry contains current state details when frozen." } } }, "v2FreezeTransactionResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2FreezeType": { "type": "string", "enum": [ "FREEZE_TYPE_MANUAL", "FREEZE_TYPE_AUTO_RISK", "FREEZE_TYPE_AUTO_AMOUNT", "FREEZE_TYPE_COMPLIANCE", "FREEZE_TYPE_AUTO_WALLET_SETTING" ] }, "v2FuzzyMatch": { "type": "object", "properties": { "value": { "type": "string", "description": "Value to match against" }, "minSimilarity": { "type": "number", "format": "float", "description": "Minimum similarity threshold (0.0-1.0)" } } }, "v2GenerateSelfServiceSSOTicketResponse": { "type": "object", "properties": { "ticket": { "type": "string" } } }, "v2GetAddressResponse": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/counterpartyv2Address" } } }, "v2GetAssetResponse": { "type": "object", "properties": { "asset": { "$ref": "#/components/schemas/commonv2Asset" } } }, "v2GetBackupStrategyResponse": { "type": "object", "properties": { "strategy": { "$ref": "#/components/schemas/v2BackupStrategy" } } }, "v2GetBlockchainResponse": { "type": "object", "properties": { "blockchain": { "$ref": "#/components/schemas/v2BlockchainInfo" } } }, "v2GetConnectionResponse": { "type": "object", "properties": { "connection": { "$ref": "#/components/schemas/v2Connection" } } }, "v2GetCounterpartyResponse": { "type": "object", "properties": { "counterparty": { "$ref": "#/components/schemas/v2Counterparty" } } }, "v2GetCredentialInfoResponse": { "type": "object", "properties": { "credential": { "$ref": "#/components/schemas/v2CredentialInfo" } }, "required": [ "credential" ] }, "v2GetCredentialResponse": { "type": "object", "properties": { "credential": { "$ref": "#/components/schemas/v2Credential" } }, "required": [ "credential" ] }, "v2GetCurrencyResponse": { "type": "object", "properties": { "currency": { "$ref": "#/components/schemas/v2Currency" } } }, "v2GetDeviceCredentialsResponse": { "type": "object", "properties": { "mqCredentials": { "$ref": "#/components/schemas/v2MQCredentials" } } }, "v2GetDevicePairingCredentialsResponse": { "type": "object", "properties": { "pairingCredentials": { "$ref": "#/components/schemas/v2PairingCredentials" } } }, "v2GetDeviceResponse": { "type": "object", "properties": { "device": { "$ref": "#/components/schemas/v2Device" } } }, "v2GetDeviceSessionDataResponse": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": { "type": "string" } } } }, "v2GetFirehoseConfigurationResponse": { "type": "object", "properties": { "configuration": { "$ref": "#/components/schemas/v2FirehoseConfiguration" } } }, "v2GetKeyApproversResponse": { "type": "object", "properties": { "approvalGroups": { "type": "array", "items": { "$ref": "#/components/schemas/v2ApprovalGroup" } } } }, "v2GetNotabeneCustomerTokenResponse": { "type": "object", "properties": { "accessToken": { "type": "string" }, "scope": { "type": "string" }, "tokenType": { "type": "string" } }, "required": [ "accessToken", "scope", "tokenType" ] }, "v2GetNotabeneVASPSearchResponse": { "type": "object", "properties": { "vasps": { "type": "array", "items": { "$ref": "#/components/schemas/v2VASPInfoSimple" } }, "pagination": { "$ref": "#/components/schemas/v2NotabenePagination" } } }, "v2GetOrgApproversResponse": { "type": "object", "properties": { "approvalGroups": { "type": "array", "items": { "$ref": "#/components/schemas/v2ApprovalGroup" } } } }, "v2GetOrgBalancesResponse": { "type": "object", "properties": { "currencyCode": { "type": "string", "example": "USD", "description": "The currency code to be used for the fiat value. When omitted, 'USD' will be used." }, "aggregatedFiatValue": { "type": "string", "example": "100.00", "description": "The aggregated fiat value of the organization's balances" }, "balances": { "type": "array", "items": { "$ref": "#/components/schemas/v2VaultBalance" } } }, "required": [ "currencyCode" ] }, "v2GetOrganizationAuthMethodResponse": { "type": "object", "properties": { "authMethod": { "$ref": "#/components/schemas/v2OrganizationAuthMethod" } } }, "v2GetOrganizationResponse": { "type": "object", "properties": { "organization": { "$ref": "#/components/schemas/accountv2Organization" } } }, "v2GetPushTokenResponse": { "type": "object", "properties": { "token": { "type": "string" } } }, "v2GetQuorumResponse": { "type": "object", "properties": { "quorum": { "$ref": "#/components/schemas/v2Quorum" } } }, "v2GetRateResponse": { "type": "object", "properties": { "rate": { "type": "string", "example": "100.00", "description": "The rate of the currency pair" } }, "required": [ "rate" ] }, "v2GetSelfResponse": { "type": "object", "properties": { "device": { "$ref": "#/components/schemas/v2Device" } } }, "v2GetSessionResponse": { "type": "object", "properties": { "session": { "$ref": "#/components/schemas/v2Session" } }, "required": [ "session" ] }, "v2GetSubscriptionResponse": { "type": "object", "properties": { "subscription": { "$ref": "#/components/schemas/v2Subscription" } } }, "v2GetSweepConfigurationResponse": { "type": "object", "properties": { "sweepConfiguration": { "$ref": "#/components/schemas/v2SweepConfiguration" } }, "required": [ "sweepConfiguration" ] }, "v2GetUserInfoResponse": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/v2UserInfo" } } }, "v2GetUserResponse": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/v2User" } } }, "v2GetVaultBalancesResponse": { "type": "object", "properties": { "currencyCode": { "type": "string", "example": "USD", "description": "The currency code to be used for the fiat value. When omitted, 'USD' will be used." }, "aggregatedFiatValue": { "type": "string", "example": "100.00", "description": "The aggregated fiat value of the vault's balances" }, "balances": { "type": "array", "items": { "$ref": "#/components/schemas/v2WalletBalance" } } }, "required": [ "currencyCode" ] }, "v2GetVaultResponse": { "type": "object", "properties": { "vault": { "$ref": "#/components/schemas/v2Vault" } } }, "v2GetWalletBalancesResponse": { "type": "object", "properties": { "currencyCode": { "type": "string", "example": "USD", "description": "The currency code to be used for the fiat value. When omitted, 'USD' will be used." }, "aggregatedFiatValue": { "type": "string" }, "balances": { "type": "array", "items": { "$ref": "#/components/schemas/v2Balance" } } }, "required": [ "currencyCode" ] }, "v2GetWalletByIDResponse": { "type": "object", "properties": { "wallet": { "$ref": "#/components/schemas/vaultv2Wallet" } } }, "v2GetWalletLimitResponse": { "type": "object", "properties": { "walletLimit": { "$ref": "#/components/schemas/v2WalletLimit" } } }, "v2GetWalletSequenceResponse": { "type": "object", "properties": { "sequence": { "type": "string", "format": "uint64", "example": "2", "description": "The wallets nonce/sequence" } } }, "v2GetWebhookResponse": { "type": "object", "properties": { "webhook": { "$ref": "#/components/schemas/v2Webhook" } } }, "v2HydratedSweepAsset": { "type": "object", "properties": { "asset": { "$ref": "#/components/schemas/commonv2Asset" }, "minimumSweepQty": { "type": "string", "example": "10.00", "description": "The minimum sweep qty" } }, "required": [ "asset", "minimumSweepQty" ] }, "v2Import": { "type": "object", "properties": { "importId": { "type": "string", "description": "Unique identifier for this import" }, "batchId": { "type": "string", "description": "Import batch identifier" }, "source": { "type": "string", "description": "Source of the import (e.g., 'coingecko')" }, "status": { "type": "string", "example": "completed", "description": "Current status of the import" }, "triggeredBy": { "type": "string", "description": "User or system that triggered the import" }, "dryRun": { "type": "boolean", "description": "Whether this was a dry-run" }, "startedAt": { "type": "string", "format": "date-time", "description": "When the import started" }, "completedAt": { "type": "string", "format": "date-time", "description": "When the import completed" }, "totalProcessed": { "type": "integer", "format": "int32", "description": "Total number of items processed" }, "newAssets": { "type": "integer", "format": "int32", "description": "Number of new assets created" }, "updatedAssets": { "type": "integer", "format": "int32", "description": "Number of assets updated" }, "failedAssets": { "type": "integer", "format": "int32", "description": "Number of failed assets" }, "conflicts": { "type": "array", "items": { "$ref": "#/components/schemas/v2ConflictReport" }, "description": "Conflicts encountered during import" }, "errorMessage": { "type": "string", "description": "Error message if import failed" } } }, "v2Individual": { "type": "object", "properties": { "firstName": { "type": "string", "example": "Joe", "description": "The persons first name" }, "lastName": { "type": "string", "example": "Bloggs", "description": "The persons last name" }, "address": { "$ref": "#/components/schemas/commonv2Address" } }, "required": [ "firstName", "lastName" ] }, "v2IntFilter": { "type": "object", "properties": { "eq": { "type": "integer", "format": "int32", "description": "Equals" }, "notEq": { "type": "integer", "format": "int32", "description": "Not equal to" }, "in": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Value is in the list" }, "notIn": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Value is not in the list" }, "isNull": { "type": "boolean", "description": "Check if field is null" }, "gt": { "type": "integer", "format": "int32", "description": "Greater than" }, "gte": { "type": "integer", "format": "int32", "description": "Greater than or equal to" }, "lt": { "type": "integer", "format": "int32", "description": "Less than" }, "lte": { "type": "integer", "format": "int32", "description": "Less than or equal to" } } }, "v2InternalApproverCountResponse": { "type": "object", "properties": { "approverCount": { "type": "integer", "format": "int32" } } }, "v2InternalDecompileTransactionResponse": { "type": "object", "properties": { "asset": { "$ref": "#/components/schemas/commonv2Asset" }, "destinationAddress": { "type": "string" }, "qty": { "type": "string" }, "feeQtyLimit": { "type": "string" }, "sequence": { "type": "string", "format": "uint64" }, "transactionType": { "type": "string" }, "attributes": { "type": "object", "additionalProperties": { "type": "string" } }, "originAddress": { "type": "string" } } }, "v2InternalEstimateNetworkFeeResponse": { "type": "object", "properties": { "feeEstimate": { "$ref": "#/components/schemas/v2FeeEstimate" } } }, "v2InternalEstimateTransferFeeResponse": { "type": "object", "properties": { "feeEstimate": { "$ref": "#/components/schemas/v2FeeEstimate" } } }, "v2InternalFreezeTransactionResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2InternalGetAddressesResponse": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string" } } } }, "v2InternalGetAssetResponse": { "type": "object", "properties": { "asset": { "$ref": "#/components/schemas/commonv2Asset" } } }, "v2InternalGetBackupStrategyResponse": { "type": "object", "properties": { "strategy": { "$ref": "#/components/schemas/v2BackupStrategy" } } }, "v2InternalGetBlockchainResponse": { "type": "object", "properties": { "blockchain": { "$ref": "#/components/schemas/v2BlockchainInfo" } } }, "v2InternalGetComplianceInfoResponse": { "type": "object", "properties": { "counterparty": { "$ref": "#/components/schemas/v2Counterparty" }, "address": { "$ref": "#/components/schemas/counterpartyv2Address" } } }, "v2InternalGetCurrencyResponse": { "type": "object", "properties": { "currency": { "$ref": "#/components/schemas/v2Currency" } } }, "v2InternalGetDeviceResponse": { "type": "object", "properties": { "device": { "$ref": "#/components/schemas/v2Device" } }, "required": [ "device" ] }, "v2InternalGetOrgBalancesResponse": { "type": "object", "properties": { "currencyCode": { "type": "string" }, "aggregatedFiatValue": { "type": "string" }, "balances": { "type": "array", "items": { "$ref": "#/components/schemas/v2VaultBalance" } } } }, "v2InternalGetOrganizationResponse": { "type": "object", "properties": { "organization": { "$ref": "#/components/schemas/accountv2Organization" } } }, "v2InternalGetRateResponse": { "type": "object", "properties": { "rate": { "type": "string" } } }, "v2InternalGetTotalWithdrawnResponse": { "type": "object", "properties": { "totalWithdrawn": { "type": "string" } } }, "v2InternalGetTransactionResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2InternalGetWalletBalancesResponse": { "type": "object", "properties": { "currencyCode": { "type": "string" }, "aggregatedFiatValue": { "type": "string" }, "balances": { "type": "array", "items": { "$ref": "#/components/schemas/v2Balance" } } }, "required": [ "currencyCode" ] }, "v2InternalGetWalletResponse": { "type": "object", "properties": { "wallet": { "$ref": "#/components/schemas/vaultv2Wallet" } } }, "v2InternalListApprovalSummariesResponse": { "type": "object", "properties": { "approvalSummaries": { "type": "array", "items": { "$ref": "#/components/schemas/approvalv2ApprovalSummary" } } }, "required": [ "approvalSummaries" ] }, "v2InternalListAssetsResponse": { "type": "object", "properties": { "assets": { "type": "array", "items": { "$ref": "#/components/schemas/commonv2Asset" } }, "pagination": { "$ref": "#/components/schemas/v2PaginationResponse" } } }, "v2InternalListBlockchainsResponse": { "type": "object", "properties": { "blockchains": { "type": "array", "items": { "$ref": "#/components/schemas/v2BlockchainInfo" } }, "pagination": { "$ref": "#/components/schemas/v2PaginationResponse" } } }, "v2InternalListCurrenciesResponse": { "type": "object", "properties": { "currencies": { "type": "array", "items": { "$ref": "#/components/schemas/v2Currency" } }, "pagination": { "$ref": "#/components/schemas/v2PaginationResponse" } } }, "v2InternalListDevicesResponse": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/components/schemas/v2Device" } } } }, "v2InternalListVaultsResponse": { "type": "object", "properties": { "vaults": { "type": "array", "items": { "$ref": "#/components/schemas/v2Vault" } } } }, "v2InternalListWalletsResponse": { "type": "object", "properties": { "wallets": { "type": "array", "items": { "$ref": "#/components/schemas/vaultv2Wallet" } } } }, "v2InternalLookupAddressResponse": { "type": "object", "properties": { "counterparty": { "$ref": "#/components/schemas/v2Counterparty" }, "address": { "$ref": "#/components/schemas/counterpartyv2Address" } } }, "v2InternalLookupWalletResponse": { "type": "object", "properties": { "wallet": { "$ref": "#/components/schemas/vaultv2Wallet" } } }, "v2InternalPublishDeviceNotificationResponse": { "type": "object", "properties": { "deviceIds": { "type": "array", "items": { "type": "string" } } } }, "v2InternalPublishInterestNotificationResponse": { "type": "object" }, "v2InternalStreamWalletsResponse": { "type": "object", "properties": { "wallets": { "type": "array", "items": { "$ref": "#/components/schemas/v2WalletMetadata" } } } }, "v2InternalSubmitAMMCreateResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2InternalSubmitAMMDepositResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2InternalSubmitAMMWithdrawResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2InternalSubmitAccountSetResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2InternalSubmitClawbackResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2InternalSubmitOfferCancelResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2InternalSubmitOfferCreateResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2InternalSubmitSignerListSetResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2InternalSubmitTrustSetResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2InternalSweepTransactionResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2InternalUnfreezeTransactionResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2InternalUpdateFrozenAmountResponse": { "type": "object" }, "v2InternalValidateS3AccessResponse": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errorMessage": { "type": "string" } } }, "v2InternalWeb3SignResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2InternalWeb3TransactionResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2IsWalletOwnerResponse": { "type": "object" }, "v2KeyAlgorithm": { "type": "string", "enum": [ "SECP256K1", "ED25519" ] }, "v2Keystore": { "type": "string", "enum": [ "HSM", "MPC" ] }, "v2LimitType": { "type": "string", "enum": [ "PER_TX", "CONSTANT", "ROLLING_DURATION" ] }, "v2ListAddressesResponse": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/v2FilterResponse" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/counterpartyv2Address" } } } }, "v2ListAssetsRequest": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/v2AssetFilter" }, "search": { "$ref": "#/components/schemas/v2SearchQuery" }, "pagination": { "$ref": "#/components/schemas/v2PaginationRequest" } } }, "v2ListAssetsResponse": { "type": "object", "properties": { "assets": { "type": "array", "items": { "$ref": "#/components/schemas/commonv2Asset" } }, "pagination": { "$ref": "#/components/schemas/v2PaginationResponse" } } }, "v2ListBackupStrategiesResponse": { "type": "object", "properties": { "strategies": { "type": "array", "items": { "$ref": "#/components/schemas/v2BackupStrategy" }, "description": "List of backup strategies" } } }, "v2ListBlockchainsRequest": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/v2BlockchainFilter" }, "search": { "$ref": "#/components/schemas/v2SearchQuery" }, "pagination": { "$ref": "#/components/schemas/v2PaginationRequest" } } }, "v2ListBlockchainsResponse": { "type": "object", "properties": { "blockchains": { "type": "array", "items": { "$ref": "#/components/schemas/v2BlockchainInfo" } }, "pagination": { "$ref": "#/components/schemas/v2PaginationResponse" } } }, "v2ListConnectionsResponse": { "type": "object", "properties": { "connections": { "type": "array", "items": { "$ref": "#/components/schemas/v2Connection" } } } }, "v2ListCounterpartiesResponse": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/v2FilterResponse" }, "counterparties": { "type": "array", "items": { "$ref": "#/components/schemas/v2Counterparty" } } } }, "v2ListCredentialInfoResponse": { "type": "object", "properties": { "credentials": { "type": "array", "items": { "$ref": "#/components/schemas/v2CredentialInfo" } } }, "required": [ "credentials" ] }, "v2ListCredentialsResponse": { "type": "object", "properties": { "credentials": { "type": "array", "items": { "$ref": "#/components/schemas/v2Credential" } } }, "required": [ "credentials" ] }, "v2ListCurrenciesRequest": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/v2CurrencyFilter" }, "search": { "$ref": "#/components/schemas/v2SearchQuery" }, "pagination": { "$ref": "#/components/schemas/v2PaginationRequest" } } }, "v2ListCurrenciesResponse": { "type": "object", "properties": { "currencies": { "type": "array", "items": { "$ref": "#/components/schemas/v2Currency" } }, "pagination": { "$ref": "#/components/schemas/v2PaginationResponse" } } }, "v2ListDevicesResponse": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/components/schemas/v2Device" } } } }, "v2ListEligibleApproversResponse": { "type": "object", "properties": { "eligibleApprovers": { "type": "array", "items": { "$ref": "#/components/schemas/v2EligibleApprover" } } } }, "v2ListEligibleDevicesResponse": { "type": "object", "properties": { "eligibleDevices": { "type": "array", "items": { "$ref": "#/components/schemas/v2EligibleDevice" } } } }, "v2ListGlobalAddressesResponse": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/v2FilterResponse" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/counterpartyv2Address" } } } }, "v2ListGlobalConnectionsResponse": { "type": "object", "properties": { "connections": { "type": "array", "items": { "$ref": "#/components/schemas/v2Connection" } } } }, "v2ListGlobalTagsResponse": { "type": "object", "properties": { "walletTags": { "type": "array", "items": { "$ref": "#/components/schemas/v2WalletTag" } }, "vaultTags": { "type": "array", "items": { "$ref": "#/components/schemas/v2VaultTag" } } } }, "v2ListGlobalVaultTagsResponse": { "type": "object", "properties": { "tags": { "type": "array", "items": { "$ref": "#/components/schemas/v2VaultTag" } } } }, "v2ListGlobalWalletLimitsResponse": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/v2FilterResponse" }, "walletLimits": { "type": "array", "items": { "$ref": "#/components/schemas/v2WalletLimit" } } } }, "v2ListGlobalWalletsResponse": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/v2FilterResponse" }, "wallets": { "type": "array", "items": { "$ref": "#/components/schemas/vaultv2Wallet" } } } }, "v2ListMembershipsForDeviceResponse": { "type": "object", "properties": { "memberships": { "type": "array", "items": { "$ref": "#/components/schemas/v2Membership" } } } }, "v2ListMembershipsForQuorumResponse": { "type": "object", "properties": { "memberships": { "type": "array", "items": { "$ref": "#/components/schemas/v2Membership" } } } }, "v2ListOrganizationAuthMethodsResponse": { "type": "object", "properties": { "authMethods": { "type": "array", "items": { "$ref": "#/components/schemas/v2OrganizationAuthMethod" } } } }, "v2ListPermittedDestinationsResponse": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/v2FilterResponse" }, "destinations": { "type": "array", "items": { "$ref": "#/components/schemas/v2Destination" } } } }, "v2ListQuorumsByDeviceResponse": { "type": "object", "properties": { "quorums": { "type": "array", "items": { "$ref": "#/components/schemas/v2Quorum" } } } }, "v2ListQuorumsResponse": { "type": "object", "properties": { "quorums": { "type": "array", "items": { "$ref": "#/components/schemas/v2Quorum" } } } }, "v2ListSessionSetsResponse": { "type": "object", "properties": { "sessionSets": { "type": "array", "items": { "$ref": "#/components/schemas/v2SessionSet" } } } }, "v2ListSessionsForDeviceResponse": { "type": "object", "properties": { "sessions": { "type": "array", "items": { "$ref": "#/components/schemas/v2Session" } } } }, "v2ListSubscriptionsResponse": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/v2FilterResponse" }, "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/v2Subscription" } } } }, "v2ListSupportedAssetsResponse": { "type": "object", "properties": { "assets": { "type": "array", "items": { "$ref": "#/components/schemas/commonv2Asset" } } } }, "v2ListSupportedCurrenciesResponse": { "type": "object", "properties": { "currencies": { "type": "array", "items": { "$ref": "#/components/schemas/v2Currency" } } } }, "v2ListSweepConfigurationsResponse": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/v2FilterResponse" }, "sweepConfigurations": { "type": "array", "items": { "$ref": "#/components/schemas/v2SweepConfiguration" }, "description": "The list of sweep configurations" } } }, "v2ListSweepInstanceTransactionsResponse": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/v2FilterResponse" }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/transactionsv2Transaction" } } } }, "v2ListSweepInstancesResponse": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/v2FilterResponse" }, "sweepInstances": { "type": "array", "items": { "$ref": "#/components/schemas/v2SweepInstance" }, "description": "The list of sweep instances with metadata" } } }, "v2ListUserAuthMethodsResponse": { "type": "object", "properties": { "authMethods": { "type": "array", "items": { "$ref": "#/components/schemas/v2UserAuthMethod" } } } }, "v2ListUserInfoResponse": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/v2UserInfo" } } } }, "v2ListUsersResponse": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/v2User" } } } }, "v2ListVariantsResponse": { "type": "object", "example": { "wallets": { "balances": { "read": [ "org", "vault", "key" ] }, "key": { "create": [ "org", "vault" ], "read": [ "org", "vault", "key" ], "update": [ "org", "vault", "key" ] }, "vault": { "create": [ "org" ], "read": [ "org", "vault" ] } }, "transactions": { "transaction": { "read": [ "org", "vault", "key" ], "create": [ "org", "vault", "key" ] } }, "controls": { "allowaddress": { "create": [ "org", "vault", "key" ], "delete": [ "org", "vault", "key" ], "read": [ "org", "vault", "key" ] }, "keylimit": { "create": [ "org", "vault", "key" ], "delete": [ "org", "vault", "key" ], "read": [ "org", "vault", "key" ] } } }, "properties": { "wallets": { "type": "object" }, "transactions": { "type": "object" }, "controls": { "type": "object" }, "audit": { "type": "object" } }, "required": [ "wallets", "transactions", "controls", "audit" ] }, "v2ListVaultTagsResponse": { "type": "object", "properties": { "tags": { "type": "array", "items": { "$ref": "#/components/schemas/v2VaultTag" } } } }, "v2ListVaultWalletsResponse": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/v2FilterResponse" }, "wallets": { "type": "array", "items": { "$ref": "#/components/schemas/vaultv2Wallet" } } } }, "v2ListVaultsResponse": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/v2FilterResponse" }, "vaults": { "type": "array", "items": { "$ref": "#/components/schemas/v2Vault" } } } }, "v2ListWalletLimitsResponse": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/v2FilterResponse" }, "walletLimits": { "type": "array", "items": { "$ref": "#/components/schemas/v2WalletLimit" } } } }, "v2ListWalletTagsInVaultResponse": { "type": "object", "properties": { "tags": { "type": "array", "items": { "$ref": "#/components/schemas/v2WalletTag" } } } }, "v2ListWalletTagsResponse": { "type": "object", "properties": { "tags": { "type": "array", "items": { "$ref": "#/components/schemas/v2WalletTag" } } } }, "v2ListWalletTransactionsResponse": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/v2FilterResponse" }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/transactionsv2Transaction" } } } }, "v2ListWebhooksResponse": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/v2FilterResponse" }, "webhooks": { "type": "array", "items": { "$ref": "#/components/schemas/v2Webhook" } } } }, "v2MPCAlgorithm": { "type": "string", "enum": [ "MPC_ALGORITHM_DKLS19", "MPC_ALGORITHM_PDKLS23" ] }, "v2MQCredentials": { "type": "object", "properties": { "host": { "type": "string", "description": "The host of the MQ server" }, "username": { "type": "string", "description": "The username for the MQ server" }, "password": { "type": "string", "description": "The password for the MQ server" } }, "required": [ "host", "username", "password" ] }, "v2ManagementCreateAssetRequest": { "type": "object", "properties": { "blockchainId": { "$ref": "#/components/schemas/v2Blockchain" }, "contractAddress": { "type": "string", "example": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", "description": "Contract address (empty for native assets)" }, "symbol": { "type": "string", "example": "USDC", "description": "Asset symbol" }, "name": { "type": "string", "example": "USD Coin", "description": "Asset name" }, "decimals": { "type": "integer", "format": "int32", "example": 6, "description": "Number of decimal places" }, "standard": { "$ref": "#/components/schemas/v2Standard" }, "coingeckoId": { "type": "string", "example": "usd-coin", "description": "CoinGecko identifier for price data" }, "enabled": { "type": "boolean", "example": true, "description": "Whether the asset is enabled (default: true)" }, "vetted": { "type": "boolean", "example": false, "description": "Whether the asset is vetted (default: false)" } }, "required": [ "blockchainId", "symbol", "standard" ] }, "v2ManagementCreateAssetResponse": { "type": "object", "properties": { "asset": { "$ref": "#/components/schemas/commonv2Asset" } } }, "v2ManagementCreateBlockchainRequest": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/v2Blockchain" }, "name": { "type": "string", "example": "Ethereum Mainnet", "description": "Blockchain name" }, "namespace": { "type": "string", "example": "ethereum", "description": "Blockchain namespace" }, "chain": { "type": "string", "example": "mainnet", "description": "Chain identifier" }, "chainId": { "type": "string", "example": "1", "description": "Chain ID (for EVM chains)" }, "routing": { "type": "string", "example": "primary", "description": "Routing configuration" }, "status": { "$ref": "#/components/schemas/v2BlockchainStatus" }, "supportsWalletConnect": { "type": "boolean", "example": true, "description": "Whether blockchain supports WalletConnect" }, "rpcEndpoints": { "type": "array", "items": { "$ref": "#/components/schemas/v2RPCEndpoint" }, "description": "RPC endpoints for the blockchain" }, "explorers": { "type": "array", "items": { "$ref": "#/components/schemas/v2Explorer" }, "description": "Block explorers for the blockchain" }, "keystoreTypes": { "type": "array", "items": { "$ref": "#/components/schemas/v2Keystore" }, "description": "Supported keystore types" }, "keyAlgorithms": { "type": "array", "items": { "$ref": "#/components/schemas/v2KeyAlgorithm" }, "description": "Supported key algorithms" }, "supportedEvents": { "type": "array", "items": { "type": "string" }, "description": "Supported blockchain events" }, "supportedMethods": { "type": "array", "items": { "type": "string" }, "description": "Supported blockchain methods" } }, "required": [ "id", "name", "namespace", "status" ] }, "v2ManagementCreateBlockchainResponse": { "type": "object", "properties": { "blockchain": { "$ref": "#/components/schemas/v2BlockchainInfo" } } }, "v2ManagementCreateCurrencyRequest": { "type": "object", "properties": { "code": { "type": "string", "example": "USD", "description": "ISO 4217 currency code" }, "name": { "type": "string", "example": "United States Dollar", "description": "Currency name" }, "symbol": { "type": "string", "example": "$", "description": "Currency symbol" }, "decimals": { "type": "integer", "format": "int32", "example": 2, "description": "Number of decimal places (default: 2)" }, "enabled": { "type": "boolean", "example": true, "description": "Whether the currency is enabled (default: true)" } }, "required": [ "code", "name", "symbol" ] }, "v2ManagementCreateCurrencyResponse": { "type": "object", "properties": { "currency": { "$ref": "#/components/schemas/v2Currency" } } }, "v2ManagementDeleteAssetResponse": { "type": "object" }, "v2ManagementDeleteBlockchainResponse": { "type": "object" }, "v2ManagementDeleteCurrencyResponse": { "type": "object" }, "v2ManagementGetImportHistoryResponse": { "type": "object", "properties": { "imports": { "type": "array", "items": { "$ref": "#/components/schemas/v2Import" } }, "pagination": { "$ref": "#/components/schemas/v2PaginationResponse" } } }, "v2ManagementGetImportResponse": { "type": "object", "properties": { "import": { "$ref": "#/components/schemas/v2Import" } } }, "v2ManagementGetSyncStatusResponse": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether sync is enabled" }, "running": { "type": "boolean", "description": "Whether sync is currently running" }, "schedule": { "type": "string", "example": "0 0 0 * * 0", "description": "Cron schedule for automatic sync" }, "nextRun": { "type": "string", "example": "2024-08-11T00:00:00Z", "description": "Next scheduled sync time" }, "dryRun": { "type": "boolean", "description": "Whether dry-run mode is enabled" }, "batchSize": { "type": "integer", "format": "int32", "description": "Batch size for processing" } } }, "v2ManagementTriggerSyncRequest": { "type": "object", "properties": { "dryRun": { "type": "boolean", "example": false, "description": "Whether to run in dry-run mode (no changes)" }, "batchSize": { "type": "integer", "format": "int32", "example": 100, "description": "Number of assets to process in each batch" } } }, "v2ManagementTriggerSyncResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/v2SyncResult" } } }, "v2ManagementUpdateAssetResponse": { "type": "object", "properties": { "asset": { "$ref": "#/components/schemas/commonv2Asset" } } }, "v2ManagementUpdateBlockchainResponse": { "type": "object", "properties": { "blockchain": { "$ref": "#/components/schemas/v2BlockchainInfo" } } }, "v2ManagementUpdateCurrencyResponse": { "type": "object", "properties": { "currency": { "$ref": "#/components/schemas/v2Currency" } } }, "v2Matcher": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/v2MatcherType" }, "value": { "type": "string", "description": "Comma seperated list of matcher values." }, "values": { "type": "array", "items": { "type": "string" }, "description": "Matcher values." } }, "required": [ "type" ] }, "v2MatcherType": { "type": "string", "enum": [ "USER", "API_CREDENTIAL", "COUNTERPARTY", "TRANSACTION_TYPE", "SIGN_FOR", "COUNTERPARTY_ID", "ADDRESS_ID", "WALLET_ID" ] }, "v2Membership": { "type": "object", "properties": { "id": { "type": "string" }, "deviceId": { "type": "string" }, "organizationId": { "type": "string" }, "quorumId": { "type": "string" }, "quorumName": { "type": "string" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "publicKey": { "type": "string" }, "playerId": { "type": "integer", "format": "int64" }, "state": { "$ref": "#/components/schemas/v2MembershipState" } }, "required": [ "id", "deviceId", "organizationId", "quorumId", "quorumName", "createdBy", "createdAt", "updatedAt", "publicKey", "playerId", "state" ] }, "v2MembershipState": { "type": "string", "enum": [ "MEMBERSHIP_STATE_CREATED", "MEMBERSHIP_STATE_PENDING", "MEMBERSHIP_STATE_CONFIRMED", "MEMBERSHIP_STATE_REJECTED", "MEMBERSHIP_STATE_FAILED", "MEMBERSHIP_STATE_SUPER", "MEMBERSHIP_STATE_INITIAL" ] }, "v2Metadata": { "type": "object", "properties": { "name": { "type": "string", "example": "Uniswap", "description": "The name of the DApp" }, "description": { "type": "string", "example": "Uniswap Interface", "description": "A description of the DApp" }, "url": { "type": "string", "example": "https://app.uniswap.org", "description": "The URL of the DApp" }, "icons": { "type": "array", "example": [ "https://app.uniswap.org/favicon.ico" ], "items": { "type": "string" }, "description": "The DApp icons" } }, "required": [ "name", "description", "url", "icons" ] }, "v2ModifyQuorumResponse": { "type": "object", "properties": { "quorum": { "$ref": "#/components/schemas/v2Quorum" } } }, "v2NotabenePagination": { "type": "object", "properties": { "page": { "type": "integer", "format": "int32" }, "perPage": { "type": "integer", "format": "int32" }, "order": { "type": "string" }, "total": { "type": "integer", "format": "int32" } } }, "v2Notification": { "type": "object", "properties": { "alert": { "$ref": "#/components/schemas/v2Alert" }, "event": { "$ref": "#/components/schemas/v2Event" }, "data": { "type": "string", "format": "byte" } } }, "v2OrganizationAuthMethod": { "type": "object", "properties": { "id": { "type": "string", "example": "con_PCUH08Sxb4Sxg22Q", "description": "The ID of the authentication method" }, "name": { "type": "string", "example": "customer-ui-password", "description": "The name of the authentication method" }, "strategy": { "type": "string", "example": "auth0", "description": "The strategy of the authentication method" }, "default": { "type": "boolean", "example": true, "description": "Whether this is the default authentication method for the organization" }, "idpSettings": { "$ref": "#/components/schemas/v2OrganizationAuthMethodIdpSettings" } }, "required": [ "id", "name", "strategy", "default", "idpSettings" ] }, "v2OrganizationAuthMethodIdpSettings": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true, "description": "Whether IDP is enabled for this authentication method" } }, "required": [ "enabled" ] }, "v2OrganizationSettings": { "type": "object", "properties": { "organizationType": { "$ref": "#/components/schemas/v2OrganizationType" }, "enabledComplianceIntegrations": { "type": "array", "items": { "$ref": "#/components/schemas/v2ComplianceIntegration" } }, "enabledKeystores": { "type": "array", "items": { "$ref": "#/components/schemas/v2Keystore" } }, "region": { "type": "string", "example": "France", "description": "The region in which the organization data is stored" }, "enabled": { "type": "boolean", "example": true, "description": "Whether the organization is enabled" }, "logo": { "type": "string" }, "legalName": { "type": "string", "example": "Palisade Financial", "description": "The full legal name of the organization" }, "vaspName": { "type": "string", "example": "Palisade Financial", "description": "The Virtual Asset Service Provider" }, "vaspDid": { "type": "string", "example": "did:example:123456789abcdefghi", "description": "The Virtual Asset Service Providers' Decentralized Identifier" }, "allowRawSigning": { "type": "boolean", "example": false, "description": "Whether the organization can create raw signed transactions (PALISADE_RAW). Defaults based on organization_type: false for CUSTODIAL, true for NON_CUSTODIAL." }, "allowNonVettedAssets": { "type": "boolean", "example": false, "description": "Whether the organization can transact with non-vetted assets. Defaults based on organization_type: false for CUSTODIAL, true for NON_CUSTODIAL." }, "allowConnections": { "type": "boolean", "example": false, "description": "Whether the organization can use WalletConnect/Web3 connections (WEB3_RAW, WEB3_SIGN). Defaults based on organization_type: false for CUSTODIAL, true for NON_CUSTODIAL." }, "allowFreeze": { "type": "boolean", "example": true, "description": "Whether Palisade can freeze/unfreeze transactions. Defaults based on organization_type: true for CUSTODIAL, false for NON_CUSTODIAL." } }, "required": [ "organizationType", "enabledComplianceIntegrations", "enabledKeystores", "region", "enabled", "legalName", "vaspName", "vaspDid" ] }, "v2OrganizationType": { "type": "string", "enum": [ "CUSTODIAL", "NON_CUSTODIAL" ] }, "v2PaginationRequest": { "type": "object", "properties": { "pageSize": { "type": "integer", "format": "int32", "example": 50, "description": "Number of results per page (default 50, max 1000)" }, "pageToken": { "type": "string", "example": "cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA=", "description": "Token for pagination from previous response" }, "orderBy": { "type": "string", "example": "created_at", "description": "Field to order results by" }, "order": { "$ref": "#/components/schemas/v2SortOrder" } } }, "v2PaginationResponse": { "type": "object", "properties": { "previousPageToken": { "type": "string", "example": "cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA=", "description": "The token to retrieve the previous page of results" }, "nextPageToken": { "type": "string", "example": "cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA=", "description": "The token to retrieve the next page of results" }, "total": { "type": "integer", "format": "int32", "example": 100, "description": "The total number of results" } }, "required": [ "total" ] }, "v2PairDeviceWithCredentialRequest": { "type": "object", "properties": { "credential": { "type": "string" } }, "required": [ "credential" ] }, "v2PairDeviceWithCredentialResponse": { "type": "object", "properties": { "device": { "$ref": "#/components/schemas/v2Device" } } }, "v2PairingCredentials": { "type": "object", "properties": { "id": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The device ID" }, "clientId": { "type": "string", "description": "The client ID" }, "clientSecret": { "type": "string", "description": "The client secret" }, "pairingKey": { "type": "string", "description": "The pairing key" } }, "required": [ "id", "clientId", "clientSecret", "pairingKey" ] }, "v2PasskeyTransactionResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2PendingSession": { "type": "object", "properties": { "session": { "$ref": "#/components/schemas/v2Session" }, "membership": { "$ref": "#/components/schemas/v2Membership" } } }, "v2PendingSessionResponse": { "type": "object", "properties": { "pending": { "$ref": "#/components/schemas/v2PendingSession" } } }, "v2PollQuorumStatusResponse": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/v2QuorumStatus" } } }, "v2PollSessionSetStatusResponse": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/v2SessionSetStatus" } } }, "v2Proposer": { "type": "object", "properties": { "publicKey": { "type": "string", "example": "497f83bc461e9ec55be08592cecea561ccd713781954d313976feb2d7d93293a", "description": "The public key of the DApp" }, "metadata": { "$ref": "#/components/schemas/v2Metadata" } }, "required": [ "publicKey" ] }, "v2Quorum": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "deviceIds": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "operationTimeoutSeconds": { "type": "integer", "format": "int64" }, "sessionTimeoutSeconds": { "type": "integer", "format": "int64" }, "requiredSigners": { "type": "integer", "format": "int64" }, "state": { "$ref": "#/components/schemas/v2QuorumState" }, "type": { "$ref": "#/components/schemas/v2QuorumType" }, "backupStrategyId": { "type": "string" }, "modificationRequestJsonBase64": { "type": "string" }, "mpcAlgorithm": { "$ref": "#/components/schemas/v2MPCAlgorithm" } }, "required": [ "id", "organizationId", "createdBy", "createdAt", "updatedAt", "deviceIds", "name", "operationTimeoutSeconds", "sessionTimeoutSeconds", "requiredSigners", "state", "type" ] }, "v2QuorumState": { "type": "string", "enum": [ "QUORUM_STATE_CREATED", "QUORUM_STATE_PENDING", "QUORUM_STATE_CONFIRMED", "QUORUM_STATE_REJECTED", "QUORUM_STATE_FAILED", "QUORUM_STATE_SUPER", "QUORUM_STATE_INITIAL", "QUORUM_STATE_MODIFY_MEMBERSHIP", "QUORUM_STATE_MODIFY_SHARDS", "QUORUM_STATE_FINALIZE_MODIFICATION" ] }, "v2QuorumStateUpdate": { "type": "object", "properties": { "quorum": { "$ref": "#/components/schemas/v2Quorum" } } }, "v2QuorumStateUpdatedResponse": { "type": "object", "properties": { "update": { "$ref": "#/components/schemas/v2QuorumStateUpdate" } } }, "v2QuorumStatus": { "type": "object", "properties": { "expectedMemberCount": { "type": "integer", "format": "int64" }, "acceptedMemberCount": { "type": "integer", "format": "int64" }, "rejectedMemberCount": { "type": "integer", "format": "int64" }, "state": { "$ref": "#/components/schemas/v2QuorumState" } }, "required": [ "expectedMemberCount", "acceptedMemberCount", "rejectedMemberCount", "state" ] }, "v2QuorumType": { "type": "string", "enum": [ "QUORUM_TYPE_MOBILE", "QUORUM_TYPE_CLOUD", "QUORUM_TYPE_MIXED" ] }, "v2RPCEndpoint": { "type": "object", "properties": { "url": { "type": "string", "example": "https://mainnet.infura.io/v3/YOUR-PROJECT-ID", "description": "The RPC endpoint URL" }, "priority": { "type": "integer", "format": "int32", "example": 0, "description": "Priority for endpoint selection (lower number = higher priority)" }, "type": { "$ref": "#/components/schemas/v2RPCEndpointType" } }, "required": [ "url", "type" ] }, "v2RPCEndpointType": { "type": "string", "enum": [ "RPC_ENDPOINT_TYPE_HTTP", "RPC_ENDPOINT_TYPE_WEBSOCKET" ] }, "v2RawTransactionResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2RecoveryPublicKey": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the recovery public key" }, "publicKey": { "type": "string", "description": "The DER formatted, hex encoded RSA public key (stored/returned format is always hex)" }, "createdBy": { "type": "string", "description": "User who created the recovery public key" } } }, "v2RejectConnectionResponse": { "type": "object", "properties": { "connection": { "$ref": "#/components/schemas/v2Connection" } } }, "v2Role": { "type": "string", "enum": [ "ADMINISTRATOR", "APPROVER", "AUDITOR", "OWNER", "PROPOSER", "VIEWER" ] }, "v2S3Config": { "type": "object", "properties": { "bucket": { "type": "string", "description": "S3 bucket name" }, "region": { "type": "string", "description": "S3 region" }, "assumeRoleArn": { "type": "string", "description": "ARN of the role to assume for S3 access" }, "externalId": { "type": "string", "description": "External ID for role assumption (optional, for enhanced security)" }, "kmsKeyArn": { "type": "string", "description": "KMS key ARN for server-side encryption (optional)" } } }, "v2SearchOptions": { "type": "object", "properties": { "caseSensitive": { "type": "boolean", "description": "Enable case-sensitive search (default: false)" }, "minTermLength": { "type": "integer", "format": "int32", "description": "Minimum search term length" }, "maxResults": { "type": "integer", "format": "int32", "description": "Maximum number of results to return" }, "multiTermAnd": { "type": "boolean", "description": "Use AND logic for multiple terms (default: false for OR)" } } }, "v2SearchQuery": { "type": "object", "properties": { "term": { "type": "string", "example": "stable", "description": "Search term" }, "fields": { "type": "array", "example": [ "name", "symbol" ], "items": { "type": "string" }, "description": "Fields to search in" }, "type": { "$ref": "#/components/schemas/v2SearchType" }, "minScore": { "type": "number", "format": "float", "description": "Minimum relevance score for fuzzy/fulltext search" }, "options": { "$ref": "#/components/schemas/v2SearchOptions" } } }, "v2SearchType": { "type": "string", "enum": [ "SEARCH_TYPE_CONTAINS", "SEARCH_TYPE_STARTS_WITH", "SEARCH_TYPE_EXACT", "SEARCH_TYPE_FUZZY", "SEARCH_TYPE_FULLTEXT" ] }, "v2Session": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "membershipId": { "type": "string" }, "sessionSetId": { "type": "string" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "type": { "$ref": "#/components/schemas/v2SessionType" }, "accepted": { "type": "boolean" }, "payloadId": { "type": "string" }, "devicePayload": { "type": "string" }, "notificationPayload": { "type": "string", "format": "byte" }, "notificationTrigger": { "type": "string" }, "notificationBody": { "type": "string" }, "state": { "$ref": "#/components/schemas/v2SessionState" } }, "required": [ "id", "organizationId", "membershipId", "sessionSetId", "createdBy", "createdAt", "updatedAt", "expiresAt", "type", "accepted", "payloadId", "devicePayload", "notificationPayload", "notificationTrigger", "notificationBody", "state" ] }, "v2SessionSet": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "quorumId": { "type": "string" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "type": { "$ref": "#/components/schemas/v2SessionSetType" }, "payloadId": { "type": "string" }, "payloadRaw": { "type": "string" }, "state": { "$ref": "#/components/schemas/v2SessionSetState" } }, "required": [ "id", "organizationId", "quorumId", "createdBy", "createdAt", "updatedAt", "expiresAt", "type", "payloadId", "payloadRaw", "state" ] }, "v2SessionSetState": { "type": "string", "enum": [ "SESSION_SET_STATE_CREATED", "SESSION_SET_STATE_IN_PROGRESS", "SESSION_SET_STATE_COMPLETE", "SESSION_SET_STATE_TIMED_OUT", "SESSION_SET_STATE_FAILED", "SESSION_SET_STATE_SUPER", "SESSION_SET_STATE_INITIAL" ] }, "v2SessionSetStatus": { "type": "object", "properties": { "expectedCount": { "type": "integer", "format": "int64" }, "submittedCount": { "type": "integer", "format": "int64" }, "acceptedCount": { "type": "integer", "format": "int64" }, "state": { "$ref": "#/components/schemas/v2SessionSetState" } }, "required": [ "expectedCount", "submittedCount", "acceptedCount", "state" ] }, "v2SessionSetType": { "type": "string", "enum": [ "SESSION_SET_TYPE_QUORUM_CREATION", "SESSION_SET_TYPE_KEY_CREATION", "SESSION_SET_TYPE_TX_SIGN_POOL", "SESSION_SET_TYPE_TX_SIGN_REQUEST", "SESSION_SET_TYPE_QUORUM_JOIN", "SESSION_SET_TYPE_QUORUM_MODIFY", "SESSION_SET_TYPE_QUORUM_MODIFY_FINALIZE" ] }, "v2SessionState": { "type": "string", "enum": [ "SESSION_STATE_CREATED", "SESSION_STATE_PENDING", "SESSION_STATE_SUBMITTED", "SESSION_STATE_COMPLETED", "SESSION_STATE_TIMED_OUT", "SESSION_STATE_FAILED", "SESSION_STATE_PROCESSED", "SESSION_STATE_SUPER", "SESSION_STATE_INITIAL" ] }, "v2SessionType": { "type": "string", "enum": [ "SESSION_TYPE_QUORUM_CREATION", "SESSION_TYPE_KEY_CREATION", "SESSION_TYPE_TX_SIGN_POOL", "SESSION_TYPE_TX_SIGN_REQUEST", "SESSION_TYPE_QUORUM_JOIN", "SESSION_TYPE_QUORUM_MODIFY", "SESSION_TYPE_QUORUM_MODIFY_FINALIZE" ] }, "v2SetDefaultOrganizationAuthMethodResponse": { "type": "object", "properties": { "authMethod": { "$ref": "#/components/schemas/v2OrganizationAuthMethod" } } }, "v2SetDeviceVersionRequest": { "type": "object", "properties": { "version": { "type": "string" } } }, "v2SetDeviceVersionResponse": { "type": "object" }, "v2SetFirehoseConfigurationRequest": { "type": "object", "properties": { "streamName": { "type": "string", "example": "audit-logs-stream", "description": "Firehose stream name" }, "region": { "type": "string", "example": "eu-west-2", "description": "Firehose region" }, "assumeRoleArn": { "type": "string", "example": "arn:aws:iam::123456789012:role/my-audit-logs-role", "description": "ARN of the role for the Palisade auditor to assume for Firehose access. Must have `firehose:PutRecordBatch` permissions on the stream." }, "enabled": { "type": "boolean", "example": true, "description": "Whether to enable the Firehose stream. Set to false to temporarily disable without deleting the configuration. Defaults to true (enabled/pending)." } }, "required": [ "streamName", "region", "assumeRoleArn" ] }, "v2SetFirehoseConfigurationResponse": { "type": "object", "properties": { "configuration": { "$ref": "#/components/schemas/v2FirehoseConfiguration" } } }, "v2SignPlaintextResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2SigningPayload": { "type": "object", "properties": { "inputIndex": { "type": "integer", "format": "int64", "example": 0, "description": "The index of the UTXO input this signing payload corresponds to" }, "signingHash": { "type": "string", "example": "30674cddb3025f9681839c63d20357f54e914bd7a9ddfe53a6691f4a530a5671", "description": "The signing hash for this UTXO input" }, "signature": { "type": "string", "example": "3046022100c60dc1337d69261e7c7e92e4dac78e0c317d444d4690be2b86cc53b1989d1b0602210090c63e3a5cf692c9387292451fada038a0e4d85a2f5c91ee1e7a635df0440b43", "description": "The signature for this UTXO input" } }, "required": [ "inputIndex", "signingHash" ] }, "v2SortOrder": { "type": "string", "enum": [ "SORT_ORDER_ASC", "SORT_ORDER_DESC" ] }, "v2SourceType": { "type": "string", "enum": [ "TRANSACTION", "DEVICE", "API_CREDENTIAL", "ALLOW_LIST_ENTRY", "POLICY", "USER", "APPROVAL_GROUP", "ADDRESS" ] }, "v2Standard": { "type": "string", "enum": [ "NATIVE", "ERC20", "ISSUED_CURRENCY", "ERC721", "SPL", "CUSTOM" ] }, "v2StringFilter": { "type": "object", "properties": { "eq": { "type": "string", "description": "Exact match" }, "notEq": { "type": "string", "description": "Not equal to" }, "contains": { "type": "string", "description": "Contains substring (case-insensitive)" }, "startsWith": { "type": "string", "description": "Starts with prefix (case-insensitive)" }, "endsWith": { "type": "string", "description": "Ends with suffix (case-insensitive)" }, "in": { "type": "array", "items": { "type": "string" }, "description": "Value is in the list" }, "notIn": { "type": "array", "items": { "type": "string" }, "description": "Value is not in the list" }, "regex": { "type": "string", "description": "Regular expression match" }, "isNull": { "type": "boolean", "description": "Check if field is null" }, "fuzzy": { "$ref": "#/components/schemas/v2FuzzyMatch" } } }, "v2SubmitAMMCreateResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2SubmitAMMDepositResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2SubmitAMMWithdrawResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2SubmitAccountSetResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2SubmitClawbackResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2SubmitOfferCancelResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2SubmitOfferCreateResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2SubmitSessionResponse": { "type": "object", "properties": { "session": { "$ref": "#/components/schemas/v2Session" } } }, "v2SubmitSignerListSetResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2SubmitTrustSetResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2Subscription": { "type": "object", "properties": { "id": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The webhook subscription ID" }, "webhookId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The webhook ID" }, "organizationId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The organization ID" }, "createdBy": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The ID of the user who created this webhook" }, "createdAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the webhook was created" }, "updatedBy": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The ID of the user who updated this webhook" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the webhook was updated" }, "config": { "$ref": "#/components/schemas/v2SubscriptionConfig" } }, "required": [ "id", "webhookId", "organizationId", "createdBy", "createdAt", "updatedBy", "updatedAt", "config" ] }, "v2SubscriptionConfig": { "type": "object", "properties": { "domain": { "$ref": "#/components/schemas/v2SubscriptionDomain" }, "scope": { "$ref": "#/components/schemas/v2SubscriptionScope" } }, "required": [ "domain", "scope" ] }, "v2SubscriptionDomain": { "type": "string", "enum": [ "TRANSACTION", "WALLET", "APPROVAL" ] }, "v2SubscriptionScope": { "type": "string", "enum": [ "ORG" ] }, "v2SweepAsset": { "type": "object", "properties": { "contract": { "type": "string", "example": "0xdAC17F958D2ee523a2206206994597C13D831ec7", "description": "The contract/issuing address" }, "symbol": { "type": "string", "example": "USD", "description": "The asset symbol" }, "minimumSweepQty": { "type": "string", "example": "10.00", "description": "The minimum sweep qty" } }, "required": [ "symbol", "minimumSweepQty" ] }, "v2SweepConfiguration": { "type": "object", "properties": { "id": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The sweep configuration ID" }, "organizationId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The organization ID" }, "createdBy": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The ID of the user who created this sweep configuration" }, "createdAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the sweep configuration was created" }, "updatedBy": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The ID of the user who updated this sweep configuration" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the sweep configuration was updated" }, "name": { "type": "string", "example": "Customer deposit sweep", "description": "The sweep configuration name" }, "description": { "type": "string", "example": "A sweep configuration used to sweep customer deposits", "description": "The sweep configuration description" }, "blockchain": { "$ref": "#/components/schemas/v2Blockchain" }, "feeWallet": { "$ref": "#/components/schemas/v2VaultWalletIdentifier" }, "destinationWallet": { "$ref": "#/components/schemas/v2VaultWalletIdentifier" }, "sweepFrequency": { "$ref": "#/components/schemas/v2SweepFrequency" }, "assets": { "type": "array", "items": { "$ref": "#/components/schemas/v2HydratedSweepAsset" }, "description": "The assets to sweep" }, "status": { "$ref": "#/components/schemas/v2SweepStatus" }, "lastSwept": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the sweep configuration was last executed" }, "sweepRunning": { "type": "boolean", "example": true, "description": "Whether the sweep is currently running" } }, "required": [ "id", "organizationId", "createdBy", "createdAt", "updatedBy", "updatedAt", "name", "blockchain", "feeWallet", "destinationWallet", "sweepFrequency", "assets", "status", "sweepRunning" ] }, "v2SweepFrequency": { "type": "string", "enum": [ "SWEEP_FREQUENCY_HOURLY", "SWEEP_FREQUENCY_DAILY" ] }, "v2SweepInstance": { "type": "object", "properties": { "id": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The sweep instance ID" }, "sweepConfigurationId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The sweep configuration ID" }, "startedAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the sweep instance was started" }, "completedAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the sweep instance was completed" }, "totalWalletsSwept": { "type": "string", "format": "uint64", "example": "5", "description": "The total number of wallets swept in the sweep instance" }, "totalSuccessfulWallets": { "type": "string", "format": "uint64", "example": "5", "description": "The number of wallets successfully swept in the sweep instance" }, "totalFailedWallets": { "type": "string", "format": "uint64", "example": "2", "description": "The number of wallets that failed to sweep in the sweep instance" }, "totalAmountSwept": { "type": "object", "example": { "BTC": "100.00", "ETH": "50.00" }, "additionalProperties": { "type": "string" }, "description": "A map of blockchain asset to total amount swept in the sweep instance" }, "incomingFee": { "type": "string", "example": "1.00", "description": "the incoming estimated fee from the funder wallets" }, "status": { "$ref": "#/components/schemas/v2SweepingInstanceStatus" }, "errorMessage": { "type": "string", "example": "Insufficient funds for transaction", "description": "Error message in case the sweep failed" }, "outgoingFee": { "type": "string", "example": "0.01", "description": "The actual outgoing fee for the sweep instance" } }, "required": [ "id", "sweepConfigurationId", "startedAt", "totalWalletsSwept", "totalSuccessfulWallets", "totalFailedWallets", "totalAmountSwept", "incomingFee", "status" ] }, "v2SweepInstanceByIDResponse": { "type": "object", "properties": { "sweepInstance": { "$ref": "#/components/schemas/v2SweepInstance" } }, "required": [ "sweepInstance" ] }, "v2SweepStatus": { "type": "string", "enum": [ "SWEEP_STATUS_ENABLED", "SWEEP_STATUS_DISABLED" ] }, "v2SweepingInstanceStatus": { "type": "string", "enum": [ "STATUS_COMPLETED", "STATUS_FAILED", "STATUS_RUNNING" ] }, "v2SyncResult": { "type": "object", "properties": { "importId": { "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000", "description": "Unique identifier for this import" }, "totalProcessed": { "type": "integer", "format": "int32", "example": 1500, "description": "Total number of assets processed" }, "newAssets": { "type": "integer", "format": "int32", "example": 50, "description": "Number of new assets created" }, "updatedAssets": { "type": "integer", "format": "int32", "example": 100, "description": "Number of existing assets updated" }, "failedAssets": { "type": "integer", "format": "int32", "example": 5, "description": "Number of assets that failed to process" }, "conflicts": { "type": "array", "items": { "$ref": "#/components/schemas/v2ConflictReport" }, "description": "List of conflicts encountered during sync" }, "startedAt": { "type": "string", "format": "date-time", "example": "2024-08-08T10:00:00.000Z", "description": "When the sync started" }, "completedAt": { "type": "string", "format": "date-time", "example": "2024-08-08T10:15:00.000Z", "description": "When the sync completed" } } }, "v2SyncWalletBalancesResponse": { "type": "object" }, "v2TimestampFilter": { "type": "object", "properties": { "eq": { "type": "string", "format": "date-time", "example": "2024-08-08T10:00:00Z", "description": "Exact timestamp match" }, "notEq": { "type": "string", "format": "date-time", "example": "2024-08-08T10:00:00Z", "description": "Not equal to timestamp" }, "before": { "type": "string", "format": "date-time", "example": "2024-08-08T10:00:00Z", "description": "Before this timestamp" }, "after": { "type": "string", "format": "date-time", "example": "2024-08-08T10:00:00Z", "description": "After this timestamp" }, "gte": { "type": "string", "format": "date-time", "example": "2024-08-08T10:00:00Z", "description": "Greater than or equal to timestamp" }, "lte": { "type": "string", "format": "date-time", "example": "2024-08-08T10:00:00Z", "description": "Less than or equal to timestamp" }, "between": { "$ref": "#/components/schemas/TimestampFilterTimestampRange" }, "isNull": { "type": "boolean", "description": "Check if field is null" }, "relativeDays": { "type": "integer", "format": "int32", "example": -7, "description": "Relative days from now (negative for past, positive for future)" } } }, "v2TransactionStatusUpdate": { "type": "object", "properties": { "tx": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2TransactionUpdatedResponse": { "type": "object", "properties": { "update": { "$ref": "#/components/schemas/v2TransactionStatusUpdate" } } }, "v2TransferTransactionResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2TriggerPasswordResetResponse": { "type": "object" }, "v2TriggerSweepConfigurationResponse": { "type": "object" }, "v2TrustOrganizationResponse": { "type": "object", "properties": { "trustedOrganization": { "$ref": "#/components/schemas/v2TrustedOrganization" } } }, "v2TrustedOrganization": { "type": "object", "properties": { "id": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The trusted organization ID" }, "name": { "type": "string", "example": "Mega Corp", "description": "The name of the trusted organization" } }, "required": [ "id", "name" ] }, "v2UnfreezeTransactionResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/transactionsv2Transaction" } } }, "v2UpdateCounterpartyResponse": { "type": "object", "properties": { "counterparty": { "$ref": "#/components/schemas/v2Counterparty" } } }, "v2UpdateCredentialActiveStatusResponse": { "type": "object", "properties": { "credential": { "$ref": "#/components/schemas/v2Credential" } }, "required": [ "credential" ] }, "v2UpdateCredentialPermissionsResponse": { "type": "object", "properties": { "credential": { "$ref": "#/components/schemas/v2Credential" } }, "required": [ "credential" ] }, "v2UpdateDeviceApprovalStatusResponse": { "type": "object", "properties": { "device": { "$ref": "#/components/schemas/v2Device" } } }, "v2UpdateDeviceDisplayNameResponse": { "type": "object", "properties": { "device": { "$ref": "#/components/schemas/v2Device" } } }, "v2UpdateDeviceEnabledStatusResponse": { "type": "object", "properties": { "device": { "$ref": "#/components/schemas/v2Device" } } }, "v2UpdateKeyApproversResponse": { "type": "object", "properties": { "approvalGroup": { "$ref": "#/components/schemas/v2ApprovalGroup" } } }, "v2UpdateOrgApproversResponse": { "type": "object", "properties": { "approvalGroup": { "$ref": "#/components/schemas/v2ApprovalGroup" } } }, "v2UpdateOrganizationAuthMethodIdpSettingsResponse": { "type": "object", "properties": { "settings": { "$ref": "#/components/schemas/v2OrganizationAuthMethodIdpSettings" } } }, "v2UpdateSweepConfigurationResponse": { "type": "object", "properties": { "sweepConfiguration": { "$ref": "#/components/schemas/v2SweepConfiguration" } }, "required": [ "sweepConfiguration" ] }, "v2UpdateUserResponse": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/v2User" } } }, "v2UpdateUserRoleResponse": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/v2User" } } }, "v2UpdateUserStatusResponse": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/v2User" } } }, "v2UpdateVaultResponse": { "type": "object", "properties": { "vault": { "$ref": "#/components/schemas/v2Vault" } } }, "v2UpdateWalletResponse": { "type": "object", "properties": { "wallet": { "$ref": "#/components/schemas/vaultv2Wallet" } } }, "v2UpdateWalletSettingsResponse": { "type": "object", "properties": { "wallet": { "$ref": "#/components/schemas/vaultv2Wallet" } } }, "v2User": { "type": "object", "properties": { "id": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The user ID" }, "organizationId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The organization ID" }, "firstName": { "type": "string", "example": "Joe", "description": "The users first name" }, "lastName": { "type": "string", "example": "Bloggs", "description": "The users last name" }, "email": { "type": "string", "example": "jbloggs@gmail.com", "description": "The users email" }, "roles": { "type": "array", "example": [ "ADMINISTRATOR" ], "items": { "$ref": "#/components/schemas/v2Role" }, "description": "The roles that the user has" }, "createdBy": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The ID of the user who created this user" }, "createdAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the user was created" }, "updatedBy": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The ID of the user who updated this user" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the user was updated" }, "status": { "$ref": "#/components/schemas/v2UserStatus" }, "blockedBy": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The ID of the user who blocked this user" }, "blockedReason": { "type": "string", "example": "Lost device", "description": "The reason the user was blocked" }, "authLoginCount": { "type": "integer", "format": "int32", "example": 10, "description": "The number of time the user has logged in" }, "authLastLogin": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the user last logged in" }, "authLastPasswordReset": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the user last reset their password" }, "authLastIp": { "type": "string", "example": "192.168.0.1", "description": "The last IP address from which this user logged in" }, "picture": { "type": "string", "example": "https://s.gravatar.com/avatar/621f114992de896519becb13976039cd?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fka.png", "description": "A link to the users gravatar image" }, "proposedFirstName": { "type": "string", "example": "Joe", "description": "The proposed first name for the user" }, "proposedUpdatedBy": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The ID of the user who proposed the update" }, "proposedLastName": { "type": "string", "example": "Bloggs", "description": "The proposed last name for the user" }, "proposedRoles": { "type": "array", "example": [ "ADMINISTRATOR" ], "items": { "$ref": "#/components/schemas/v2Role" }, "description": "The proposed roles for the user" }, "proposedBlockedReason": { "type": "string", "example": "Lost device", "description": "The proposed reason the user was blocked" } }, "required": [ "id", "organizationId", "firstName", "lastName", "email", "roles", "createdBy", "createdAt", "updatedBy", "updatedAt", "status" ] }, "v2UserAuthMethod": { "type": "object", "properties": { "id": { "type": "string", "example": "webauthn-roaming|dev_o8x1jtp0FTt7b35V", "description": "The ID of the authentication method" }, "type": { "type": "string", "example": "webauthn-roaming", "description": "The type of the authentication method" }, "name": { "type": "string", "example": "My first key", "description": "A human-readable label to identify the authentication method" }, "createdAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the authenticator was created" }, "lastAuthedAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the authenticator was last used" } }, "required": [ "id", "type", "name", "createdAt", "lastAuthedAt" ] }, "v2UserInfo": { "type": "object", "properties": { "id": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The user ID" }, "organizationId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The organization ID" }, "firstName": { "type": "string", "example": "Joe", "description": "The users first name" }, "lastName": { "type": "string", "example": "Bloggs", "description": "The users last name" }, "email": { "type": "string", "example": "jbloggs@gmail.com", "description": "The users email" } }, "required": [ "id", "organizationId", "firstName", "lastName", "email" ] }, "v2UserStatus": { "type": "string", "enum": [ "CREATED", "INVITED", "ACTIVATED", "BLOCKED", "REJECTED", "DELETED", "ERROR", "CREATION_APPROVAL_PENDING", "CREATION_APPROVAL_COMPLETE", "BLOCK_APPROVAL_PENDING", "BLOCK_APPROVAL_COMPLETE", "UNBLOCK_APPROVAL_PENDING", "UNBLOCK_APPROVAL_COMPLETE", "MODIFICATION_APPROVAL_PENDING", "MODIFICATION_APPROVAL_COMPLETE" ] }, "v2UserUpdate": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/v2User" } } }, "v2UserUpdatedResponse": { "type": "object", "properties": { "update": { "$ref": "#/components/schemas/v2UserUpdate" } } }, "v2VASPInfoSimple": { "type": "object", "properties": { "did": { "type": "string" }, "name": { "type": "string" }, "website": { "type": "string" }, "logo": { "type": "string" }, "incorporationCountry": { "type": "string" }, "documents": { "type": "string" }, "hasAdmin": { "type": "boolean" }, "isNotifiable": { "type": "boolean" }, "isActiveSender": { "type": "boolean" }, "isActiveReceiver": { "type": "boolean" }, "issuers": { "type": "string" } } }, "v2Vault": { "type": "object", "properties": { "id": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The vault ID" }, "organizationId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The organization ID" }, "createdBy": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The user ID that created the vault" }, "createdAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the vault was created" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the vault was updated" }, "name": { "type": "string", "example": "Treasury vault", "description": "The name of the vault" }, "description": { "type": "string", "example": "A vault used by the treasury department", "description": "The description of the vault" }, "externalId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "External ID of this vault, unique to the organization" }, "correlationId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "Correlation ID for the vault" } }, "required": [ "id", "organizationId", "createdBy", "createdAt", "updatedAt", "name" ] }, "v2VaultBalance": { "type": "object", "properties": { "vaultId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The vault ID that the connection is associated with" }, "aggregatedFiatValue": { "type": "string", "example": "100.00", "description": "The aggregated fiat value of the vault" } } }, "v2VaultTag": { "type": "object", "properties": { "vaultId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The vault ID" }, "tags": { "type": "array", "example": [ "Treasury vault" ], "items": { "type": "string" }, "description": "The tags belonging to the vault" } }, "required": [ "vaultId" ] }, "v2VaultWalletIdentifier": { "type": "object", "properties": { "walletId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The ID of the wallet" }, "vaultId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The ID of the vault" } }, "required": [ "walletId", "vaultId" ] }, "v2WalletBalance": { "type": "object", "properties": { "walletId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The wallet ID that the connection is associated with" }, "aggregatedFiatValue": { "type": "string", "example": "100.00", "description": "The aggregated fiat value of the wallet" } } }, "v2WalletLimit": { "type": "object", "properties": { "id": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The wallet limit policy ID" }, "createdBy": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The creator ID" }, "organizationId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The organization ID" }, "walletId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The wallet ID" }, "vaultId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The vault ID" }, "limitQty": { "type": "string", "example": "200.00", "description": "The limit quantity" }, "duration": { "type": "string", "example": "200s", "description": "The limit duration" }, "limitType": { "$ref": "#/components/schemas/v2LimitType" }, "createdAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the wallet limit policy was created" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the wallet limit policy was updated" }, "asset": { "$ref": "#/components/schemas/commonv2Asset" }, "matchers": { "type": "array", "items": { "$ref": "#/components/schemas/v2Matcher" } }, "status": { "$ref": "#/components/schemas/v2WalletLimitStatus" }, "active": { "type": "boolean", "example": true, "description": "Whether the limit is active" }, "blockchain": { "$ref": "#/components/schemas/v2Blockchain" } }, "required": [ "id", "createdBy", "organizationId", "walletId", "vaultId", "limitType", "createdAt", "updatedAt", "asset", "status", "active" ] }, "v2WalletLimitStatus": { "type": "string", "enum": [ "LIMIT_CREATED", "LIMIT_ENABLED", "LIMIT_REJECTED", "LIMIT_DELETED", "LIMIT_ERROR", "LIMIT_CREATION_APPROVAL_PENDING", "LIMIT_CREATION_APPROVAL_COMPLETE", "LIMIT_DELETION_APPROVAL_PENDING", "LIMIT_DELETION_APPROVAL_COMPLETE" ] }, "v2WalletLimitUpdate": { "type": "object", "properties": { "limit": { "$ref": "#/components/schemas/v2WalletLimit" } } }, "v2WalletLimitUpdatedResponse": { "type": "object", "properties": { "update": { "$ref": "#/components/schemas/v2WalletLimitUpdate" } } }, "v2WalletMetadata": { "type": "object", "properties": { "organizationId": { "type": "string" }, "vaultId": { "type": "string" }, "keyId": { "type": "string" }, "address": { "type": "string" }, "blockchain": { "$ref": "#/components/schemas/v2Blockchain" }, "alias": { "type": "string" } }, "required": [ "blockchain" ] }, "v2WalletSettings": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": "true", "description": "Whether the wallet is enabled or not" }, "rawSigningEnabled": { "type": "boolean", "example": "true", "description": "Whether raw signing is enabled for the wallet" }, "sweepingEnabled": { "type": "boolean", "example": "true", "description": "Whether sweeping is enabled for the wallet" }, "defaultFreezeEnabled": { "type": "boolean", "example": "true", "description": "Whether to freeze inbound transactions by default" } }, "required": [ "enabled", "rawSigningEnabled", "sweepingEnabled", "defaultFreezeEnabled" ] }, "v2WalletStatusUpdate": { "type": "object", "properties": { "wallet": { "$ref": "#/components/schemas/vaultv2Wallet" } } }, "v2WalletTag": { "type": "object", "properties": { "walletId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The wallet ID" }, "vaultId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The vault ID" }, "tags": { "type": "array", "example": [ "Issuing wallet" ], "items": { "type": "string" }, "description": "The tags belonging to the wallet" } }, "required": [ "walletId", "vaultId" ] }, "v2WalletUpdatedResponse": { "type": "object", "properties": { "update": { "$ref": "#/components/schemas/v2WalletStatusUpdate" } } }, "v2Webhook": { "type": "object", "properties": { "id": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The webhook ID." }, "organizationId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The organization ID" }, "createdBy": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The ID of the user who created this webhook" }, "createdAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the webhook was created" }, "updatedBy": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The ID of the user who updated this webhook" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the webhook was updated" }, "name": { "type": "string", "example": "Palisade Transactions", "description": "The webhook name" }, "description": { "type": "string", "example": "A webhook used to monitor transactions", "description": "The webhook description" }, "endpoint": { "type": "string", "example": "https://palisade.co/webhook", "description": "The webhook endpoint to send data to" }, "subscriptionCount": { "type": "integer", "format": "int32", "example": 5, "description": "The number of subscriptions associated with the webhook" }, "publicKey": { "type": "string", "example": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEpHiEkdd/ba5dU4sNCgsWrMOE6fLakHywl0OgF5aVfxkiqNh22oybRAREev7jvnwH4jqitHx79KGi6CMwiJjmaw==", "description": "The public key used to verify the webhook signature" }, "lastSuccess": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The timestamp of the last successful webhook delivery" }, "lastFailure": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The timestamp of the last failed webhook delivery" }, "successCount": { "type": "integer", "format": "int32", "example": 42, "description": "The number of successful webhook deliveries in the last hour" }, "failureCount": { "type": "integer", "format": "int32", "example": 3, "description": "The number of failed webhook deliveries in the last hour" } }, "required": [ "id", "organizationId", "createdBy", "createdAt", "updatedBy", "updatedAt", "name", "endpoint", "subscriptionCount", "publicKey", "successCount", "failureCount" ] }, "v2XRPTransactionConfig": { "type": "object", "properties": { "sourceTag": { "type": "string", "example": "123456", "description": "The source tag for XRP transactions" }, "destinationTag": { "type": "string", "example": "123456", "description": "The destination tag for XRP transactions" } } }, "vaultv2GetWalletResponse": { "type": "object", "properties": { "wallet": { "$ref": "#/components/schemas/vaultv2Wallet" } } }, "vaultv2Wallet": { "type": "object", "properties": { "id": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The wallet ID" }, "vaultId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The vault ID" }, "organizationId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The organization ID" }, "quorumId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The quorum ID" }, "createdBy": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "The user ID that created the wallet" }, "createdAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the wallet was created" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2022-03-29T10:22:22.420Z", "description": "The date and time the wallet was update" }, "name": { "type": "string", "example": "USD Issuing wallet", "description": "The name of the wallet" }, "description": { "type": "string", "example": "Main USD issuing account used internally", "description": "The description of the wallet" }, "address": { "type": "string", "example": "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4", "description": "The address of the wallet" }, "publicKey": { "type": "string", "example": "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4", "description": "The public key of the wallet" }, "keystore": { "$ref": "#/components/schemas/v2Keystore" }, "blockchain": { "$ref": "#/components/schemas/v2Blockchain" }, "settings": { "$ref": "#/components/schemas/v2WalletSettings" }, "status": { "$ref": "#/components/schemas/vaultv2WalletStatus" }, "reasons": { "type": "array", "example": [ "MPC session timed out" ], "items": { "type": "string" }, "description": "The reasons why the wallet may have failed to provision" }, "passkeyPublic": { "type": "string", "format": "byte" }, "alias": { "type": "string", "example": "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4", "description": "The alias of the wallet" }, "externalId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "External ID of this wallet, unique to the organization" }, "correlationId": { "type": "string", "example": "ce4918bf-a199-4ce2-85a3-d0d296855384", "description": "Correlation ID for the wallet" }, "keyAlgorithm": { "$ref": "#/components/schemas/v2KeyAlgorithm" } }, "required": [ "id", "vaultId", "organizationId", "createdBy", "createdAt", "updatedAt", "name", "keystore", "blockchain", "settings", "status", "keyAlgorithm" ] }, "vaultv2WalletStatus": { "type": "string", "enum": [ "CREATED", "PROVISIONING", "PROVISIONED_WALLET", "PROVISIONING_POLICY", "PROVISIONING_COMPLIANCE", "PROVISIONED_COMPLIANCE", "PROVISIONED", "PROVISIONING_FAILED" ] }, "xrpv2AMMDepositFlag": { "type": "string", "enum": [ "DEPOSIT_LP_TOKEN", "DEPOSIT_SINGLE_ASSET", "DEPOSIT_TWO_ASSET", "DEPOSIT_ONE_ASSET_LP_TOKEN", "DEPOSIT_LIMIT_LP_TOKEN", "DEPOSIT_TWO_ASSET_IF_EMPTY" ] }, "xrpv2AMMWithdrawFlag": { "type": "string", "enum": [ "WITHDRAW_LP_TOKEN", "WITHDRAW_WITHDRAW_ALL", "WITHDRAW_ONE_ASSET_WITHDRAW_ALL", "WITHDRAW_SINGLE_ASSET", "WITHDRAW_TWO_ASSET", "WITHDRAW_ONE_ASSET_LP_TOKEN", "WITHDRAW_LIMIT_LP_TOKEN" ] }, "xrpv2AccountSetFlag": { "type": "string", "enum": [ "ACCOUNT_TXN_ID", "ALLOW_TRUSTLINE_CLAWBACK", "AUTHZ_NFTOKEN_MINTER", "DEFAULT_RIPPLE", "DEPOSIT_AUTH", "DISABLE_MASTER", "DISALLOW_INCOMING_CHECK", "DISALLOW_INCOMING_PAY_CHAN", "DISALLOW_INCOMING_TRUSTLINE", "DISALLOW_XRP", "GLOBAL_FREEZE", "NO_FREEZE", "REQUIRE_AUTH", "REQUIRE_DEST" ] }, "xrpv2Asset": { "type": "object", "properties": { "asset": { "type": "string", "example": "USD", "description": "The asset symbol" }, "issuer": { "type": "string", "example": "0xdAC17F958D2ee523a2206206994597C13D831ec7", "description": "The contract/issuing address. Optional if asset is XRP." } }, "required": [ "asset" ] }, "xrpv2CurrencyAmount": { "type": "object", "properties": { "value": { "type": "string", "example": "155.672", "description": "The quantity of the asset" }, "asset": { "type": "string", "example": "USD", "description": "The asset symbol" }, "issuer": { "type": "string", "example": "0xdAC17F958D2ee523a2206206994597C13D831ec7", "description": "The contract/issuing address. Optional if asset is XRP." } }, "required": [ "value", "asset" ] }, "xrpv2OfferCreateFlags": { "type": "string", "enum": [ "PASSIVE", "IMMEDIATE_OR_CANCEL", "FILL_OR_KILL", "SELL" ] }, "xrpv2SignerEntry": { "type": "object", "properties": { "account": { "type": "string" }, "signerWeight": { "type": "integer", "format": "int64" } } }, "xrpv2TrustSetFlag": { "type": "string", "enum": [ "SETF_AUTH", "SET_NORIPPLE", "UNSET_NORIPPLE", "SET_FREEZE", "UNSET_FREEZE", "SET_DEEP_FREEZE", "UNSET_DEEP_FREEZE" ] } } }, "servers": [ { "url": "https://api.sandbox.palisade.co", "description": "Sandbox server (uses TESTNET data, private keys and accounts)" }, { "url": "https://api.palisade.co", "description": "Palisade server (uses MAINNET data, private keys and accounts)" } ] }