{ "openapi": "3.0.1", "info": { "title": "Ripple Custody API", "version": "", "x-logo": { "url": "images/ripple-custody.png", "altText": "Ripple Custody logo" }, "x-app-version": "1.27.0" }, "paths": { "/v1/backups/{backupId}": { "get": { "tags": [ "Backups" ], "summary": "Get Backup information", "operationId": "getBackup", "parameters": [ { "name": "backupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ApiBackup" } } } }, "400": { "description": "Invalid value for: path parameter backupId", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/backups": { "get": { "tags": [ "Backups" ], "summary": "List Backups", "operationId": "getBackups", "parameters": [ { "name": "limit", "in": "query", "description": "The number of entities to return.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "description": "Entity id used to the determine beginning of query results.", "schema": { "type": "string", "format": "uuid" } }, { "name": "sortBy", "in": "query", "description": "Property name used to sort the query results.", "schema": { "enum": [ "id", "alias", "metadata.createdAt", "metadata.lastModifiedAt" ], "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sort order applied to the query results.", "schema": { "$ref": "#/components/schemas/Core_SortOrder" } }, { "name": "vaultId", "in": "query", "description": "Return entities matching given vault id.", "schema": { "type": "string", "format": "uuid" }, "example": "8e92eb53-40e7-4809-bb52-7e7b3b41a4be" }, { "name": "lastOnly", "in": "query", "description": "Return entities with acknowledged status and limits results to latest one.", "schema": { "type": "boolean" }, "example": "true" }, { "name": "acknowledged", "in": "query", "description": "Return entities with acknowledged status equals true.", "schema": { "type": "boolean" }, "example": "true" }, { "name": "data.type", "in": "query", "description": "Return entities that matches given type.", "schema": { "$ref": "#/components/schemas/Core_BackupType" }, "example": "VaultMpc" }, { "name": "metadata.createdBy", "in": "query", "description": "Return entities that were created by matching user.", "schema": { "type": "string", "format": "uuid" }, "example": "fdeeeb4b-f987-4ec4-9880-1eb280581d49" }, { "name": "metadata.lastModifiedBy", "in": "query", "description": "Return entities that were last modified by matching user.", "schema": { "type": "string", "format": "uuid" }, "example": "90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b" }, { "name": "metadata.description", "in": "query", "description": "Return entities with descriptions that contains or equals to provided description.", "schema": { "minLength": 0, "type": "string" }, "example": "description1" }, { "name": "metadata.customProperties", "in": "query", "description": "Return entities that contains provided custom properties.", "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "key1:value1", "key2:value2" ] }, { "name": "additionalDetails.processingStatus", "in": "query", "description": "Return entities matching given processing status.", "schema": { "$ref": "#/components/schemas/Core_BackupProcessingStatus" }, "example": "Pending" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_BackupsCollection" } } } }, "400": { "description": "Invalid value for: query parameter limit, Invalid value for: query parameter startingAfter, Invalid value for: query parameter sortBy, Invalid value for: query parameter sortOrder, Invalid value for: query parameter vaultId, Invalid value for: query parameter lastOnly, Invalid value for: query parameter acknowledged, Invalid value for: query parameter data.type, Invalid value for: query parameter metadata.createdBy, Invalid value for: query parameter metadata.lastModifiedBy, Invalid value for: query parameter metadata.description, Invalid value for: query parameter metadata.customProperties, Invalid value for: query parameter additionalDetails.processingStatus", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/backups/{backupId}/trusted-entity": { "get": { "tags": [ "Backups" ], "summary": "Get Backup trusted entity details", "operationId": "getBackupTrustedEntity", "parameters": [ { "name": "backupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ApiTrustedBackup" } } } }, "400": { "description": "Invalid value for: path parameter backupId", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}": { "get": { "tags": [ "Domains" ], "summary": "Get domain details", "operationId": "getDomain", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_TrustedDomain" } } } }, "400": { "description": "Invalid value for: path parameter domainId", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains": { "get": { "tags": [ "Domains" ], "summary": "List domains", "operationId": "getDomains", "parameters": [ { "name": "limit", "in": "query", "description": "The number of entities to return.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "description": "Entity id used to the determine beginning of query results.", "schema": { "type": "string", "format": "uuid" } }, { "name": "sortBy", "in": "query", "description": "Property name used to sort the query results.", "schema": { "enum": [ "id", "parentId", "alias", "lock", "metadata.createdAt", "metadata.lastModifiedAt" ], "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sort order applied to the query results.", "schema": { "$ref": "#/components/schemas/Core_SortOrder" } }, { "name": "parentId", "in": "query", "description": "Filter domains based on given parent/root id.", "schema": { "type": "string", "format": "uuid" }, "example": "8e92eb53-40e7-4809-bb52-7e7b3b41a4be" }, { "name": "alias", "in": "query", "description": "Return entities with aliases that contains or equals to provided alias.", "schema": { "minLength": 1, "type": "string" }, "example": "alias1" }, { "name": "metadata.createdBy", "in": "query", "description": "Return entities that were created by matching user.", "schema": { "type": "string", "format": "uuid" }, "example": "fdeeeb4b-f987-4ec4-9880-1eb280581d49" }, { "name": "metadata.lastModifiedBy", "in": "query", "description": "Return entities that were last modified by matching user.", "schema": { "type": "string", "format": "uuid" }, "example": "90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b" }, { "name": "metadata.description", "in": "query", "description": "Return entities with descriptions that contains or equals to provided description.", "schema": { "minLength": 0, "type": "string" }, "example": "description1" }, { "name": "metadata.customProperties", "in": "query", "description": "Return entities that contains provided custom properties.", "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "key1:value1", "key2:value2" ] }, { "name": "lock", "in": "query", "description": "Return entities matching given lock status.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Core_LockStatus" } }, "example": [ "Locked", "Unlocked" ] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_TrustedDomainsCollection" } } } }, "400": { "description": "Invalid value for: query parameter limit, Invalid value for: query parameter startingAfter, Invalid value for: query parameter sortBy, Invalid value for: query parameter sortOrder, Invalid value for: query parameter parentId, Invalid value for: query parameter alias, Invalid value for: query parameter metadata.createdBy, Invalid value for: query parameter metadata.lastModifiedBy, Invalid value for: query parameter metadata.description, Invalid value for: query parameter metadata.customProperties, Invalid value for: query parameter lock", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/vaults": { "get": { "tags": [ "Vaults" ], "summary": "List vaults", "operationId": "getVaults", "parameters": [ { "name": "limit", "in": "query", "description": "The number of entities to return.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "description": "Entity id used to the determine beginning of query results.", "schema": { "type": "string", "format": "uuid" } }, { "name": "sortBy", "in": "query", "description": "Property name used to sort the query results.", "schema": { "enum": [ "id", "alias", "lock", "metadata.createdAt", "metadata.lastModifiedAt" ], "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sort order applied to the query results.", "schema": { "$ref": "#/components/schemas/Core_SortOrder" } }, { "name": "alias", "in": "query", "description": "Return entities with aliases that contains or equals to provided alias.", "schema": { "minLength": 1, "type": "string" }, "example": "alias1" }, { "name": "publicKey", "in": "query", "description": "Return entities matching given public key. It should be provided in Base64 format.", "schema": { "minLength": 1, "type": "string" }, "example": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAENYOHIq0Pgg5ERTQOahVK3I45+efvsRvw1rcyk+oqpnj7qkXSEis3BbgnwBY42uolGg7lPbusmAMWVDYRqKMApQ==" }, { "name": "lock", "in": "query", "description": "Return entities matching given lock status.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Core_LockStatus" } }, "example": [ "Locked", "Unlocked" ] }, { "name": "metadata.createdBy", "in": "query", "description": "Return entities that were created by matching user.", "schema": { "type": "string", "format": "uuid" }, "example": "fdeeeb4b-f987-4ec4-9880-1eb280581d49" }, { "name": "metadata.lastModifiedBy", "in": "query", "description": "Return entities that were last modified by matching user.", "schema": { "type": "string", "format": "uuid" }, "example": "90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b" }, { "name": "metadata.description", "in": "query", "description": "Return entities with descriptions that contains or equals to provided description.", "schema": { "minLength": 0, "type": "string" }, "example": "description1" }, { "name": "metadata.customProperties", "in": "query", "description": "Return entities that contains provided custom properties.", "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "key1:value1", "key2:value2" ] }, { "name": "additionalDetails.processingStatus", "in": "query", "description": "Return entities matching given processing status.", "schema": { "$ref": "#/components/schemas/Core_VaultProcessingStatus" }, "example": "Pending" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_VaultsCollection" } } } }, "400": { "description": "Invalid value for: query parameter limit, Invalid value for: query parameter startingAfter, Invalid value for: query parameter sortBy, Invalid value for: query parameter sortOrder, Invalid value for: query parameter alias, Invalid value for: query parameter publicKey, Invalid value for: query parameter lock, Invalid value for: query parameter metadata.createdBy, Invalid value for: query parameter metadata.lastModifiedBy, Invalid value for: query parameter metadata.description, Invalid value for: query parameter metadata.customProperties, Invalid value for: query parameter additionalDetails.processingStatus", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/vaults/{vaultId}": { "get": { "tags": [ "Vaults" ], "summary": "Get vault details", "operationId": "getVault", "parameters": [ { "name": "vaultId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ApiVault" } } } }, "400": { "description": "Invalid value for: path parameter vaultId", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/policies": { "get": { "tags": [ "Policies" ], "summary": "List policies", "operationId": "getPolicies", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "description": "The number of entities to return.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "description": "Entity id used to the determine beginning of query results.", "schema": { "type": "string", "format": "uuid" } }, { "name": "sortBy", "in": "query", "description": "Property name used to sort the query results.", "schema": { "enum": [ "id", "alias", "rank", "scope", "lock", "metadata.createdAt", "metadata.lastModifiedAt" ], "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sort order applied to the query results.", "schema": { "$ref": "#/components/schemas/Core_SortOrder" } }, { "name": "alias", "in": "query", "description": "Return entities with aliases that contains or equals to provided alias.", "schema": { "minLength": 1, "type": "string" }, "example": "alias1" }, { "name": "intentTypes", "in": "query", "description": "Return entities matching any of given intent types.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Core_IntentType" } }, "example": [ "v0_UnlockPolicy", "v0_UpdatePolicy" ] }, { "name": "scope", "in": "query", "description": "Return entities matching given policy scope.", "schema": { "$ref": "#/components/schemas/Core_PolicyScope" }, "example": "Descendants" }, { "name": "scriptingEngine", "in": "query", "description": "Return entities matching given scripting engine.", "schema": { "$ref": "#/components/schemas/Core_ScriptingEngine" }, "example": "Javascript_v0" }, { "name": "metadata.createdBy", "in": "query", "description": "Return entities that were created by matching user.", "schema": { "type": "string", "format": "uuid" }, "example": "fdeeeb4b-f987-4ec4-9880-1eb280581d49" }, { "name": "metadata.lastModifiedBy", "in": "query", "description": "Return entities that were last modified by matching user.", "schema": { "type": "string", "format": "uuid" }, "example": "90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b" }, { "name": "metadata.description", "in": "query", "description": "Return entities with descriptions that contains or equals to provided description.", "schema": { "minLength": 0, "type": "string" }, "example": "description1" }, { "name": "metadata.customProperties", "in": "query", "description": "Return entities that contains provided custom properties.", "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "key1:value1", "key2:value2" ] }, { "name": "lock", "in": "query", "description": "Return entities matching given lock status.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Core_LockStatus" } }, "example": [ "Locked", "Unlocked" ] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_TrustedPoliciesCollection" } } } }, "400": { "description": "Invalid value for: path parameter domainId, Invalid value for: query parameter limit, Invalid value for: query parameter startingAfter, Invalid value for: query parameter sortBy, Invalid value for: query parameter sortOrder, Invalid value for: query parameter alias, Invalid value for: query parameter intentTypes, Invalid value for: query parameter scope, Invalid value for: query parameter scriptingEngine, Invalid value for: query parameter metadata.createdBy, Invalid value for: query parameter metadata.lastModifiedBy, Invalid value for: query parameter metadata.description, Invalid value for: query parameter metadata.customProperties, Invalid value for: query parameter lock", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/policies/{policyId}": { "get": { "tags": [ "Policies" ], "summary": "Get policy details", "operationId": "getPolicy", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_TrustedPolicy" } } } }, "400": { "description": "Invalid value for: path parameter domainId, Invalid value for: path parameter policyId", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/users": { "get": { "tags": [ "Users" ], "summary": "List users", "operationId": "getUsers", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "description": "The number of entities to return.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "description": "Entity id used to the determine beginning of query results.", "schema": { "type": "string", "format": "uuid" } }, { "name": "sortBy", "in": "query", "description": "Property name used to sort the query results.", "schema": { "enum": [ "id", "alias", "lock", "metadata.createdAt", "metadata.lastModifiedAt" ], "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sort order applied to the query results.", "schema": { "$ref": "#/components/schemas/Core_SortOrder" } }, { "name": "alias", "in": "query", "description": "Return entities matching given alias.", "schema": { "minLength": 1, "type": "string" }, "example": "alias1" }, { "name": "publicKey", "in": "query", "description": "Return entities matching given public key. It should be provided in Base64 format.", "schema": { "minLength": 1, "type": "string" }, "example": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAENYOHIq0Pgg5ERTQOahVK3I45+efvsRvw1rcyk+oqpnj7qkXSEis3BbgnwBY42uolGg7lPbusmAMWVDYRqKMApQ==" }, { "name": "roles", "in": "query", "description": "Return entities that are assigned to roles.", "deprecated": true, "schema": { "type": "array", "items": { "minLength": 1, "type": "string" } }, "example": [ "admin", "testUser" ] }, { "name": "roles[]", "in": "query", "description": "Return entities that are assigned to at least all the roles provided in the array.", "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "admin,testUser", "editor" ] }, { "name": "lock", "in": "query", "description": "Return entities matching given lock status.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Core_LockStatus" } }, "example": [ "Locked", "Unlocked" ] }, { "name": "metadata.createdBy", "in": "query", "description": "Return entities that were created by matching user.", "schema": { "type": "string", "format": "uuid" }, "example": "fdeeeb4b-f987-4ec4-9880-1eb280581d49" }, { "name": "metadata.lastModifiedBy", "in": "query", "description": "Return entities that were last modified by matching user.", "schema": { "type": "string", "format": "uuid" }, "example": "90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b" }, { "name": "metadata.description", "in": "query", "description": "Return entities with descriptions that contains or equals to provided description.", "schema": { "minLength": 0, "type": "string" }, "example": "description1" }, { "name": "metadata.customProperties", "in": "query", "description": "Return entities that contains provided custom properties.", "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "key1:value1", "key2:value2" ] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_TrustedUsersCollection" } } } }, "400": { "description": "Invalid value for: path parameter domainId, Invalid value for: query parameter limit, Invalid value for: query parameter startingAfter, Invalid value for: query parameter sortBy, Invalid value for: query parameter sortOrder, Invalid value for: query parameter alias, Invalid value for: query parameter publicKey, Invalid value for: query parameter roles, Invalid value for: query parameter roles[], Invalid value for: query parameter lock, Invalid value for: query parameter metadata.createdBy, Invalid value for: query parameter metadata.lastModifiedBy, Invalid value for: query parameter metadata.description, Invalid value for: query parameter metadata.customProperties", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/users/roles": { "get": { "tags": [ "Users" ], "summary": "Get known users roles", "operationId": "getKnownUserRoles", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ApiRoles" } } } }, "400": { "description": "Invalid value for: path parameter domainId", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/users/{userId}": { "get": { "tags": [ "Users" ], "summary": "Get user details", "operationId": "getUser", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_TrustedUser" } } } }, "400": { "description": "Invalid value for: path parameter domainId, Invalid value for: path parameter userId", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/me": { "get": { "tags": [ "Users" ], "summary": "List users belonging to the same public key", "operationId": "getMe", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_MeReference" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError); User not authorized (UnauthorizedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/accounts": { "get": { "tags": [ "Accounts" ], "summary": "List accounts", "operationId": "getAccounts", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "description": "The number of entities to return.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "description": "Entity id used to the determine beginning of query results.", "schema": { "type": "string", "format": "uuid" } }, { "name": "sortBy", "in": "query", "description": "Property name used to sort the query results.", "schema": { "enum": [ "id", "alias", "ledgerId", "lock", "metadata.createdAt", "metadata.lastModifiedAt" ], "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sort order applied to the query results.", "schema": { "$ref": "#/components/schemas/Core_SortOrder" } }, { "name": "ledgerId", "in": "query", "description": "Return entities matching given default ledger id.", "schema": { "minLength": 1, "type": "string" }, "example": "1234567" }, { "name": "alias", "in": "query", "description": "Return entities with aliases that contains or equals to provided alias.", "schema": { "minLength": 1, "type": "string" }, "example": "alias1" }, { "name": "providerDetails.vaultId", "in": "query", "description": "Return entities matching given vault id.", "schema": { "type": "string", "format": "uuid" }, "example": "8e92eb53-40e7-4809-bb52-7e7b3b41a4be" }, { "name": "metadata.createdBy", "in": "query", "description": "Return entities that were created by matching user.", "schema": { "type": "string", "format": "uuid" }, "example": "fdeeeb4b-f987-4ec4-9880-1eb280581d49" }, { "name": "metadata.lastModifiedBy", "in": "query", "description": "Return entities that were last modified by matching user.", "schema": { "type": "string", "format": "uuid" }, "example": "90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b" }, { "name": "metadata.description", "in": "query", "description": "Return entities with descriptions that contains or equals to provided description.", "schema": { "minLength": 0, "type": "string" }, "example": "description1" }, { "name": "metadata.customProperties", "in": "query", "description": "Return entities that contains provided custom properties.", "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "key1:value1", "key2:value2" ] }, { "name": "lock", "in": "query", "description": "Return entities matching given lock status(/-es).", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Core_LockStatus" } }, "example": [ "Locked", "Archived" ] }, { "name": "additionalDetails.processingStatus", "in": "query", "description": "Return entities matching given processing status.", "deprecated": true, "schema": { "$ref": "#/components/schemas/Core_AccountProcessingStatus" }, "example": "Completed" }, { "name": "additionalDetails.ledgers.ledgerId", "in": "query", "description": "Return entities given ledger id.", "schema": { "type": "array", "items": { "minLength": 1, "type": "string" } }, "example": [ "bitcoin", "bitcoin-testnet" ] }, { "name": "additionalDetails.ledgers.status", "in": "query", "description": "Return entities having a ledger matching given status.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Core_AccountLedgerStatus" } }, "example": [ "Activating", "Activated" ] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_AccountsCollection" } } } }, "400": { "description": "One of: Domain locked (DomainLockedError); Requester locked (RequesterLockedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/addresses": { "get": { "tags": [ "Accounts" ], "summary": "Get address from all generated addresses across domains", "operationId": "getAllDomainsAddresses", "parameters": [ { "name": "address", "in": "query", "description": "Address required and only one for getting entities matching this address.", "required": true, "schema": { "minLength": 1, "type": "string" }, "example": "someLedgerAddress" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_AddressReferenceCollection" } } } }, "400": { "description": "Invalid value for: query parameter address", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/accounts/{accountId}": { "get": { "tags": [ "Accounts" ], "summary": "Get account details", "operationId": "getAccount", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ApiAccount" } } } }, "400": { "description": "One of: Domain locked (DomainLockedError); Requester locked (RequesterLockedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/accounts/{accountId}/addresses": { "get": { "tags": [ "Accounts" ], "summary": "Retrieve all generated addresses", "operationId": "getAddresses", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "description": "The number of entities to return.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "description": "AccountAddressId id used to the determine beginning of query results.", "schema": { "type": "string", "format": "uuid" } }, { "name": "sortBy", "in": "query", "description": "Property name used to sort the query results.", "schema": { "enum": [ "id", "ledgerId", "address", "createdAt", "scope" ], "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sort order applied to the query results.", "schema": { "$ref": "#/components/schemas/Core_SortOrder" } }, { "name": "ledgerId", "in": "query", "description": "Return addresses matching given ledgers.", "schema": { "type": "array", "items": { "minLength": 1, "type": "string" } }, "example": [ "1234567", "abcdefg" ] }, { "name": "lastOnly", "in": "query", "description": "Return only last addresses for matching ledgers.", "schema": { "type": "boolean" }, "example": "true" }, { "name": "scope", "in": "query", "description": "Return addresses matching given scopes.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Core_AccountAddressScope" } }, "example": [ "External" ] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_AddressesCollection" } } } }, "400": { "description": "One of: Domain locked (DomainLockedError); Requester locked (RequesterLockedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "409": { "description": "One of: Account not processed (AccountNotProcessed); Account not ready yet (AccountNotReady)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] }, "post": { "tags": [ "Accounts" ], "summary": "Generate new account external address", "operationId": "generateNewExternalAddressDeprecated", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ledgerId", "in": "query", "description": "Return entities matching given ledger id.", "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_AccountAddress" } } } }, "400": { "description": "One of: Domain locked (DomainLockedError); Requester locked (RequesterLockedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "409": { "description": "One of: Account new addresses exhausted (AccountAddressesExhausted); Account not processed (AccountNotProcessed); Account not ready yet (AccountNotReady)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "deprecated": true, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/accounts/{accountId}/addresses/{ledgerId}": { "post": { "tags": [ "Accounts" ], "summary": "Generate new account external address", "operationId": "generateNewExternalAddress", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ledgerId", "in": "path", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_AccountAddress" } } } }, "400": { "description": "One of: Domain locked (DomainLockedError); Requester locked (RequesterLockedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "409": { "description": "One of: Account new addresses exhausted (AccountAddressesExhausted); Account not processed (AccountNotProcessed); Account not ready yet (AccountNotReady)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/accounts/{accountId}/addresses/latest": { "get": { "tags": [ "Accounts" ], "summary": "Retrieve latest external address", "operationId": "getLatestAddress", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ledgerId", "in": "query", "description": "Return entities matching given ledger id.", "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_AccountAddress" } } } }, "400": { "description": "One of: Domain locked (DomainLockedError); Requester locked (RequesterLockedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "deprecated": true, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/accounts/{accountId}/addresses/{accountAddressId}": { "get": { "tags": [ "Accounts" ], "summary": "Retrieve account address", "operationId": "getAccountAddress", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountAddressId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_AccountAddress" } } } }, "400": { "description": "One of: Domain locked (DomainLockedError); Requester locked (RequesterLockedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "409": { "description": "One of: Account not processed (AccountNotProcessed); Account not ready yet (AccountNotReady)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/accounts/{accountId}/confirmed-balance/{tickerId}": { "get": { "tags": [ "Accounts" ], "summary": "Get account confirmed balance for a specific ticker", "operationId": "getAccountConfirmedBalance", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "tickerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_BalanceWithConfirmedAmount" } } } }, "400": { "description": "Balance not found (BalanceNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "deprecated": true, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/accounts/{accountId}/balances": { "get": { "tags": [ "Accounts" ], "summary": "Get account balances", "operationId": "getAccountBalances", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "description": "The number of entities to return.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "description": "Ticker id used to the determine beginning of query results.", "schema": { "type": "string", "format": "uuid" } }, { "name": "sortBy", "in": "query", "description": "Property name used to sort the query results.", "schema": { "enum": [ "id", "tickerId", "totalAmount", "reservedAmount", "quarantinedAmount", "lastUpdatedAt" ], "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sort order applied to the query results.", "schema": { "$ref": "#/components/schemas/Core_SortOrder" } }, { "name": "ticker.id", "in": "query", "description": "Return balances of tickers with this id for the account.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "example": [ "4e066dff-e2aa-45ec-9398-1140e9aa98d9", "f0390b50-1abd-47df-9580-b69a1298226a" ] }, { "name": "ticker.name", "in": "query", "description": "Return balances of tickers with this name for the account.", "schema": { "type": "array", "items": { "minLength": 1, "type": "string" } }, "example": [ "mati", "nft" ] }, { "name": "ticker.symbol", "in": "query", "description": "Return balances of tickers with this symbol for the account.", "schema": { "type": "array", "items": { "minLength": 1, "type": "string" } }, "example": [ "btc", "doge" ] }, { "name": "ticker.ledgerId", "in": "query", "description": "Return balances matching given ledger ids.", "schema": { "type": "array", "items": { "minLength": 1, "type": "string" } }, "example": [ "bitcoin", "bitcoin-testnet" ] }, { "name": "ticker.validationStatus", "in": "query", "description": "Return transfers with ticker matching the requested validation status", "schema": { "$ref": "#/components/schemas/Core_TickerValidationStatusFilter" }, "example": "Validated" }, { "name": "ticker.lock", "in": "query", "description": "Return transfers with ticker matching given lock status.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Core_LockStatus" } }, "example": [ "Locked", "Archived" ] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_BalancesCollection" } } } }, "400": { "description": "One of: Domain locked (DomainLockedError); Requester locked (RequesterLockedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "409": { "description": "One of: Account not processed (AccountNotProcessed); Account not ready yet (AccountNotReady)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/accounts/{accountId}/balances/refresh": { "post": { "tags": [ "Accounts" ], "summary": "Update account balances forcefully", "operationId": "forceUpdateAccountBalances", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ledgerId", "in": "query", "description": "Updates only balances with the given ledger id. Reduces execution time.", "schema": { "minLength": 1, "type": "string" } }, { "name": "tickerId", "in": "query", "description": "Updates only balances with the given ticker id. Reduces execution time.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "" }, "400": { "description": "One of: Domain locked (DomainLockedError); Requester locked (RequesterLockedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "409": { "description": "One of: Account not processed (AccountNotProcessed); Account not ready yet (AccountNotReady)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/endpoints": { "get": { "tags": [ "Endpoints" ], "summary": "List endpoints", "operationId": "getEndpoints", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "description": "The number of entities to return.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "description": "Entity id used to the determine beginning of query results.", "schema": { "type": "string", "format": "uuid" } }, { "name": "sortBy", "in": "query", "description": "Property name used to sort the query results.", "schema": { "enum": [ "id", "alias", "address", "ledgerId", "trustScore", "lock", "metadata.createdAt", "metadata.lastModifiedAt" ], "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sort order applied to the query results.", "schema": { "$ref": "#/components/schemas/Core_SortOrder" } }, { "name": "ledgerId", "in": "query", "description": "Return entities matching given ledger id.", "schema": { "type": "array", "items": { "minLength": 1, "type": "string" } }, "example": [ "45671234" ] }, { "name": "alias", "in": "query", "description": "Return entities with aliases that contains or equals to provided alias.", "schema": { "minLength": 1, "type": "string" }, "example": "alias1" }, { "name": "address", "in": "query", "description": "Return entities matching given alias.", "schema": { "type": "array", "items": { "minLength": 1, "type": "string" } }, "example": [ "someLedgerAddress" ] }, { "name": "metadata.createdBy", "in": "query", "description": "Return entities that were created by matching user.", "schema": { "type": "string", "format": "uuid" }, "example": "fdeeeb4b-f987-4ec4-9880-1eb280581d49" }, { "name": "metadata.lastModifiedBy", "in": "query", "description": "Return entities that were last modified by matching user.", "schema": { "type": "string", "format": "uuid" }, "example": "90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b" }, { "name": "metadata.description", "in": "query", "description": "Return entities with descriptions that contains or equals to provided description.", "schema": { "minLength": 0, "type": "string" }, "example": "description1" }, { "name": "metadata.customProperties", "in": "query", "description": "Return entities that contains provided custom properties.", "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "key1:value1", "key2:value2" ] }, { "name": "lock", "in": "query", "description": "Return entities matching given lock status.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Core_LockStatus" } }, "example": [ "Locked", "Unlocked" ] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_TrustedEndpointsCollection" } } } }, "400": { "description": "Invalid value for: path parameter domainId, Invalid value for: query parameter limit, Invalid value for: query parameter startingAfter, Invalid value for: query parameter sortBy, Invalid value for: query parameter sortOrder, Invalid value for: query parameter ledgerId, Invalid value for: query parameter alias, Invalid value for: query parameter address, Invalid value for: query parameter metadata.createdBy, Invalid value for: query parameter metadata.lastModifiedBy, Invalid value for: query parameter metadata.description, Invalid value for: query parameter metadata.customProperties, Invalid value for: query parameter lock", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/endpoints/{endpointId}": { "get": { "tags": [ "Endpoints" ], "summary": "Get endpoint details", "operationId": "getEndpoint", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "endpointId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_TrustedEndpoint" } } } }, "400": { "description": "Invalid value for: path parameter domainId, Invalid value for: path parameter endpointId", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/transactions/orders": { "get": { "tags": [ "Transactions" ], "summary": "List transaction orders", "operationId": "getOrders", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "description": "The number of entities to return.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "description": "Entity id used to the determine beginning of query results.", "schema": { "type": "string", "format": "uuid" } }, { "name": "sortBy", "in": "query", "description": "Property name used to sort the query results.", "schema": { "enum": [ "id", "accountId", "metadata.createdAt", "metadata.lastModifiedAt" ], "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sort order applied to the query results.", "schema": { "$ref": "#/components/schemas/Core_SortOrder" } }, { "name": "accountId", "in": "query", "description": "Return entities matching given accountId.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "example": [ "8e92eb53-40e7-4809-bb52-7e7b3b41a4be", "fdeeeb4b-f987-4ec4-9880-1eb280581d49" ] }, { "name": "ledgerId", "in": "query", "description": "Return entities matching given ledgerId.", "schema": { "type": "array", "items": { "minLength": 1, "type": "string" } }, "example": [ "ledgerId1", "ledgerId2" ] }, { "name": "intentId", "in": "query", "description": "Return entities matching given intentId.", "schema": { "type": "string", "format": "uuid" }, "example": "90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b" }, { "name": "parameters.type", "in": "query", "description": "Return entities that matches given parameter type.", "schema": { "$ref": "#/components/schemas/Core_TransactionOrderParameterType" }, "example": "XRPL" }, { "name": "metadata.createdBy", "in": "query", "description": "Return entities that were created by matching user.", "schema": { "type": "string", "format": "uuid" }, "example": "fdeeeb4b-f987-4ec4-9880-1eb280581d49" }, { "name": "metadata.lastModifiedBy", "in": "query", "description": "Return entities that were last modified by matching user.", "schema": { "type": "string", "format": "uuid" }, "example": "90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b" }, { "name": "metadata.createdAt.lt", "in": "query", "description": "Used to return only results created before the given date/time (lt=less than)", "schema": { "type": "string", "format": "date-time" }, "example": "2022-11-22T14:06:00.0000000+00:00" }, { "name": "metadata.createdAt.gt", "in": "query", "description": "Used to return only results created after the given date/time (gt=greater than)", "schema": { "type": "string", "format": "date-time" }, "example": "2022-11-22T14:06:00.0000000+00:00" }, { "name": "metadata.lastModifiedAt.lt", "in": "query", "description": "Used to return only results last modified before the given date/time (lt=less than)", "schema": { "type": "string", "format": "date-time" }, "example": "2022-11-22T14:06:00.0000000+00:00" }, { "name": "metadata.lastModifiedAt.gt", "in": "query", "description": "Used to return only results last modified after the given date/time (gt=greater than)", "schema": { "type": "string", "format": "date-time" }, "example": "2022-11-22T14:06:00.0000000+00:00" }, { "name": "metadata.description", "in": "query", "description": "Return entities with descriptions that contains or equals to provided description.", "schema": { "minLength": 0, "type": "string" }, "example": "description1" }, { "name": "metadata.customProperties", "in": "query", "description": "Return entities that contains provided custom properties.", "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "key1:value1", "key2:value2" ] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_TrustedTransactionOrdersCollection" } } } }, "400": { "description": "Invalid request (InvalidRequestError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/transactions/orders/{transactionOrderId}": { "get": { "tags": [ "Transactions" ], "summary": "Get transaction order details", "operationId": "getOrder", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "transactionOrderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_TrustedTransactionOrder" } } } }, "400": { "description": "Invalid value for: path parameter domainId, Invalid value for: path parameter transactionOrderId", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/transactions/transfers": { "get": { "tags": [ "Transactions" ], "summary": "List transfers", "operationId": "getTransfers", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "description": "The number of entities to return.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "description": "Entity id used to the determine beginning of query results.", "schema": { "type": "string", "format": "uuid" } }, { "name": "sortBy", "in": "query", "description": "Property name used to sort the query results.", "schema": { "enum": [ "id", "transactionId", "tickerId", "quarantined", "value", "kind", "registeredAt" ], "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sort order applied to the query results.", "schema": { "$ref": "#/components/schemas/Core_SortOrder" } }, { "name": "transactionId", "in": "query", "description": "Return entities matching given transactionId.", "schema": { "type": "string", "format": "uuid" }, "example": "90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b" }, { "name": "tickerId", "in": "query", "description": "Return entities matching given tickerId.", "schema": { "type": "string", "format": "uuid" }, "example": "fdeeeb4b-f987-4ec4-9880-1eb280581d49" }, { "name": "quarantined", "in": "query", "description": "Return entities matching given quarantined status.", "schema": { "type": "boolean" }, "example": "true" }, { "name": "kind", "in": "query", "description": "Return entities matching given kind.", "schema": { "$ref": "#/components/schemas/Core_TransferKind" }, "example": "Fee" }, { "name": "accountId", "in": "query", "description": "Return entities matching given accountId.", "schema": { "type": "string", "format": "uuid" }, "example": "8e92eb53-40e7-4809-bb52-7e7b3b41a4be" }, { "name": "recipient.accountId", "in": "query", "description": "Return entities matching given recipient accountIds.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "example": [ "8e92eb53-40e7-4809-bb52-7e7b3b41a4be", "f2dd81b0-374f-41b1-800e-b18dff241e3a" ] }, { "name": "registeredAt.lt", "in": "query", "description": "Return only results registered before the given date/time (lt=less than)", "schema": { "type": "string", "format": "date-time" }, "example": "2022-11-22T14:06:00.0000000+00:00" }, { "name": "registeredAt.gt", "in": "query", "description": "Return only results registered after the given date/time (gt=greater than)", "schema": { "type": "string", "format": "date-time" }, "example": "2022-11-22T14:06:00.0000000+00:00" }, { "name": "recipient.addressDetails.address", "in": "query", "description": "Return results where recipient's address contains or equals provided address.", "schema": { "type": "array", "items": { "minLength": 1, "type": "string" } }, "example": [ "mnRxKt2zGV89qJ9rG9SLCbzD6ZMsbGvU6Z", "mtMNbaxSdWMYRjmkwumCykV7x5kVVtjGhH" ] }, { "name": "ticker.ledgerId", "in": "query", "description": "Return entities matching given ledger.", "schema": { "type": "array", "items": { "minLength": 1, "type": "string" } }, "example": [ "1234567", "abcdefg" ] }, { "name": "ticker.validationStatus", "in": "query", "description": "Return transfers with ticker matching the requested validation status", "schema": { "$ref": "#/components/schemas/Core_TickerValidationStatusFilter" }, "example": "Validated" }, { "name": "ticker.lock", "in": "query", "description": "Return transfers with ticker matching given lock status.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Core_LockStatus" } }, "example": [ "Locked", "Archived" ] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_TransfersCollection" } } } }, "400": { "description": "Invalid request (InvalidRequestError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/transactions/transfers/{transferId}": { "get": { "tags": [ "Transactions" ], "summary": "Get transfer details", "operationId": "getTransfer", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "transferId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ApiTransfer" } } } }, "400": { "description": "Invalid value for: path parameter domainId, Invalid value for: path parameter transferId", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/transactions": { "get": { "tags": [ "Transactions" ], "summary": "List transactions", "operationId": "getTransactions", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "description": "The number of entities to return.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "description": "Entity id used to the determine beginning of query results.", "schema": { "type": "string", "format": "uuid" } }, { "name": "sortBy", "in": "query", "description": "Property name used to sort the query results.", "schema": { "enum": [ "id", "ledgerId", "processingStatus", "registeredAt", "ledgerTransactionData.ledgerStatus", "ledgerTransactionData.statusLastUpdatedAt" ], "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sort order applied to the query results.", "schema": { "$ref": "#/components/schemas/Core_SortOrder" } }, { "name": "ledgerId", "in": "query", "description": "Return entities matching given ledger id.", "schema": { "minLength": 1, "type": "string" }, "example": "1234567" }, { "name": "orderReference.Id", "in": "query", "description": "Return entities matching given order reference id.", "schema": { "type": "string", "format": "uuid" }, "example": "90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b" }, { "name": "orderReference.domainId", "in": "query", "description": "Return entities matching given order domain id.", "schema": { "type": "string", "format": "uuid" }, "example": "fdeeeb4b-f987-4ec4-9880-1eb280581d49" }, { "name": "accountId", "in": "query", "description": "Return entities matching given accountId.", "schema": { "type": "string", "format": "uuid" }, "example": "8e92eb53-40e7-4809-bb52-7e7b3b41a4be" }, { "name": "processing.status", "in": "query", "description": "Return entities matching given processing status.", "schema": { "$ref": "#/components/schemas/Core_TransactionProcessingStatus" }, "example": "Prepared" }, { "name": "ledgerTransactionData.ledgerStatus", "in": "query", "description": "Return entities matching given status of ledger transaction.", "schema": { "$ref": "#/components/schemas/Core_LedgerTransactionStatus" }, "example": "Confirmed" }, { "name": "ledgerTransactionData.ledgerTransactionId", "in": "query", "description": "Return entities matching given ledger transaction id.", "schema": { "minLength": 1, "type": "string" }, "example": "tx1id" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_TransactionsCollection" } } } }, "400": { "description": "Invalid value for: path parameter domainId, Invalid value for: query parameter limit, Invalid value for: query parameter startingAfter, Invalid value for: query parameter sortBy, Invalid value for: query parameter sortOrder, Invalid value for: query parameter ledgerId, Invalid value for: query parameter orderReference.Id, Invalid value for: query parameter orderReference.domainId, Invalid value for: query parameter accountId, Invalid value for: query parameter processing.status, Invalid value for: query parameter ledgerTransactionData.ledgerStatus, Invalid value for: query parameter ledgerTransactionData.ledgerTransactionId", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/transactions/{transactionId}": { "get": { "tags": [ "Transactions" ], "summary": "Get transaction details", "operationId": "getTransaction", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ApiTransaction" } } } }, "400": { "description": "Invalid value for: path parameter domainId, Invalid value for: path parameter transactionId", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/transactions/dry-run": { "post": { "tags": [ "Transactions" ], "summary": "Dry run a transaction order", "operationId": "dryRunTransaction", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_DryRunTransactionParameters" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_TransactionDryRun" } } } }, "400": { "description": "Invalid dry run arguments (TransactionDryRunError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "504": { "description": "Remote service timeout (RemoteServiceTimeout)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/accounts/{accountId}/manifests": { "get": { "tags": [ "Accounts" ], "summary": "List manifests", "operationId": "getManifests", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "description": "The number of entities to return.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "description": "Entity id used to the determine beginning of query results.", "schema": { "type": "string", "format": "uuid" } }, { "name": "sortBy", "in": "query", "description": "Property name used to sort the query results.", "schema": { "enum": [ "id", "metadata.createdAt", "metadata.lastModifiedAt" ], "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sort order applied to the query results.", "schema": { "$ref": "#/components/schemas/Core_SortOrder" } }, { "name": "metadata.createdBy", "in": "query", "description": "Return entities that were created by matching user.", "schema": { "type": "string", "format": "uuid" }, "example": "fdeeeb4b-f987-4ec4-9880-1eb280581d49" }, { "name": "metadata.lastModifiedBy", "in": "query", "description": "Return entities that were last modified by matching user.", "schema": { "type": "string", "format": "uuid" }, "example": "90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b" }, { "name": "content.type", "in": "query", "description": "Return entities filtered by manifest content type.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Core_ManifestContentType" } }, "example": [ "EIP-191" ] }, { "name": "metadata.description", "in": "query", "description": "Return entities with descriptions that contains or equals to provided description.", "schema": { "minLength": 0, "type": "string" }, "example": "description1" }, { "name": "metadata.customProperties", "in": "query", "description": "Return entities that contains provided custom properties.", "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "key1:value1", "key2:value2" ] }, { "name": "additionalDetails.processingStatus", "in": "query", "description": "Return entities matching given processing status.", "schema": { "$ref": "#/components/schemas/Core_ManifestProcessingStatus" }, "example": "Pending" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ManifestsCollection" } } } }, "400": { "description": "One of: Domain locked (DomainLockedError); Requester locked (RequesterLockedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/accounts/{accountId}/manifests/{manifestId}": { "get": { "tags": [ "Accounts" ], "summary": "Get manifest details", "operationId": "getManifest", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "manifestId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ApiManifest" } } } }, "400": { "description": "One of: Domain locked (DomainLockedError); Requester locked (RequesterLockedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/intents": { "post": { "tags": [ "Intents" ], "summary": "Propose an intent", "operationId": "createIntent", "parameters": [ { "name": "requestId", "in": "header", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ProposeIntentBody" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": { "requestId": { "required": true, "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_IntentResponse" } } } }, "400": { "description": "One of: Domain locked (DomainLockedError); Intent expired (ExpiredRequestError); Invalid intent (InvalidIntentError); Invalid request (InvalidRequestError); Requester locked (RequesterLockedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); Invalid signature (InvalidSignatureError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "409": { "description": "Request already exists (ConflictingRequestIdError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/intents/approve": { "post": { "tags": [ "Intents" ], "summary": "Approve an intent", "operationId": "approveIntent", "parameters": [ { "name": "requestId", "in": "header", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ApproveIntentBody" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": { "requestId": { "required": true, "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_IntentResponse" } } } }, "400": { "description": "One of: Domain locked (DomainLockedError); Intent expired (ExpiredRequestError); Invalid intent (InvalidIntentError); Invalid request (InvalidRequestError); Requester locked (RequesterLockedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); Invalid signature (InvalidSignatureError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "409": { "description": "Request already exists (ConflictingRequestIdError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "500": { "description": " (SystemError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/intents/reject": { "post": { "tags": [ "Intents" ], "summary": "Reject an intent", "operationId": "rejectIntent", "parameters": [ { "name": "requestId", "in": "header", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_RejectIntentBody" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": { "requestId": { "required": true, "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_IntentResponse" } } } }, "400": { "description": "One of: Domain locked (DomainLockedError); Intent expired (ExpiredRequestError); Invalid intent (InvalidIntentError); Invalid request (InvalidRequestError); Requester locked (RequesterLockedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); Invalid signature (InvalidSignatureError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "409": { "description": "Request already exists (ConflictingRequestIdError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "500": { "description": " (SystemError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/genesis": { "post": { "tags": [ "Genesis" ], "summary": "Run the genesis", "operationId": "runGenesis", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_GenesisRequest" } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "Invalid value for: body", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "409": { "description": "Genesis already applied (GenesisCantBeLaunchedTwiceError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "500": { "description": " (SystemError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } } } }, "/v1/domains/{domainId}/intents": { "get": { "tags": [ "Intents" ], "summary": "List intents", "operationId": "getIntents", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "description": "The number of entities to return.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "description": "Return entity intents starting after given intent. DomainId and IntentId should be separated with underscore (_)", "schema": { "minLength": 1, "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Property name used to sort the query results.", "schema": { "enum": [ "id", "state.status", "details.expiryAt", "details.metadata.createdAt", "state.lastModifiedAt" ], "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sort order applied to the query results.", "schema": { "$ref": "#/components/schemas/Core_SortOrder" } }, { "name": "details.payload.type", "in": "query", "description": "Return entities intents matching given intent types.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Core_IntentType" } }, "example": [ "v0_CreateUser", "v0_LockAccount" ] }, { "name": "details.author.domainId", "in": "query", "description": "Return entities intents matching given author domain id.", "schema": { "type": "string", "format": "uuid" }, "example": "8e92eb53-40e7-4809-bb52-7e7b3b41a4be" }, { "name": "details.author.id", "in": "query", "description": "Return entities intents matching given author id.", "schema": { "type": "string", "format": "uuid" }, "example": "fdeeeb4b-f987-4ec4-9880-1eb280581d49" }, { "name": "details.targetDomainId", "in": "query", "description": "Return entities intents matching given target domain id.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "example": [ "fdeeeb4b-f987-4ec4-9880-1eb280581d49" ] }, { "name": "details.metadata.description", "in": "query", "description": "Return entities intents with descriptions that contains or equals to provided description.", "schema": { "minLength": 0, "type": "string" }, "example": "description1" }, { "name": "details.metadata.customProperties", "in": "query", "description": "Return entities intents that contains provided custom properties.", "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "key1:value1", "key2:value2" ] }, { "name": "state.status", "in": "query", "description": "Return entities intents matching given status.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Core_IntentStatus" } }, "example": [ "Executed" ] }, { "name": "entityId", "in": "query", "description": "Return entity intents.", "schema": { "type": "string" }, "example": "90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b" }, { "name": "revision", "in": "query", "description": "Return entities intents matching provided revision.", "schema": { "minimum": 1, "type": "integer", "format": "int64" }, "example": "100" }, { "name": "policyId", "in": "query", "description": "Return entities intents with matching policy id being executed.", "schema": { "type": "string", "format": "uuid" }, "example": "8e92eb53-40e7-4809-bb52-7e7b3b41a4be" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_TrustedIntentsCollection" } } } }, "400": { "description": "Invalid value for: path parameter domainId, Invalid value for: query parameter limit, Invalid value for: query parameter startingAfter, Invalid value for: query parameter sortBy, Invalid value for: query parameter sortOrder, Invalid value for: query parameter details.payload.type, Invalid value for: query parameter details.author.domainId, Invalid value for: query parameter details.author.id, Invalid value for: query parameter details.targetDomainId, Invalid value for: query parameter details.metadata.description, Invalid value for: query parameter details.metadata.customProperties, Invalid value for: query parameter state.status, Invalid value for: query parameter entityId, Invalid value for: query parameter revision, Invalid value for: query parameter policyId", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/intents/{intentId}": { "get": { "tags": [ "Intents" ], "summary": "Get intent details", "operationId": "getIntent", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "intentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_TrustedIntent" } } } }, "400": { "description": "Invalid value for: path parameter domainId, Invalid value for: path parameter intentId", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/intents/{intentId}/remaining-users": { "get": { "tags": [ "Intents" ], "summary": "Get remaining users", "description": "This API will return the remaining user IDs able to approve for the currently open step of the intent approval process.", "operationId": "getRemainingUsers", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "intentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "users.lock", "in": "query", "description": "Return only users with given lockstatuses.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Core_LockStatus" } }, "example": [ "Locked", "Unlocked" ] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Core_RemainingDomainUsers" } } } } }, "400": { "description": "Intent is not opened (IntentNotOpenedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/intents/dry-run": { "post": { "tags": [ "Intents" ], "summary": "Perform a dry-run for given intent payload", "operationId": "intentDryRun", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_IntentDryRunRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_IntentDryRunResponse" } } } }, "400": { "description": "Invalid value for: body", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/tickers": { "get": { "tags": [ "Tickers" ], "summary": "List tickers", "operationId": "getTickers", "parameters": [ { "name": "limit", "in": "query", "description": "The number of entities to return.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "description": "Entity id used to the determine beginning of query results.", "schema": { "type": "string", "format": "uuid" } }, { "name": "sortBy", "in": "query", "description": "Property name used to sort the query results.", "schema": { "enum": [ "id", "ledgerId", "kind", "name", "symbol" ], "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sort order applied to the query results.", "schema": { "$ref": "#/components/schemas/Core_SortOrder" } }, { "name": "ledgerId", "in": "query", "description": "Return entities matching given ledger id.", "schema": { "type": "array", "items": { "minLength": 1, "type": "string" } }, "example": [ "exemplaryLedgerId1", "exemplaryLedgerId2" ] }, { "name": "kind", "in": "query", "description": "Return entities matching given kind.", "schema": { "$ref": "#/components/schemas/Core_TickerKind" }, "example": "Native" }, { "name": "name", "in": "query", "description": "Return entities with names that contains or equals to provided name.", "schema": { "type": "array", "items": { "minLength": 1, "type": "string" } }, "example": [ "exemplaryTickerName1", "exemplaryTickerName2" ] }, { "name": "symbol", "in": "query", "description": "Return entities with names that contains or equals to provided symbol.", "schema": { "type": "array", "items": { "minLength": 1, "type": "string" } }, "example": [ "exemplaryTickerSymbol1", "exemplaryTickerSymbol2" ] }, { "name": "validationStatus", "in": "query", "description": "Return entities matching the requested validation status", "schema": { "$ref": "#/components/schemas/Core_TickerValidationStatusFilter" }, "example": "Validated" }, { "name": "lock", "in": "query", "description": "Return tickers matching given lock status.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Core_LockStatus" } }, "example": [ "Locked", "Archived" ] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_TickersCollection" } } } }, "400": { "description": "Invalid value for: query parameter limit, Invalid value for: query parameter startingAfter, Invalid value for: query parameter sortBy, Invalid value for: query parameter sortOrder, Invalid value for: query parameter ledgerId, Invalid value for: query parameter kind, Invalid value for: query parameter name, Invalid value for: query parameter symbol, Invalid value for: query parameter validationStatus, Invalid value for: query parameter lock", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/tickers/{tickerId}": { "get": { "tags": [ "Tickers" ], "summary": "Get ticker details", "operationId": "getTicker", "parameters": [ { "name": "tickerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ApiTicker" } } } }, "400": { "description": "Invalid value for: path parameter tickerId", "content": { "text/plain": { "schema": { "type": "string" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/ledgers": { "get": { "tags": [ "Ledgers" ], "summary": "List ledgers", "operationId": "getLedgers", "parameters": [ { "name": "limit", "in": "query", "description": "The number of entities to return.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "description": "Entity id used to the determine beginning of query results.", "schema": { "minLength": 1, "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Property name used to sort the query results.", "schema": { "enum": [ "id", "alias", "metadata.createdAt", "metadata.lastModifiedAt" ], "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sort order applied to the query results.", "schema": { "$ref": "#/components/schemas/Core_SortOrder" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_TrustedLedgersCollection" } } } }, "400": { "description": "Invalid value for: query parameter limit, Invalid value for: query parameter startingAfter, Invalid value for: query parameter sortBy, Invalid value for: query parameter sortOrder, Invalid value for: query parameters", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/ledgers/{ledgerId}": { "get": { "tags": [ "Ledgers" ], "summary": "Get ledger details", "operationId": "getLedger", "parameters": [ { "name": "ledgerId", "in": "path", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_TrustedLedger" } } } }, "400": { "description": "Invalid value for: path parameter ledgerId", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/ledgers/{ledgerId}/fees": { "get": { "tags": [ "Ledgers" ], "summary": "Get ledger's fee details", "operationId": "getLedgerFees", "parameters": [ { "name": "ledgerId", "in": "path", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_CurrentFees" } } } }, "400": { "description": "Invalid value for: path parameter ledgerId", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "405": { "description": "No fee information (NoFeeInformation)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/ledgers/{ledgerId}/ethereum/call": { "post": { "tags": [ "Ledgers" ], "summary": "[Ethereum] Process contract call", "operationId": "processEthereumContractCall", "parameters": [ { "name": "ledgerId", "in": "path", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "requestBody": { "description": "A contract call to execute on an ethereum compatible ledger.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_EthereumCallRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "pattern": "^0[xX]([a-fA-F0-9]*)$", "type": "string" } } } }, "400": { "description": "Invalid value for: path parameter ledgerId, Invalid value for: body", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/trusted-ledgers/{ledgerId}": { "get": { "tags": [ "Ledgers" ], "summary": "Get trusted ledger details", "operationId": "getTrustedLedger", "parameters": [ { "name": "ledgerId", "in": "path", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_TrustedLedger" } } } }, "400": { "description": "Invalid value for: path parameter ledgerId", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/trusted-ledgers": { "get": { "tags": [ "Ledgers" ], "summary": "List trusted ledgers", "operationId": "getTrustedLedgers", "parameters": [ { "name": "limit", "in": "query", "description": "The number of entities to return.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "description": "Entity id used to the determine beginning of query results.", "schema": { "minLength": 1, "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Property name used to sort the query results.", "schema": { "enum": [ "id", "alias", "metadata.createdAt", "metadata.lastModifiedAt" ], "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sort order applied to the query results.", "schema": { "$ref": "#/components/schemas/Core_SortOrder" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_TrustedLedgersCollection" } } } }, "400": { "description": "Invalid value for: query parameter limit, Invalid value for: query parameter startingAfter, Invalid value for: query parameter sortBy, Invalid value for: query parameter sortOrder, Invalid value for: query parameters", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/requests/{requestId}": { "get": { "tags": [ "Requests" ], "summary": "Get request state", "operationId": "getRequestState", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_RequestState" } } } }, "400": { "description": "Invalid value for: path parameter domainId, Invalid value for: path parameter requestId", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/me/requests": { "get": { "tags": [ "Requests" ], "summary": "Get all user requests state", "operationId": "getAllUserRequestsState", "parameters": [ { "name": "limit", "in": "query", "description": "The number of entities to return.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "description": "For backward compatibility reasons, the startingAfter used to paginate to the next page should be the last requestId in the response json array of the current page", "schema": { "type": "string", "format": "uuid" } }, { "name": "sortBy", "in": "query", "description": "Property name used to sort the query results.", "schema": { "enum": [ "id" ], "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sort order applied to the query results.", "schema": { "$ref": "#/components/schemas/Core_SortOrder" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Core_RequestState" } } } } }, "400": { "description": "Invalid value for: query parameter limit, Invalid value for: query parameter startingAfter, Invalid value for: query parameter sortBy, Invalid value for: query parameter sortOrder", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError); User not authorized (UnauthorizedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/requests": { "get": { "tags": [ "Requests" ], "summary": "Get all user requests state in domain", "operationId": "getAllUserRequestsStateInDomain", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "description": "The number of entities to return.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "description": "For backward compatibility reasons, the startingAfter used to paginate to the next page should be the last requestId in the response json array of the current page", "schema": { "type": "string", "format": "uuid" } }, { "name": "sortBy", "in": "query", "description": "Property name used to sort the query results.", "schema": { "enum": [ "id" ], "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sort order applied to the query results.", "schema": { "$ref": "#/components/schemas/Core_SortOrder" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Core_RequestState" } } } } }, "400": { "description": "Invalid value for: path parameter domainId, Invalid value for: query parameter limit, Invalid value for: query parameter startingAfter, Invalid value for: query parameter sortBy, Invalid value for: query parameter sortOrder", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError); User not authorized (UnauthorizedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/trusted-public-keys/trusted-collection": { "get": { "tags": [ "TrustedPublicKeys" ], "summary": "List trusted-collection public keys", "operationId": "getTrustedPublicKeysTrustedCollection", "parameters": [ { "name": "limit", "in": "query", "description": "The number of entities to return.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "description": "Entity id used to the determine beginning of query results.", "schema": { "minLength": 1, "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Property name used to sort the query results.", "schema": { "enum": [ "metadata.createdAt", "metadata.lastModifiedAt" ], "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sort order applied to the query results.", "schema": { "$ref": "#/components/schemas/Core_SortOrder" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_TrustedTrustedPublicKeysCollection" } } } }, "400": { "description": "Invalid value for: query parameter limit, Invalid value for: query parameter startingAfter, Invalid value for: query parameter sortBy, Invalid value for: query parameter sortOrder, Invalid value for: query parameters", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/trusted-public-keys/api": { "get": { "tags": [ "TrustedPublicKeys" ], "summary": "List api public keys", "operationId": "getTrustedPublicKeysApi", "parameters": [ { "name": "limit", "in": "query", "description": "The number of entities to return.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "description": "Entity id used to the determine beginning of query results.", "schema": { "minLength": 1, "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Property name used to sort the query results.", "schema": { "enum": [ "metadata.createdAt", "metadata.lastModifiedAt" ], "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sort order applied to the query results.", "schema": { "$ref": "#/components/schemas/Core_SortOrder" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_TrustedTrustedPublicKeysCollection" } } } }, "400": { "description": "Invalid value for: query parameter limit, Invalid value for: query parameter startingAfter, Invalid value for: query parameter sortBy, Invalid value for: query parameter sortOrder, Invalid value for: query parameters", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/trusted-public-keys/messages": { "get": { "tags": [ "TrustedPublicKeys" ], "summary": "List messages public keys", "operationId": "getTrustedPublicKeysMessages", "parameters": [ { "name": "limit", "in": "query", "description": "The number of entities to return.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "description": "Entity id used to the determine beginning of query results.", "schema": { "minLength": 1, "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Property name used to sort the query results.", "schema": { "enum": [ "metadata.createdAt", "metadata.lastModifiedAt" ], "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sort order applied to the query results.", "schema": { "$ref": "#/components/schemas/Core_SortOrder" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_TrustedTrustedPublicKeysCollection" } } } }, "400": { "description": "Invalid value for: query parameter limit, Invalid value for: query parameter startingAfter, Invalid value for: query parameter sortBy, Invalid value for: query parameter sortOrder, Invalid value for: query parameters", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/events": { "get": { "tags": [ "Events" ], "summary": "List events", "operationId": "getEvents", "parameters": [ { "name": "domainId", "in": "path", "description": "Unique identifier for the domain.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "description": "The number of entities to return.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "description": "Entity id used to the determine beginning of query results.", "schema": { "type": "string", "format": "uuid" } }, { "name": "sortBy", "in": "query", "description": "Property name used to sort the query results.", "schema": { "enum": [ "sequenceNumber" ], "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sort order applied to the query results.", "schema": { "$ref": "#/components/schemas/Core_SortOrder" } }, { "name": "scope", "in": "query", "description": "Return events for scope of own domain, Self (default), or including subdomains, SelfAndDescendants.", "schema": { "$ref": "#/components/schemas/Core_EventScope" }, "example": "SelfAndDescendants" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_EventsCollection" } } } }, "400": { "description": "One of: Domain locked (DomainLockedError); Requester locked (RequesterLockedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/properties": { "get": { "tags": [ "SystemProperties" ], "summary": "List system properties", "operationId": "getSystemProperties", "parameters": [ { "name": "limit", "in": "query", "description": "The number of entities to return.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "description": "Entity id used to the determine beginning of query results.", "schema": { "$ref": "#/components/schemas/Core_SystemPropertyId" } }, { "name": "sortBy", "in": "query", "description": "Property name used to sort the query results.", "schema": { "enum": [ "id", "metadata.createdAt", "metadata.lastModifiedAt" ], "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sort order applied to the query results.", "schema": { "$ref": "#/components/schemas/Core_SortOrder" } }, { "name": "id", "in": "query", "description": "Return entities matching given system property id.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Core_SystemPropertyId" } }, "example": [ "NOTARY_API_KEY", "STATE_REVIEW_AUTHORITY" ] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_TrustedSystemPropertiesCollection" } } } }, "400": { "description": "Invalid value for: query parameter limit, Invalid value for: query parameter startingAfter, Invalid value for: query parameter sortBy, Invalid value for: query parameter sortOrder, Invalid value for: query parameter id", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } }, "404": { "description": "Entity or Domain not found (EntityNotFoundError)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_ErrorMessage" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/users/invitations": { "get": { "tags": [ "User invitations" ], "description": "List user invitations", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "sortOrder", "in": "query", "schema": { "$ref": "#/components/schemas/CoreExtensions_SortOrder" } }, { "name": "sortBy", "in": "query", "schema": { "$ref": "#/components/schemas/CoreExtensions_SortBy" } }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CoreExtensions_InvitationStatusQuery" } } }, { "name": "alias", "in": "query", "schema": { "type": "string" } }, { "name": "roles[]", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreExtensions_InvitationPaginationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CoreExtensions_InvitationPaginationResult" } } } } }, "security": [ { "httpAuth": [] } ] }, "post": { "tags": [ "User invitations" ], "description": "Create a user invitation", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreExtensions_InvitationIn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CoreExtensions_InvitationIn" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CoreExtensions_InvitationIn" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreExtensions_InvitationOut" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CoreExtensions_InvitationOut" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/users/invitations/{id}": { "get": { "tags": [ "User invitations" ], "description": "Get user invitation details", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreExtensions_InvitationOut" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CoreExtensions_InvitationOut" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/users/invitations/{id}/cancel": { "post": { "tags": [ "User invitations" ], "description": "Cancel a user invitation", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreExtensions_InvitationOut" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CoreExtensions_InvitationOut" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/users/invitations/{id}/renew": { "post": { "tags": [ "User invitations" ], "description": "Renew a user invitation", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreExtensions_InvitationOut" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CoreExtensions_InvitationOut" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/users/invitations/{id}/complete": { "post": { "tags": [ "User invitations" ], "description": "Complete a user invitation", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreExtensions_InvitationOut" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CoreExtensions_InvitationOut" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/users/invitations/{idOrCode}": { "post": { "tags": [ "User invitations" ], "description": "Fill a user invitation", "parameters": [ { "name": "idOrCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreExtensions_InvitationAnswerIn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CoreExtensions_InvitationAnswerIn" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CoreExtensions_InvitationAnswerIn" } } } }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "User invitations" ], "description": "Get public data of user invitation", "parameters": [ { "name": "idOrCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreExtensions_PublicInvitationOut" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CoreExtensions_PublicInvitationOut" } } } } } } }, "/v1/vaults/{vaultId}/operations/prepared": { "get": { "tags": [ "Vaults" ], "description": "Export prepared operations", "parameters": [ { "name": "vaultId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/vaults/operations/signed": { "post": { "tags": [ "Vaults" ], "description": "Import signed operations", "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "files" ], "type": "object", "properties": { "files": { "type": "array", "items": { "type": "string", "format": "binary" } } } }, "encoding": { "files": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreExtensions_ErrorMessages" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/external-accounts/providers/{connectionId}/pairs": { "get": { "tags": [ "External account trading" ], "description": "Get available trade pairs", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "connectionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "externalTickerName", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Flows_PairOut" } } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/external-accounts/providers/{connectionId}/balances": { "get": { "tags": [ "External account trading" ], "description": "Get balance directly from a connection and a specified ticker name", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "connectionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "externalTickerName", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Flows_BalanceOut" } } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/external-accounts/providers/{connectionId}/pairs/{baseExternalTickerName}/{quoteExternalTickerName}/price": { "get": { "tags": [ "External account trading" ], "description": "Get pair price", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "connectionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "baseExternalTickerName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "quoteExternalTickerName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Flows_PairPriceOut" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/external-accounts/transactions/orders": { "get": { "tags": [ "External account transactions" ], "description": "Get external account orders", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "externalAccountIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "intentId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "createdBy", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "lastModifiedBy", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "description", "in": "query", "schema": { "type": "string" } }, { "name": "customProperties", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "startingAfter", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "sortOrder", "in": "query", "schema": { "$ref": "#/components/schemas/Flows_SortOrder" } }, { "name": "sortBy", "in": "query", "schema": { "$ref": "#/components/schemas/Flows_OrderOutSortBy" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Flows_GuidNullableTransactionOrderOutPaginationResult" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/external-accounts/transactions/transfers": { "get": { "tags": [ "External account transactions" ], "description": "Get external account transfers", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "sortOrder", "in": "query", "schema": { "$ref": "#/components/schemas/Flows_SortOrder" } }, { "name": "sortBy", "in": "query", "schema": { "$ref": "#/components/schemas/Flows_TransactionOutSortBy" } }, { "name": "kind", "in": "query", "schema": { "$ref": "#/components/schemas/Flows_TransactionKind" } }, { "name": "externalAccountId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "transactionOrderId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "id", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "startDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Flows_GuidNullableTransferOutPaginationResult" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/external-accounts/transactions/dry-run": { "post": { "tags": [ "External account transactions" ], "description": "Transaction dry run", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Flows_TransactionDryRunParametersTransactionDryRunIn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Flows_TransactionDryRunParametersTransactionDryRunIn" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Flows_TransactionDryRunParametersTransactionDryRunIn" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Flows_TransactionDryRunOut" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/external-accounts/providers": { "post": { "tags": [ "External accounts" ], "description": "Connect an external account provider", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Flows_ProviderConnectionParametersInCreateProviderConnectionIn" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Flows_ProviderConnectionOut" } } } } }, "security": [ { "httpAuth": [] } ] }, "get": { "tags": [ "External accounts" ], "description": "List external account provider connections", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Flows_ProviderConnectionOut" } } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/external-accounts/providers/{connectionId}": { "post": { "tags": [ "External accounts" ], "description": "Update an external account provider connection", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "connectionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Flows_ProviderConnectionParametersInUpdateProviderConnectionIn" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Flows_ProviderConnectionOut" } } } } }, "security": [ { "httpAuth": [] } ] }, "get": { "tags": [ "External accounts" ], "description": "Get external account provider connections", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "connectionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Flows_ProviderConnectionOut" } } } } }, "security": [ { "httpAuth": [] } ] }, "delete": { "tags": [ "External accounts" ], "description": "Disconnect an external account provider", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "connectionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/external-accounts": { "get": { "tags": [ "External accounts" ], "description": "List external accounts", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "sortOrder", "in": "query", "schema": { "$ref": "#/components/schemas/Flows_SortOrder" } }, { "name": "sortBy", "in": "query", "schema": { "$ref": "#/components/schemas/Flows_ExternalAccountSortBy" } }, { "name": "connectionId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "alias", "in": "query", "schema": { "type": "string" } }, { "name": "ledgerId", "in": "query", "schema": { "type": "string" } }, { "name": "externalTickerName", "in": "query", "schema": { "type": "string" } }, { "name": "connectionState", "in": "query", "schema": { "$ref": "#/components/schemas/Flows_ConnectionState" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Flows_GuidNullableExternalAccountOutPaginationResult" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/external-accounts/{externalAccountId}": { "get": { "tags": [ "External accounts" ], "description": "Get external account details", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "externalAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Flows_ExternalAccountOut" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/external-accounts/{externalAccountId}/balances": { "get": { "tags": [ "External accounts" ], "description": "Get external account balances", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "externalAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Flows_BalanceOut" } } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/external-accounts/{externalAccountId}/addresses/latest": { "get": { "tags": [ "External accounts" ], "description": "Retrieve latest external address", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "externalAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Flows_AdressesOut" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/external-accounts/{externalAccountId}/addresses": { "get": { "tags": [ "External accounts" ], "description": "Retrieve all generated addresses", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "externalAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "startingAfter", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Flows_GuidNullableAdressesOutPaginationResult" } } } } }, "security": [ { "httpAuth": [] } ] }, "post": { "tags": [ "External accounts" ], "description": "Generate new account external address", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "externalAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Flows_AdressesOut" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/external-accounts/{externalAccountId}/addresses/{externalAccountAddressId}": { "get": { "tags": [ "External accounts" ], "description": "Retrieve account external address", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "externalAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "externalAccountAddressId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Flows_AdressesOut" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/virtual-ledgers": { "get": { "tags": [ "VirtualAccounting" ], "description": "Get virtual ledgers", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "sortOrder", "in": "query", "schema": { "$ref": "#/components/schemas/VirtualAccounting_SortOrder" } }, { "name": "sortBy", "in": "query", "schema": { "$ref": "#/components/schemas/VirtualAccounting_VirtualLedgerSortBy" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualAccounting_VirtualLedgerOutPagedCollectionResponse" } } } } }, "security": [ { "httpAuth": [] } ] }, "post": { "tags": [ "VirtualAccounting" ], "description": "Create a virtual ledger", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualAccounting_VirtualLedgerIn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VirtualAccounting_VirtualLedgerIn" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VirtualAccounting_VirtualLedgerIn" } } } }, "responses": { "201": { "description": "Virtual Ledger created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualAccounting_VirtualLedgerOut" } } } }, "400": { "description": "Incorrect data" } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/virtual-ledgers/{virtualLedgerId}": { "get": { "tags": [ "VirtualAccounting" ], "description": "Get virtual ledger", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "virtualLedgerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualAccounting_VirtualLedgerOut" } } } }, "404": { "description": "Virtual Ledger not found" } }, "security": [ { "httpAuth": [] } ] }, "put": { "tags": [ "VirtualAccounting" ], "description": "Update virtual ledger", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "virtualLedgerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualAccounting_VirtualLedgerUpdate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VirtualAccounting_VirtualLedgerUpdate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VirtualAccounting_VirtualLedgerUpdate" } } } }, "responses": { "204": { "description": "Virtual Ledger updated" }, "400": { "description": "Incorrect data" }, "404": { "description": "Virtual Ledger not found" } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/virtual-ledgers/{virtualLedgerId}/balances": { "get": { "tags": [ "VirtualAccounting" ], "description": "Get virtual ledger balances", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "virtualLedgerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualAccounting_BalanceCollectionResponse" } } } }, "404": { "description": "Virtual Ledger not found" } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/virtual-ledgers/{virtualLedgerId}/accounts": { "get": { "tags": [ "VirtualAccounting" ], "description": "Get virtual ledger accounts", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "virtualLedgerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "sortOrder", "in": "query", "schema": { "$ref": "#/components/schemas/VirtualAccounting_SortOrder" } }, { "name": "sortBy", "in": "query", "schema": { "$ref": "#/components/schemas/VirtualAccounting_VirtualAccountSortBy" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualAccounting_VirtualAccountOutPagedCollectionResponse" } } } }, "404": { "description": "Virtual Ledger not found" } }, "security": [ { "httpAuth": [] } ] }, "post": { "tags": [ "VirtualAccounting" ], "description": "Create a virtual account", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "virtualLedgerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualAccounting_VirtualAccountIn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VirtualAccounting_VirtualAccountIn" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VirtualAccounting_VirtualAccountIn" } } } }, "responses": { "201": { "description": "Virtual Account created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualAccounting_VirtualAccountOut" } } } }, "404": { "description": "Virtual Ledger not found" } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/virtual-ledgers/{virtualLedgerId}/accounts/{accountId}": { "put": { "tags": [ "VirtualAccounting" ], "description": "Update a virtual account", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "virtualLedgerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualAccounting_VirtualAccountUpdate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VirtualAccounting_VirtualAccountUpdate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VirtualAccounting_VirtualAccountUpdate" } } } }, "responses": { "204": { "description": "Virtual Account updated" }, "404": { "description": "Virtual Ledger or Virtual Account not found" } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/virtual-ledgers/{virtualLedgerId}/accounts/{accountId}/balances": { "get": { "tags": [ "VirtualAccounting" ], "description": "Get virtual account balances", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "virtualLedgerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualAccounting_BalanceCollectionResponse" } } } }, "404": { "description": "Virtual Ledger or Virtual Account not found" } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/virtual-ledgers/{virtualLedgerId}/accounts/{accountId}/deposit-identification-sources": { "post": { "tags": [ "VirtualAccounting" ], "description": "Assign a deposit identification source to an account", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "virtualLedgerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualAccounting_DepositIdentificationSourceBaseIn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VirtualAccounting_DepositIdentificationSourceBaseIn" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VirtualAccounting_DepositIdentificationSourceBaseIn" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Deposit identification already existing" }, "404": { "description": "Virtual Ledger or Virtual Account not found" } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/virtual-ledgers/{virtualLedgerId}/accounts/{accountId}/addresses": { "get": { "tags": [ "VirtualAccounting" ], "description": "Get virtual account addresses", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "virtualLedgerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "ledgerId", "in": "query", "schema": { "type": "string" } }, { "name": "custodyAccountId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "custodyDomainId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualAccounting_LedgerAddressPagedCollectionResponse" } } } }, "400": { "description": "Address not yet ready" }, "404": { "description": "Virtual Ledger or Virtual Account not found" } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/virtual-ledgers/{virtualLedgerId}/operations": { "get": { "tags": [ "VirtualAccounting" ], "description": "Get virtual ledger's operations", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "virtualLedgerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "sortOrder", "in": "query", "schema": { "$ref": "#/components/schemas/VirtualAccounting_SortOrder" } }, { "name": "sortBy", "in": "query", "schema": { "$ref": "#/components/schemas/VirtualAccounting_OperationSortBy" } }, { "name": "virtualAccountId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "status", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "tickerId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualAccounting_OperationOutPagedCollectionResponse" } } } }, "404": { "description": "Virtual Ledger not found" } }, "security": [ { "httpAuth": [] } ] }, "post": { "tags": [ "VirtualAccounting" ], "description": "Create operation", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "virtualLedgerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualAccounting_OperationIn" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VirtualAccounting_OperationIn" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VirtualAccounting_OperationIn" } } } }, "responses": { "201": { "description": "Operation created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualAccounting_OperationOut" } } } }, "400": { "description": "Error while creating operation" }, "404": { "description": "Virtual Ledger not found" } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/virtual-ledgers/{virtualLedgerId}/transfers": { "get": { "tags": [ "VirtualAccounting" ], "description": "Get transfers", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "virtualLedgerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "startingAfter", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "sortOrder", "in": "query", "schema": { "$ref": "#/components/schemas/VirtualAccounting_SortOrder" } }, { "name": "sortBy", "in": "query", "schema": { "$ref": "#/components/schemas/VirtualAccounting_TransferSortBy" } }, { "name": "virtualAccountId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "status", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "tickerId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualAccounting_TransferBasePagedCollectionResponse" } } } }, "404": { "description": "Virtual Ledger not found" } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/compliance/providers/{provider}/toggle-preview-screening": { "put": { "tags": [ "Compliance" ], "summary": "Enables or disables the preview screening for an existing provider connection", "operationId": "TogglePreviewScreening", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "provider", "in": "path", "required": true, "schema": { "enum": [ "ELLIPTIC", "CHAINALYSIS" ], "type": "string" } }, { "name": "enabled", "in": "query", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Compliance_ErrorResponse" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/compliance/providers/{provider}/pause-connection": { "put": { "tags": [ "Compliance" ], "summary": "Pause/unpause an existing external provider connection", "operationId": "PauseProviderConnection", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "provider", "in": "path", "required": true, "schema": { "enum": [ "ELLIPTIC", "CHAINALYSIS" ], "type": "string" } }, { "name": "paused", "in": "query", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Compliance_ProviderConnectionResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Compliance_ErrorResponse" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/compliance/providers": { "get": { "tags": [ "Compliance" ], "summary": "Retrieves configuration steps and provider connection status for the give domain", "operationId": "GetAllProvidersForDomain", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Compliance_ConfigurationDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Compliance_ErrorResponse" } } } } }, "security": [ { "httpAuth": [] } ] }, "post": { "tags": [ "Compliance" ], "summary": "Connects different external providers with Custody", "operationId": "ConnectProvider", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Compliance_ProviderConnectRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Compliance_ProviderConnectionResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Compliance_ErrorResponse" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/compliance/providers/{provider}/screening-rules": { "get": { "tags": [ "Compliance" ], "summary": "Retrieves screening rules for connected provider of the given domain", "operationId": "GetScreeningRulesForDomainAndProvider", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "provider", "in": "path", "required": true, "schema": { "enum": [ "ELLIPTIC", "CHAINALYSIS" ], "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Compliance_GetScreeningRulesResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Compliance_ErrorResponse" } } } } }, "security": [ { "httpAuth": [] } ] }, "post": { "tags": [ "Compliance" ], "summary": "Creates screening rules for connected provider of the given domain", "operationId": "ConfigureScreeningRulesForDomainAndProvider", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "provider", "in": "path", "required": true, "schema": { "enum": [ "ELLIPTIC", "CHAINALYSIS" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Compliance_ConfigureScreeningRulesRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Compliance_ErrorResponse" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/compliance/policy": { "post": { "tags": [ "Compliance" ], "summary": "Create Compliance Policy Payload", "operationId": "CreatePolicyPayload", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Compliance_PolicyPayloadRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Compliance_ErrorResponse" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/compliance/domain": { "post": { "tags": [ "Compliance" ], "summary": "Creates Domain payload", "operationId": "CreateDomainPayload", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Compliance_DomainPayloadRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Compliance_ErrorResponse" } } } } } }, "delete": { "tags": [ "Compliance" ], "summary": "Delete compliance domain", "operationId": "DeleteComplianceDomain", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Compliance_ValidateComplianceDomainCreationResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Compliance_ErrorResponse" } } } } } } }, "/v1/domains/{domainId}/compliance/domain/validation": { "post": { "tags": [ "Compliance" ], "summary": "Check if compliance domain creation/injection is allowed", "operationId": "ValidateComplianceDomainCreation", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Compliance_ValidateComplianceDomainCreationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Compliance_ValidateComplianceDomainCreationResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Compliance_ErrorResponse" } } } } } } }, "/v1/domains/{domainId}/compliance/analysis": { "post": { "tags": [ "Compliance" ], "summary": "Retrieves compliance analysis against all established external providers.", "operationId": "analysis", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Compliance_ComplianceAnalysisRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Compliance_ComplianceAnalysisResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Compliance_ErrorResponse" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/compliance/analysis/preview": { "post": { "tags": [ "Compliance" ], "summary": "Performs a preview analysis of the wallet", "operationId": "PreviewAnalysis", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Compliance_WalletAnalysisRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Compliance_WalletAnalysisResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Compliance_ErrorResponse" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/compliance/transactionType/{transactionType}/exception-role": { "get": { "tags": [ "Compliance" ], "summary": "Gets Exception role for the domain", "operationId": "GetExceptionRole", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "transactionType", "in": "path", "required": true, "schema": { "enum": [ "INCOMING", "OUTGOING" ], "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Compliance_ExceptionRoleResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Compliance_ErrorResponse" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/compliance/provider-connection": { "get": { "tags": [ "Compliance" ], "summary": "Retrieves connected provider connection details for the given domain", "operationId": "GetAllProviderConnectionForDomain", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Compliance_ProviderConnectionsResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Compliance_ErrorResponse" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/compliance/policy/{policyType}/transaction/{transactionType}": { "get": { "tags": [ "Compliance" ], "summary": "Gets Compliance policy for the domain", "operationId": "GetPolicy", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "policyType", "in": "path", "required": true, "schema": { "enum": [ "AUTOMATIC", "EXCEPTION" ], "type": "string" } }, { "name": "transactionType", "in": "path", "required": true, "schema": { "enum": [ "INCOMING", "OUTGOING" ], "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Compliance_PolicyResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Compliance_ErrorResponse" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/compliance/providers/{provider}": { "delete": { "tags": [ "Compliance" ], "summary": "Deletes provider connection and screening rules for the given domain & provider", "operationId": "DeleteProviderConnectionAndScreeningRules", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "provider", "in": "path", "required": true, "schema": { "enum": [ "ELLIPTIC", "CHAINALYSIS" ], "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Compliance_ErrorResponse" } } } } }, "security": [ { "httpAuth": [] } ] } }, "/v1/domains/{domainId}/channels": { "get": { "tags": [ "Event Distribution Service" ], "operationId": "getAllChannels", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EDS_Channel" } } } } } } }, "post": { "tags": [ "Event Distribution Service" ], "operationId": "createChannel", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/EDS_WebhookChannelCreate" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/EDS_Channel" } } } } } } }, "/v1/domains/{domainId}/channels/{channelId}/test": { "post": { "tags": [ "Event Distribution Service" ], "operationId": "testChannel", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/domains/{domainId}/channels/{channelId}": { "get": { "tags": [ "Event Distribution Service" ], "operationId": "getChannel", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/EDS_Channel" } } } } } }, "delete": { "tags": [ "Event Distribution Service" ], "operationId": "deleteChannel", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "patch": { "tags": [ "Event Distribution Service" ], "operationId": "updateChannel", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EDS_ChannelUpdate" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/EDS_Channel" } } } } } } }, "/v1/domains/{domainId}/channels/{channelId}/events": { "get": { "tags": [ "Event Distribution Service" ], "operationId": "getAllChannelEvents", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EDS_Event" } } } } } } } }, "/v1/domains/{domainId}/channels/{channelId}/events/{eventId}": { "get": { "tags": [ "Event Distribution Service" ], "operationId": "getEvent", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "eventId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/EDS_Event" } } } } } } }, "/v1/domains/{domainId}/channels/events": { "get": { "tags": [ "Event Distribution Service" ], "operationId": "getAllEvents", "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EDS_Event" } } } } } } } } }, "components": { "schemas": { "Core_Account": { "required": [ "id", "domainId", "alias", "providerDetails", "lock", "metadata" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "domainId": { "type": "string", "format": "uuid" }, "alias": { "maxLength": 75, "minLength": 1, "type": "string" }, "ledgerId": { "maxLength": 100, "minLength": 1, "type": "string" }, "providerDetails": { "$ref": "#/components/schemas/Core_AccountProviderInformation" }, "lock": { "$ref": "#/components/schemas/Core_LockStatus" }, "metadata": { "$ref": "#/components/schemas/Core_EntityMetadata" } } }, "Core_AccountAdditionalDetails": { "required": [ "processing", "ledgers" ], "type": "object", "properties": { "processing": { "$ref": "#/components/schemas/Core_AccountProcessingDetails" }, "lastBalancesUpdateRequestedAt": { "type": "string", "format": "date-time", "deprecated": true }, "lastBalancesUpdateProcessedAt": { "type": "string", "format": "date-time", "deprecated": true }, "ledgers": { "type": "array", "items": { "$ref": "#/components/schemas/Core_ApiAccountLedgerProcessing" } } } }, "Core_AccountAddress": { "required": [ "data", "id", "ledgerId", "address", "createdAt", "scope" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Core_AccountAddressData" }, "id": { "type": "string", "description": "Deletion target: Dec. 1st 2024", "format": "uuid", "deprecated": true }, "ledgerId": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Deletion target: Dec. 1st 2024", "deprecated": true }, "address": { "maxLength": 512, "minLength": 1, "type": "string", "description": "Deletion target: Dec. 1st 2024", "deprecated": true }, "keyPath": { "minLength": 1, "type": "string", "description": "Deletion target: Dec. 1st 2024", "deprecated": true }, "signature": { "type": "string", "format": "base64" }, "signingKey": { "type": "string", "format": "base64" }, "createdAt": { "type": "string", "description": "Deletion target: Dec. 1st 2024", "format": "date-time", "deprecated": true }, "scope": { "enum": [ "Internal", "External" ], "type": "string", "description": "Deletion target: Dec. 1st 2024", "example": "External", "deprecated": true } } }, "Core_AccountAddressData": { "required": [ "id", "ledgerId", "address", "createdAt", "scope" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "ledgerId": { "maxLength": 100, "minLength": 1, "type": "string" }, "domainId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "address": { "maxLength": 512, "minLength": 1, "type": "string" }, "keyPath": { "minLength": 1, "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "scope": { "enum": [ "Internal", "External" ], "type": "string", "example": "External" } } }, "Core_AccountAddressReference": { "required": [ "id", "address", "ledgerId", "domainId", "accountId", "createdAt", "custodyType", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "address": { "maxLength": 512, "minLength": 1, "type": "string" }, "ledgerId": { "maxLength": 100, "minLength": 1, "type": "string" }, "domainId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "custodyType": { "$ref": "#/components/schemas/Core_CustodyType" }, "type": { "enum": [ "AccountAddressReference" ], "type": "string" } } }, "Core_AccountAddressScope": { "enum": [ "Internal", "External" ], "type": "string" }, "Core_AccountCreated": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "enum": [ "AccountCreated" ], "type": "string" } } }, "Core_AccountKeyStrategy": { "enum": [ "VaultHard", "VaultSoft", "Random" ], "type": "string" }, "Core_AccountLedgerProcessingDetails": { "oneOf": [ { "$ref": "#/components/schemas/Core_AccountLedgerProcessingDetails_Pending" }, { "$ref": "#/components/schemas/Core_AccountLedgerProcessingDetails_Preparing" }, { "$ref": "#/components/schemas/Core_AccountLedgerProcessingDetails_Recovering" }, { "$ref": "#/components/schemas/Core_AccountLedgerProcessingDetails_Tracked" } ], "discriminator": { "propertyName": "status", "mapping": { "Pending": "#/components/schemas/Core_AccountLedgerProcessingDetails_Pending", "Preparing": "#/components/schemas/Core_AccountLedgerProcessingDetails_Preparing", "Recovering": "#/components/schemas/Core_AccountLedgerProcessingDetails_Recovering", "Tracked": "#/components/schemas/Core_AccountLedgerProcessingDetails_Tracked" } } }, "Core_AccountLedgerProcessingDetails_Pending": { "required": [ "status" ], "type": "object", "properties": { "hint": { "$ref": "#/components/schemas/Core_AccountLedgerProcessingDetails_Pending_Hint" }, "status": { "enum": [ "Pending" ], "type": "string" } } }, "Core_AccountLedgerProcessingDetails_Pending_Hint": { "enum": [ "TransientIssue", "InternalError" ], "type": "string" }, "Core_AccountLedgerProcessingDetails_Preparing": { "required": [ "status" ], "type": "object", "properties": { "hint": { "$ref": "#/components/schemas/Core_AccountLedgerProcessingDetails_Preparing_Hint" }, "status": { "enum": [ "Preparing" ], "type": "string" } } }, "Core_AccountLedgerProcessingDetails_Preparing_Hint": { "enum": [ "TransientIssue", "InternalError" ], "type": "string" }, "Core_AccountLedgerProcessingDetails_Recovering": { "required": [ "status" ], "type": "object", "properties": { "hint": { "$ref": "#/components/schemas/Core_AccountLedgerProcessingDetails_Recovering_Hint" }, "status": { "enum": [ "Recovering" ], "type": "string" } } }, "Core_AccountLedgerProcessingDetails_Recovering_Hint": { "enum": [ "TransientIssue", "InternalError" ], "type": "string" }, "Core_AccountLedgerProcessingDetails_Tracked": { "required": [ "status" ], "type": "object", "properties": { "hint": { "$ref": "#/components/schemas/Core_AccountLedgerProcessingDetails_Tracked_Hint" }, "status": { "enum": [ "Tracked" ], "type": "string" } } }, "Core_AccountLedgerProcessingDetails_Tracked_Hint": { "enum": [ "TransientIssue", "InternalError" ], "type": "string" }, "Core_AccountLedgerStatus": { "enum": [ "Activating", "AwaitingLedgerActivation", "Activated" ], "type": "string" }, "Core_AccountProcessingDetails": { "oneOf": [ { "$ref": "#/components/schemas/Core_AccountProcessingDetails_Completed" }, { "$ref": "#/components/schemas/Core_AccountProcessingDetails_Interrupted" }, { "$ref": "#/components/schemas/Core_AccountProcessingDetails_Pending" }, { "$ref": "#/components/schemas/Core_AccountProcessingDetails_Preparing" }, { "$ref": "#/components/schemas/Core_AccountProcessingDetails_Recovering" }, { "$ref": "#/components/schemas/Core_AccountProcessingDetails_Tracked" } ], "discriminator": { "propertyName": "status", "mapping": { "Completed": "#/components/schemas/Core_AccountProcessingDetails_Completed", "Interrupted": "#/components/schemas/Core_AccountProcessingDetails_Interrupted", "Pending": "#/components/schemas/Core_AccountProcessingDetails_Pending", "Preparing": "#/components/schemas/Core_AccountProcessingDetails_Preparing", "Recovering": "#/components/schemas/Core_AccountProcessingDetails_Recovering", "Tracked": "#/components/schemas/Core_AccountProcessingDetails_Tracked" } } }, "Core_AccountProcessingDetails_Completed": { "required": [ "status" ], "type": "object", "properties": { "status": { "enum": [ "Completed" ], "type": "string" } } }, "Core_AccountProcessingDetails_Interrupted": { "required": [ "reason", "status" ], "type": "object", "properties": { "reason": { "maxLength": 200, "minLength": 1, "type": "string" }, "status": { "enum": [ "Interrupted" ], "type": "string" } } }, "Core_AccountProcessingDetails_Pending": { "required": [ "status" ], "type": "object", "properties": { "hint": { "$ref": "#/components/schemas/Core_ApiPendingAccountProcessingHint" }, "status": { "enum": [ "Pending" ], "type": "string" } } }, "Core_AccountProcessingDetails_Preparing": { "required": [ "status" ], "type": "object", "properties": { "hint": { "$ref": "#/components/schemas/Core_ApiPreparingAccountProcessingHint" }, "status": { "enum": [ "Preparing" ], "type": "string" } } }, "Core_AccountProcessingDetails_Recovering": { "required": [ "status" ], "type": "object", "properties": { "hint": { "$ref": "#/components/schemas/Core_ApiRecoveringAccountProcessingHint" }, "status": { "enum": [ "Recovering" ], "type": "string" } } }, "Core_AccountProcessingDetails_Tracked": { "required": [ "status" ], "type": "object", "properties": { "status": { "enum": [ "Tracked" ], "type": "string" } } }, "Core_AccountProcessingStatus": { "enum": [ "Pending", "Preparing", "Tracked", "Recovering", "Completed", "Interrupted" ], "type": "string" }, "Core_AccountProviderInformation": { "oneOf": [ { "$ref": "#/components/schemas/Core_AccountProviderInformation_Vault" } ], "discriminator": { "propertyName": "type", "mapping": { "Vault": "#/components/schemas/Core_AccountProviderInformation_Vault" } } }, "Core_AccountProviderInformation_Vault": { "required": [ "vaultId", "keyStrategy", "keyInformation", "type" ], "type": "object", "properties": { "vaultId": { "type": "string", "format": "uuid" }, "keyStrategy": { "$ref": "#/components/schemas/Core_AccountKeyStrategy" }, "keyInformation": { "$ref": "#/components/schemas/Core_VaultAccountKeyInformation" }, "keys": { "type": "array", "items": { "$ref": "#/components/schemas/Core_VaultAccountProviderInformation_Key" } }, "type": { "enum": [ "Vault" ], "type": "string" } } }, "Core_AccountPublicKey": { "oneOf": [ { "$ref": "#/components/schemas/Core_AccountPublicKey_ExtendedPublicKey" }, { "$ref": "#/components/schemas/Core_AccountPublicKey_PublicKey" } ], "discriminator": { "propertyName": "type", "mapping": { "ExtendedPublicKey": "#/components/schemas/Core_AccountPublicKey_ExtendedPublicKey", "PublicKey": "#/components/schemas/Core_AccountPublicKey_PublicKey" } } }, "Core_AccountPublicKeyExtendedOnly": { "oneOf": [ { "$ref": "#/components/schemas/Core_AccountPublicKeyExtendedOnly_ExtendedPublicKey" } ], "discriminator": { "propertyName": "type", "mapping": { "ExtendedPublicKey": "#/components/schemas/Core_AccountPublicKeyExtendedOnly_ExtendedPublicKey" } } }, "Core_AccountPublicKeyExtendedOnly_ExtendedPublicKey": { "required": [ "value", "chainCode", "type" ], "type": "object", "properties": { "value": { "type": "string", "format": "base64" }, "chainCode": { "type": "string", "format": "base64" }, "type": { "enum": [ "ExtendedPublicKey" ], "type": "string" } } }, "Core_AccountPublicKeyOnly": { "oneOf": [ { "$ref": "#/components/schemas/Core_AccountPublicKeyOnly_PublicKey" } ], "discriminator": { "propertyName": "type", "mapping": { "PublicKey": "#/components/schemas/Core_AccountPublicKeyOnly_PublicKey" } } }, "Core_AccountPublicKeyOnly_PublicKey": { "required": [ "value", "type" ], "type": "object", "properties": { "value": { "type": "string", "format": "base64" }, "type": { "enum": [ "PublicKey" ], "type": "string" } } }, "Core_AccountPublicKey_ExtendedPublicKey": { "required": [ "value", "chainCode", "type" ], "type": "object", "properties": { "value": { "type": "string", "format": "base64" }, "chainCode": { "type": "string", "format": "base64" }, "type": { "enum": [ "ExtendedPublicKey" ], "type": "string" } } }, "Core_AccountPublicKey_PublicKey": { "required": [ "value", "type" ], "type": "object", "properties": { "value": { "type": "string", "format": "base64" }, "type": { "enum": [ "PublicKey" ], "type": "string" } } }, "Core_AccountReference": { "required": [ "id", "domainId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "domainId": { "type": "string", "format": "uuid" } } }, "Core_AccountUpdated": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "enum": [ "AccountUpdated" ], "type": "string" } } }, "Core_AccountsCollection": { "required": [ "items", "count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core_ApiAccount" } }, "count": { "type": "integer", "format": "int32" }, "currentStartingAfter": { "type": "string" }, "nextStartingAfter": { "type": "string" } } }, "Core_AddressCreated": { "required": [ "id", "accountReference", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "accountReference": { "$ref": "#/components/schemas/Core_AccountReference" }, "type": { "enum": [ "AddressCreated" ], "type": "string" } } }, "Core_AddressDetails": { "required": [ "address", "resolvedEndpoints" ], "type": "object", "properties": { "address": { "maxLength": 512, "minLength": 1, "type": "string" }, "resolvedEndpoints": { "type": "array", "items": { "$ref": "#/components/schemas/Core_ResolvedEndpoint" } } } }, "Core_AddressForChange": { "enum": [ "GenerateNewAddress", "PrimaryAddress" ], "type": "string", "description": "Override default change address strategy to set explicitly PrimaryAddress or GenerateNewAddress." }, "Core_AddressReferenceCollection": { "required": [ "items", "count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core_AddressesReference" } }, "count": { "type": "integer", "format": "int32" }, "currentStartingAfter": { "type": "string" }, "nextStartingAfter": { "type": "string" } } }, "Core_AddressesCollection": { "required": [ "items", "count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core_AccountAddress" } }, "count": { "type": "integer", "format": "int32" }, "currentStartingAfter": { "type": "string" }, "nextStartingAfter": { "type": "string" } } }, "Core_AddressesReference": { "oneOf": [ { "$ref": "#/components/schemas/Core_AccountAddressReference" } ], "discriminator": { "propertyName": "type", "mapping": { "AccountAddressReference": "#/components/schemas/Core_AccountAddressReference" } } }, "Core_AlgorandFeeStrategy": { "oneOf": [ { "$ref": "#/components/schemas/Core_AlgorandFeeStrategy_Priority" } ], "discriminator": { "propertyName": "type", "mapping": { "Priority": "#/components/schemas/Core_AlgorandFeeStrategy_Priority" } } }, "Core_AlgorandFeeStrategy_Priority": { "required": [ "priority", "type" ], "type": "object", "properties": { "priority": { "$ref": "#/components/schemas/Core_FeePriority" }, "type": { "enum": [ "Priority" ], "type": "string" } } }, "Core_AlgorandOperation": { "oneOf": [ { "$ref": "#/components/schemas/Core_AlgorandOperation_Payment" } ], "discriminator": { "propertyName": "type", "mapping": { "Payment": "#/components/schemas/Core_AlgorandOperation_Payment" } } }, "Core_AlgorandOperation_Payment": { "required": [ "destination", "amount", "type" ], "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/Core_TransactionDestination" }, "amount": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "Payment" ], "type": "string" } } }, "Core_AlgorandTickerProperties": { "oneOf": [ { "$ref": "#/components/schemas/Core_AlgorandTickerProperties_Native" } ], "discriminator": { "propertyName": "type", "mapping": { "Native": "#/components/schemas/Core_AlgorandTickerProperties_Native" } } }, "Core_AlgorandTickerProperties_Native": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "Native" ], "type": "string" } } }, "Core_ApiAccount": { "required": [ "data", "signature", "signingKey" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Core_Account" }, "signature": { "type": "string", "format": "base64" }, "signingKey": { "type": "string", "format": "base64" }, "additionalDetails": { "$ref": "#/components/schemas/Core_AccountAdditionalDetails" } } }, "Core_ApiAccountLedgerProcessing": { "oneOf": [ { "$ref": "#/components/schemas/Core_ApiAccountLedgerProcessing_Activated" }, { "$ref": "#/components/schemas/Core_ApiAccountLedgerProcessing_Activating" }, { "$ref": "#/components/schemas/Core_ApiAccountLedgerProcessing_Available" }, { "$ref": "#/components/schemas/Core_ApiAccountLedgerProcessing_AwaitingLedgerActivation" }, { "$ref": "#/components/schemas/Core_ApiAccountLedgerProcessing_Unavailable" } ], "discriminator": { "propertyName": "status", "mapping": { "Activated": "#/components/schemas/Core_ApiAccountLedgerProcessing_Activated", "Activating": "#/components/schemas/Core_ApiAccountLedgerProcessing_Activating", "Available": "#/components/schemas/Core_ApiAccountLedgerProcessing_Available", "AwaitingLedgerActivation": "#/components/schemas/Core_ApiAccountLedgerProcessing_AwaitingLedgerActivation", "Unavailable": "#/components/schemas/Core_ApiAccountLedgerProcessing_Unavailable" } } }, "Core_ApiAccountLedgerProcessing_Activated": { "required": [ "ledgerId", "status" ], "type": "object", "properties": { "ledgerId": { "maxLength": 100, "minLength": 1, "type": "string" }, "lastBalancesUpdateRequestedAt": { "type": "string", "format": "date-time" }, "lastBalancesUpdateProcessedAt": { "type": "string", "format": "date-time" }, "status": { "enum": [ "Activated" ], "type": "string" } } }, "Core_ApiAccountLedgerProcessing_Activating": { "required": [ "ledgerId", "processing", "status" ], "type": "object", "properties": { "ledgerId": { "maxLength": 100, "minLength": 1, "type": "string" }, "processing": { "$ref": "#/components/schemas/Core_AccountLedgerProcessingDetails" }, "status": { "enum": [ "Activating" ], "type": "string" } } }, "Core_ApiAccountLedgerProcessing_Available": { "required": [ "ledgerId", "status" ], "type": "object", "properties": { "ledgerId": { "maxLength": 100, "minLength": 1, "type": "string" }, "status": { "enum": [ "Available" ], "type": "string" } } }, "Core_ApiAccountLedgerProcessing_AwaitingLedgerActivation": { "required": [ "ledgerId", "status" ], "type": "object", "properties": { "ledgerId": { "maxLength": 100, "minLength": 1, "type": "string" }, "status": { "enum": [ "AwaitingLedgerActivation" ], "type": "string" } } }, "Core_ApiAccountLedgerProcessing_Unavailable": { "required": [ "ledgerId", "status" ], "type": "object", "properties": { "ledgerId": { "maxLength": 100, "minLength": 1, "type": "string" }, "status": { "enum": [ "Unavailable" ], "type": "string" } } }, "Core_ApiBackup": { "required": [ "id", "data", "metadata" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/Core_ApiBackupData" }, "metadata": { "$ref": "#/components/schemas/Core_EntityMetadata" }, "additionalDetails": { "$ref": "#/components/schemas/Core_BackupAdditionalDetails" } } }, "Core_ApiBackupData": { "oneOf": [ { "$ref": "#/components/schemas/Core_ApiBackupData_VaultHSM" }, { "$ref": "#/components/schemas/Core_ApiBackupData_VaultMPC" } ], "discriminator": { "propertyName": "type", "mapping": { "VaultHSM": "#/components/schemas/Core_ApiBackupData_VaultHSM", "VaultMPC": "#/components/schemas/Core_ApiBackupData_VaultMPC" } } }, "Core_ApiBackupData_VaultHSM": { "required": [ "vaultId", "acknowledged", "type" ], "type": "object", "properties": { "vaultId": { "type": "string", "format": "uuid" }, "acknowledged": { "type": "boolean" }, "type": { "enum": [ "VaultHSM" ], "type": "string" } } }, "Core_ApiBackupData_VaultMPC": { "required": [ "vaultId", "acknowledged", "type" ], "type": "object", "properties": { "vaultId": { "type": "string", "format": "uuid" }, "acknowledged": { "type": "boolean" }, "type": { "enum": [ "VaultMPC" ], "type": "string" } } }, "Core_ApiBroadcastingTransactionProcessingHint": { "enum": [ "CurrentlyFeesTooSmall", "CurrentlyRejectedByLedger", "InternalError", "TransientIssue" ], "type": "string" }, "Core_ApiDryRunTransactionProcessingHint": { "enum": [ "AccountAlreadyActivatedOnLedger", "AccountNotReadyOnLedger", "BroadcastExpired", "CurrentlyFeesTooLarge", "CurrentlyFeesTooSmall", "CurrentlyFundsTooFragmented", "CurrentlyNotEnoughFunds", "CurrentlyUnusableDestination", "InternalError", "InvalidAccountStateOnLedger", "InvalidAmount", "InvalidContractParameters", "InvalidDestination", "InvalidUserPayload", "LockedDestination", "OnLedgerFailure", "ReplacementTransactionFeesTooLow", "TransactionEstimationFailure", "TransactionNotEligibleForReplacement", "TransactionRejected", "TransientIssue" ], "type": "string" }, "Core_ApiFailedTransactionProcessingHint": { "enum": [ "AccountAlreadyActivatedOnLedger", "BroadcastExpired", "InternalError", "InvalidAccountStateOnLedger", "InvalidAmount", "InvalidContractParameters", "InvalidDestination", "InvalidUserPayload", "LockedDestination", "OnLedgerFailure", "ReplacementTransactionFeesTooLow", "TransactionNotEligibleForReplacement", "TransactionRejected", "TransientIssue" ], "type": "string" }, "Core_ApiInterruptedTransactionCause": { "enum": [ "Cancellation", "Internal", "Replacement" ], "type": "string" }, "Core_ApiManifest": { "required": [ "data", "signature", "signingKey" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Core_Manifest" }, "signature": { "type": "string", "format": "base64" }, "signingKey": { "type": "string", "format": "base64" }, "additionalDetails": { "$ref": "#/components/schemas/Core_ManifestAdditionalDetails" } } }, "Core_ApiPendingAccountProcessingHint": { "enum": [ "TransientIssue", "InternalError" ], "type": "string" }, "Core_ApiPendingTransactionProcessingHint": { "enum": [ "InternalError", "TransientIssue" ], "type": "string" }, "Core_ApiPreparingAccountProcessingHint": { "enum": [ "TransientIssue", "InternalError" ], "type": "string" }, "Core_ApiPreparingTransactionProcessingHint": { "enum": [ "AccountAlreadyActivatedOnLedger", "AccountNotReadyOnLedger", "CurrentlyFeesTooLarge", "CurrentlyFeesTooSmall", "CurrentlyFundsTooFragmented", "CurrentlyNotEnoughFunds", "CurrentlyUnusableDestination", "InternalError", "InvalidAccountStateOnLedger", "InvalidContractParameters", "InvalidDestination", "OnLedgerFailure", "TransactionEstimationFailure", "TransientIssue" ], "type": "string" }, "Core_ApiRecoveringAccountProcessingHint": { "enum": [ "TransientIssue", "InternalError" ], "type": "string" }, "Core_ApiRoles": { "required": [ "roles" ], "type": "object", "properties": { "roles": { "type": "array", "items": { "maxLength": 50, "minLength": 1, "pattern": "[a-z0-9\\-]+", "type": "string" } } } }, "Core_ApiTicker": { "required": [ "id", "ledgerId", "kind", "name", "ledgerDetails", "data" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "deprecated": true }, "ledgerId": { "maxLength": 100, "minLength": 1, "type": "string", "deprecated": true }, "kind": { "$ref": "#/components/schemas/Core_TickerKind" }, "name": { "maxLength": 100, "minLength": 1, "type": "string", "deprecated": true }, "decimals": { "type": "integer", "format": "int32", "deprecated": true }, "symbol": { "maxLength": 100, "minLength": 1, "type": "string", "deprecated": true }, "ledgerDetails": { "$ref": "#/components/schemas/Core_TickerLedgerDetails" }, "data": { "$ref": "#/components/schemas/Core_ApiTickerData" }, "signature": { "type": "string", "format": "base64" } } }, "Core_ApiTickerData": { "required": [ "id", "ledgerId", "kind", "name", "ledgerDetails", "lock" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "ledgerId": { "maxLength": 100, "minLength": 1, "type": "string" }, "kind": { "$ref": "#/components/schemas/Core_TickerKind" }, "name": { "maxLength": 100, "minLength": 1, "type": "string" }, "decimals": { "type": "integer", "format": "int32" }, "symbol": { "maxLength": 100, "minLength": 1, "type": "string" }, "ledgerDetails": { "$ref": "#/components/schemas/Core_TickerLedgerDetails" }, "lock": { "$ref": "#/components/schemas/Core_LockStatus" }, "metadata": { "$ref": "#/components/schemas/Core_EntityMetadata" } } }, "Core_ApiTransaction": { "required": [ "id", "ledgerId", "relatedAccounts", "registeredAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "ledgerId": { "maxLength": 100, "minLength": 1, "type": "string" }, "orderReference": { "$ref": "#/components/schemas/Core_TransactionOrderReference" }, "relatedAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/Core_TransactionRelatedAccountReference" } }, "processing": { "$ref": "#/components/schemas/Core_ApiTransactionProcessingDetails" }, "registeredAt": { "type": "string", "format": "date-time" }, "ledgerTransactionData": { "$ref": "#/components/schemas/Core_LedgerTransactionData" } } }, "Core_ApiTransactionProcessingDetails": { "oneOf": [ { "$ref": "#/components/schemas/Core_ApiTransactionProcessingDetails_Broadcasting" }, { "$ref": "#/components/schemas/Core_ApiTransactionProcessingDetails_Completed" }, { "$ref": "#/components/schemas/Core_ApiTransactionProcessingDetails_Failed" }, { "$ref": "#/components/schemas/Core_ApiTransactionProcessingDetails_Interrupted" }, { "$ref": "#/components/schemas/Core_ApiTransactionProcessingDetails_Pending" }, { "$ref": "#/components/schemas/Core_ApiTransactionProcessingDetails_Prepared" }, { "$ref": "#/components/schemas/Core_ApiTransactionProcessingDetails_Preparing" }, { "$ref": "#/components/schemas/Core_ApiTransactionProcessingDetails_Reserved" } ], "discriminator": { "propertyName": "status", "mapping": { "Broadcasting": "#/components/schemas/Core_ApiTransactionProcessingDetails_Broadcasting", "Completed": "#/components/schemas/Core_ApiTransactionProcessingDetails_Completed", "Failed": "#/components/schemas/Core_ApiTransactionProcessingDetails_Failed", "Interrupted": "#/components/schemas/Core_ApiTransactionProcessingDetails_Interrupted", "Pending": "#/components/schemas/Core_ApiTransactionProcessingDetails_Pending", "Prepared": "#/components/schemas/Core_ApiTransactionProcessingDetails_Prepared", "Preparing": "#/components/schemas/Core_ApiTransactionProcessingDetails_Preparing", "Reserved": "#/components/schemas/Core_ApiTransactionProcessingDetails_Reserved" } } }, "Core_ApiTransactionProcessingDetails_Broadcasting": { "required": [ "status" ], "type": "object", "properties": { "hint": { "$ref": "#/components/schemas/Core_ApiBroadcastingTransactionProcessingHint" }, "status": { "enum": [ "Broadcasting" ], "type": "string" } } }, "Core_ApiTransactionProcessingDetails_Completed": { "required": [ "status" ], "type": "object", "properties": { "status": { "enum": [ "Completed" ], "type": "string" } } }, "Core_ApiTransactionProcessingDetails_Failed": { "required": [ "hint", "status" ], "type": "object", "properties": { "hint": { "$ref": "#/components/schemas/Core_ApiFailedTransactionProcessingHint" }, "status": { "enum": [ "Failed" ], "type": "string" } } }, "Core_ApiTransactionProcessingDetails_Interrupted": { "required": [ "reason", "cause", "status" ], "type": "object", "properties": { "reason": { "maxLength": 200, "minLength": 1, "type": "string" }, "cause": { "$ref": "#/components/schemas/Core_ApiInterruptedTransactionCause" }, "status": { "enum": [ "Interrupted" ], "type": "string" } } }, "Core_ApiTransactionProcessingDetails_Pending": { "required": [ "status" ], "type": "object", "properties": { "hint": { "$ref": "#/components/schemas/Core_ApiPendingTransactionProcessingHint" }, "status": { "enum": [ "Pending" ], "type": "string" } } }, "Core_ApiTransactionProcessingDetails_Prepared": { "required": [ "status" ], "type": "object", "properties": { "status": { "enum": [ "Prepared" ], "type": "string" } } }, "Core_ApiTransactionProcessingDetails_Preparing": { "required": [ "status" ], "type": "object", "properties": { "hint": { "$ref": "#/components/schemas/Core_ApiPreparingTransactionProcessingHint" }, "status": { "enum": [ "Preparing" ], "type": "string" } } }, "Core_ApiTransactionProcessingDetails_Reserved": { "required": [ "status" ], "type": "object", "properties": { "status": { "enum": [ "Reserved" ], "type": "string" } } }, "Core_ApiTransfer": { "required": [ "id", "tickerId", "quarantined", "senders", "value", "kind", "registeredAt", "metadata" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "transactionId": { "type": "string", "format": "uuid" }, "tickerId": { "type": "string", "format": "uuid" }, "quarantined": { "type": "boolean" }, "senders": { "type": "array", "items": { "$ref": "#/components/schemas/Core_SenderTransferParty" } }, "recipient": { "$ref": "#/components/schemas/Core_RecipientTransferParty" }, "value": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "kind": { "$ref": "#/components/schemas/Core_TransferKind" }, "registeredAt": { "type": "string", "format": "date-time" }, "metadata": { "$ref": "#/components/schemas/Core_TransferMetadata" } } }, "Core_ApiTrustedBackup": { "required": [ "data", "signature", "signingKey" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Core_Backup" }, "signature": { "type": "string", "format": "base64" }, "signingKey": { "type": "string", "format": "base64" }, "additionalDetails": { "$ref": "#/components/schemas/Core_BackupAdditionalDetails" } } }, "Core_ApiVault": { "required": [ "data", "signature", "signingKey" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Core_Vault" }, "signature": { "type": "string", "format": "base64" }, "signingKey": { "type": "string", "format": "base64" }, "additionalDetails": { "$ref": "#/components/schemas/Core_VaultAdditionalDetails" } } }, "Core_ApprovalDecision": { "enum": [ "Approve", "Reject" ], "type": "string" }, "Core_Approve": { "required": [ "author", "targetDomainId", "intentId", "proposalSignature", "type" ], "type": "object", "properties": { "author": { "$ref": "#/components/schemas/Core_UserReference" }, "expiryAt": { "type": "string", "format": "date-time", "deprecated": true }, "targetDomainId": { "type": "string", "format": "uuid" }, "intentId": { "type": "string", "format": "uuid" }, "proposalSignature": { "type": "string", "format": "base64" }, "approvalReason": { "maxLength": 5000, "minLength": 0, "type": "string" }, "type": { "enum": [ "Approve" ], "type": "string" } } }, "Core_ApproveIntentBody": { "required": [ "request", "signature" ], "type": "object", "properties": { "request": { "$ref": "#/components/schemas/Core_Approve" }, "signature": { "type": "string", "format": "base64" } } }, "Core_Backup": { "required": [ "id", "data", "metadata" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/Core_BackupData" }, "metadata": { "$ref": "#/components/schemas/Core_EntityMetadata" } } }, "Core_BackupAdditionalDetails": { "required": [ "processing" ], "type": "object", "properties": { "processing": { "$ref": "#/components/schemas/Core_BackupProcessingDetails" } } }, "Core_BackupCreated": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "enum": [ "BackupCreated" ], "type": "string" } } }, "Core_BackupData": { "oneOf": [ { "$ref": "#/components/schemas/Core_BackupData_VaultHsm" }, { "$ref": "#/components/schemas/Core_BackupData_VaultMpc" } ], "discriminator": { "propertyName": "type", "mapping": { "VaultHsm": "#/components/schemas/Core_BackupData_VaultHsm", "VaultMpc": "#/components/schemas/Core_BackupData_VaultMpc" } } }, "Core_BackupData_VaultHsm": { "required": [ "vaultId", "data", "type" ], "type": "object", "properties": { "vaultId": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/Core_VaultHsmBackupData" }, "type": { "enum": [ "VaultHsm" ], "type": "string" } } }, "Core_BackupData_VaultMpc": { "required": [ "vaultId", "type" ], "type": "object", "properties": { "vaultId": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/Core_VaultMpcBackupData" }, "type": { "enum": [ "VaultMpc" ], "type": "string" } } }, "Core_BackupProcessingDetails": { "oneOf": [ { "$ref": "#/components/schemas/Core_BackupProcessingDetails_Completed" }, { "$ref": "#/components/schemas/Core_BackupProcessingDetails_Failed" }, { "$ref": "#/components/schemas/Core_BackupProcessingDetails_Pending" }, { "$ref": "#/components/schemas/Core_BackupProcessingDetails_Preparing" } ], "discriminator": { "propertyName": "status", "mapping": { "Completed": "#/components/schemas/Core_BackupProcessingDetails_Completed", "Failed": "#/components/schemas/Core_BackupProcessingDetails_Failed", "Pending": "#/components/schemas/Core_BackupProcessingDetails_Pending", "Preparing": "#/components/schemas/Core_BackupProcessingDetails_Preparing" } } }, "Core_BackupProcessingDetails_Completed": { "required": [ "status" ], "type": "object", "properties": { "status": { "enum": [ "Completed" ], "type": "string" } } }, "Core_BackupProcessingDetails_Failed": { "required": [ "status" ], "type": "object", "properties": { "status": { "enum": [ "Failed" ], "type": "string" } } }, "Core_BackupProcessingDetails_Pending": { "required": [ "status" ], "type": "object", "properties": { "status": { "enum": [ "Pending" ], "type": "string" } } }, "Core_BackupProcessingDetails_Preparing": { "required": [ "status" ], "type": "object", "properties": { "status": { "enum": [ "Preparing" ], "type": "string" } } }, "Core_BackupProcessingStatus": { "enum": [ "Pending", "Preparing", "Completed", "Failed" ], "type": "string" }, "Core_BackupType": { "enum": [ "VaultHsm", "VaultMpc" ], "type": "string" }, "Core_BackupUpdated": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "enum": [ "BackupUpdated" ], "type": "string" } } }, "Core_BackupsCollection": { "required": [ "items", "count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core_ApiBackup" } }, "count": { "type": "integer", "format": "int32" }, "currentStartingAfter": { "type": "string" }, "nextStartingAfter": { "type": "string" } } }, "Core_Balance": { "required": [ "accountReference", "tickerId", "totalAmount", "reservedAmount", "quarantinedAmount", "lastUpdatedAt" ], "type": "object", "properties": { "accountReference": { "$ref": "#/components/schemas/Core_AccountReference" }, "tickerId": { "type": "string", "format": "uuid" }, "totalAmount": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "reservedAmount": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "quarantinedAmount": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "lastUpdatedAt": { "type": "string", "format": "date-time" } } }, "Core_BalanceWithConfirmedAmount": { "required": [ "accountReference", "tickerId", "confirmedAmount", "unconfirmedAmount", "reservedAmount", "quarantinedAmount" ], "type": "object", "properties": { "accountReference": { "$ref": "#/components/schemas/Core_AccountReference" }, "tickerId": { "type": "string", "format": "uuid" }, "confirmedAmount": { "type": "string", "description": "This field is a large integer and represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "unconfirmedAmount": { "type": "string", "description": "This field is a large integer and represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "reservedAmount": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "quarantinedAmount": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." } } }, "Core_BalancesCollection": { "required": [ "items", "count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core_Balance" } }, "count": { "type": "integer", "format": "int32" }, "currentStartingAfter": { "type": "string" }, "nextStartingAfter": { "type": "string" } } }, "Core_BalancesUpdated": { "required": [ "accountReference", "tickerIds", "type" ], "type": "object", "properties": { "accountReference": { "$ref": "#/components/schemas/Core_AccountReference" }, "tickerIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "type": { "enum": [ "BalancesUpdated" ], "type": "string" } } }, "Core_BitcoinFee": { "required": [ "satoshiPerVbyte" ], "type": "object", "properties": { "satoshiPerVbyte": { "type": "string", "description": "This field is a large decimal and represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." } } }, "Core_BitcoinFeeStrategy": { "oneOf": [ { "$ref": "#/components/schemas/Core_BitcoinFeeStrategy_Priority" }, { "$ref": "#/components/schemas/Core_BitcoinFeeStrategy_SpecifiedRate" } ], "discriminator": { "propertyName": "type", "mapping": { "Priority": "#/components/schemas/Core_BitcoinFeeStrategy_Priority", "SpecifiedRate": "#/components/schemas/Core_BitcoinFeeStrategy_SpecifiedRate" } } }, "Core_BitcoinFeeStrategy_Priority": { "required": [ "priority", "type" ], "type": "object", "properties": { "priority": { "$ref": "#/components/schemas/Core_FeePriority" }, "type": { "enum": [ "Priority" ], "type": "string" } } }, "Core_BitcoinFeeStrategy_SpecifiedRate": { "required": [ "satoshiPerVbyte", "type" ], "type": "object", "properties": { "satoshiPerVbyte": { "type": "string", "description": "This field is a large decimal and represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "SpecifiedRate" ], "type": "string" } } }, "Core_BitcoinLikeVaultLedgerIdentifier": { "enum": [ "btc", "ltc", "bch", "doge", "dash" ], "type": "string" }, "Core_BitcoinOnLedgerDataInput": { "required": [ "index" ], "type": "object", "properties": { "accountReference": { "$ref": "#/components/schemas/Core_AccountReference" }, "address": { "maxLength": 512, "minLength": 1, "type": "string" }, "index": { "type": "integer", "format": "int32" }, "scriptPubKey": { "maxLength": 20000, "minLength": 0, "type": "string" }, "transactionHash": { "maxLength": 500, "minLength": 1, "type": "string" } } }, "Core_BitcoinOnLedgerDataOutput": { "required": [ "amount", "index", "scriptPubKey" ], "type": "object", "properties": { "accountReference": { "$ref": "#/components/schemas/Core_AccountReference" }, "address": { "maxLength": 512, "minLength": 1, "type": "string" }, "amount": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "index": { "type": "integer", "format": "int32" }, "scriptPubKey": { "maxLength": 20000, "minLength": 0, "type": "string" } } }, "Core_BitcoinOutputParameters": { "required": [ "destination", "amount" ], "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/Core_TransactionDestination" }, "amount": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "paysFee": { "type": "boolean" } } }, "Core_BitcoinResourceStrategy": { "oneOf": [ { "$ref": "#/components/schemas/Core_BitcoinResourceStrategy_OrderReplacement" } ], "discriminator": { "propertyName": "type", "mapping": { "OrderReplacement": "#/components/schemas/Core_BitcoinResourceStrategy_OrderReplacement" } } }, "Core_BitcoinResourceStrategy_OrderReplacement": { "required": [ "transactionOrderId", "type" ], "type": "object", "properties": { "transactionOrderId": { "type": "string", "format": "uuid" }, "reason": { "maxLength": 200, "minLength": 1, "type": "string" }, "type": { "enum": [ "OrderReplacement" ], "type": "string" } } }, "Core_BitcoinTickerProperties": { "oneOf": [ { "$ref": "#/components/schemas/Core_BitcoinTickerProperties_Native" } ], "discriminator": { "propertyName": "type", "mapping": { "Native": "#/components/schemas/Core_BitcoinTickerProperties_Native" } } }, "Core_BitcoinTickerProperties_Native": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "Native" ], "type": "string" } } }, "Core_CardanoFeeStrategy": { "oneOf": [ { "$ref": "#/components/schemas/Core_CardanoFeeStrategy_Priority" } ], "discriminator": { "propertyName": "type", "mapping": { "Priority": "#/components/schemas/Core_CardanoFeeStrategy_Priority" } } }, "Core_CardanoFeeStrategy_Priority": { "required": [ "priority", "type" ], "type": "object", "properties": { "priority": { "$ref": "#/components/schemas/Core_FeePriority" }, "type": { "enum": [ "Priority" ], "type": "string" } } }, "Core_CardanoOperation": { "oneOf": [ { "$ref": "#/components/schemas/Core_CardanoOperation_DelegateRepresentative" }, { "$ref": "#/components/schemas/Core_CardanoOperation_DelegateStaking" }, { "$ref": "#/components/schemas/Core_CardanoOperation_RegisterStaking" }, { "$ref": "#/components/schemas/Core_CardanoOperation_Transfer" }, { "$ref": "#/components/schemas/Core_CardanoOperation_UnregisterStaking" }, { "$ref": "#/components/schemas/Core_CardanoOperation_WithdrawRewards" } ], "discriminator": { "propertyName": "type", "mapping": { "DelegateRepresentative": "#/components/schemas/Core_CardanoOperation_DelegateRepresentative", "DelegateStaking": "#/components/schemas/Core_CardanoOperation_DelegateStaking", "RegisterStaking": "#/components/schemas/Core_CardanoOperation_RegisterStaking", "Transfer": "#/components/schemas/Core_CardanoOperation_Transfer", "UnregisterStaking": "#/components/schemas/Core_CardanoOperation_UnregisterStaking", "WithdrawRewards": "#/components/schemas/Core_CardanoOperation_WithdrawRewards" } } }, "Core_CardanoOperation_DelegateRepresentative": { "required": [ "parameters", "type" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/Core_DelegateRepresentativeParameters" }, "type": { "enum": [ "DelegateRepresentative" ], "type": "string" } } }, "Core_CardanoOperation_DelegateStaking": { "required": [ "poolId", "type" ], "type": "object", "properties": { "poolId": { "maxLength": 56, "minLength": 56, "type": "string", "description": "A valid Cardano pool id", "example": "pool1ywpt43nttzjd7883wafg255mh0hmjypwe65ercw6p2sxg5lt7ez" }, "type": { "enum": [ "DelegateStaking" ], "type": "string" } } }, "Core_CardanoOperation_RegisterStaking": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "RegisterStaking" ], "type": "string" } } }, "Core_CardanoOperation_Transfer": { "required": [ "outputs", "type" ], "type": "object", "properties": { "outputs": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/Core_CardanoOutputParameters" } }, "type": { "enum": [ "Transfer" ], "type": "string" } } }, "Core_CardanoOperation_UnregisterStaking": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "UnregisterStaking" ], "type": "string" } } }, "Core_CardanoOperation_WithdrawRewards": { "required": [ "amount", "type" ], "type": "object", "properties": { "amount": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "WithdrawRewards" ], "type": "string" } } }, "Core_CardanoOutputParameters": { "required": [ "destination", "amount" ], "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/Core_TransactionDestination" }, "amount": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "paysFee": { "type": "boolean" } } }, "Core_CardanoTickerProperties": { "oneOf": [ { "$ref": "#/components/schemas/Core_CardanoTickerProperties_Native" } ], "discriminator": { "propertyName": "type", "mapping": { "Native": "#/components/schemas/Core_CardanoTickerProperties_Native" } } }, "Core_CardanoTickerProperties_Native": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "Native" ], "type": "string" } } }, "Core_ContractParameters": { "oneOf": [ { "$ref": "#/components/schemas/Core_ContractParameters_Raw" } ], "discriminator": { "propertyName": "type", "mapping": { "Raw": "#/components/schemas/Core_ContractParameters_Raw" } } }, "Core_ContractParameters_Raw": { "required": [ "value", "type" ], "type": "object", "properties": { "value": { "pattern": "^[A-Fa-f0-9]*$", "type": "string", "description": "Hex encoded string." }, "type": { "enum": [ "Raw" ], "type": "string" } } }, "Core_CreateAccountDryRunResult": { "required": [ "ledgers" ], "type": "object", "properties": { "ledgers": { "type": "array", "items": { "$ref": "#/components/schemas/Core_ResultLedger" } } } }, "Core_CreateDomainGenesisPolicy": { "required": [ "id", "alias", "rank", "scope", "scriptingEngine", "lock", "customProperties" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "maxLength": 75, "minLength": 1, "type": "string" }, "rank": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" }, "intentTypes": { "type": "array", "items": { "$ref": "#/components/schemas/Core_IntentType" } }, "scope": { "$ref": "#/components/schemas/Core_PolicyScope" }, "scriptingEngine": { "$ref": "#/components/schemas/Core_ScriptingEngine" }, "condition": { "$ref": "#/components/schemas/Core_PolicyCondition" }, "workflow": { "type": "array", "items": { "$ref": "#/components/schemas/Core_WorkflowCondition" } }, "lock": { "$ref": "#/components/schemas/Core_IntentLockStatus" }, "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" } } }, "Core_CreateDomainGenesisUser": { "required": [ "id", "alias", "publicKey", "roles", "lock", "customProperties" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "maxLength": 75, "minLength": 1, "type": "string" }, "publicKey": { "type": "string", "format": "base64" }, "roles": { "minItems": 1, "type": "array", "items": { "maxLength": 50, "minLength": 1, "pattern": "[a-z0-9\\-]+", "type": "string" } }, "lock": { "$ref": "#/components/schemas/Core_IntentLockStatus" }, "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" }, "loginIds": { "type": "array", "items": { "$ref": "#/components/schemas/Core_LoginId" }, "description": "Domain-unique `loginId`-`loginProviderId` pairs. Must be specified for login and match pre-configured values." } } }, "Core_CreateDomainsPayload": { "required": [ "id", "alias", "lock", "permissions", "customProperties", "users", "policies", "descendants" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "maxLength": 75, "minLength": 1, "type": "string" }, "lock": { "$ref": "#/components/schemas/Core_IntentLockStatus" }, "governingStrategy": { "$ref": "#/components/schemas/Core_GoverningStrategy" }, "permissions": { "$ref": "#/components/schemas/Core_Permissions" }, "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/Core_CreateDomainGenesisUser" } }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/Core_CreateDomainGenesisPolicy" } }, "descendants": { "type": "array", "items": { "$ref": "#/components/schemas/Core_CreateDomainsPayload" } } } }, "Core_CreateLedgerGenesis": { "required": [ "id", "alias", "parameters", "customProperties" ], "type": "object", "properties": { "id": { "type": "string" }, "alias": { "maxLength": 200, "minLength": 1, "type": "string" }, "parameters": { "$ref": "#/components/schemas/Core_LedgerParameters" }, "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" } } }, "Core_CreateTransferOrderOutput": { "required": [ "destination", "amount" ], "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/Core_TransactionDestination" }, "amount": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "paysFee": { "type": "boolean" } } }, "Core_CreatedEntitiesReferences": { "required": [ "rootUsers", "rootPolicies" ], "type": "object", "properties": { "rootUsers": { "type": "array", "items": { "$ref": "#/components/schemas/Core_CreatedEntitiesReferences_User" } }, "rootPolicies": { "type": "array", "items": { "$ref": "#/components/schemas/Core_CreatedEntitiesReferences_Policy" } } }, "description": "A list of all entities created during genesis." }, "Core_CreatedEntitiesReferences_Policy": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } }, "Core_CreatedEntitiesReferences_User": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } }, "Core_CurrentFees": { "oneOf": [ { "$ref": "#/components/schemas/Core_CurrentFees_Bitcoin" }, { "$ref": "#/components/schemas/Core_CurrentFees_Ethereum" }, { "$ref": "#/components/schemas/Core_CurrentFees_Stellar" }, { "$ref": "#/components/schemas/Core_CurrentFees_XRPL" } ], "discriminator": { "propertyName": "type", "mapping": { "Bitcoin": "#/components/schemas/Core_CurrentFees_Bitcoin", "Ethereum": "#/components/schemas/Core_CurrentFees_Ethereum", "Stellar": "#/components/schemas/Core_CurrentFees_Stellar", "XRPL": "#/components/schemas/Core_CurrentFees_XRPL" } } }, "Core_CurrentFees_Bitcoin": { "required": [ "high", "medium", "low", "type" ], "type": "object", "properties": { "high": { "$ref": "#/components/schemas/Core_BitcoinFee" }, "medium": { "$ref": "#/components/schemas/Core_BitcoinFee" }, "low": { "$ref": "#/components/schemas/Core_BitcoinFee" }, "type": { "enum": [ "Bitcoin" ], "type": "string" } } }, "Core_CurrentFees_Ethereum": { "required": [ "high", "medium", "low", "type" ], "type": "object", "properties": { "high": { "$ref": "#/components/schemas/Core_EthereumFee" }, "medium": { "$ref": "#/components/schemas/Core_EthereumFee" }, "low": { "$ref": "#/components/schemas/Core_EthereumFee" }, "type": { "enum": [ "Ethereum" ], "type": "string" } } }, "Core_CurrentFees_Stellar": { "required": [ "high", "medium", "low", "type" ], "type": "object", "properties": { "high": { "$ref": "#/components/schemas/Core_StellarFee" }, "medium": { "$ref": "#/components/schemas/Core_StellarFee" }, "low": { "$ref": "#/components/schemas/Core_StellarFee" }, "type": { "enum": [ "Stellar" ], "type": "string" } } }, "Core_CurrentFees_XRPL": { "required": [ "high", "medium", "low", "type" ], "type": "object", "properties": { "high": { "$ref": "#/components/schemas/Core_XrplFee" }, "medium": { "$ref": "#/components/schemas/Core_XrplFee" }, "low": { "$ref": "#/components/schemas/Core_XrplFee" }, "type": { "enum": [ "XRPL" ], "type": "string" } } }, "Core_CustodyType": { "enum": [ "SelfCustody", "SubCustody" ], "type": "string" }, "Core_DecisionPayload": { "required": [ "author", "authorRoles", "seenBySystemAt", "decision", "rawRequest", "signature" ], "type": "object", "properties": { "author": { "$ref": "#/components/schemas/Core_UserReference" }, "authorRoles": { "minItems": 1, "type": "array", "items": { "maxLength": 50, "minLength": 1, "pattern": "[a-z0-9\\-]+", "type": "string" } }, "seenBySystemAt": { "type": "string", "format": "date-time" }, "expiryAt": { "type": "string", "format": "date-time" }, "decision": { "$ref": "#/components/schemas/Core_ApprovalDecision" }, "approvalReason": { "maxLength": 5000, "minLength": 0, "type": "string" }, "rejectionReason": { "maxLength": 5000, "minLength": 1, "type": "string" }, "rawRequest": { "maxLength": 80000, "minLength": 1, "type": "string" }, "signature": { "type": "string", "format": "base64" } } }, "Core_DelegateRepresentativeParameters": { "oneOf": [ { "$ref": "#/components/schemas/Core_DelegateRepresentativeParameters_AlwaysAbstain" } ], "discriminator": { "propertyName": "type", "mapping": { "AlwaysAbstain": "#/components/schemas/Core_DelegateRepresentativeParameters_AlwaysAbstain" } } }, "Core_DelegateRepresentativeParameters_AlwaysAbstain": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "AlwaysAbstain" ], "type": "string" } } }, "Core_Domain": { "required": [ "id", "alias", "lock", "permissions", "metadata" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "parentId": { "type": "string", "format": "uuid" }, "alias": { "maxLength": 75, "minLength": 1, "type": "string" }, "lock": { "$ref": "#/components/schemas/Core_LockStatus" }, "governingStrategy": { "$ref": "#/components/schemas/Core_GoverningStrategy" }, "permissions": { "$ref": "#/components/schemas/Core_Permissions" }, "metadata": { "$ref": "#/components/schemas/Core_EntityMetadata" } } }, "Core_DomainCreated": { "required": [ "id", "parentId", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "parentId": { "type": "string", "format": "uuid" }, "type": { "enum": [ "DomainCreated" ], "type": "string" } } }, "Core_DomainUpdated": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "parentId": { "type": "string", "format": "uuid" }, "type": { "enum": [ "DomainUpdated" ], "type": "string" } } }, "Core_DryRunTransactionParameters": { "required": [ "accountId", "parameters" ], "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid" }, "ledgerId": { "maxLength": 100, "minLength": 1, "type": "string" }, "parameters": { "$ref": "#/components/schemas/Core_TransactionOrderParameters" } } }, "Core_Endpoint": { "required": [ "id", "domainId", "address", "ledgerId", "alias", "lock", "metadata", "trustScore" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "domainId": { "type": "string", "format": "uuid" }, "address": { "maxLength": 512, "minLength": 1, "type": "string" }, "ledgerId": { "maxLength": 100, "minLength": 1, "type": "string" }, "parameters": { "$ref": "#/components/schemas/Core_EndpointLedgerParameters" }, "alias": { "maxLength": 75, "minLength": 1, "type": "string" }, "lock": { "$ref": "#/components/schemas/Core_LockStatus" }, "metadata": { "$ref": "#/components/schemas/Core_EntityMetadata" }, "trustScore": { "maximum": 100, "minimum": 0, "type": "integer", "format": "int32" } } }, "Core_EndpointCreated": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "enum": [ "EndpointCreated" ], "type": "string" } } }, "Core_EndpointLedgerParameters": { "oneOf": [ { "$ref": "#/components/schemas/Core_EndpointLedgerParameters_Ethereum" } ], "discriminator": { "propertyName": "type", "mapping": { "Ethereum": "#/components/schemas/Core_EndpointLedgerParameters_Ethereum" } } }, "Core_EndpointLedgerParameters_Ethereum": { "required": [ "type" ], "type": "object", "properties": { "ABI": { "type": "string", "description": "This field can be used to provide an Application Binary Interface (ABI) for EVM-based smart contracts, Harmonize's front-end uses the field to provide an extended support when interacting with smart contracts, therefore it is not recommended to submit invalid ABIs in this field but Harmonize will not prevent the submission of invalid ABIs to tolerate use cases outside of Harmonize's front-end." }, "type": { "enum": [ "Ethereum" ], "type": "string" } } }, "Core_EndpointUpdated": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "enum": [ "EndpointUpdated" ], "type": "string" } } }, "Core_EntityIdAndRevision": { "required": [ "id", "revision" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "revision": { "minimum": 1, "type": "integer", "format": "int64" } } }, "Core_EntityMetadata": { "required": [ "revision", "createdAt", "lastModifiedAt", "customProperties" ], "type": "object", "properties": { "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "revision": { "minimum": 1, "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "$ref": "#/components/schemas/Core_UserReference" }, "lastModifiedAt": { "type": "string", "format": "date-time" }, "lastModifiedBy": { "$ref": "#/components/schemas/Core_UserReference" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" } } }, "Core_EntityStringIdAndRevision": { "required": [ "id", "revision" ], "type": "object", "properties": { "id": { "type": "string" }, "revision": { "minimum": 1, "type": "integer", "format": "int64" } } }, "Core_ErrorMessage": { "required": [ "reason" ], "type": "object", "properties": { "reason": { "type": "string" }, "message": { "type": "string" } } }, "Core_EthereumCallRequest": { "required": [ "contractAddress", "from" ], "type": "object", "properties": { "contractAddress": { "maxLength": 512, "minLength": 1, "type": "string" }, "from": { "$ref": "#/components/schemas/Core_EthereumCaller" }, "value": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "data": { "pattern": "^0[xX]([a-fA-F0-9]*)$", "type": "string" } } }, "Core_EthereumCaller": { "oneOf": [ { "$ref": "#/components/schemas/Core_EthereumCaller_Account" }, { "$ref": "#/components/schemas/Core_EthereumCaller_Address" } ], "discriminator": { "propertyName": "type", "mapping": { "Account": "#/components/schemas/Core_EthereumCaller_Account", "Address": "#/components/schemas/Core_EthereumCaller_Address" } } }, "Core_EthereumCaller_Account": { "required": [ "domainId", "accountId", "type" ], "type": "object", "properties": { "domainId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "type": { "enum": [ "Account" ], "type": "string" } } }, "Core_EthereumCaller_Address": { "required": [ "address", "type" ], "type": "object", "properties": { "address": { "maxLength": 512, "minLength": 1, "type": "string" }, "type": { "enum": [ "Address" ], "type": "string" } } }, "Core_EthereumEIP1559Prices": { "required": [ "basePrice", "priorityPrice" ], "type": "object", "properties": { "basePrice": { "type": "string", "description": "This field is a large integer and represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "priorityPrice": { "type": "string", "description": "This field is a large integer and represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." } } }, "Core_EthereumFee": { "required": [ "gasPrice" ], "type": "object", "properties": { "gasPrice": { "type": "string", "description": "This field is a large integer and represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "eip1559Prices": { "$ref": "#/components/schemas/Core_EthereumEIP1559Prices" } } }, "Core_EthereumFeeStrategy": { "oneOf": [ { "$ref": "#/components/schemas/Core_EthereumFeeStrategy_Priority" }, { "$ref": "#/components/schemas/Core_EthereumFeeStrategy_SpecifiedRate" }, { "$ref": "#/components/schemas/Core_EthereumFeeStrategy_SpecifiedRateEIP1559" } ], "discriminator": { "propertyName": "type", "mapping": { "Priority": "#/components/schemas/Core_EthereumFeeStrategy_Priority", "SpecifiedRate": "#/components/schemas/Core_EthereumFeeStrategy_SpecifiedRate", "SpecifiedRateEIP1559": "#/components/schemas/Core_EthereumFeeStrategy_SpecifiedRateEIP1559" } } }, "Core_EthereumFeeStrategy_Priority": { "required": [ "priority", "type" ], "type": "object", "properties": { "priority": { "$ref": "#/components/schemas/Core_FeePriority" }, "type": { "enum": [ "Priority" ], "type": "string" } } }, "Core_EthereumFeeStrategy_SpecifiedRate": { "required": [ "gasPrice", "type" ], "type": "object", "properties": { "gasPrice": { "type": "string", "description": "This field is a large integer and represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "SpecifiedRate" ], "type": "string" } } }, "Core_EthereumFeeStrategy_SpecifiedRateEIP1559": { "required": [ "maxFeePerGas", "maxPriorityFeePerGas", "type" ], "type": "object", "properties": { "maxFeePerGas": { "type": "string", "description": "This field is a large integer and represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "maxPriorityFeePerGas": { "type": "string", "description": "This field is a large integer and represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "SpecifiedRateEIP1559" ], "type": "string" } } }, "Core_EthereumLedgerLog": { "required": [ "logIndex", "address", "data", "topics" ], "type": "object", "properties": { "logIndex": { "type": "string", "description": "This field is a large integer and represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "address": { "maxLength": 512, "minLength": 1, "type": "string" }, "data": { "pattern": "^0[xX]([a-fA-F0-9]*)$", "type": "string" }, "topics": { "type": "array", "items": { "pattern": "^0[xX]([a-fA-F0-9]*)$", "type": "string" } } } }, "Core_EthereumLikeVaultLedgerIdentifier": { "enum": [ "eth", "etc" ], "type": "string" }, "Core_EthereumResourceStrategy": { "oneOf": [ { "$ref": "#/components/schemas/Core_EthereumResourceStrategy_OrderReplacement" } ], "discriminator": { "propertyName": "type", "mapping": { "OrderReplacement": "#/components/schemas/Core_EthereumResourceStrategy_OrderReplacement" } } }, "Core_EthereumResourceStrategy_OrderReplacement": { "required": [ "transactionOrderId", "type" ], "type": "object", "properties": { "transactionOrderId": { "type": "string", "format": "uuid" }, "reason": { "maxLength": 200, "minLength": 1, "type": "string" }, "type": { "enum": [ "OrderReplacement" ], "type": "string" } } }, "Core_EthereumTickerProperties": { "oneOf": [ { "$ref": "#/components/schemas/Core_EthereumTickerProperties_ERC1155" }, { "$ref": "#/components/schemas/Core_EthereumTickerProperties_ERC20" }, { "$ref": "#/components/schemas/Core_EthereumTickerProperties_ERC721" }, { "$ref": "#/components/schemas/Core_EthereumTickerProperties_Native" } ], "discriminator": { "propertyName": "type", "mapping": { "ERC1155": "#/components/schemas/Core_EthereumTickerProperties_ERC1155", "ERC20": "#/components/schemas/Core_EthereumTickerProperties_ERC20", "ERC721": "#/components/schemas/Core_EthereumTickerProperties_ERC721", "Native": "#/components/schemas/Core_EthereumTickerProperties_Native" } } }, "Core_EthereumTickerProperties_ERC1155": { "required": [ "address", "tokenId", "type" ], "type": "object", "properties": { "address": { "maxLength": 512, "minLength": 1, "type": "string" }, "tokenId": { "type": "string" }, "type": { "enum": [ "ERC1155" ], "type": "string" } } }, "Core_EthereumTickerProperties_ERC20": { "required": [ "address", "type" ], "type": "object", "properties": { "address": { "maxLength": 512, "minLength": 1, "type": "string" }, "type": { "enum": [ "ERC20" ], "type": "string" } } }, "Core_EthereumTickerProperties_ERC721": { "required": [ "address", "tokenId", "type" ], "type": "object", "properties": { "address": { "maxLength": 512, "minLength": 1, "type": "string" }, "tokenId": { "type": "string", "description": "This field is a large integer and represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "ERC721" ], "type": "string" } } }, "Core_EthereumTickerProperties_Native": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "Native" ], "type": "string" } } }, "Core_EventScope": { "enum": [ "Self", "SelfAndDescendants" ], "type": "string", "default": "Self" }, "Core_EventsCollection": { "required": [ "items", "count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core_HarmonizeEvent" } }, "count": { "type": "integer", "format": "int32" }, "currentStartingAfter": { "type": "string" }, "nextStartingAfter": { "type": "string" } } }, "Core_FeePriority": { "enum": [ "High", "Medium", "Low" ], "type": "string" }, "Core_Genesis": { "required": [ "data", "signature" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Core_GenesisData" }, "signature": { "type": "string", "format": "base64" } }, "description": "Complete genesis payload, copied in and signed by the notary at genesis." }, "Core_GenesisCryptoSetup": { "required": [ "apiSigning", "collectionSigning", "messageSigning" ], "type": "object", "properties": { "apiSigning": { "$ref": "#/components/schemas/Core_KeyType" }, "collectionSigning": { "$ref": "#/components/schemas/Core_KeyType" }, "messageSigning": { "$ref": "#/components/schemas/Core_KeyType" } } }, "Core_GenesisData": { "required": [ "executedAt", "payload" ], "type": "object", "properties": { "executedAt": { "type": "string", "format": "date-time" }, "payload": { "$ref": "#/components/schemas/Core_GenesisPayload" } } }, "Core_GenesisPayload": { "required": [ "rootDomainSetup", "cryptoSetup" ], "type": "object", "properties": { "rootDomainSetup": { "$ref": "#/components/schemas/Core_RootDomainSetup" }, "cryptoSetup": { "$ref": "#/components/schemas/Core_GenesisCryptoSetup" }, "tickers": { "type": "array", "items": { "$ref": "#/components/schemas/Core_TickerToValidate" } }, "systemProperties": { "type": "array", "items": { "$ref": "#/components/schemas/Core_ReadWriteSystemPropertyKeyValue" } }, "ledgers": { "type": "array", "items": { "$ref": "#/components/schemas/Core_CreateLedgerGenesis" } } } }, "Core_GenesisRequest": { "required": [ "rootDomainSetup" ], "type": "object", "properties": { "rootDomainSetup": { "$ref": "#/components/schemas/Core_RootDomainSetup" }, "cryptoSetup": { "$ref": "#/components/schemas/Core_GenesisCryptoSetup" }, "tickers": { "type": "array", "items": { "$ref": "#/components/schemas/Core_TickerToValidate" } }, "systemProperties": { "type": "array", "items": { "$ref": "#/components/schemas/Core_ReadWriteSystemPropertyKeyValue" } }, "ledgers": { "type": "array", "items": { "$ref": "#/components/schemas/Core_CreateLedgerGenesis" } } } }, "Core_GenesisSucceeded": { "required": [ "apiPublicKey", "messagingPublicKey", "type" ], "type": "object", "properties": { "apiPublicKey": { "type": "string", "format": "base64" }, "messagingPublicKey": { "type": "string", "format": "base64" }, "genesis": { "$ref": "#/components/schemas/Core_Genesis" }, "createdEntitiesReferences": { "$ref": "#/components/schemas/Core_CreatedEntitiesReferences" }, "type": { "enum": [ "GenesisSucceeded" ], "type": "string" } } }, "Core_GoverningStrategy": { "enum": [ "ConsiderDescendants", "CoerceDescendants" ], "type": "string" }, "Core_HarmonizeEvent": { "required": [ "domainId", "payload", "id", "sequenceNumber", "savedAt" ], "type": "object", "properties": { "domainId": { "type": "string", "format": "uuid" }, "payload": { "$ref": "#/components/schemas/Core_HarmonizeEventPayload" }, "id": { "type": "string", "format": "uuid" }, "sequenceNumber": { "type": "integer", "format": "int64" }, "savedAt": { "type": "string", "format": "date-time" } } }, "Core_HarmonizeEventPayload": { "oneOf": [ { "$ref": "#/components/schemas/Core_AccountCreated" }, { "$ref": "#/components/schemas/Core_AccountUpdated" }, { "$ref": "#/components/schemas/Core_AddressCreated" }, { "$ref": "#/components/schemas/Core_BackupCreated" }, { "$ref": "#/components/schemas/Core_BackupUpdated" }, { "$ref": "#/components/schemas/Core_BalancesUpdated" }, { "$ref": "#/components/schemas/Core_DomainCreated" }, { "$ref": "#/components/schemas/Core_DomainUpdated" }, { "$ref": "#/components/schemas/Core_EndpointCreated" }, { "$ref": "#/components/schemas/Core_EndpointUpdated" }, { "$ref": "#/components/schemas/Core_GenesisSucceeded" }, { "$ref": "#/components/schemas/Core_IntentClosed" }, { "$ref": "#/components/schemas/Core_IntentCreated" }, { "$ref": "#/components/schemas/Core_IntentExecuted" }, { "$ref": "#/components/schemas/Core_IntentUpdated" }, { "$ref": "#/components/schemas/Core_LedgerCreated" }, { "$ref": "#/components/schemas/Core_LedgerUpdated" }, { "$ref": "#/components/schemas/Core_ManifestCreated" }, { "$ref": "#/components/schemas/Core_ManifestUpdated" }, { "$ref": "#/components/schemas/Core_PolicyCreated" }, { "$ref": "#/components/schemas/Core_PolicyUpdated" }, { "$ref": "#/components/schemas/Core_SystemPropertySet" }, { "$ref": "#/components/schemas/Core_TickerCreated" }, { "$ref": "#/components/schemas/Core_TickerUpdated" }, { "$ref": "#/components/schemas/Core_TransactionCreated" }, { "$ref": "#/components/schemas/Core_TransactionDetected" }, { "$ref": "#/components/schemas/Core_TransactionUpdated" }, { "$ref": "#/components/schemas/Core_TransferUpdated" }, { "$ref": "#/components/schemas/Core_TrustedPublicKeyAdded" }, { "$ref": "#/components/schemas/Core_TrustedPublicKeyUpdated" }, { "$ref": "#/components/schemas/Core_UserCreated" }, { "$ref": "#/components/schemas/Core_UserUpdated" }, { "$ref": "#/components/schemas/Core_VaultCreated" }, { "$ref": "#/components/schemas/Core_VaultUpdated" } ], "discriminator": { "propertyName": "type", "mapping": { "AccountCreated": "#/components/schemas/Core_AccountCreated", "AccountUpdated": "#/components/schemas/Core_AccountUpdated", "AddressCreated": "#/components/schemas/Core_AddressCreated", "BackupCreated": "#/components/schemas/Core_BackupCreated", "BackupUpdated": "#/components/schemas/Core_BackupUpdated", "BalancesUpdated": "#/components/schemas/Core_BalancesUpdated", "DomainCreated": "#/components/schemas/Core_DomainCreated", "DomainUpdated": "#/components/schemas/Core_DomainUpdated", "EndpointCreated": "#/components/schemas/Core_EndpointCreated", "EndpointUpdated": "#/components/schemas/Core_EndpointUpdated", "GenesisSucceeded": "#/components/schemas/Core_GenesisSucceeded", "IntentClosed": "#/components/schemas/Core_IntentClosed", "IntentCreated": "#/components/schemas/Core_IntentCreated", "IntentExecuted": "#/components/schemas/Core_IntentExecuted", "IntentUpdated": "#/components/schemas/Core_IntentUpdated", "LedgerCreated": "#/components/schemas/Core_LedgerCreated", "LedgerUpdated": "#/components/schemas/Core_LedgerUpdated", "ManifestCreated": "#/components/schemas/Core_ManifestCreated", "ManifestUpdated": "#/components/schemas/Core_ManifestUpdated", "PolicyCreated": "#/components/schemas/Core_PolicyCreated", "PolicyUpdated": "#/components/schemas/Core_PolicyUpdated", "SystemPropertySet": "#/components/schemas/Core_SystemPropertySet", "TickerCreated": "#/components/schemas/Core_TickerCreated", "TickerUpdated": "#/components/schemas/Core_TickerUpdated", "TransactionCreated": "#/components/schemas/Core_TransactionCreated", "TransactionDetected": "#/components/schemas/Core_TransactionDetected", "TransactionUpdated": "#/components/schemas/Core_TransactionUpdated", "TransferUpdated": "#/components/schemas/Core_TransferUpdated", "TrustedPublicKeyAdded": "#/components/schemas/Core_TrustedPublicKeyAdded", "TrustedPublicKeyUpdated": "#/components/schemas/Core_TrustedPublicKeyUpdated", "UserCreated": "#/components/schemas/Core_UserCreated", "UserUpdated": "#/components/schemas/Core_UserUpdated", "VaultCreated": "#/components/schemas/Core_VaultCreated", "VaultUpdated": "#/components/schemas/Core_VaultUpdated" } } }, "Core_HederaFeeStrategy": { "oneOf": [ { "$ref": "#/components/schemas/Core_HederaFeeStrategy_Priority" } ], "discriminator": { "propertyName": "type", "mapping": { "Priority": "#/components/schemas/Core_HederaFeeStrategy_Priority" } } }, "Core_HederaFeeStrategy_Priority": { "required": [ "priority", "type" ], "type": "object", "properties": { "priority": { "$ref": "#/components/schemas/Core_FeePriority" }, "type": { "enum": [ "Priority" ], "type": "string" } } }, "Core_HederaOperation": { "oneOf": [ { "$ref": "#/components/schemas/Core_HederaOperation_AccountUpdate" }, { "$ref": "#/components/schemas/Core_HederaOperation_TokenAssociate" }, { "$ref": "#/components/schemas/Core_HederaOperation_TokenDissociate" }, { "$ref": "#/components/schemas/Core_HederaOperation_Transfer" } ], "discriminator": { "propertyName": "type", "mapping": { "AccountUpdate": "#/components/schemas/Core_HederaOperation_AccountUpdate", "TokenAssociate": "#/components/schemas/Core_HederaOperation_TokenAssociate", "TokenDissociate": "#/components/schemas/Core_HederaOperation_TokenDissociate", "Transfer": "#/components/schemas/Core_HederaOperation_Transfer" } } }, "Core_HederaOperation_AccountUpdate": { "required": [ "maxAutomaticTokenAssociations", "type" ], "type": "object", "properties": { "maxAutomaticTokenAssociations": { "type": "integer", "format": "int32" }, "type": { "enum": [ "AccountUpdate" ], "type": "string" } } }, "Core_HederaOperation_TokenAssociate": { "required": [ "tokens", "type" ], "type": "object", "properties": { "tokens": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/Core_TokenDestination" } }, "type": { "enum": [ "TokenAssociate" ], "type": "string" } } }, "Core_HederaOperation_TokenDissociate": { "required": [ "tokens", "type" ], "type": "object", "properties": { "tokens": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/Core_TokenDestination" } }, "type": { "enum": [ "TokenDissociate" ], "type": "string" } } }, "Core_HederaOperation_Transfer": { "required": [ "type" ], "type": "object", "properties": { "outputs": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/Core_HederaTransferOutput" } }, "tokenOutputs": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/Core_TokenOutput" } }, "type": { "enum": [ "Transfer" ], "type": "string" } } }, "Core_HederaTickerProperties": { "oneOf": [ { "$ref": "#/components/schemas/Core_HederaTickerProperties_FungibleToken" }, { "$ref": "#/components/schemas/Core_HederaTickerProperties_Native" }, { "$ref": "#/components/schemas/Core_HederaTickerProperties_NonFungibleToken" } ], "discriminator": { "propertyName": "type", "mapping": { "FungibleToken": "#/components/schemas/Core_HederaTickerProperties_FungibleToken", "Native": "#/components/schemas/Core_HederaTickerProperties_Native", "NonFungibleToken": "#/components/schemas/Core_HederaTickerProperties_NonFungibleToken" } } }, "Core_HederaTickerProperties_FungibleToken": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "maxLength": 20, "minLength": 5, "type": "string", "description": "String consisting Hedera Token Id" }, "type": { "enum": [ "FungibleToken" ], "type": "string" } } }, "Core_HederaTickerProperties_Native": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "Native" ], "type": "string" } } }, "Core_HederaTickerProperties_NonFungibleToken": { "required": [ "id", "serialNumber", "type" ], "type": "object", "properties": { "id": { "maxLength": 20, "minLength": 5, "type": "string", "description": "String consisting Hedera Token Id" }, "serialNumber": { "type": "integer", "format": "int64" }, "type": { "enum": [ "NonFungibleToken" ], "type": "string" } } }, "Core_HederaTransferOutput": { "required": [ "destination", "amount" ], "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/Core_TransactionDestination" }, "amount": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." } } }, "Core_IntentClosed": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "enum": [ "IntentClosed" ], "type": "string" } } }, "Core_IntentCreated": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "enum": [ "IntentCreated" ], "type": "string" } } }, "Core_IntentDetails": { "required": [ "payload", "expiryAt", "author", "targetDomainId", "metadata", "proposalSignature" ], "type": "object", "properties": { "payload": { "$ref": "#/components/schemas/Core_UserIntentPayload" }, "expiryAt": { "type": "string", "format": "date-time" }, "author": { "$ref": "#/components/schemas/Core_UserReference" }, "targetDomainId": { "type": "string", "format": "uuid" }, "metadata": { "$ref": "#/components/schemas/Core_IntentMetadata" }, "proposalSignature": { "type": "string", "format": "base64" } } }, "Core_IntentDryRunRequest": { "required": [ "author", "expiryAt", "targetDomainId", "id", "payload", "customProperties" ], "type": "object", "properties": { "author": { "$ref": "#/components/schemas/Core_UserReference" }, "expiryAt": { "type": "string", "format": "date-time" }, "targetDomainId": { "type": "string", "format": "uuid" }, "id": { "type": "string", "format": "uuid" }, "payload": { "$ref": "#/components/schemas/Core_UserIntentPayload" }, "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" } } }, "Core_IntentDryRunResponse": { "oneOf": [ { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_AcknowledgeBackup" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_AddAccountLedgers" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_AddTrustedPublicKeysForMigration" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_AttemptTransactionOrderCancellation" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_CreateAccount" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_CreateBackup" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_CreateDomain" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_CreateEndpoint" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_CreateLedger" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_CreatePolicy" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_CreateTicker" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_CreateTransactionOrder" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_CreateTransferOrder" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_CreateUser" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_CreateVault" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_ExecuteExtension" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_LockAccount" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_LockDomain" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_LockEndpoint" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_LockPolicy" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_LockTicker" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_LockUser" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_LockVault" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_MigrateSilo3AccountBatch" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_NotarizeData" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_ReleaseQuarantinedTransfers" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_SetSystemProperty" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_SignManifest" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_UnlockAccount" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_UnlockDomain" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_UnlockEndpoint" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_UnlockPolicy" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_UnlockTicker" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_UnlockUser" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_UnlockVault" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_UpdateAccount" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_UpdateDomain" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_UpdateDomainPermissions" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_UpdateEndpoint" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_UpdateLedger" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_UpdatePolicy" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_UpdateTicker" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_UpdateUser" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_UpdateVault" }, { "$ref": "#/components/schemas/Core_IntentDryRunResponse_v0_ValidateTickers" } ], "discriminator": { "propertyName": "type", "mapping": { "v0_AcknowledgeBackup": "#/components/schemas/Core_IntentDryRunResponse_v0_AcknowledgeBackup", "v0_AddAccountLedgers": "#/components/schemas/Core_IntentDryRunResponse_v0_AddAccountLedgers", "v0_AddTrustedPublicKeysForMigration": "#/components/schemas/Core_IntentDryRunResponse_v0_AddTrustedPublicKeysForMigration", "v0_AttemptTransactionOrderCancellation": "#/components/schemas/Core_IntentDryRunResponse_v0_AttemptTransactionOrderCancellation", "v0_CreateAccount": "#/components/schemas/Core_IntentDryRunResponse_v0_CreateAccount", "v0_CreateBackup": "#/components/schemas/Core_IntentDryRunResponse_v0_CreateBackup", "v0_CreateDomain": "#/components/schemas/Core_IntentDryRunResponse_v0_CreateDomain", "v0_CreateEndpoint": "#/components/schemas/Core_IntentDryRunResponse_v0_CreateEndpoint", "v0_CreateLedger": "#/components/schemas/Core_IntentDryRunResponse_v0_CreateLedger", "v0_CreatePolicy": "#/components/schemas/Core_IntentDryRunResponse_v0_CreatePolicy", "v0_CreateTicker": "#/components/schemas/Core_IntentDryRunResponse_v0_CreateTicker", "v0_CreateTransactionOrder": "#/components/schemas/Core_IntentDryRunResponse_v0_CreateTransactionOrder", "v0_CreateTransferOrder": "#/components/schemas/Core_IntentDryRunResponse_v0_CreateTransferOrder", "v0_CreateUser": "#/components/schemas/Core_IntentDryRunResponse_v0_CreateUser", "v0_CreateVault": "#/components/schemas/Core_IntentDryRunResponse_v0_CreateVault", "v0_ExecuteExtension": "#/components/schemas/Core_IntentDryRunResponse_v0_ExecuteExtension", "v0_LockAccount": "#/components/schemas/Core_IntentDryRunResponse_v0_LockAccount", "v0_LockDomain": "#/components/schemas/Core_IntentDryRunResponse_v0_LockDomain", "v0_LockEndpoint": "#/components/schemas/Core_IntentDryRunResponse_v0_LockEndpoint", "v0_LockPolicy": "#/components/schemas/Core_IntentDryRunResponse_v0_LockPolicy", "v0_LockTicker": "#/components/schemas/Core_IntentDryRunResponse_v0_LockTicker", "v0_LockUser": "#/components/schemas/Core_IntentDryRunResponse_v0_LockUser", "v0_LockVault": "#/components/schemas/Core_IntentDryRunResponse_v0_LockVault", "v0_MigrateSilo3AccountBatch": "#/components/schemas/Core_IntentDryRunResponse_v0_MigrateSilo3AccountBatch", "v0_NotarizeData": "#/components/schemas/Core_IntentDryRunResponse_v0_NotarizeData", "v0_ReleaseQuarantinedTransfers": "#/components/schemas/Core_IntentDryRunResponse_v0_ReleaseQuarantinedTransfers", "v0_SetSystemProperty": "#/components/schemas/Core_IntentDryRunResponse_v0_SetSystemProperty", "v0_SignManifest": "#/components/schemas/Core_IntentDryRunResponse_v0_SignManifest", "v0_UnlockAccount": "#/components/schemas/Core_IntentDryRunResponse_v0_UnlockAccount", "v0_UnlockDomain": "#/components/schemas/Core_IntentDryRunResponse_v0_UnlockDomain", "v0_UnlockEndpoint": "#/components/schemas/Core_IntentDryRunResponse_v0_UnlockEndpoint", "v0_UnlockPolicy": "#/components/schemas/Core_IntentDryRunResponse_v0_UnlockPolicy", "v0_UnlockTicker": "#/components/schemas/Core_IntentDryRunResponse_v0_UnlockTicker", "v0_UnlockUser": "#/components/schemas/Core_IntentDryRunResponse_v0_UnlockUser", "v0_UnlockVault": "#/components/schemas/Core_IntentDryRunResponse_v0_UnlockVault", "v0_UpdateAccount": "#/components/schemas/Core_IntentDryRunResponse_v0_UpdateAccount", "v0_UpdateDomain": "#/components/schemas/Core_IntentDryRunResponse_v0_UpdateDomain", "v0_UpdateDomainPermissions": "#/components/schemas/Core_IntentDryRunResponse_v0_UpdateDomainPermissions", "v0_UpdateEndpoint": "#/components/schemas/Core_IntentDryRunResponse_v0_UpdateEndpoint", "v0_UpdateLedger": "#/components/schemas/Core_IntentDryRunResponse_v0_UpdateLedger", "v0_UpdatePolicy": "#/components/schemas/Core_IntentDryRunResponse_v0_UpdatePolicy", "v0_UpdateTicker": "#/components/schemas/Core_IntentDryRunResponse_v0_UpdateTicker", "v0_UpdateUser": "#/components/schemas/Core_IntentDryRunResponse_v0_UpdateUser", "v0_UpdateVault": "#/components/schemas/Core_IntentDryRunResponse_v0_UpdateVault", "v0_ValidateTickers": "#/components/schemas/Core_IntentDryRunResponse_v0_ValidateTickers" } } }, "Core_IntentDryRunResponse_v0_AcknowledgeBackup": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_AcknowledgeBackup" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_AddAccountLedgers": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_AddAccountLedgers" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_AddTrustedPublicKeysForMigration": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_AddTrustedPublicKeysForMigration" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_AttemptTransactionOrderCancellation": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "cancellation": { "$ref": "#/components/schemas/Core_TransactionCancellationDetails" }, "type": { "enum": [ "v0_AttemptTransactionOrderCancellation" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_CreateAccount": { "required": [ "success", "result", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "result": { "$ref": "#/components/schemas/Core_CreateAccountDryRunResult" }, "type": { "enum": [ "v0_CreateAccount" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_CreateBackup": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_CreateBackup" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_CreateDomain": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_CreateDomain" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_CreateEndpoint": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_CreateEndpoint" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_CreateLedger": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_CreateLedger" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_CreatePolicy": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_CreatePolicy" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_CreateTicker": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_CreateTicker" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_CreateTransactionOrder": { "required": [ "success", "result", "estimate", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "result": { "$ref": "#/components/schemas/Core_TransactionDryRunResult" }, "estimate": { "$ref": "#/components/schemas/Core_TransactionEstimate" }, "type": { "enum": [ "v0_CreateTransactionOrder" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_CreateTransferOrder": { "required": [ "success", "result", "estimate", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "result": { "$ref": "#/components/schemas/Core_TransactionDryRunResult" }, "estimate": { "$ref": "#/components/schemas/Core_TransferDryRunEstimate" }, "type": { "enum": [ "v0_CreateTransferOrder" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_CreateUser": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_CreateUser" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_CreateVault": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_CreateVault" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_ExecuteExtension": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_ExecuteExtension" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_LockAccount": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_LockAccount" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_LockDomain": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_LockDomain" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_LockEndpoint": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_LockEndpoint" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_LockPolicy": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_LockPolicy" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_LockTicker": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_LockTicker" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_LockUser": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_LockUser" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_LockVault": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_LockVault" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_MigrateSilo3AccountBatch": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_MigrateSilo3AccountBatch" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_NotarizeData": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_NotarizeData" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_ReleaseQuarantinedTransfers": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_ReleaseQuarantinedTransfers" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_SetSystemProperty": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_SetSystemProperty" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_SignManifest": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_SignManifest" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_UnlockAccount": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_UnlockAccount" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_UnlockDomain": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_UnlockDomain" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_UnlockEndpoint": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_UnlockEndpoint" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_UnlockPolicy": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_UnlockPolicy" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_UnlockTicker": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_UnlockTicker" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_UnlockUser": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_UnlockUser" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_UnlockVault": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_UnlockVault" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_UpdateAccount": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_UpdateAccount" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_UpdateDomain": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_UpdateDomain" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_UpdateDomainPermissions": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_UpdateDomainPermissions" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_UpdateEndpoint": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_UpdateEndpoint" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_UpdateLedger": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_UpdateLedger" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_UpdatePolicy": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_UpdatePolicy" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_UpdateTicker": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_UpdateTicker" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_UpdateUser": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_UpdateUser" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_UpdateVault": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_UpdateVault" ], "type": "string" } } }, "Core_IntentDryRunResponse_v0_ValidateTickers": { "required": [ "success", "type" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errors": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "v0_ValidateTickers" ], "type": "string" } } }, "Core_IntentEntity": { "required": [ "id", "details", "state" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "details": { "$ref": "#/components/schemas/Core_IntentDetails" }, "state": { "$ref": "#/components/schemas/Core_IntentState" } } }, "Core_IntentError": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "$ref": "#/components/schemas/Core_UserOperationRejectionCode" }, "message": { "maxLength": 1000, "minLength": 0, "type": "string" } } }, "Core_IntentExecuted": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "enum": [ "IntentExecuted" ], "type": "string" } } }, "Core_IntentLockStatus": { "enum": [ "Unlocked", "Locked" ], "type": "string" }, "Core_IntentMetadata": { "required": [ "createdAt", "customProperties" ], "type": "object", "properties": { "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" } } }, "Core_IntentReference": { "required": [ "domainId", "id" ], "type": "object", "properties": { "domainId": { "type": "string", "format": "uuid" }, "id": { "type": "string", "format": "uuid" } } }, "Core_IntentResponse": { "required": [ "requestId" ], "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" } } }, "Core_IntentState": { "required": [ "status" ], "type": "object", "properties": { "status": { "$ref": "#/components/schemas/Core_IntentStatus" }, "lastModifiedAt": { "type": "string", "format": "date-time" }, "error": { "$ref": "#/components/schemas/Core_IntentError" }, "progressPerPolicy": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/Core_WorkflowProgress" } } } }, "Core_IntentStatus": { "enum": [ "Open", "Approved", "Executed", "Failed", "Expired", "Rejected", "Executing" ], "type": "string" }, "Core_IntentType": { "enum": [ "v0_NotarizeData", "v0_ExecuteExtension", "v0_CreateDomain", "v0_UpdateDomain", "v0_UpdateDomainPermissions", "v0_UnlockDomain", "v0_LockDomain", "v0_CreateUser", "v0_UpdateUser", "v0_UnlockUser", "v0_LockUser", "v0_CreatePolicy", "v0_UpdatePolicy", "v0_UnlockPolicy", "v0_LockPolicy", "v0_CreateVault", "v0_UpdateVault", "v0_UnlockVault", "v0_LockVault", "v0_UnlockTicker", "v0_LockTicker", "v0_CreateEndpoint", "v0_UpdateEndpoint", "v0_UnlockEndpoint", "v0_LockEndpoint", "v0_CreateAccount", "v0_MigrateSilo3AccountBatch", "v0_UpdateAccount", "v0_UnlockAccount", "v0_LockAccount", "v0_AddAccountLedgers", "v0_CreateTransactionOrder", "v0_ReleaseQuarantinedTransfers", "v0_CreateTicker", "v0_AttemptTransactionOrderCancellation", "v0_ValidateTickers", "v0_UpdateTicker", "v0_CreateTransferOrder", "v0_SignManifest", "v0_SetSystemProperty", "v0_CreateLedger", "v0_UpdateLedger", "v0_AddTrustedPublicKeysForMigration", "v0_CreateBackup", "v0_AcknowledgeBackup" ], "type": "string" }, "Core_IntentUpdated": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "enum": [ "IntentUpdated" ], "type": "string" } } }, "Core_KeyType": { "enum": [ "Secp256r1", "Secp256k1", "Ed25519" ], "type": "string" }, "Core_Ledger": { "required": [ "id", "alias", "parameters", "metadata" ], "type": "object", "properties": { "id": { "maxLength": 100, "minLength": 1, "type": "string" }, "alias": { "maxLength": 200, "minLength": 1, "type": "string" }, "parameters": { "$ref": "#/components/schemas/Core_LedgerParameters" }, "metadata": { "$ref": "#/components/schemas/Core_EntityMetadata" } } }, "Core_LedgerCreated": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "maxLength": 100, "minLength": 1, "type": "string" }, "type": { "enum": [ "LedgerCreated" ], "type": "string" } } }, "Core_LedgerParameters": { "oneOf": [ { "$ref": "#/components/schemas/Core_LedgerParameters_Algorand" }, { "$ref": "#/components/schemas/Core_LedgerParameters_Bitcoin" }, { "$ref": "#/components/schemas/Core_LedgerParameters_Cardano" }, { "$ref": "#/components/schemas/Core_LedgerParameters_Ethereum" }, { "$ref": "#/components/schemas/Core_LedgerParameters_Hedera" }, { "$ref": "#/components/schemas/Core_LedgerParameters_Solana" }, { "$ref": "#/components/schemas/Core_LedgerParameters_Stellar" }, { "$ref": "#/components/schemas/Core_LedgerParameters_Substrate" }, { "$ref": "#/components/schemas/Core_LedgerParameters_Tezos" }, { "$ref": "#/components/schemas/Core_LedgerParameters_Tron" }, { "$ref": "#/components/schemas/Core_LedgerParameters_XRPL" } ], "discriminator": { "propertyName": "type", "mapping": { "Algorand": "#/components/schemas/Core_LedgerParameters_Algorand", "Bitcoin": "#/components/schemas/Core_LedgerParameters_Bitcoin", "Cardano": "#/components/schemas/Core_LedgerParameters_Cardano", "Ethereum": "#/components/schemas/Core_LedgerParameters_Ethereum", "Hedera": "#/components/schemas/Core_LedgerParameters_Hedera", "Solana": "#/components/schemas/Core_LedgerParameters_Solana", "Stellar": "#/components/schemas/Core_LedgerParameters_Stellar", "Substrate": "#/components/schemas/Core_LedgerParameters_Substrate", "Tezos": "#/components/schemas/Core_LedgerParameters_Tezos", "Tron": "#/components/schemas/Core_LedgerParameters_Tron", "XRPL": "#/components/schemas/Core_LedgerParameters_XRPL" } } }, "Core_LedgerParameters_Algorand": { "required": [ "genesisId", "genesisHash", "nativeTickerSymbol", "nativeTickerName", "nativeTickerDecimals", "type" ], "type": "object", "properties": { "genesisId": { "maxLength": 50, "minLength": 0, "type": "string" }, "genesisHash": { "maxLength": 44, "minLength": 44, "type": "string" }, "nativeTickerSymbol": { "maxLength": 100, "minLength": 1, "type": "string" }, "nativeTickerName": { "maxLength": 100, "minLength": 1, "type": "string" }, "nativeTickerDecimals": { "type": "integer", "format": "int32" }, "type": { "enum": [ "Algorand" ], "type": "string" } } }, "Core_LedgerParameters_Bitcoin": { "required": [ "supportsSegWit", "vaultLedgerIdentifier", "network", "tickerSymbol", "tickerName", "dustLimit", "type" ], "type": "object", "properties": { "supportsSegWit": { "type": "boolean" }, "vaultLedgerIdentifier": { "$ref": "#/components/schemas/Core_BitcoinLikeVaultLedgerIdentifier" }, "network": { "$ref": "#/components/schemas/Core_Network" }, "tickerSymbol": { "maxLength": 100, "minLength": 1, "type": "string" }, "tickerName": { "maxLength": 100, "minLength": 1, "type": "string" }, "dustLimit": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "Bitcoin" ], "type": "string" } } }, "Core_LedgerParameters_Cardano": { "required": [ "nativeTickerSymbol", "nativeTickerName", "type" ], "type": "object", "properties": { "nativeTickerSymbol": { "maxLength": 100, "minLength": 1, "type": "string" }, "nativeTickerName": { "maxLength": 100, "minLength": 1, "type": "string" }, "testnetMagic": { "maximum": 4294967295, "minimum": 0, "type": "integer", "format": "int64" }, "type": { "enum": [ "Cardano" ], "type": "string" } } }, "Core_LedgerParameters_Ethereum": { "required": [ "chainId", "vaultLedgerIdentifier", "nativeTickerSymbol", "nativeTickerName", "supportsEIP1559", "type" ], "type": "object", "properties": { "chainId": { "type": "integer", "format": "int32" }, "vaultLedgerIdentifier": { "$ref": "#/components/schemas/Core_EthereumLikeVaultLedgerIdentifier" }, "nativeTickerSymbol": { "maxLength": 100, "minLength": 1, "type": "string" }, "nativeTickerName": { "maxLength": 100, "minLength": 1, "type": "string" }, "supportsEIP1559": { "type": "boolean" }, "type": { "enum": [ "Ethereum" ], "type": "string" } } }, "Core_LedgerParameters_Hedera": { "required": [ "nativeTickerSymbol", "nativeTickerName", "type" ], "type": "object", "properties": { "nativeTickerSymbol": { "maxLength": 100, "minLength": 1, "type": "string" }, "nativeTickerName": { "maxLength": 100, "minLength": 1, "type": "string" }, "type": { "enum": [ "Hedera" ], "type": "string" } } }, "Core_LedgerParameters_Solana": { "required": [ "nativeTickerSymbol", "nativeTickerName", "lamportsPerSignature", "type" ], "type": "object", "properties": { "nativeTickerSymbol": { "maxLength": 100, "minLength": 1, "type": "string" }, "nativeTickerName": { "maxLength": 100, "minLength": 1, "type": "string" }, "lamportsPerSignature": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "Solana" ], "type": "string" } } }, "Core_LedgerParameters_Stellar": { "required": [ "nativeTickerSymbol", "nativeTickerName", "networkPassphrase", "type" ], "type": "object", "properties": { "nativeTickerSymbol": { "maxLength": 100, "minLength": 1, "type": "string" }, "nativeTickerName": { "maxLength": 100, "minLength": 1, "type": "string" }, "networkPassphrase": { "maxLength": 100, "minLength": 12, "type": "string" }, "type": { "enum": [ "Stellar" ], "type": "string" } } }, "Core_LedgerParameters_Substrate": { "required": [ "genesisHash", "addressPrefix", "nativeTickerSymbol", "nativeTickerName", "nativeTickerDecimals", "supportedRuntimeVersions", "type" ], "type": "object", "properties": { "genesisHash": { "type": "string", "format": "^0x[a-f0-9]{64}$" }, "addressPrefix": { "maximum": 16383, "minimum": 0, "type": "integer" }, "nativeTickerSymbol": { "maxLength": 100, "minLength": 1, "type": "string" }, "nativeTickerName": { "maxLength": 100, "minLength": 1, "type": "string" }, "nativeTickerDecimals": { "type": "integer", "format": "int32" }, "supportedRuntimeVersions": { "type": "array", "items": { "$ref": "#/components/schemas/Core_SubstrateRuntimeInfo" } }, "type": { "enum": [ "Substrate" ], "type": "string" } } }, "Core_LedgerParameters_Tezos": { "required": [ "nativeTickerSymbol", "nativeTickerName", "chainId", "type" ], "type": "object", "properties": { "nativeTickerSymbol": { "maxLength": 100, "minLength": 1, "type": "string" }, "nativeTickerName": { "maxLength": 100, "minLength": 1, "type": "string" }, "chainId": { "type": "string" }, "type": { "enum": [ "Tezos" ], "type": "string" } } }, "Core_LedgerParameters_Tron": { "required": [ "nativeTickerSymbol", "nativeTickerName", "type" ], "type": "object", "properties": { "nativeTickerSymbol": { "maxLength": 100, "minLength": 1, "type": "string" }, "nativeTickerName": { "maxLength": 100, "minLength": 1, "type": "string" }, "type": { "enum": [ "Tron" ], "type": "string" } } }, "Core_LedgerParameters_XRPL": { "required": [ "nativeTickerSymbol", "nativeTickerName", "networkId", "type" ], "type": "object", "properties": { "nativeTickerSymbol": { "maxLength": 100, "minLength": 1, "type": "string" }, "nativeTickerName": { "maxLength": 100, "minLength": 1, "type": "string" }, "networkId": { "type": "integer", "format": "int32" }, "type": { "enum": [ "XRPL" ], "type": "string" } } }, "Core_LedgerTransactionData": { "required": [ "ledgerStatus", "ledgerTransactionId", "statusLastUpdatedAt" ], "type": "object", "properties": { "ledgerStatus": { "$ref": "#/components/schemas/Core_LedgerTransactionStatus" }, "failure": { "$ref": "#/components/schemas/Core_LedgerTransactionFailure" }, "ledgerTransactionId": { "maxLength": 500, "minLength": 1, "type": "string" }, "rawTransaction": { "maxLength": 5000000, "minLength": 1, "type": "string" }, "blockTime": { "type": "string", "format": "date-time", "deprecated": true }, "statusLastUpdatedAt": { "type": "string", "format": "date-time" }, "providerStatusLastUpdatedAt": { "type": "string", "format": "date-time" }, "ledgerData": { "$ref": "#/components/schemas/Core_OnLedgerData" } } }, "Core_LedgerTransactionFailure": { "enum": [ "FailedOnChain", "PartiallyFailedOnChain" ], "type": "string" }, "Core_LedgerTransactionStatus": { "enum": [ "Detected", "Confirmed", "Expired", "Replaced" ], "type": "string" }, "Core_LedgerUpdated": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "maxLength": 100, "minLength": 1, "type": "string" }, "type": { "enum": [ "LedgerUpdated" ], "type": "string" } } }, "Core_LockStatus": { "enum": [ "Unlocked", "Locked", "Archived" ], "type": "string" }, "Core_LoginId": { "required": [ "id", "providerId" ], "type": "object", "properties": { "id": { "maxLength": 500, "minLength": 1, "type": "string", "description": "User identifier used by the provider." }, "providerId": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Login provider. For internal login, set to `harmonize`. For external identity providers, must match the provider name." } } }, "Core_Manifest": { "required": [ "id", "domainId", "accountId", "content", "metadata" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "domainId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "ledgerId": { "maxLength": 100, "minLength": 1, "type": "string" }, "content": { "$ref": "#/components/schemas/Core_ManifestContent" }, "value": { "$ref": "#/components/schemas/Core_ManifestValue" }, "metadata": { "$ref": "#/components/schemas/Core_EntityMetadata" } } }, "Core_ManifestAdditionalDetails": { "required": [ "processing" ], "type": "object", "properties": { "processing": { "$ref": "#/components/schemas/Core_ManifestProcessingDetails" } } }, "Core_ManifestContent": { "oneOf": [ { "$ref": "#/components/schemas/Core_ManifestContent_EIP-191" }, { "$ref": "#/components/schemas/Core_ManifestContent_JWT" }, { "$ref": "#/components/schemas/Core_ManifestContent_Unsafe" } ], "discriminator": { "propertyName": "type", "mapping": { "EIP-191": "#/components/schemas/Core_ManifestContent_EIP-191", "JWT": "#/components/schemas/Core_ManifestContent_JWT", "Unsafe": "#/components/schemas/Core_ManifestContent_Unsafe" } } }, "Core_ManifestContentType": { "enum": [ "EIP-191", "JWT", "Unsafe" ], "type": "string" }, "Core_ManifestContent_EIP-191": { "required": [ "value", "type" ], "type": "object", "properties": { "value": { "maxLength": 20002, "minLength": 2, "pattern": "^0[xX](([a-fA-F0-9][a-fA-F0-9])*)$", "type": "string" }, "type": { "enum": [ "EIP-191" ], "type": "string" } } }, "Core_ManifestContent_JWT": { "required": [ "header", "payload", "type" ], "type": "object", "properties": { "header": { "$ref": "#/components/schemas/Core_ManifestContent_JWT_Header" }, "payload": { "$ref": "#/components/schemas/Core_ManifestContent_JWT_Payload" }, "type": { "enum": [ "JWT" ], "type": "string" } } }, "Core_ManifestContent_JWT_Header": { "type": "object", "properties": { "type": { "maxLength": 75, "minLength": 1, "type": "string" }, "algorithm": { "maxLength": 75, "minLength": 1, "type": "string" }, "additionalParameters": { "$ref": "#/components/schemas/Core_StringsMap" } } }, "Core_ManifestContent_JWT_Payload": { "type": "object", "properties": { "issuer": { "maxLength": 75, "minLength": 1, "type": "string" }, "subject": { "maxLength": 75, "minLength": 1, "type": "string" }, "audience": { "maxLength": 75, "minLength": 1, "type": "string" }, "expiration": { "type": "integer", "format": "int64" }, "notBefore": { "type": "integer", "format": "int64" }, "issuedAt": { "type": "integer", "format": "int64" }, "jwtId": { "maxLength": 75, "minLength": 1, "type": "string" }, "additionalClaims": { "$ref": "#/components/schemas/Core_StringsMap" } } }, "Core_ManifestContent_Unsafe": { "required": [ "value", "type" ], "type": "object", "properties": { "value": { "type": "string", "format": "base64" }, "type": { "enum": [ "Unsafe" ], "type": "string" } } }, "Core_ManifestCreated": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "type": { "enum": [ "ManifestCreated" ], "type": "string" } } }, "Core_ManifestProcessingDetails": { "oneOf": [ { "$ref": "#/components/schemas/Core_ManifestProcessingDetails_Completed" }, { "$ref": "#/components/schemas/Core_ManifestProcessingDetails_Pending" }, { "$ref": "#/components/schemas/Core_ManifestProcessingDetails_Preparing" } ], "discriminator": { "propertyName": "type", "mapping": { "Completed": "#/components/schemas/Core_ManifestProcessingDetails_Completed", "Pending": "#/components/schemas/Core_ManifestProcessingDetails_Pending", "Preparing": "#/components/schemas/Core_ManifestProcessingDetails_Preparing" } } }, "Core_ManifestProcessingDetails_Completed": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "Completed" ], "type": "string" } } }, "Core_ManifestProcessingDetails_Pending": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "Pending" ], "type": "string" } } }, "Core_ManifestProcessingDetails_Preparing": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "Preparing" ], "type": "string" } } }, "Core_ManifestProcessingStatus": { "enum": [ "Pending", "Preparing", "Completed" ], "type": "string" }, "Core_ManifestUpdated": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "type": { "enum": [ "ManifestUpdated" ], "type": "string" } } }, "Core_ManifestValue": { "oneOf": [ { "$ref": "#/components/schemas/Core_ManifestValue_EIP-191" }, { "$ref": "#/components/schemas/Core_ManifestValue_JWT" }, { "$ref": "#/components/schemas/Core_ManifestValue_Unsafe" } ], "discriminator": { "propertyName": "type", "mapping": { "EIP-191": "#/components/schemas/Core_ManifestValue_EIP-191", "JWT": "#/components/schemas/Core_ManifestValue_JWT", "Unsafe": "#/components/schemas/Core_ManifestValue_Unsafe" } } }, "Core_ManifestValue_EIP-191": { "required": [ "value", "type" ], "type": "object", "properties": { "value": { "maxLength": 20002, "minLength": 2, "pattern": "^0[xX](([a-fA-F0-9][a-fA-F0-9])*)$", "type": "string" }, "type": { "enum": [ "EIP-191" ], "type": "string" } } }, "Core_ManifestValue_JWT": { "required": [ "value", "type" ], "type": "object", "properties": { "value": { "type": "string" }, "type": { "enum": [ "JWT" ], "type": "string" } } }, "Core_ManifestValue_Unsafe": { "required": [ "signature", "type" ], "type": "object", "properties": { "signature": { "type": "string", "format": "base64" }, "recoveryId": { "type": "string", "format": "base64" }, "type": { "enum": [ "Unsafe" ], "type": "string" } } }, "Core_ManifestsCollection": { "required": [ "items", "count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core_ApiManifest" } }, "count": { "type": "integer", "format": "int32" }, "currentStartingAfter": { "type": "string" }, "nextStartingAfter": { "type": "string" } } }, "Core_MeDomainReference": { "required": [ "id", "alias", "userReference" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "maxLength": 75, "minLength": 1, "type": "string" }, "userReference": { "$ref": "#/components/schemas/Core_MeUserReference" } } }, "Core_MeReference": { "required": [ "publicKey", "domains" ], "type": "object", "properties": { "publicKey": { "type": "string", "format": "base64" }, "domains": { "type": "array", "items": { "$ref": "#/components/schemas/Core_MeDomainReference" } }, "loginId": { "$ref": "#/components/schemas/Core_LoginId" } } }, "Core_MeUserReference": { "required": [ "id", "alias", "roles" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "maxLength": 75, "minLength": 1, "type": "string" }, "roles": { "minItems": 1, "type": "array", "items": { "maxLength": 50, "minLength": 1, "pattern": "[a-z0-9\\-]+", "type": "string" } } } }, "Core_Network": { "enum": [ "mainnet", "testnet", "regtest" ], "type": "string" }, "Core_NonFungibleTokenDestination": { "oneOf": [ { "$ref": "#/components/schemas/Core_NonFungibleTokenDestination_NftTokenId" }, { "$ref": "#/components/schemas/Core_NonFungibleTokenDestination_Ticker" } ], "discriminator": { "propertyName": "type", "mapping": { "NftTokenId": "#/components/schemas/Core_NonFungibleTokenDestination_NftTokenId", "Ticker": "#/components/schemas/Core_NonFungibleTokenDestination_Ticker" } } }, "Core_NonFungibleTokenDestination_NftTokenId": { "required": [ "tokenId", "serialNumber", "type" ], "type": "object", "properties": { "tokenId": { "maxLength": 20, "minLength": 5, "type": "string", "description": "String consisting Hedera Token Id" }, "serialNumber": { "type": "integer", "format": "int64" }, "type": { "enum": [ "NftTokenId" ], "type": "string" } } }, "Core_NonFungibleTokenDestination_Ticker": { "required": [ "tickerId", "type" ], "type": "object", "properties": { "tickerId": { "type": "string", "format": "uuid" }, "type": { "enum": [ "Ticker" ], "type": "string" } } }, "Core_NotaryApiKeyValue": { "required": [ "publicKey" ], "type": "object", "properties": { "publicKey": { "$ref": "#/components/schemas/Core_AccountPublicKeyOnly" } } }, "Core_NotaryCollectionsKeyValue": { "required": [ "publicKey" ], "type": "object", "properties": { "publicKey": { "$ref": "#/components/schemas/Core_AccountPublicKeyOnly" } } }, "Core_NotaryCommunicationKeyValue": { "required": [ "publicKey" ], "type": "object", "properties": { "publicKey": { "$ref": "#/components/schemas/Core_AccountPublicKeyOnly" } } }, "Core_OnLedgerData": { "oneOf": [ { "$ref": "#/components/schemas/Core_OnLedgerData_Bitcoin" }, { "$ref": "#/components/schemas/Core_OnLedgerData_Ethereum" } ], "discriminator": { "propertyName": "type", "mapping": { "Bitcoin": "#/components/schemas/Core_OnLedgerData_Bitcoin", "Ethereum": "#/components/schemas/Core_OnLedgerData_Ethereum" } } }, "Core_OnLedgerData_Bitcoin": { "required": [ "inputs", "outputs", "type" ], "type": "object", "properties": { "inputs": { "type": "array", "items": { "$ref": "#/components/schemas/Core_BitcoinOnLedgerDataInput" } }, "outputs": { "type": "array", "items": { "$ref": "#/components/schemas/Core_BitcoinOnLedgerDataOutput" } }, "type": { "enum": [ "Bitcoin" ], "type": "string" } } }, "Core_OnLedgerData_Ethereum": { "required": [ "logs", "type" ], "type": "object", "properties": { "logs": { "type": "array", "items": { "$ref": "#/components/schemas/Core_EthereumLedgerLog" } }, "createdContractAddresses": { "type": "array", "items": { "maxLength": 512, "minLength": 1, "type": "string" } }, "deletedContractAddresses": { "type": "array", "items": { "maxLength": 512, "minLength": 1, "type": "string" } }, "type": { "enum": [ "Ethereum" ], "type": "string" } } }, "Core_Permissions": { "required": [ "readAccess" ], "type": "object", "properties": { "readAccess": { "$ref": "#/components/schemas/Core_ReadAccess" } } }, "Core_Policy": { "required": [ "id", "domainId", "alias", "rank", "scope", "scriptingEngine", "lock", "metadata" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "domainId": { "type": "string", "format": "uuid" }, "alias": { "maxLength": 75, "minLength": 1, "type": "string" }, "rank": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" }, "intentTypes": { "type": "array", "items": { "$ref": "#/components/schemas/Core_IntentType" } }, "scope": { "$ref": "#/components/schemas/Core_PolicyScope" }, "scriptingEngine": { "$ref": "#/components/schemas/Core_ScriptingEngine" }, "condition": { "$ref": "#/components/schemas/Core_PolicyCondition" }, "workflow": { "type": "array", "items": { "$ref": "#/components/schemas/Core_WorkflowCondition" } }, "lock": { "$ref": "#/components/schemas/Core_LockStatus" }, "metadata": { "$ref": "#/components/schemas/Core_EntityMetadata" } } }, "Core_PolicyCondition": { "oneOf": [ { "$ref": "#/components/schemas/Core_PolicyCondition_And" }, { "$ref": "#/components/schemas/Core_PolicyCondition_Expression" }, { "$ref": "#/components/schemas/Core_PolicyCondition_Or" } ], "discriminator": { "propertyName": "type", "mapping": { "And": "#/components/schemas/Core_PolicyCondition_And", "Expression": "#/components/schemas/Core_PolicyCondition_Expression", "Or": "#/components/schemas/Core_PolicyCondition_Or" } }, "example": { "left": { "left": { "expression": "true == true", "type": "Expression" }, "right": { "expression": "false == true", "type": "Expression" }, "type": "And" }, "right": { "left": { "expression": "true == false", "type": "Expression" }, "right": { "expression": "false == false", "type": "Expression" }, "type": "Or" } } }, "Core_PolicyCondition_And": { "required": [ "left", "right", "type" ], "type": "object", "properties": { "left": { "$ref": "#/components/schemas/Core_PolicyCondition" }, "right": { "$ref": "#/components/schemas/Core_PolicyCondition" }, "type": { "enum": [ "And" ], "type": "string" } } }, "Core_PolicyCondition_Expression": { "required": [ "expression", "type" ], "type": "object", "properties": { "expression": { "maxLength": 10000, "minLength": 1, "type": "string" }, "type": { "enum": [ "Expression" ], "type": "string" } } }, "Core_PolicyCondition_Or": { "required": [ "left", "right", "type" ], "type": "object", "properties": { "left": { "$ref": "#/components/schemas/Core_PolicyCondition" }, "right": { "$ref": "#/components/schemas/Core_PolicyCondition" }, "type": { "enum": [ "Or" ], "type": "string" } } }, "Core_PolicyCreated": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "enum": [ "PolicyCreated" ], "type": "string" } } }, "Core_PolicyReference": { "required": [ "id", "revision", "domainId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "revision": { "minimum": 1, "type": "integer", "format": "int64" }, "domainId": { "type": "string", "format": "uuid" } } }, "Core_PolicyScope": { "enum": [ "Self", "Descendants", "SelfAndDescendants" ], "type": "string" }, "Core_PolicyUpdated": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "enum": [ "PolicyUpdated" ], "type": "string" } } }, "Core_PreferredAddressForChange": { "enum": [ "PrimaryAddress" ], "type": "string", "description": "Hint for specifically bitcoin ledgers to have the transaction happen with addressForChange PrimaryAddress - so change utxo goes to address \\0\\0 - aligned with dry-runs - rather than the default generate a new chain-internal address." }, "Core_Propose": { "required": [ "author", "expiryAt", "targetDomainId", "id", "payload", "customProperties", "type" ], "type": "object", "properties": { "author": { "$ref": "#/components/schemas/Core_UserReference" }, "expiryAt": { "type": "string", "format": "date-time" }, "targetDomainId": { "type": "string", "format": "uuid" }, "id": { "type": "string", "format": "uuid" }, "payload": { "$ref": "#/components/schemas/Core_ProposeUserIntentPayload" }, "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" }, "type": { "enum": [ "Propose" ], "type": "string" } } }, "Core_ProposeIntentBody": { "required": [ "request", "signature" ], "type": "object", "properties": { "request": { "$ref": "#/components/schemas/Core_Propose" }, "signature": { "type": "string", "format": "base64" } } }, "Core_ProposeTransactionOrderParameters": { "oneOf": [ { "$ref": "#/components/schemas/Core_TransactionOrderParameters_Algorand" }, { "$ref": "#/components/schemas/Core_TransactionOrderParameters_Bitcoin" }, { "$ref": "#/components/schemas/Core_TransactionOrderParameters_Cardano" }, { "$ref": "#/components/schemas/Core_TransactionOrderParameters_Ethereum" }, { "$ref": "#/components/schemas/Core_TransactionOrderParameters_Hedera" }, { "$ref": "#/components/schemas/Core_TransactionOrderParameters_Solana" }, { "$ref": "#/components/schemas/Core_TransactionOrderParameters_Stellar" }, { "$ref": "#/components/schemas/Core_TransactionOrderParameters_Substrate" }, { "$ref": "#/components/schemas/Core_TransactionOrderParameters_Tezos" }, { "$ref": "#/components/schemas/Core_TransactionOrderParameters_Tron" }, { "$ref": "#/components/schemas/Core_TransactionOrderParameters_XRPL" } ], "discriminator": { "propertyName": "type", "mapping": { "Algorand": "#/components/schemas/Core_TransactionOrderParameters_Algorand", "Bitcoin": "#/components/schemas/Core_TransactionOrderParameters_Bitcoin", "Cardano": "#/components/schemas/Core_TransactionOrderParameters_Cardano", "Ethereum": "#/components/schemas/Core_TransactionOrderParameters_Ethereum", "Hedera": "#/components/schemas/Core_TransactionOrderParameters_Hedera", "Solana": "#/components/schemas/Core_TransactionOrderParameters_Solana", "Stellar": "#/components/schemas/Core_TransactionOrderParameters_Stellar", "Substrate": "#/components/schemas/Core_TransactionOrderParameters_Substrate", "Tezos": "#/components/schemas/Core_TransactionOrderParameters_Tezos", "Tron": "#/components/schemas/Core_TransactionOrderParameters_Tron", "XRPL": "#/components/schemas/Core_TransactionOrderParameters_XRPL" } } }, "Core_ProposeUserIntentPayload": { "oneOf": [ { "$ref": "#/components/schemas/Core_Propose_v0_CreateTransactionOrder" }, { "$ref": "#/components/schemas/Core_v0_AcknowledgeBackup" }, { "$ref": "#/components/schemas/Core_v0_AddAccountLedgers" }, { "$ref": "#/components/schemas/Core_v0_AddTrustedPublicKeysForMigration" }, { "$ref": "#/components/schemas/Core_v0_AttemptTransactionOrderCancellation" }, { "$ref": "#/components/schemas/Core_v0_CreateAccount" }, { "$ref": "#/components/schemas/Core_v0_CreateBackup" }, { "$ref": "#/components/schemas/Core_v0_CreateDomain" }, { "$ref": "#/components/schemas/Core_v0_CreateEndpoint" }, { "$ref": "#/components/schemas/Core_v0_CreateLedger" }, { "$ref": "#/components/schemas/Core_v0_CreatePolicy" }, { "$ref": "#/components/schemas/Core_v0_CreateTicker" }, { "$ref": "#/components/schemas/Core_v0_CreateTransferOrder" }, { "$ref": "#/components/schemas/Core_v0_CreateUser" }, { "$ref": "#/components/schemas/Core_v0_CreateVault" }, { "$ref": "#/components/schemas/Core_v0_ExecuteExtension" }, { "$ref": "#/components/schemas/Core_v0_LockAccount" }, { "$ref": "#/components/schemas/Core_v0_LockDomain" }, { "$ref": "#/components/schemas/Core_v0_LockEndpoint" }, { "$ref": "#/components/schemas/Core_v0_LockPolicy" }, { "$ref": "#/components/schemas/Core_v0_LockTicker" }, { "$ref": "#/components/schemas/Core_v0_LockUser" }, { "$ref": "#/components/schemas/Core_v0_LockVault" }, { "$ref": "#/components/schemas/Core_v0_MigrateSilo3AccountBatch" }, { "$ref": "#/components/schemas/Core_v0_NotarizeData" }, { "$ref": "#/components/schemas/Core_v0_ReleaseQuarantinedTransfers" }, { "$ref": "#/components/schemas/Core_v0_SetSystemProperty" }, { "$ref": "#/components/schemas/Core_v0_SignManifest" }, { "$ref": "#/components/schemas/Core_v0_UnlockAccount" }, { "$ref": "#/components/schemas/Core_v0_UnlockDomain" }, { "$ref": "#/components/schemas/Core_v0_UnlockEndpoint" }, { "$ref": "#/components/schemas/Core_v0_UnlockPolicy" }, { "$ref": "#/components/schemas/Core_v0_UnlockTicker" }, { "$ref": "#/components/schemas/Core_v0_UnlockUser" }, { "$ref": "#/components/schemas/Core_v0_UnlockVault" }, { "$ref": "#/components/schemas/Core_v0_UpdateAccount" }, { "$ref": "#/components/schemas/Core_v0_UpdateDomain" }, { "$ref": "#/components/schemas/Core_v0_UpdateDomainPermissions" }, { "$ref": "#/components/schemas/Core_v0_UpdateEndpoint" }, { "$ref": "#/components/schemas/Core_v0_UpdateLedger" }, { "$ref": "#/components/schemas/Core_v0_UpdatePolicy" }, { "$ref": "#/components/schemas/Core_v0_UpdateTicker" }, { "$ref": "#/components/schemas/Core_v0_UpdateUser" }, { "$ref": "#/components/schemas/Core_v0_UpdateVault" }, { "$ref": "#/components/schemas/Core_v0_ValidateTickers" } ], "discriminator": { "propertyName": "type", "mapping": { "v0_AcknowledgeBackup": "#/components/schemas/Core_v0_AcknowledgeBackup", "v0_AddAccountLedgers": "#/components/schemas/Core_v0_AddAccountLedgers", "v0_AddTrustedPublicKeysForMigration": "#/components/schemas/Core_v0_AddTrustedPublicKeysForMigration", "v0_AttemptTransactionOrderCancellation": "#/components/schemas/Core_v0_AttemptTransactionOrderCancellation", "v0_CreateAccount": "#/components/schemas/Core_v0_CreateAccount", "v0_CreateBackup": "#/components/schemas/Core_v0_CreateBackup", "v0_CreateDomain": "#/components/schemas/Core_v0_CreateDomain", "v0_CreateEndpoint": "#/components/schemas/Core_v0_CreateEndpoint", "v0_CreateLedger": "#/components/schemas/Core_v0_CreateLedger", "v0_CreatePolicy": "#/components/schemas/Core_v0_CreatePolicy", "v0_CreateTicker": "#/components/schemas/Core_v0_CreateTicker", "v0_CreateTransactionOrder": "#/components/schemas/Core_Propose_v0_CreateTransactionOrder", "v0_CreateTransferOrder": "#/components/schemas/Core_v0_CreateTransferOrder", "v0_CreateUser": "#/components/schemas/Core_v0_CreateUser", "v0_CreateVault": "#/components/schemas/Core_v0_CreateVault", "v0_ExecuteExtension": "#/components/schemas/Core_v0_ExecuteExtension", "v0_LockAccount": "#/components/schemas/Core_v0_LockAccount", "v0_LockDomain": "#/components/schemas/Core_v0_LockDomain", "v0_LockEndpoint": "#/components/schemas/Core_v0_LockEndpoint", "v0_LockPolicy": "#/components/schemas/Core_v0_LockPolicy", "v0_LockTicker": "#/components/schemas/Core_v0_LockTicker", "v0_LockUser": "#/components/schemas/Core_v0_LockUser", "v0_LockVault": "#/components/schemas/Core_v0_LockVault", "v0_MigrateSilo3AccountBatch": "#/components/schemas/Core_v0_MigrateSilo3AccountBatch", "v0_NotarizeData": "#/components/schemas/Core_v0_NotarizeData", "v0_ReleaseQuarantinedTransfers": "#/components/schemas/Core_v0_ReleaseQuarantinedTransfers", "v0_SetSystemProperty": "#/components/schemas/Core_v0_SetSystemProperty", "v0_SignManifest": "#/components/schemas/Core_v0_SignManifest", "v0_UnlockAccount": "#/components/schemas/Core_v0_UnlockAccount", "v0_UnlockDomain": "#/components/schemas/Core_v0_UnlockDomain", "v0_UnlockEndpoint": "#/components/schemas/Core_v0_UnlockEndpoint", "v0_UnlockPolicy": "#/components/schemas/Core_v0_UnlockPolicy", "v0_UnlockTicker": "#/components/schemas/Core_v0_UnlockTicker", "v0_UnlockUser": "#/components/schemas/Core_v0_UnlockUser", "v0_UnlockVault": "#/components/schemas/Core_v0_UnlockVault", "v0_UpdateAccount": "#/components/schemas/Core_v0_UpdateAccount", "v0_UpdateDomain": "#/components/schemas/Core_v0_UpdateDomain", "v0_UpdateDomainPermissions": "#/components/schemas/Core_v0_UpdateDomainPermissions", "v0_UpdateEndpoint": "#/components/schemas/Core_v0_UpdateEndpoint", "v0_UpdateLedger": "#/components/schemas/Core_v0_UpdateLedger", "v0_UpdatePolicy": "#/components/schemas/Core_v0_UpdatePolicy", "v0_UpdateTicker": "#/components/schemas/Core_v0_UpdateTicker", "v0_UpdateUser": "#/components/schemas/Core_v0_UpdateUser", "v0_UpdateVault": "#/components/schemas/Core_v0_UpdateVault", "v0_ValidateTickers": "#/components/schemas/Core_v0_ValidateTickers" } } }, "Core_Propose_v0_CreateTransactionOrder": { "required": [ "id", "accountId", "parameters", "customProperties", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "ledgerId": { "maxLength": 100, "minLength": 1, "type": "string" }, "parameters": { "$ref": "#/components/schemas/Core_ProposeTransactionOrderParameters" }, "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" }, "type": { "enum": [ "v0_CreateTransactionOrder" ], "type": "string" } } }, "Core_ReadAccess": { "required": [ "domains", "users", "endpoints", "policies", "accounts", "transactions", "requests", "events" ], "type": "object", "properties": { "domains": { "type": "array", "items": { "maxLength": 50, "minLength": 1, "pattern": "[a-z0-9\\-]+", "type": "string" } }, "users": { "type": "array", "items": { "maxLength": 50, "minLength": 1, "pattern": "[a-z0-9\\-]+", "type": "string" } }, "endpoints": { "type": "array", "items": { "maxLength": 50, "minLength": 1, "pattern": "[a-z0-9\\-]+", "type": "string" } }, "policies": { "type": "array", "items": { "maxLength": 50, "minLength": 1, "pattern": "[a-z0-9\\-]+", "type": "string" } }, "accounts": { "type": "array", "items": { "maxLength": 50, "minLength": 1, "pattern": "[a-z0-9\\-]+", "type": "string" } }, "transactions": { "type": "array", "items": { "maxLength": 50, "minLength": 1, "pattern": "[a-z0-9\\-]+", "type": "string" } }, "requests": { "type": "array", "items": { "maxLength": 50, "minLength": 1, "pattern": "[a-z0-9\\-]+", "type": "string" } }, "events": { "type": "array", "items": { "maxLength": 50, "minLength": 1, "pattern": "[a-z0-9\\-]+", "type": "string" } } } }, "Core_ReadWriteSystemPropertyKeyValue": { "oneOf": [ { "$ref": "#/components/schemas/Core_ReadWriteSystemPropertyKeyValue_StateReviewAuthorityProperty" } ], "discriminator": { "propertyName": "type", "mapping": { "StateReviewAuthorityProperty": "#/components/schemas/Core_ReadWriteSystemPropertyKeyValue_StateReviewAuthorityProperty" } } }, "Core_ReadWriteSystemPropertyKeyValue_StateReviewAuthorityProperty": { "required": [ "value", "type" ], "type": "object", "properties": { "value": { "$ref": "#/components/schemas/Core_StateReviewAuthorityValue" }, "type": { "enum": [ "StateReviewAuthorityProperty" ], "type": "string" } } }, "Core_RecipientTransferParty": { "oneOf": [ { "$ref": "#/components/schemas/Core_RecipientTransferParty_Account" }, { "$ref": "#/components/schemas/Core_RecipientTransferParty_Address" } ], "discriminator": { "propertyName": "type", "mapping": { "Account": "#/components/schemas/Core_RecipientTransferParty_Account", "Address": "#/components/schemas/Core_RecipientTransferParty_Address" } } }, "Core_RecipientTransferParty_Account": { "required": [ "domainId", "accountId", "type" ], "type": "object", "properties": { "domainId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "address": { "maxLength": 512, "minLength": 1, "type": "string", "deprecated": true }, "addressDetails": { "$ref": "#/components/schemas/Core_AddressDetails" }, "type": { "enum": [ "Account" ], "type": "string" } } }, "Core_RecipientTransferParty_Address": { "required": [ "address", "addressDetails", "type" ], "type": "object", "properties": { "address": { "maxLength": 512, "minLength": 1, "type": "string" }, "addressDetails": { "$ref": "#/components/schemas/Core_AddressDetails" }, "type": { "enum": [ "Address" ], "type": "string" } } }, "Core_Reject": { "required": [ "author", "targetDomainId", "intentId", "proposalSignature", "rejectReason", "type" ], "type": "object", "properties": { "author": { "$ref": "#/components/schemas/Core_UserReference" }, "expiryAt": { "type": "string", "format": "date-time", "deprecated": true }, "targetDomainId": { "type": "string", "format": "uuid" }, "intentId": { "type": "string", "format": "uuid" }, "proposalSignature": { "type": "string", "format": "base64" }, "rejectReason": { "maxLength": 5000, "minLength": 1, "type": "string" }, "type": { "enum": [ "Reject" ], "type": "string" } } }, "Core_RejectIntentBody": { "required": [ "request", "signature" ], "type": "object", "properties": { "request": { "$ref": "#/components/schemas/Core_Reject" }, "signature": { "type": "string", "format": "base64" } } }, "Core_RemainingDomainUsers": { "required": [ "domainId", "users" ], "type": "object", "properties": { "domainId": { "type": "string", "format": "uuid" }, "users": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "Core_RequestState": { "required": [ "id", "requester", "status", "history", "lastModifiedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "requester": { "$ref": "#/components/schemas/Core_UserReference" }, "status": { "$ref": "#/components/schemas/Core_RequestStateStatus" }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/Core_RequestStateHistory" } }, "lastModifiedAt": { "type": "string", "format": "date-time" }, "intent": { "$ref": "#/components/schemas/Core_IntentReference" } } }, "Core_RequestStateHistory": { "required": [ "source", "status", "createdAt" ], "type": "object", "properties": { "source": { "maxLength": 200, "minLength": 1, "type": "string" }, "status": { "$ref": "#/components/schemas/Core_RequestStateStatus" }, "hint": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } } }, "Core_RequestStateStatus": { "enum": [ "Processing", "Failed", "Succeeded" ], "type": "string" }, "Core_ResolvedEndpoint": { "required": [ "endpointId", "domainId" ], "type": "object", "properties": { "endpointId": { "type": "string", "format": "uuid" }, "domainId": { "type": "string", "format": "uuid" } } }, "Core_ResultLedger": { "required": [ "ledgerId", "available" ], "type": "object", "properties": { "ledgerId": { "maxLength": 100, "minLength": 1, "type": "string" }, "available": { "type": "boolean" } } }, "Core_RootDomainSetup": { "required": [ "id", "alias", "lock", "permissions", "customProperties", "users", "policies" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "maxLength": 75, "minLength": 1, "type": "string" }, "lock": { "$ref": "#/components/schemas/Core_IntentLockStatus" }, "governingStrategy": { "$ref": "#/components/schemas/Core_GoverningStrategy" }, "permissions": { "$ref": "#/components/schemas/Core_Permissions" }, "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/Core_CreateDomainGenesisUser" } }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/Core_CreateDomainGenesisPolicy" } }, "descendants": { "type": "array", "items": { "$ref": "#/components/schemas/Core_CreateDomainsPayload" } } } }, "Core_ScriptingEngine": { "enum": [ "Javascript_v0" ], "type": "string" }, "Core_SenderTransferParty": { "oneOf": [ { "$ref": "#/components/schemas/Core_SenderTransferParty_Account" }, { "$ref": "#/components/schemas/Core_SenderTransferParty_Address" } ], "discriminator": { "propertyName": "type", "mapping": { "Account": "#/components/schemas/Core_SenderTransferParty_Account", "Address": "#/components/schemas/Core_SenderTransferParty_Address" } } }, "Core_SenderTransferParty_Account": { "required": [ "domainId", "accountId", "type" ], "type": "object", "properties": { "domainId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "addresses": { "type": "array", "items": { "maxLength": 512, "minLength": 1, "type": "string" }, "deprecated": true }, "addressesDetails": { "type": "array", "items": { "$ref": "#/components/schemas/Core_AddressDetails" } }, "type": { "enum": [ "Account" ], "type": "string" } } }, "Core_SenderTransferParty_Address": { "required": [ "address", "addressDetails", "type" ], "type": "object", "properties": { "address": { "maxLength": 512, "minLength": 1, "type": "string" }, "addressDetails": { "$ref": "#/components/schemas/Core_AddressDetails" }, "type": { "enum": [ "Address" ], "type": "string" } } }, "Core_SolanaFeeStrategy": { "oneOf": [ { "$ref": "#/components/schemas/Core_SolanaFeeStrategy_Priority" } ], "discriminator": { "propertyName": "type", "mapping": { "Priority": "#/components/schemas/Core_SolanaFeeStrategy_Priority" } } }, "Core_SolanaFeeStrategy_Priority": { "required": [ "priority", "type" ], "type": "object", "properties": { "priority": { "$ref": "#/components/schemas/Core_FeePriority" }, "type": { "enum": [ "Priority" ], "type": "string" } } }, "Core_SolanaMintAccount": { "oneOf": [ { "$ref": "#/components/schemas/Core_SolanaMintAccount_Destination" }, { "$ref": "#/components/schemas/Core_SolanaMintAccount_Ticker" } ], "discriminator": { "propertyName": "type", "mapping": { "Destination": "#/components/schemas/Core_SolanaMintAccount_Destination", "Ticker": "#/components/schemas/Core_SolanaMintAccount_Ticker" } } }, "Core_SolanaMintAccount_Destination": { "required": [ "destination", "type" ], "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/Core_TransactionDestination" }, "type": { "enum": [ "Destination" ], "type": "string" } } }, "Core_SolanaMintAccount_Ticker": { "required": [ "tickerId", "type" ], "type": "object", "properties": { "tickerId": { "type": "string", "format": "uuid" }, "type": { "enum": [ "Ticker" ], "type": "string" } } }, "Core_SolanaOperation": { "oneOf": [ { "$ref": "#/components/schemas/Core_SolanaOperation_Burn" }, { "$ref": "#/components/schemas/Core_SolanaOperation_CreateNonceAccount" }, { "$ref": "#/components/schemas/Core_SolanaOperation_FundAtaAccount" }, { "$ref": "#/components/schemas/Core_SolanaOperation_InitializeMint" }, { "$ref": "#/components/schemas/Core_SolanaOperation_MintTo" }, { "$ref": "#/components/schemas/Core_SolanaOperation_Transfer" }, { "$ref": "#/components/schemas/Core_SolanaOperation_TransferToken" } ], "discriminator": { "propertyName": "type", "mapping": { "Burn": "#/components/schemas/Core_SolanaOperation_Burn", "CreateNonceAccount": "#/components/schemas/Core_SolanaOperation_CreateNonceAccount", "FundAtaAccount": "#/components/schemas/Core_SolanaOperation_FundAtaAccount", "InitializeMint": "#/components/schemas/Core_SolanaOperation_InitializeMint", "MintTo": "#/components/schemas/Core_SolanaOperation_MintTo", "Transfer": "#/components/schemas/Core_SolanaOperation_Transfer", "TransferToken": "#/components/schemas/Core_SolanaOperation_TransferToken" } } }, "Core_SolanaOperation_Burn": { "required": [ "mintAccount", "amount", "type" ], "type": "object", "properties": { "mintAccount": { "$ref": "#/components/schemas/Core_SolanaMintAccount" }, "amount": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "Burn" ], "type": "string" } } }, "Core_SolanaOperation_CreateNonceAccount": { "required": [ "createOnAccount", "type" ], "type": "object", "properties": { "createOnAccount": { "type": "string", "format": "uuid" }, "type": { "enum": [ "CreateNonceAccount" ], "type": "string" } } }, "Core_SolanaOperation_FundAtaAccount": { "required": [ "mintAccount", "type" ], "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/Core_TransactionDestination" }, "mintAccount": { "$ref": "#/components/schemas/Core_SolanaMintAccount" }, "type": { "enum": [ "FundAtaAccount" ], "type": "string" } } }, "Core_SolanaOperation_InitializeMint": { "required": [ "mintAccount", "decimals", "tokenType", "type" ], "type": "object", "properties": { "mintAccount": { "type": "string", "format": "uuid" }, "decimals": { "minimum": 0, "type": "integer", "format": "int32" }, "tokenType": { "$ref": "#/components/schemas/Core_SolanaTokenType" }, "type": { "enum": [ "InitializeMint" ], "type": "string" } } }, "Core_SolanaOperation_MintTo": { "required": [ "destination", "mintAccount", "amount", "type" ], "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/Core_TransactionDestination" }, "mintAccount": { "$ref": "#/components/schemas/Core_SolanaMintAccount" }, "amount": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "MintTo" ], "type": "string" } } }, "Core_SolanaOperation_Transfer": { "required": [ "outputs", "type" ], "type": "object", "properties": { "outputs": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/Core_SolanaTransferOutput" } }, "type": { "enum": [ "Transfer" ], "type": "string" } } }, "Core_SolanaOperation_TransferToken": { "required": [ "outputs", "mintAccount", "type" ], "type": "object", "properties": { "outputs": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/Core_SolanaTransferOutput" } }, "mintAccount": { "$ref": "#/components/schemas/Core_SolanaMintAccount" }, "type": { "enum": [ "TransferToken" ], "type": "string" } } }, "Core_SolanaTickerProperties": { "oneOf": [ { "$ref": "#/components/schemas/Core_SolanaTickerProperties_Native" }, { "$ref": "#/components/schemas/Core_SolanaTickerProperties_Token" } ], "discriminator": { "propertyName": "type", "mapping": { "Native": "#/components/schemas/Core_SolanaTickerProperties_Native", "Token": "#/components/schemas/Core_SolanaTickerProperties_Token" } } }, "Core_SolanaTickerProperties_Native": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "Native" ], "type": "string" } } }, "Core_SolanaTickerProperties_Token": { "required": [ "mint", "tokenType", "type" ], "type": "object", "properties": { "mint": { "maxLength": 512, "minLength": 1, "type": "string" }, "tokenType": { "$ref": "#/components/schemas/Core_SolanaTokenType" }, "type": { "enum": [ "Token" ], "type": "string" } } }, "Core_SolanaTokenType": { "enum": [ "SPL", "SPL2022" ], "type": "string" }, "Core_SolanaTransferOutput": { "required": [ "destination", "amount" ], "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/Core_TransactionDestination" }, "amount": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." } } }, "Core_SortOrder": { "enum": [ "ASC", "DESC" ], "type": "string" }, "Core_StateReviewAuthorityValue": { "required": [ "publicKey" ], "type": "object", "properties": { "publicKey": { "$ref": "#/components/schemas/Core_AccountPublicKeyOnly" } } }, "Core_StellarAsset": { "required": [ "code", "issuer" ], "type": "object", "properties": { "code": { "maxLength": 100, "minLength": 1, "type": "string" }, "issuer": { "maxLength": 512, "minLength": 1, "type": "string" } } }, "Core_StellarFee": { "required": [ "baseFeeStroops" ], "type": "object", "properties": { "baseFeeStroops": { "type": "string", "description": "This field is a large integer and represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." } } }, "Core_StellarFeeStrategy": { "oneOf": [ { "$ref": "#/components/schemas/Core_StellarFeeStrategy_Priority" }, { "$ref": "#/components/schemas/Core_StellarFeeStrategy_SpecifiedRate" } ], "discriminator": { "propertyName": "type", "mapping": { "Priority": "#/components/schemas/Core_StellarFeeStrategy_Priority", "SpecifiedRate": "#/components/schemas/Core_StellarFeeStrategy_SpecifiedRate" } } }, "Core_StellarFeeStrategy_Priority": { "required": [ "priority", "type" ], "type": "object", "properties": { "priority": { "$ref": "#/components/schemas/Core_FeePriority" }, "type": { "enum": [ "Priority" ], "type": "string" } } }, "Core_StellarFeeStrategy_SpecifiedRate": { "required": [ "baseFee", "type" ], "type": "object", "properties": { "baseFee": { "type": "string", "description": "This field is a large integer and represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "SpecifiedRate" ], "type": "string" } } }, "Core_StellarMemo": { "oneOf": [ { "$ref": "#/components/schemas/Core_StellarMemo_Hash" }, { "$ref": "#/components/schemas/Core_StellarMemo_Id" }, { "$ref": "#/components/schemas/Core_StellarMemo_Return" }, { "$ref": "#/components/schemas/Core_StellarMemo_Text" } ], "discriminator": { "propertyName": "type", "mapping": { "Hash": "#/components/schemas/Core_StellarMemo_Hash", "Id": "#/components/schemas/Core_StellarMemo_Id", "Return": "#/components/schemas/Core_StellarMemo_Return", "Text": "#/components/schemas/Core_StellarMemo_Text" } } }, "Core_StellarMemo_Hash": { "required": [ "value", "type" ], "type": "object", "properties": { "value": { "maxLength": 64, "minLength": 64, "pattern": "^[A-Fa-f0-9]*$", "type": "string", "description": "Hex encoded stellar hash." }, "type": { "enum": [ "Hash" ], "type": "string" } } }, "Core_StellarMemo_Id": { "required": [ "value", "type" ], "type": "object", "properties": { "value": { "maximum": 18446744073709552000, "minimum": 0, "type": "string", "description": "This field is a unsigned 64bit integer that can store values in range from 0 to 18446744073709551615.It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "Id" ], "type": "string" } } }, "Core_StellarMemo_Return": { "required": [ "value", "type" ], "type": "object", "properties": { "value": { "maxLength": 64, "minLength": 64, "pattern": "^[A-Fa-f0-9]*$", "type": "string", "description": "Hex encoded stellar hash." }, "type": { "enum": [ "Return" ], "type": "string" } } }, "Core_StellarMemo_Text": { "required": [ "value", "type" ], "type": "object", "properties": { "value": { "maxLength": 28, "minLength": 1, "type": "string", "description": "String encoded using either ASCII or UTF-8, up to 28-bytes long" }, "type": { "enum": [ "Text" ], "type": "string" } } }, "Core_StellarOperation": { "oneOf": [ { "$ref": "#/components/schemas/Core_StellarOperation_AccountMerge" }, { "$ref": "#/components/schemas/Core_StellarOperation_ChangeTrust" }, { "$ref": "#/components/schemas/Core_StellarOperation_CreateAccount" }, { "$ref": "#/components/schemas/Core_StellarOperation_Payment" }, { "$ref": "#/components/schemas/Core_StellarOperation_SetOptions" } ], "discriminator": { "propertyName": "type", "mapping": { "AccountMerge": "#/components/schemas/Core_StellarOperation_AccountMerge", "ChangeTrust": "#/components/schemas/Core_StellarOperation_ChangeTrust", "CreateAccount": "#/components/schemas/Core_StellarOperation_CreateAccount", "Payment": "#/components/schemas/Core_StellarOperation_Payment", "SetOptions": "#/components/schemas/Core_StellarOperation_SetOptions" } } }, "Core_StellarOperation_AccountMerge": { "required": [ "destination", "type" ], "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/Core_TransactionDestination" }, "type": { "enum": [ "AccountMerge" ], "type": "string" } } }, "Core_StellarOperation_ChangeTrust": { "required": [ "limit", "asset", "type" ], "type": "object", "properties": { "limit": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "asset": { "$ref": "#/components/schemas/Core_StellarAsset" }, "type": { "enum": [ "ChangeTrust" ], "type": "string" } } }, "Core_StellarOperation_CreateAccount": { "required": [ "destination", "startingBalance", "type" ], "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/Core_TransactionDestination" }, "startingBalance": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "CreateAccount" ], "type": "string" } } }, "Core_StellarOperation_Payment": { "required": [ "destination", "amount", "type" ], "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/Core_TransactionDestination" }, "amount": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "asset": { "$ref": "#/components/schemas/Core_StellarAsset" }, "type": { "enum": [ "Payment" ], "type": "string" } } }, "Core_StellarOperation_SetOptions": { "required": [ "option", "type" ], "type": "object", "properties": { "option": { "$ref": "#/components/schemas/Core_StellarOption" }, "type": { "enum": [ "SetOptions" ], "type": "string" } } }, "Core_StellarOption": { "oneOf": [ { "$ref": "#/components/schemas/Core_StellarOption_OptionHomeDomain" }, { "$ref": "#/components/schemas/Core_StellarOption_OptionSetFlag" } ], "discriminator": { "propertyName": "type", "mapping": { "OptionHomeDomain": "#/components/schemas/Core_StellarOption_OptionHomeDomain", "OptionSetFlag": "#/components/schemas/Core_StellarOption_OptionSetFlag" } } }, "Core_StellarOption_OptionHomeDomain": { "required": [ "homeDomain", "type" ], "type": "object", "properties": { "homeDomain": { "type": "string" }, "type": { "enum": [ "OptionHomeDomain" ], "type": "string" } } }, "Core_StellarOption_OptionSetFlag": { "required": [ "setFlag", "type" ], "type": "object", "properties": { "setFlag": { "$ref": "#/components/schemas/Core_Stellar_OptionFlag" }, "type": { "enum": [ "OptionSetFlag" ], "type": "string" } } }, "Core_StellarTickerProperties": { "oneOf": [ { "$ref": "#/components/schemas/Core_StellarTickerProperties_Native" }, { "$ref": "#/components/schemas/Core_StellarTickerProperties_Token" } ], "discriminator": { "propertyName": "type", "mapping": { "Native": "#/components/schemas/Core_StellarTickerProperties_Native", "Token": "#/components/schemas/Core_StellarTickerProperties_Token" } } }, "Core_StellarTickerProperties_Native": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "Native" ], "type": "string" } } }, "Core_StellarTickerProperties_Token": { "required": [ "code", "issuer", "type" ], "type": "object", "properties": { "code": { "maxLength": 100, "minLength": 1, "type": "string" }, "issuer": { "maxLength": 512, "minLength": 1, "type": "string" }, "type": { "enum": [ "Token" ], "type": "string" } } }, "Core_Stellar_OptionFlag": { "enum": [ "AuthImmutable" ], "type": "string" }, "Core_StringsMap": { "type": "object", "additionalProperties": { "type": "string" } }, "Core_SubstrateBalancesMethod": { "oneOf": [ { "$ref": "#/components/schemas/Core_SubstrateBalancesMethod_TransferKeepAlive" } ], "discriminator": { "propertyName": "type", "mapping": { "TransferKeepAlive": "#/components/schemas/Core_SubstrateBalancesMethod_TransferKeepAlive" } } }, "Core_SubstrateBalancesMethod_TransferKeepAlive": { "required": [ "destination", "amount", "type" ], "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/Core_TransactionDestination" }, "amount": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "TransferKeepAlive" ], "type": "string" } } }, "Core_SubstrateChainType": { "enum": [ "RelayChain", "AssetHub" ], "type": "string" }, "Core_SubstrateFeeParameters": { "oneOf": [ { "$ref": "#/components/schemas/Core_SubstrateFeeParameters_TransactionPayment" } ], "discriminator": { "propertyName": "type", "mapping": { "TransactionPayment": "#/components/schemas/Core_SubstrateFeeParameters_TransactionPayment" } } }, "Core_SubstrateFeeParameters_TransactionPayment": { "required": [ "baseExtrinsic", "readWeight", "writeWeight", "transactionByteFee", "weightToFeePolynomial", "type" ], "type": "object", "properties": { "baseExtrinsic": { "minimum": 0, "type": "integer", "format": "int64" }, "readWeight": { "minimum": 0, "type": "integer", "format": "int64" }, "writeWeight": { "minimum": 0, "type": "integer", "format": "int64" }, "transactionByteFee": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "weightToFeePolynomial": { "type": "array", "items": { "type": "string", "description": "This field is a large decimal and represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." } }, "type": { "enum": [ "TransactionPayment" ], "type": "string" } } }, "Core_SubstrateFeeStrategy": { "oneOf": [ { "$ref": "#/components/schemas/Core_SubstrateFeeStrategy_Priority" } ], "discriminator": { "propertyName": "type", "mapping": { "Priority": "#/components/schemas/Core_SubstrateFeeStrategy_Priority" } } }, "Core_SubstrateFeeStrategy_Priority": { "required": [ "priority", "type" ], "type": "object", "properties": { "priority": { "$ref": "#/components/schemas/Core_FeePriority" }, "type": { "enum": [ "Priority" ], "type": "string" } } }, "Core_SubstrateMethodFeeParameters": { "oneOf": [ { "$ref": "#/components/schemas/Core_SubstrateMethodFeeParameters_MethodWeight" } ], "discriminator": { "propertyName": "type", "mapping": { "MethodWeight": "#/components/schemas/Core_SubstrateMethodFeeParameters_MethodWeight" } } }, "Core_SubstrateMethodFeeParameters_MethodWeight": { "required": [ "base", "reads", "writes", "type" ], "type": "object", "properties": { "base": { "minimum": 0, "type": "integer", "format": "int64" }, "reads": { "minimum": 0, "type": "integer", "format": "int32" }, "writes": { "minimum": 0, "type": "integer", "format": "int32" }, "type": { "enum": [ "MethodWeight" ], "type": "string" } } }, "Core_SubstrateMethodInfo": { "required": [ "name", "methodId", "feeParameters" ], "type": "object", "properties": { "name": { "type": "string" }, "methodId": { "type": "integer", "format": "int32" }, "feeParameters": { "$ref": "#/components/schemas/Core_SubstrateMethodFeeParameters" } } }, "Core_SubstratePallet": { "oneOf": [ { "$ref": "#/components/schemas/Core_SubstratePallet_Balances" }, { "$ref": "#/components/schemas/Core_SubstratePallet_Staking" } ], "discriminator": { "propertyName": "type", "mapping": { "Balances": "#/components/schemas/Core_SubstratePallet_Balances", "Staking": "#/components/schemas/Core_SubstratePallet_Staking" } } }, "Core_SubstratePalletInfo": { "required": [ "name", "moduleId", "methods" ], "type": "object", "properties": { "name": { "type": "string" }, "moduleId": { "type": "integer", "format": "int32" }, "methods": { "type": "array", "items": { "$ref": "#/components/schemas/Core_SubstrateMethodInfo" } } } }, "Core_SubstratePallet_Balances": { "required": [ "method", "type" ], "type": "object", "properties": { "method": { "$ref": "#/components/schemas/Core_SubstrateBalancesMethod" }, "type": { "enum": [ "Balances" ], "type": "string" } } }, "Core_SubstratePallet_Staking": { "required": [ "method", "type" ], "type": "object", "properties": { "method": { "$ref": "#/components/schemas/Core_SubstrateStakingMethod" }, "type": { "enum": [ "Staking" ], "type": "string" } } }, "Core_SubstrateRuntimeInfo": { "required": [ "transactionVersion", "feeParameters", "pallets" ], "type": "object", "properties": { "transactionVersion": { "type": "integer", "format": "int32" }, "feeParameters": { "$ref": "#/components/schemas/Core_SubstrateFeeParameters" }, "pallets": { "type": "array", "items": { "$ref": "#/components/schemas/Core_SubstratePalletInfo" } }, "chainType": { "$ref": "#/components/schemas/Core_SubstrateChainType" } } }, "Core_SubstrateStakingMethod": { "oneOf": [ { "$ref": "#/components/schemas/Core_SubstrateStakingMethod_Bond" }, { "$ref": "#/components/schemas/Core_SubstrateStakingMethod_BondExtra" }, { "$ref": "#/components/schemas/Core_SubstrateStakingMethod_Chill" }, { "$ref": "#/components/schemas/Core_SubstrateStakingMethod_Nominate" }, { "$ref": "#/components/schemas/Core_SubstrateStakingMethod_Rebond" }, { "$ref": "#/components/schemas/Core_SubstrateStakingMethod_SetController" }, { "$ref": "#/components/schemas/Core_SubstrateStakingMethod_SetPayee" }, { "$ref": "#/components/schemas/Core_SubstrateStakingMethod_Unbond" }, { "$ref": "#/components/schemas/Core_SubstrateStakingMethod_WithdrawUnbonded" } ], "discriminator": { "propertyName": "type", "mapping": { "Bond": "#/components/schemas/Core_SubstrateStakingMethod_Bond", "BondExtra": "#/components/schemas/Core_SubstrateStakingMethod_BondExtra", "Chill": "#/components/schemas/Core_SubstrateStakingMethod_Chill", "Nominate": "#/components/schemas/Core_SubstrateStakingMethod_Nominate", "Rebond": "#/components/schemas/Core_SubstrateStakingMethod_Rebond", "SetController": "#/components/schemas/Core_SubstrateStakingMethod_SetController", "SetPayee": "#/components/schemas/Core_SubstrateStakingMethod_SetPayee", "Unbond": "#/components/schemas/Core_SubstrateStakingMethod_Unbond", "WithdrawUnbonded": "#/components/schemas/Core_SubstrateStakingMethod_WithdrawUnbonded" } } }, "Core_SubstrateStakingMethod_Bond": { "required": [ "value", "payee", "type" ], "type": "object", "properties": { "controller": { "$ref": "#/components/schemas/Core_TransactionDestination" }, "value": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "payee": { "$ref": "#/components/schemas/Core_SubstrateStakingPayee" }, "type": { "enum": [ "Bond" ], "type": "string" } } }, "Core_SubstrateStakingMethod_BondExtra": { "required": [ "maxAdditional", "type" ], "type": "object", "properties": { "maxAdditional": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "BondExtra" ], "type": "string" } } }, "Core_SubstrateStakingMethod_Chill": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "Chill" ], "type": "string" } } }, "Core_SubstrateStakingMethod_Nominate": { "required": [ "targets", "type" ], "type": "object", "properties": { "targets": { "type": "array", "items": { "$ref": "#/components/schemas/Core_TransactionDestination" } }, "type": { "enum": [ "Nominate" ], "type": "string" } } }, "Core_SubstrateStakingMethod_Rebond": { "required": [ "value", "type" ], "type": "object", "properties": { "value": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "Rebond" ], "type": "string" } } }, "Core_SubstrateStakingMethod_SetController": { "required": [ "type" ], "type": "object", "properties": { "controller": { "$ref": "#/components/schemas/Core_TransactionDestination" }, "type": { "enum": [ "SetController" ], "type": "string" } } }, "Core_SubstrateStakingMethod_SetPayee": { "required": [ "payee", "type" ], "type": "object", "properties": { "payee": { "$ref": "#/components/schemas/Core_SubstrateStakingPayee" }, "type": { "enum": [ "SetPayee" ], "type": "string" } } }, "Core_SubstrateStakingMethod_Unbond": { "required": [ "value", "type" ], "type": "object", "properties": { "value": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "Unbond" ], "type": "string" } } }, "Core_SubstrateStakingMethod_WithdrawUnbonded": { "required": [ "numSlashingSpans", "type" ], "type": "object", "properties": { "numSlashingSpans": { "type": "integer", "format": "int32" }, "type": { "enum": [ "WithdrawUnbonded" ], "type": "string" } } }, "Core_SubstrateStakingPayee": { "oneOf": [ { "$ref": "#/components/schemas/Core_SubstrateStakingPayee_Account" }, { "$ref": "#/components/schemas/Core_SubstrateStakingPayee_Controller" }, { "$ref": "#/components/schemas/Core_SubstrateStakingPayee_Staked" }, { "$ref": "#/components/schemas/Core_SubstrateStakingPayee_Stash" } ], "discriminator": { "propertyName": "type", "mapping": { "Account": "#/components/schemas/Core_SubstrateStakingPayee_Account", "Controller": "#/components/schemas/Core_SubstrateStakingPayee_Controller", "Staked": "#/components/schemas/Core_SubstrateStakingPayee_Staked", "Stash": "#/components/schemas/Core_SubstrateStakingPayee_Stash" } } }, "Core_SubstrateStakingPayee_Account": { "required": [ "destination", "type" ], "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/Core_TransactionDestination" }, "type": { "enum": [ "Account" ], "type": "string" } } }, "Core_SubstrateStakingPayee_Controller": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "Controller" ], "type": "string" } } }, "Core_SubstrateStakingPayee_Staked": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "Staked" ], "type": "string" } } }, "Core_SubstrateStakingPayee_Stash": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "Stash" ], "type": "string" } } }, "Core_SubstrateTickerProperties": { "oneOf": [ { "$ref": "#/components/schemas/Core_SubstrateTickerProperties_Native" } ], "discriminator": { "propertyName": "type", "mapping": { "Native": "#/components/schemas/Core_SubstrateTickerProperties_Native" } } }, "Core_SubstrateTickerProperties_Native": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "Native" ], "type": "string" } } }, "Core_SystemProperty": { "oneOf": [ { "$ref": "#/components/schemas/Core_SystemProperty_NotaryApiKeySystemProperty" }, { "$ref": "#/components/schemas/Core_SystemProperty_NotaryCollectionsKeySystemProperty" }, { "$ref": "#/components/schemas/Core_SystemProperty_NotaryCommunicationKeySystemProperty" }, { "$ref": "#/components/schemas/Core_SystemProperty_StateReviewAuthoritySystemProperty" } ] }, "Core_SystemPropertyId": { "enum": [ "NOTARY_COMMUNICATION_KEY", "NOTARY_COLLECTIONS_KEY", "NOTARY_API_KEY", "STATE_REVIEW_AUTHORITY" ], "type": "string" }, "Core_SystemPropertySet": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/Core_SystemPropertyId" }, "type": { "enum": [ "SystemPropertySet" ], "type": "string" } } }, "Core_SystemProperty_NotaryApiKeySystemProperty": { "required": [ "id", "value", "metadata" ], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/Core_SystemPropertyId" }, "value": { "$ref": "#/components/schemas/Core_NotaryApiKeyValue" }, "metadata": { "$ref": "#/components/schemas/Core_EntityMetadata" } } }, "Core_SystemProperty_NotaryCollectionsKeySystemProperty": { "required": [ "id", "value", "metadata" ], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/Core_SystemPropertyId" }, "value": { "$ref": "#/components/schemas/Core_NotaryCollectionsKeyValue" }, "metadata": { "$ref": "#/components/schemas/Core_EntityMetadata" } } }, "Core_SystemProperty_NotaryCommunicationKeySystemProperty": { "required": [ "id", "value", "metadata" ], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/Core_SystemPropertyId" }, "value": { "$ref": "#/components/schemas/Core_NotaryCommunicationKeyValue" }, "metadata": { "$ref": "#/components/schemas/Core_EntityMetadata" } } }, "Core_SystemProperty_StateReviewAuthoritySystemProperty": { "required": [ "id", "value", "metadata" ], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/Core_SystemPropertyId" }, "value": { "$ref": "#/components/schemas/Core_StateReviewAuthorityValue" }, "metadata": { "$ref": "#/components/schemas/Core_EntityMetadata" } } }, "Core_TezosFeeStrategy": { "oneOf": [ { "$ref": "#/components/schemas/Core_TezosFeeStrategy_Priority" } ], "discriminator": { "propertyName": "type", "mapping": { "Priority": "#/components/schemas/Core_TezosFeeStrategy_Priority" } } }, "Core_TezosFeeStrategy_Priority": { "required": [ "priority", "type" ], "type": "object", "properties": { "priority": { "$ref": "#/components/schemas/Core_FeePriority" }, "type": { "enum": [ "Priority" ], "type": "string" } } }, "Core_TezosOperation": { "oneOf": [ { "$ref": "#/components/schemas/Core_TezosOperation_Delegation" }, { "$ref": "#/components/schemas/Core_TezosOperation_Reveal" }, { "$ref": "#/components/schemas/Core_TezosOperation_Transaction" }, { "$ref": "#/components/schemas/Core_TezosOperation_Undelegation" } ], "discriminator": { "propertyName": "type", "mapping": { "Delegation": "#/components/schemas/Core_TezosOperation_Delegation", "Reveal": "#/components/schemas/Core_TezosOperation_Reveal", "Transaction": "#/components/schemas/Core_TezosOperation_Transaction", "Undelegation": "#/components/schemas/Core_TezosOperation_Undelegation" } } }, "Core_TezosOperation_Delegation": { "required": [ "destination", "type" ], "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/Core_TransactionDestination" }, "type": { "enum": [ "Delegation" ], "type": "string" } } }, "Core_TezosOperation_Reveal": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "Reveal" ], "type": "string" } } }, "Core_TezosOperation_Transaction": { "required": [ "destination", "amount", "type" ], "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/Core_TransactionDestination" }, "amount": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "contractParameters": { "$ref": "#/components/schemas/Core_ContractParameters" }, "type": { "enum": [ "Transaction" ], "type": "string" } } }, "Core_TezosOperation_Undelegation": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "Undelegation" ], "type": "string" } } }, "Core_TezosTickerProperties": { "oneOf": [ { "$ref": "#/components/schemas/Core_TezosTickerProperties_Native" } ], "discriminator": { "propertyName": "type", "mapping": { "Native": "#/components/schemas/Core_TezosTickerProperties_Native" } } }, "Core_TezosTickerProperties_Native": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "Native" ], "type": "string" } } }, "Core_TickerCreated": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "enum": [ "TickerCreated" ], "type": "string" } } }, "Core_TickerKind": { "enum": [ "Native", "Contract", "Token" ], "type": "string" }, "Core_TickerLedgerDetails": { "oneOf": [ { "$ref": "#/components/schemas/Core_TickerLedgerDetails_Algorand" }, { "$ref": "#/components/schemas/Core_TickerLedgerDetails_Bitcoin" }, { "$ref": "#/components/schemas/Core_TickerLedgerDetails_Cardano" }, { "$ref": "#/components/schemas/Core_TickerLedgerDetails_Ethereum" }, { "$ref": "#/components/schemas/Core_TickerLedgerDetails_Hedera" }, { "$ref": "#/components/schemas/Core_TickerLedgerDetails_Solana" }, { "$ref": "#/components/schemas/Core_TickerLedgerDetails_Stellar" }, { "$ref": "#/components/schemas/Core_TickerLedgerDetails_Substrate" }, { "$ref": "#/components/schemas/Core_TickerLedgerDetails_Tezos" }, { "$ref": "#/components/schemas/Core_TickerLedgerDetails_Tron" }, { "$ref": "#/components/schemas/Core_TickerLedgerDetails_XRPL" } ], "discriminator": { "propertyName": "type", "mapping": { "Algorand": "#/components/schemas/Core_TickerLedgerDetails_Algorand", "Bitcoin": "#/components/schemas/Core_TickerLedgerDetails_Bitcoin", "Cardano": "#/components/schemas/Core_TickerLedgerDetails_Cardano", "Ethereum": "#/components/schemas/Core_TickerLedgerDetails_Ethereum", "Hedera": "#/components/schemas/Core_TickerLedgerDetails_Hedera", "Solana": "#/components/schemas/Core_TickerLedgerDetails_Solana", "Stellar": "#/components/schemas/Core_TickerLedgerDetails_Stellar", "Substrate": "#/components/schemas/Core_TickerLedgerDetails_Substrate", "Tezos": "#/components/schemas/Core_TickerLedgerDetails_Tezos", "Tron": "#/components/schemas/Core_TickerLedgerDetails_Tron", "XRPL": "#/components/schemas/Core_TickerLedgerDetails_XRPL" } } }, "Core_TickerLedgerDetails_Algorand": { "required": [ "properties", "type" ], "type": "object", "properties": { "properties": { "$ref": "#/components/schemas/Core_AlgorandTickerProperties" }, "type": { "enum": [ "Algorand" ], "type": "string" } } }, "Core_TickerLedgerDetails_Bitcoin": { "required": [ "properties", "type" ], "type": "object", "properties": { "properties": { "$ref": "#/components/schemas/Core_BitcoinTickerProperties" }, "type": { "enum": [ "Bitcoin" ], "type": "string" } } }, "Core_TickerLedgerDetails_Cardano": { "required": [ "properties", "type" ], "type": "object", "properties": { "properties": { "$ref": "#/components/schemas/Core_CardanoTickerProperties" }, "type": { "enum": [ "Cardano" ], "type": "string" } } }, "Core_TickerLedgerDetails_Ethereum": { "required": [ "properties", "type" ], "type": "object", "properties": { "properties": { "$ref": "#/components/schemas/Core_EthereumTickerProperties" }, "type": { "enum": [ "Ethereum" ], "type": "string" } } }, "Core_TickerLedgerDetails_Hedera": { "required": [ "properties", "type" ], "type": "object", "properties": { "properties": { "$ref": "#/components/schemas/Core_HederaTickerProperties" }, "type": { "enum": [ "Hedera" ], "type": "string" } } }, "Core_TickerLedgerDetails_Solana": { "required": [ "properties", "type" ], "type": "object", "properties": { "properties": { "$ref": "#/components/schemas/Core_SolanaTickerProperties" }, "type": { "enum": [ "Solana" ], "type": "string" } } }, "Core_TickerLedgerDetails_Stellar": { "required": [ "properties", "type" ], "type": "object", "properties": { "properties": { "$ref": "#/components/schemas/Core_StellarTickerProperties" }, "type": { "enum": [ "Stellar" ], "type": "string" } } }, "Core_TickerLedgerDetails_Substrate": { "required": [ "properties", "type" ], "type": "object", "properties": { "properties": { "$ref": "#/components/schemas/Core_SubstrateTickerProperties" }, "type": { "enum": [ "Substrate" ], "type": "string" } } }, "Core_TickerLedgerDetails_Tezos": { "required": [ "properties", "type" ], "type": "object", "properties": { "properties": { "$ref": "#/components/schemas/Core_TezosTickerProperties" }, "type": { "enum": [ "Tezos" ], "type": "string" } } }, "Core_TickerLedgerDetails_Tron": { "required": [ "properties", "type" ], "type": "object", "properties": { "properties": { "$ref": "#/components/schemas/Core_TronTickerProperties" }, "type": { "enum": [ "Tron" ], "type": "string" } } }, "Core_TickerLedgerDetails_XRPL": { "required": [ "properties", "type" ], "type": "object", "properties": { "properties": { "$ref": "#/components/schemas/Core_XrplTickerProperties" }, "type": { "enum": [ "XRPL" ], "type": "string" } } }, "Core_TickerToValidate": { "required": [ "id", "ledgerId", "kind", "name", "ledgerDetails", "lock", "customProperties" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "ledgerId": { "maxLength": 100, "minLength": 1, "type": "string" }, "kind": { "$ref": "#/components/schemas/Core_ValidatedTickerKind" }, "name": { "maxLength": 100, "minLength": 1, "type": "string" }, "decimals": { "type": "integer", "format": "int32" }, "symbol": { "maxLength": 100, "minLength": 1, "type": "string" }, "ledgerDetails": { "$ref": "#/components/schemas/Core_TickerLedgerDetails" }, "lock": { "$ref": "#/components/schemas/Core_IntentLockStatus" }, "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" } } }, "Core_TickerUpdated": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "enum": [ "TickerUpdated" ], "type": "string" } } }, "Core_TickerValidationStatusFilter": { "enum": [ "Validated", "NonValidated" ], "type": "string" }, "Core_TickersCollection": { "required": [ "items", "count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core_ApiTicker" } }, "count": { "type": "integer", "format": "int32" }, "currentStartingAfter": { "type": "string" }, "nextStartingAfter": { "type": "string" } } }, "Core_TokenDestination": { "oneOf": [ { "$ref": "#/components/schemas/Core_TokenDestination_Ticker" }, { "$ref": "#/components/schemas/Core_TokenDestination_TokenId" } ], "discriminator": { "propertyName": "type", "mapping": { "Ticker": "#/components/schemas/Core_TokenDestination_Ticker", "TokenId": "#/components/schemas/Core_TokenDestination_TokenId" } } }, "Core_TokenDestination_Ticker": { "required": [ "tickerId", "type" ], "type": "object", "properties": { "tickerId": { "type": "string", "format": "uuid" }, "type": { "enum": [ "Ticker" ], "type": "string" } } }, "Core_TokenDestination_TokenId": { "required": [ "tokenId", "type" ], "type": "object", "properties": { "tokenId": { "maxLength": 20, "minLength": 5, "type": "string", "description": "String consisting Hedera Token Id" }, "type": { "enum": [ "TokenId" ], "type": "string" } } }, "Core_TokenFee": { "required": [ "fee", "tickerId", "paidByRecipient" ], "type": "object", "properties": { "fee": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "tickerId": { "type": "string", "format": "uuid" }, "paidByRecipient": { "type": "boolean" } } }, "Core_TokenOutput": { "oneOf": [ { "$ref": "#/components/schemas/Core_TokenOutput_HederaFungibleTokenOutput" }, { "$ref": "#/components/schemas/Core_TokenOutput_HederaNonFungibleTokenOutput" } ], "discriminator": { "propertyName": "type", "mapping": { "HederaFungibleTokenOutput": "#/components/schemas/Core_TokenOutput_HederaFungibleTokenOutput", "HederaNonFungibleTokenOutput": "#/components/schemas/Core_TokenOutput_HederaNonFungibleTokenOutput" } } }, "Core_TokenOutput_HederaFungibleTokenOutput": { "required": [ "token", "destination", "amount", "type" ], "type": "object", "properties": { "token": { "$ref": "#/components/schemas/Core_TokenDestination" }, "destination": { "$ref": "#/components/schemas/Core_TransactionDestination" }, "amount": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "HederaFungibleTokenOutput" ], "type": "string" } } }, "Core_TokenOutput_HederaNonFungibleTokenOutput": { "required": [ "token", "destination", "type" ], "type": "object", "properties": { "token": { "$ref": "#/components/schemas/Core_NonFungibleTokenDestination" }, "destination": { "$ref": "#/components/schemas/Core_TransactionDestination" }, "type": { "enum": [ "HederaNonFungibleTokenOutput" ], "type": "string" } } }, "Core_TransactionCancellationDetails": { "oneOf": [ { "$ref": "#/components/schemas/Core_TransactionCancellationDetails_OffLedger" }, { "$ref": "#/components/schemas/Core_TransactionCancellationDetails_OnLedger" } ], "discriminator": { "propertyName": "type", "mapping": { "OffLedger": "#/components/schemas/Core_TransactionCancellationDetails_OffLedger", "OnLedger": "#/components/schemas/Core_TransactionCancellationDetails_OnLedger" } } }, "Core_TransactionCancellationDetails_OffLedger": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "OffLedger" ], "type": "string" } } }, "Core_TransactionCancellationDetails_OnLedger": { "required": [ "fee", "type" ], "type": "object", "properties": { "fee": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "OnLedger" ], "type": "string" } } }, "Core_TransactionCreated": { "required": [ "id", "senderReferences", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "senderReferences": { "type": "array", "items": { "$ref": "#/components/schemas/Core_AccountReference" } }, "type": { "enum": [ "TransactionCreated" ], "type": "string" } } }, "Core_TransactionDestination": { "oneOf": [ { "$ref": "#/components/schemas/Core_TransactionDestination_Account" }, { "$ref": "#/components/schemas/Core_TransactionDestination_Address" }, { "$ref": "#/components/schemas/Core_TransactionDestination_Endpoint" } ], "discriminator": { "propertyName": "type", "mapping": { "Account": "#/components/schemas/Core_TransactionDestination_Account", "Address": "#/components/schemas/Core_TransactionDestination_Address", "Endpoint": "#/components/schemas/Core_TransactionDestination_Endpoint" } } }, "Core_TransactionDestination_Account": { "required": [ "accountId", "type" ], "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid" }, "type": { "enum": [ "Account" ], "type": "string" } } }, "Core_TransactionDestination_Address": { "required": [ "address", "type" ], "type": "object", "properties": { "address": { "maxLength": 512, "minLength": 1, "type": "string" }, "type": { "enum": [ "Address" ], "type": "string" } } }, "Core_TransactionDestination_Endpoint": { "required": [ "endpointId", "type" ], "type": "object", "properties": { "endpointId": { "type": "string", "format": "uuid" }, "type": { "enum": [ "Endpoint" ], "type": "string" } } }, "Core_TransactionDetected": { "required": [ "id", "accountReferences", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "accountReferences": { "type": "array", "items": { "$ref": "#/components/schemas/Core_AccountReference" } }, "type": { "enum": [ "TransactionDetected" ], "type": "string" } } }, "Core_TransactionDryRun": { "required": [ "result", "estimate" ], "type": "object", "properties": { "result": { "$ref": "#/components/schemas/Core_TransactionDryRunResult" }, "estimate": { "$ref": "#/components/schemas/Core_TransactionEstimate" } } }, "Core_TransactionDryRunResult": { "oneOf": [ { "$ref": "#/components/schemas/Core_TransactionDryRunResult_Failure" }, { "$ref": "#/components/schemas/Core_TransactionDryRunResult_Success" } ], "discriminator": { "propertyName": "type", "mapping": { "Failure": "#/components/schemas/Core_TransactionDryRunResult_Failure", "Success": "#/components/schemas/Core_TransactionDryRunResult_Success" } } }, "Core_TransactionDryRunResult_Failure": { "required": [ "hint", "reason", "type" ], "type": "object", "properties": { "hint": { "$ref": "#/components/schemas/Core_ApiDryRunTransactionProcessingHint" }, "reason": { "type": "string" }, "type": { "enum": [ "Failure" ], "type": "string" } } }, "Core_TransactionDryRunResult_Success": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "Success" ], "type": "string" } } }, "Core_TransactionEstimate": { "oneOf": [ { "$ref": "#/components/schemas/Core_TransactionEstimate_Algorand" }, { "$ref": "#/components/schemas/Core_TransactionEstimate_Bitcoin" }, { "$ref": "#/components/schemas/Core_TransactionEstimate_Cardano" }, { "$ref": "#/components/schemas/Core_TransactionEstimate_Ethereum" }, { "$ref": "#/components/schemas/Core_TransactionEstimate_Failure" }, { "$ref": "#/components/schemas/Core_TransactionEstimate_Hedera" }, { "$ref": "#/components/schemas/Core_TransactionEstimate_Solana" }, { "$ref": "#/components/schemas/Core_TransactionEstimate_Stellar" }, { "$ref": "#/components/schemas/Core_TransactionEstimate_Substrate" }, { "$ref": "#/components/schemas/Core_TransactionEstimate_Tezos" }, { "$ref": "#/components/schemas/Core_TransactionEstimate_Tron" }, { "$ref": "#/components/schemas/Core_TransactionEstimate_XRPL" } ], "discriminator": { "propertyName": "type", "mapping": { "Algorand": "#/components/schemas/Core_TransactionEstimate_Algorand", "Bitcoin": "#/components/schemas/Core_TransactionEstimate_Bitcoin", "Cardano": "#/components/schemas/Core_TransactionEstimate_Cardano", "Ethereum": "#/components/schemas/Core_TransactionEstimate_Ethereum", "Failure": "#/components/schemas/Core_TransactionEstimate_Failure", "Hedera": "#/components/schemas/Core_TransactionEstimate_Hedera", "Solana": "#/components/schemas/Core_TransactionEstimate_Solana", "Stellar": "#/components/schemas/Core_TransactionEstimate_Stellar", "Substrate": "#/components/schemas/Core_TransactionEstimate_Substrate", "Tezos": "#/components/schemas/Core_TransactionEstimate_Tezos", "Tron": "#/components/schemas/Core_TransactionEstimate_Tron", "XRPL": "#/components/schemas/Core_TransactionEstimate_XRPL" } } }, "Core_TransactionEstimate_Algorand": { "required": [ "fee", "type" ], "type": "object", "properties": { "fee": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "Algorand" ], "type": "string" } } }, "Core_TransactionEstimate_Bitcoin": { "required": [ "vbytes", "fee", "feeEstimationMargin", "type" ], "type": "object", "properties": { "vbytes": { "type": "string", "description": "This field is a large integer and represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "fee": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "feeEstimationMargin": { "type": "string", "description": "This field is a large integer and represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "Bitcoin" ], "type": "string" } } }, "Core_TransactionEstimate_Cardano": { "required": [ "fee", "type" ], "type": "object", "properties": { "fee": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "Cardano" ], "type": "string" } } }, "Core_TransactionEstimate_Ethereum": { "required": [ "gas", "defaultedToBlockGasLimit", "type" ], "type": "object", "properties": { "gas": { "type": "string", "description": "This field is a large integer and represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "defaultedToBlockGasLimit": { "type": "boolean" }, "nodeErrorMessage": { "type": "string" }, "type": { "enum": [ "Ethereum" ], "type": "string" } } }, "Core_TransactionEstimate_Failure": { "required": [ "hint", "reason", "type" ], "type": "object", "properties": { "hint": { "$ref": "#/components/schemas/Core_ApiDryRunTransactionProcessingHint" }, "reason": { "type": "string" }, "type": { "enum": [ "Failure" ], "type": "string" } } }, "Core_TransactionEstimate_Hedera": { "required": [ "fee", "type" ], "type": "object", "properties": { "fee": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "tokenFees": { "type": "array", "items": { "$ref": "#/components/schemas/Core_TokenFee" } }, "type": { "enum": [ "Hedera" ], "type": "string" } } }, "Core_TransactionEstimate_Solana": { "required": [ "fee", "type" ], "type": "object", "properties": { "fee": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "Solana" ], "type": "string" } } }, "Core_TransactionEstimate_Stellar": { "required": [ "fee", "type" ], "type": "object", "properties": { "fee": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "Stellar" ], "type": "string" } } }, "Core_TransactionEstimate_Substrate": { "required": [ "fee", "type" ], "type": "object", "properties": { "fee": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "Substrate" ], "type": "string" } } }, "Core_TransactionEstimate_Tezos": { "required": [ "minimalFee", "fee", "type" ], "type": "object", "properties": { "minimalFee": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "fee": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "Tezos" ], "type": "string" } } }, "Core_TransactionEstimate_Tron": { "required": [ "fee", "type" ], "type": "object", "properties": { "fee": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "Tron" ], "type": "string" } } }, "Core_TransactionEstimate_XRPL": { "required": [ "minimumCostInDrops", "fee", "type" ], "type": "object", "properties": { "minimumCostInDrops": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "fee": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "XRPL" ], "type": "string" } } }, "Core_TransactionOrder": { "required": [ "id", "domainId", "accountId", "parameters", "metadata" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "domainId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "ledgerId": { "maxLength": 100, "minLength": 1, "type": "string" }, "parameters": { "$ref": "#/components/schemas/Core_TransactionOrderParameters" }, "metadata": { "$ref": "#/components/schemas/Core_EntityMetadata" } } }, "Core_TransactionOrderParameterType": { "enum": [ "Algorand", "Bitcoin", "BitcoinRedirect", "Cardano", "Ethereum", "Hedera", "Solana", "Substrate", "Tezos", "XRPL", "Stellar", "Tron" ], "type": "string" }, "Core_TransactionOrderParameters": { "oneOf": [ { "$ref": "#/components/schemas/Core_TransactionOrderParameters_Algorand" }, { "$ref": "#/components/schemas/Core_TransactionOrderParameters_Bitcoin" }, { "$ref": "#/components/schemas/Core_TransactionOrderParameters_BitcoinRedirect" }, { "$ref": "#/components/schemas/Core_TransactionOrderParameters_Cardano" }, { "$ref": "#/components/schemas/Core_TransactionOrderParameters_Ethereum" }, { "$ref": "#/components/schemas/Core_TransactionOrderParameters_Hedera" }, { "$ref": "#/components/schemas/Core_TransactionOrderParameters_Solana" }, { "$ref": "#/components/schemas/Core_TransactionOrderParameters_Stellar" }, { "$ref": "#/components/schemas/Core_TransactionOrderParameters_Substrate" }, { "$ref": "#/components/schemas/Core_TransactionOrderParameters_Tezos" }, { "$ref": "#/components/schemas/Core_TransactionOrderParameters_Tron" }, { "$ref": "#/components/schemas/Core_TransactionOrderParameters_XRPL" } ], "discriminator": { "propertyName": "type", "mapping": { "Algorand": "#/components/schemas/Core_TransactionOrderParameters_Algorand", "Bitcoin": "#/components/schemas/Core_TransactionOrderParameters_Bitcoin", "BitcoinRedirect": "#/components/schemas/Core_TransactionOrderParameters_BitcoinRedirect", "Cardano": "#/components/schemas/Core_TransactionOrderParameters_Cardano", "Ethereum": "#/components/schemas/Core_TransactionOrderParameters_Ethereum", "Hedera": "#/components/schemas/Core_TransactionOrderParameters_Hedera", "Solana": "#/components/schemas/Core_TransactionOrderParameters_Solana", "Stellar": "#/components/schemas/Core_TransactionOrderParameters_Stellar", "Substrate": "#/components/schemas/Core_TransactionOrderParameters_Substrate", "Tezos": "#/components/schemas/Core_TransactionOrderParameters_Tezos", "Tron": "#/components/schemas/Core_TransactionOrderParameters_Tron", "XRPL": "#/components/schemas/Core_TransactionOrderParameters_XRPL" } } }, "Core_TransactionOrderParameters_Algorand": { "required": [ "operation", "feeStrategy", "type" ], "type": "object", "properties": { "operation": { "$ref": "#/components/schemas/Core_AlgorandOperation" }, "note": { "maxLength": 1024, "minLength": 0, "type": "string" }, "feeStrategy": { "$ref": "#/components/schemas/Core_AlgorandFeeStrategy" }, "maximumFee": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "Algorand" ], "type": "string" } } }, "Core_TransactionOrderParameters_Bitcoin": { "required": [ "outputs", "feeStrategy", "type" ], "type": "object", "properties": { "outputs": { "type": "array", "items": { "$ref": "#/components/schemas/Core_BitcoinOutputParameters" } }, "feeStrategy": { "$ref": "#/components/schemas/Core_BitcoinFeeStrategy" }, "maximumFee": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "resourceStrategy": { "$ref": "#/components/schemas/Core_BitcoinResourceStrategy" }, "addressForChange": { "$ref": "#/components/schemas/Core_AddressForChange" }, "type": { "enum": [ "Bitcoin" ], "type": "string" } } }, "Core_TransactionOrderParameters_BitcoinRedirect": { "required": [ "transferIds", "outputs", "feeStrategy", "type" ], "type": "object", "properties": { "transferIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "outputs": { "type": "array", "items": { "$ref": "#/components/schemas/Core_BitcoinOutputParameters" } }, "feeStrategy": { "$ref": "#/components/schemas/Core_BitcoinFeeStrategy" }, "maximumFee": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "BitcoinRedirect" ], "type": "string" } } }, "Core_TransactionOrderParameters_Cardano": { "required": [ "operation", "feeStrategy", "type" ], "type": "object", "properties": { "operation": { "$ref": "#/components/schemas/Core_CardanoOperation" }, "feeStrategy": { "$ref": "#/components/schemas/Core_CardanoFeeStrategy" }, "maximumFee": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "Cardano" ], "type": "string" } } }, "Core_TransactionOrderParameters_Ethereum": { "required": [ "amount", "feeStrategy", "type" ], "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/Core_TransactionDestination" }, "amount": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "feeStrategy": { "$ref": "#/components/schemas/Core_EthereumFeeStrategy" }, "maximumFee": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "data": { "pattern": "^0[xX]([a-fA-F0-9]*)$", "type": "string" }, "resourceStrategy": { "$ref": "#/components/schemas/Core_EthereumResourceStrategy" }, "type": { "enum": [ "Ethereum" ], "type": "string" } } }, "Core_TransactionOrderParameters_Hedera": { "required": [ "operation", "feeStrategy", "type" ], "type": "object", "properties": { "operation": { "$ref": "#/components/schemas/Core_HederaOperation" }, "memo": { "maxLength": 100, "minLength": 1, "type": "string", "description": "String encoded using UTF-8, up to 100-bytes long" }, "feeStrategy": { "$ref": "#/components/schemas/Core_HederaFeeStrategy" }, "maximumFee": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "Hedera" ], "type": "string" } } }, "Core_TransactionOrderParameters_Solana": { "required": [ "operation", "memos", "feeStrategy", "type" ], "type": "object", "properties": { "operation": { "$ref": "#/components/schemas/Core_SolanaOperation" }, "memos": { "type": "array", "items": { "maxLength": 566, "minLength": 0, "type": "string" } }, "feeStrategy": { "$ref": "#/components/schemas/Core_SolanaFeeStrategy" }, "maximumFee": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "nonceAccount": { "$ref": "#/components/schemas/Core_TransactionDestination" }, "type": { "enum": [ "Solana" ], "type": "string" } } }, "Core_TransactionOrderParameters_Stellar": { "required": [ "operation", "feeStrategy", "type" ], "type": "object", "properties": { "operation": { "$ref": "#/components/schemas/Core_StellarOperation" }, "memo": { "$ref": "#/components/schemas/Core_StellarMemo" }, "feeStrategy": { "$ref": "#/components/schemas/Core_StellarFeeStrategy" }, "maximumFee": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "Stellar" ], "type": "string" } } }, "Core_TransactionOrderParameters_Substrate": { "required": [ "pallet", "feeStrategy", "type" ], "type": "object", "properties": { "pallet": { "$ref": "#/components/schemas/Core_SubstratePallet" }, "feeStrategy": { "$ref": "#/components/schemas/Core_SubstrateFeeStrategy" }, "maximumFee": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "Substrate" ], "type": "string" } } }, "Core_TransactionOrderParameters_Tezos": { "required": [ "operation", "feeStrategy", "type" ], "type": "object", "properties": { "operation": { "$ref": "#/components/schemas/Core_TezosOperation" }, "feeStrategy": { "$ref": "#/components/schemas/Core_TezosFeeStrategy" }, "maximumFee": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "Tezos" ], "type": "string" } } }, "Core_TransactionOrderParameters_Tron": { "required": [ "feeStrategy", "operation", "type" ], "type": "object", "properties": { "feeStrategy": { "$ref": "#/components/schemas/Core_TronFeeStrategy" }, "maximumFee": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "operation": { "$ref": "#/components/schemas/Core_TronOperation" }, "type": { "enum": [ "Tron" ], "type": "string" } } }, "Core_TransactionOrderParameters_XRPL": { "required": [ "feeStrategy", "memos", "type" ], "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/Core_Xrpl_DeprecatedTransactionDestination" }, "amount": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision.", "deprecated": true }, "feeStrategy": { "$ref": "#/components/schemas/Core_XrplFeeStrategy" }, "maximumFee": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "sourceTag": { "maximum": 4294967295, "minimum": 0, "type": "integer", "format": "int64" }, "destinationTag": { "maximum": 4294967295, "minimum": 0, "type": "integer", "format": "int64", "deprecated": true }, "memos": { "type": "array", "items": { "$ref": "#/components/schemas/Core_XrplMemo" } }, "operation": { "$ref": "#/components/schemas/Core_XrplOperation" }, "type": { "enum": [ "XRPL" ], "type": "string" } } }, "Core_TransactionOrderReference": { "required": [ "id", "domainId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "domainId": { "type": "string", "format": "uuid" } } }, "Core_TransactionProcessingStatus": { "enum": [ "Pending", "Preparing", "Reserved", "Prepared", "Broadcasting", "Completed", "Interrupted", "Failed" ], "type": "string" }, "Core_TransactionRelatedAccountReference": { "required": [ "id", "domainId", "sender" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "domainId": { "type": "string", "format": "uuid" }, "sender": { "type": "boolean" } } }, "Core_TransactionUpdated": { "required": [ "id", "accountReferences", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "accountReferences": { "type": "array", "items": { "$ref": "#/components/schemas/Core_AccountReference" } }, "type": { "enum": [ "TransactionUpdated" ], "type": "string" } } }, "Core_TransactionsCollection": { "required": [ "items", "count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core_ApiTransaction" } }, "count": { "type": "integer", "format": "int32" }, "currentStartingAfter": { "type": "string" }, "nextStartingAfter": { "type": "string" } } }, "Core_TransferDryRunEstimate": { "oneOf": [ { "$ref": "#/components/schemas/Core_TransferDryRunEstimate_Failure" }, { "$ref": "#/components/schemas/Core_TransferDryRunEstimate_Success" } ], "discriminator": { "propertyName": "type", "mapping": { "Failure": "#/components/schemas/Core_TransferDryRunEstimate_Failure", "Success": "#/components/schemas/Core_TransferDryRunEstimate_Success" } } }, "Core_TransferDryRunEstimate_Failure": { "required": [ "hint", "reason", "type" ], "type": "object", "properties": { "hint": { "$ref": "#/components/schemas/Core_ApiDryRunTransactionProcessingHint" }, "reason": { "type": "string" }, "type": { "enum": [ "Failure" ], "type": "string" } } }, "Core_TransferDryRunEstimate_Success": { "required": [ "fee", "tickerId", "type" ], "type": "object", "properties": { "fee": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "tickerId": { "type": "string", "format": "uuid" }, "tokenFees": { "type": "array", "items": { "$ref": "#/components/schemas/Core_TokenFee" } }, "type": { "enum": [ "Success" ], "type": "string" } } }, "Core_TransferKind": { "enum": [ "Transfer", "Fee", "Recovery" ], "type": "string" }, "Core_TransferMetadata": { "oneOf": [ { "$ref": "#/components/schemas/Core_TransferMetadata_Algorand" }, { "$ref": "#/components/schemas/Core_TransferMetadata_Bitcoin" }, { "$ref": "#/components/schemas/Core_TransferMetadata_Cardano" }, { "$ref": "#/components/schemas/Core_TransferMetadata_Ethereum" }, { "$ref": "#/components/schemas/Core_TransferMetadata_Hedera" }, { "$ref": "#/components/schemas/Core_TransferMetadata_Solana" }, { "$ref": "#/components/schemas/Core_TransferMetadata_Stellar" }, { "$ref": "#/components/schemas/Core_TransferMetadata_Substrate" }, { "$ref": "#/components/schemas/Core_TransferMetadata_Tezos" }, { "$ref": "#/components/schemas/Core_TransferMetadata_Tron" }, { "$ref": "#/components/schemas/Core_TransferMetadata_XRPL" } ], "discriminator": { "propertyName": "type", "mapping": { "Algorand": "#/components/schemas/Core_TransferMetadata_Algorand", "Bitcoin": "#/components/schemas/Core_TransferMetadata_Bitcoin", "Cardano": "#/components/schemas/Core_TransferMetadata_Cardano", "Ethereum": "#/components/schemas/Core_TransferMetadata_Ethereum", "Hedera": "#/components/schemas/Core_TransferMetadata_Hedera", "Solana": "#/components/schemas/Core_TransferMetadata_Solana", "Stellar": "#/components/schemas/Core_TransferMetadata_Stellar", "Substrate": "#/components/schemas/Core_TransferMetadata_Substrate", "Tezos": "#/components/schemas/Core_TransferMetadata_Tezos", "Tron": "#/components/schemas/Core_TransferMetadata_Tron", "XRPL": "#/components/schemas/Core_TransferMetadata_XRPL" } } }, "Core_TransferMetadata_Algorand": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "Algorand" ], "type": "string" } } }, "Core_TransferMetadata_Bitcoin": { "required": [ "type" ], "type": "object", "properties": { "outputIndex": { "type": "integer", "format": "int32" }, "type": { "enum": [ "Bitcoin" ], "type": "string" } } }, "Core_TransferMetadata_Cardano": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "Cardano" ], "type": "string" } } }, "Core_TransferMetadata_Ethereum": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "Ethereum" ], "type": "string" } } }, "Core_TransferMetadata_Hedera": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "Hedera" ], "type": "string" } } }, "Core_TransferMetadata_Solana": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "Solana" ], "type": "string" } } }, "Core_TransferMetadata_Stellar": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "Stellar" ], "type": "string" } } }, "Core_TransferMetadata_Substrate": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "Substrate" ], "type": "string" } } }, "Core_TransferMetadata_Tezos": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "Tezos" ], "type": "string" } } }, "Core_TransferMetadata_Tron": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "Tron" ], "type": "string" } } }, "Core_TransferMetadata_XRPL": { "required": [ "type" ], "type": "object", "properties": { "sourceTag": { "maximum": 4294967295, "minimum": 0, "type": "integer", "format": "int64" }, "destinationTag": { "maximum": 4294967295, "minimum": 0, "type": "integer", "format": "int64" }, "type": { "enum": [ "XRPL" ], "type": "string" } } }, "Core_TransferUpdated": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "enum": [ "TransferUpdated" ], "type": "string" } } }, "Core_TransfersCollection": { "required": [ "items", "count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core_ApiTransfer" } }, "count": { "type": "integer", "format": "int32" }, "currentStartingAfter": { "type": "string" }, "nextStartingAfter": { "type": "string" } } }, "Core_TronFeeStrategy": { "oneOf": [ { "$ref": "#/components/schemas/Core_TronFeeStrategy_Priority" } ], "discriminator": { "propertyName": "type", "mapping": { "Priority": "#/components/schemas/Core_TronFeeStrategy_Priority" } } }, "Core_TronFeeStrategy_Priority": { "required": [ "priority", "type" ], "type": "object", "properties": { "priority": { "$ref": "#/components/schemas/Core_FeePriority" }, "type": { "enum": [ "Priority" ], "type": "string" } } }, "Core_TronOperation": { "oneOf": [ { "$ref": "#/components/schemas/Core_TronOperation_NativeTransfer" }, { "$ref": "#/components/schemas/Core_TronOperation_TRC20Transfer" } ], "discriminator": { "propertyName": "type", "mapping": { "NativeTransfer": "#/components/schemas/Core_TronOperation_NativeTransfer", "TRC20Transfer": "#/components/schemas/Core_TronOperation_TRC20Transfer" } } }, "Core_TronOperation_NativeTransfer": { "required": [ "destination", "amount", "type" ], "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/Core_TransactionDestination" }, "amount": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "NativeTransfer" ], "type": "string" } } }, "Core_TronOperation_TRC20Transfer": { "required": [ "destination", "amount", "contractAddress", "type" ], "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/Core_TransactionDestination" }, "amount": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "contractAddress": { "maxLength": 512, "minLength": 1, "type": "string" }, "type": { "enum": [ "TRC20Transfer" ], "type": "string" } } }, "Core_TronTickerProperties": { "oneOf": [ { "$ref": "#/components/schemas/Core_TronTickerProperties_Native" }, { "$ref": "#/components/schemas/Core_TronTickerProperties_TRC20" } ], "discriminator": { "propertyName": "type", "mapping": { "Native": "#/components/schemas/Core_TronTickerProperties_Native", "TRC20": "#/components/schemas/Core_TronTickerProperties_TRC20" } } }, "Core_TronTickerProperties_Native": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "Native" ], "type": "string" } } }, "Core_TronTickerProperties_TRC20": { "required": [ "contractAddress", "type" ], "type": "object", "properties": { "contractAddress": { "maxLength": 512, "minLength": 1, "type": "string" }, "type": { "enum": [ "TRC20" ], "type": "string" } } }, "Core_TrustedDomain": { "required": [ "data", "signature", "signingKey" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Core_Domain" }, "signature": { "type": "string", "format": "base64" }, "signingKey": { "type": "string", "format": "base64" } } }, "Core_TrustedDomainsCollection": { "required": [ "items", "count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core_TrustedDomain" } }, "count": { "type": "integer", "format": "int32" }, "currentStartingAfter": { "type": "string" }, "nextStartingAfter": { "type": "string" } } }, "Core_TrustedEndpoint": { "required": [ "data", "signature", "signingKey" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Core_Endpoint" }, "signature": { "type": "string", "format": "base64" }, "signingKey": { "type": "string", "format": "base64" } } }, "Core_TrustedEndpointsCollection": { "required": [ "items", "count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core_TrustedEndpoint" } }, "count": { "type": "integer", "format": "int32" }, "currentStartingAfter": { "type": "string" }, "nextStartingAfter": { "type": "string" } } }, "Core_TrustedIntent": { "required": [ "data", "signature", "signingKey" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Core_IntentEntity" }, "signature": { "type": "string", "format": "base64" }, "signingKey": { "type": "string", "format": "base64" } } }, "Core_TrustedIntentsCollection": { "required": [ "items", "count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core_TrustedIntent" } }, "count": { "type": "integer", "format": "int32" }, "currentStartingAfter": { "type": "string" }, "nextStartingAfter": { "type": "string" } } }, "Core_TrustedLedger": { "required": [ "data", "signature", "signingKey" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Core_Ledger" }, "signature": { "type": "string", "format": "base64" }, "signingKey": { "type": "string", "format": "base64" } } }, "Core_TrustedLedgersCollection": { "required": [ "items", "count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core_TrustedLedger" } }, "count": { "type": "integer", "format": "int32" }, "currentStartingAfter": { "type": "string" }, "nextStartingAfter": { "type": "string" } } }, "Core_TrustedPoliciesCollection": { "required": [ "items", "count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core_TrustedPolicy" } }, "count": { "type": "integer", "format": "int32" }, "currentStartingAfter": { "type": "string" }, "nextStartingAfter": { "type": "string" } } }, "Core_TrustedPolicy": { "required": [ "data", "signature", "signingKey" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Core_Policy" }, "signature": { "type": "string", "format": "base64" }, "signingKey": { "type": "string", "format": "base64" } } }, "Core_TrustedPublicKey": { "required": [ "publicKey", "purpose", "metadata" ], "type": "object", "properties": { "publicKey": { "type": "string", "format": "base64" }, "signature": { "type": "string", "format": "base64" }, "signedBy": { "type": "string", "format": "base64" }, "purpose": { "$ref": "#/components/schemas/Core_TrustedPublicKeyPurpose" }, "metadata": { "$ref": "#/components/schemas/Core_EntityMetadata" } } }, "Core_TrustedPublicKeyAdded": { "required": [ "publicKey", "signingPurpose", "type" ], "type": "object", "properties": { "publicKey": { "type": "string", "format": "base64" }, "signingPurpose": { "$ref": "#/components/schemas/Core_TrustedPublicKeyPurpose" }, "type": { "enum": [ "TrustedPublicKeyAdded" ], "type": "string" } } }, "Core_TrustedPublicKeyPurpose": { "enum": [ "ApiSignatures", "TrustedCollectionSignatures", "MessagingSignatures" ], "type": "string" }, "Core_TrustedPublicKeyUpdated": { "required": [ "publicKey", "signingPurpose", "type" ], "type": "object", "properties": { "publicKey": { "type": "string", "format": "base64" }, "signingPurpose": { "$ref": "#/components/schemas/Core_TrustedPublicKeyPurpose" }, "type": { "enum": [ "TrustedPublicKeyUpdated" ], "type": "string" } } }, "Core_TrustedSystemPropertiesCollection": { "required": [ "items", "count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core_TrustedSystemProperty" } }, "count": { "type": "integer", "format": "int32" }, "currentStartingAfter": { "type": "string" }, "nextStartingAfter": { "type": "string" } } }, "Core_TrustedSystemProperty": { "required": [ "data", "signature", "signingKey" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Core_SystemProperty" }, "signature": { "type": "string", "format": "base64" }, "signingKey": { "type": "string", "format": "base64" } } }, "Core_TrustedTransactionOrder": { "required": [ "data", "signature", "signingKey" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Core_TransactionOrder" }, "signature": { "type": "string", "format": "base64" }, "signingKey": { "type": "string", "format": "base64" } } }, "Core_TrustedTransactionOrdersCollection": { "required": [ "items", "count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core_TrustedTransactionOrder" } }, "count": { "type": "integer", "format": "int32" }, "currentStartingAfter": { "type": "string" }, "nextStartingAfter": { "type": "string" } } }, "Core_TrustedTrustedPublicKey": { "required": [ "data", "signature", "signingKey" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Core_TrustedPublicKey" }, "signature": { "type": "string", "format": "base64" }, "signingKey": { "type": "string", "format": "base64" } } }, "Core_TrustedTrustedPublicKeysCollection": { "required": [ "items", "count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core_TrustedTrustedPublicKey" } }, "count": { "type": "integer", "format": "int32" }, "currentStartingAfter": { "type": "string" }, "nextStartingAfter": { "type": "string" } } }, "Core_TrustedUser": { "required": [ "data", "signature", "signingKey" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Core_User" }, "signature": { "type": "string", "format": "base64" }, "signingKey": { "type": "string", "format": "base64" } } }, "Core_TrustedUsersCollection": { "required": [ "items", "count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core_TrustedUser" } }, "count": { "type": "integer", "format": "int32" }, "currentStartingAfter": { "type": "string" }, "nextStartingAfter": { "type": "string" } } }, "Core_User": { "required": [ "id", "domainId", "alias", "publicKey", "roles", "lock", "metadata" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "domainId": { "type": "string", "format": "uuid" }, "alias": { "maxLength": 75, "minLength": 1, "type": "string" }, "publicKey": { "type": "string", "format": "base64" }, "roles": { "minItems": 1, "type": "array", "items": { "maxLength": 50, "minLength": 1, "pattern": "[a-z0-9\\-]+", "type": "string" } }, "lock": { "$ref": "#/components/schemas/Core_LockStatus" }, "metadata": { "$ref": "#/components/schemas/Core_EntityMetadata" }, "loginIds": { "type": "array", "items": { "$ref": "#/components/schemas/Core_LoginId" }, "description": "Domain-unique `loginId`-`loginProviderId` pairs. Must be specified for login and match pre-configured values." } } }, "Core_UserCreated": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "enum": [ "UserCreated" ], "type": "string" } } }, "Core_UserIntentPayload": { "oneOf": [ { "$ref": "#/components/schemas/Core_v0_AcknowledgeBackup" }, { "$ref": "#/components/schemas/Core_v0_AddAccountLedgers" }, { "$ref": "#/components/schemas/Core_v0_AddTrustedPublicKeysForMigration" }, { "$ref": "#/components/schemas/Core_v0_AttemptTransactionOrderCancellation" }, { "$ref": "#/components/schemas/Core_v0_CreateAccount" }, { "$ref": "#/components/schemas/Core_v0_CreateBackup" }, { "$ref": "#/components/schemas/Core_v0_CreateDomain" }, { "$ref": "#/components/schemas/Core_v0_CreateEndpoint" }, { "$ref": "#/components/schemas/Core_v0_CreateLedger" }, { "$ref": "#/components/schemas/Core_v0_CreatePolicy" }, { "$ref": "#/components/schemas/Core_v0_CreateTicker" }, { "$ref": "#/components/schemas/Core_v0_CreateTransactionOrder" }, { "$ref": "#/components/schemas/Core_v0_CreateTransferOrder" }, { "$ref": "#/components/schemas/Core_v0_CreateUser" }, { "$ref": "#/components/schemas/Core_v0_CreateVault" }, { "$ref": "#/components/schemas/Core_v0_ExecuteExtension" }, { "$ref": "#/components/schemas/Core_v0_LockAccount" }, { "$ref": "#/components/schemas/Core_v0_LockDomain" }, { "$ref": "#/components/schemas/Core_v0_LockEndpoint" }, { "$ref": "#/components/schemas/Core_v0_LockPolicy" }, { "$ref": "#/components/schemas/Core_v0_LockTicker" }, { "$ref": "#/components/schemas/Core_v0_LockUser" }, { "$ref": "#/components/schemas/Core_v0_LockVault" }, { "$ref": "#/components/schemas/Core_v0_MigrateSilo3AccountBatch" }, { "$ref": "#/components/schemas/Core_v0_NotarizeData" }, { "$ref": "#/components/schemas/Core_v0_ReleaseQuarantinedTransfers" }, { "$ref": "#/components/schemas/Core_v0_SetSystemProperty" }, { "$ref": "#/components/schemas/Core_v0_SignManifest" }, { "$ref": "#/components/schemas/Core_v0_UnlockAccount" }, { "$ref": "#/components/schemas/Core_v0_UnlockDomain" }, { "$ref": "#/components/schemas/Core_v0_UnlockEndpoint" }, { "$ref": "#/components/schemas/Core_v0_UnlockPolicy" }, { "$ref": "#/components/schemas/Core_v0_UnlockTicker" }, { "$ref": "#/components/schemas/Core_v0_UnlockUser" }, { "$ref": "#/components/schemas/Core_v0_UnlockVault" }, { "$ref": "#/components/schemas/Core_v0_UpdateAccount" }, { "$ref": "#/components/schemas/Core_v0_UpdateDomain" }, { "$ref": "#/components/schemas/Core_v0_UpdateDomainPermissions" }, { "$ref": "#/components/schemas/Core_v0_UpdateEndpoint" }, { "$ref": "#/components/schemas/Core_v0_UpdateLedger" }, { "$ref": "#/components/schemas/Core_v0_UpdatePolicy" }, { "$ref": "#/components/schemas/Core_v0_UpdateTicker" }, { "$ref": "#/components/schemas/Core_v0_UpdateUser" }, { "$ref": "#/components/schemas/Core_v0_UpdateVault" }, { "$ref": "#/components/schemas/Core_v0_ValidateTickers" } ], "discriminator": { "propertyName": "type", "mapping": { "v0_AcknowledgeBackup": "#/components/schemas/Core_v0_AcknowledgeBackup", "v0_AddAccountLedgers": "#/components/schemas/Core_v0_AddAccountLedgers", "v0_AddTrustedPublicKeysForMigration": "#/components/schemas/Core_v0_AddTrustedPublicKeysForMigration", "v0_AttemptTransactionOrderCancellation": "#/components/schemas/Core_v0_AttemptTransactionOrderCancellation", "v0_CreateAccount": "#/components/schemas/Core_v0_CreateAccount", "v0_CreateBackup": "#/components/schemas/Core_v0_CreateBackup", "v0_CreateDomain": "#/components/schemas/Core_v0_CreateDomain", "v0_CreateEndpoint": "#/components/schemas/Core_v0_CreateEndpoint", "v0_CreateLedger": "#/components/schemas/Core_v0_CreateLedger", "v0_CreatePolicy": "#/components/schemas/Core_v0_CreatePolicy", "v0_CreateTicker": "#/components/schemas/Core_v0_CreateTicker", "v0_CreateTransactionOrder": "#/components/schemas/Core_v0_CreateTransactionOrder", "v0_CreateTransferOrder": "#/components/schemas/Core_v0_CreateTransferOrder", "v0_CreateUser": "#/components/schemas/Core_v0_CreateUser", "v0_CreateVault": "#/components/schemas/Core_v0_CreateVault", "v0_ExecuteExtension": "#/components/schemas/Core_v0_ExecuteExtension", "v0_LockAccount": "#/components/schemas/Core_v0_LockAccount", "v0_LockDomain": "#/components/schemas/Core_v0_LockDomain", "v0_LockEndpoint": "#/components/schemas/Core_v0_LockEndpoint", "v0_LockPolicy": "#/components/schemas/Core_v0_LockPolicy", "v0_LockTicker": "#/components/schemas/Core_v0_LockTicker", "v0_LockUser": "#/components/schemas/Core_v0_LockUser", "v0_LockVault": "#/components/schemas/Core_v0_LockVault", "v0_MigrateSilo3AccountBatch": "#/components/schemas/Core_v0_MigrateSilo3AccountBatch", "v0_NotarizeData": "#/components/schemas/Core_v0_NotarizeData", "v0_ReleaseQuarantinedTransfers": "#/components/schemas/Core_v0_ReleaseQuarantinedTransfers", "v0_SetSystemProperty": "#/components/schemas/Core_v0_SetSystemProperty", "v0_SignManifest": "#/components/schemas/Core_v0_SignManifest", "v0_UnlockAccount": "#/components/schemas/Core_v0_UnlockAccount", "v0_UnlockDomain": "#/components/schemas/Core_v0_UnlockDomain", "v0_UnlockEndpoint": "#/components/schemas/Core_v0_UnlockEndpoint", "v0_UnlockPolicy": "#/components/schemas/Core_v0_UnlockPolicy", "v0_UnlockTicker": "#/components/schemas/Core_v0_UnlockTicker", "v0_UnlockUser": "#/components/schemas/Core_v0_UnlockUser", "v0_UnlockVault": "#/components/schemas/Core_v0_UnlockVault", "v0_UpdateAccount": "#/components/schemas/Core_v0_UpdateAccount", "v0_UpdateDomain": "#/components/schemas/Core_v0_UpdateDomain", "v0_UpdateDomainPermissions": "#/components/schemas/Core_v0_UpdateDomainPermissions", "v0_UpdateEndpoint": "#/components/schemas/Core_v0_UpdateEndpoint", "v0_UpdateLedger": "#/components/schemas/Core_v0_UpdateLedger", "v0_UpdatePolicy": "#/components/schemas/Core_v0_UpdatePolicy", "v0_UpdateTicker": "#/components/schemas/Core_v0_UpdateTicker", "v0_UpdateUser": "#/components/schemas/Core_v0_UpdateUser", "v0_UpdateVault": "#/components/schemas/Core_v0_UpdateVault", "v0_ValidateTickers": "#/components/schemas/Core_v0_ValidateTickers" } } }, "Core_UserOperationRejectionCode": { "enum": [ "AccountLocked", "AccountNotReady", "DecisionInvalid", "DomainLocked", "TickerLocked", "EndpointLocked", "EntityAlreadyCreated", "EntityRevisionMismatch", "EntityAlreadyUnlocked", "EntityAlreadyLocked", "LockStatusCannotBeChanged", "IntentAlreadyComplete", "IntentAlreadyExists", "IntentMissing", "InvalidParentDomain", "LedgerNotFound", "LedgerNotProvided", "InvalidLedgerParameters", "InvalidSystemPropertyParameters", "MustBeExecutedInCurrentDomain", "MustBeExecutedInParentDomain", "MustBeExecutedInRootDomain", "NoApplicablePoliciesForDomain", "NonUniquePoliciesById", "NonUniqueUsersByAlias", "NonUniqueValidatedTickersByLedgerDetails", "NonUniqueUsersById", "NonUniqueUsersByPublicKey", "NotApplicableForRootDomain", "PolicyRevisionMismatch", "PolicyScriptingExecutionFailed", "PolicyWorkflowFailed", "PublicKeyInvalid", "LoginIdAlreadyAssigned", "ProposerIntentSignatureMismatches", "RequestExpired", "IntentExpired", "StaleIntent", "RequestSubmitterLocked", "RequestSubmitterNotFound", "RequestSubmitterSignatureInvalid", "UnsupportedAccountKeyStrategy", "VaultNotFound", "VaultLocked", "VaultNotReady", "InvalidDestination", "InvalidTransactionOrderState", "InvalidTransactionOrderParameters", "InvalidTransferOrderParameters", "InvalidEndpointUpdateParameters", "InvalidEndpointCreateParameters", "InvalidManifestContent", "BatchTooLarge", "MigrateSilo3AccountBatchContainsDuplicateDerivationData", "MigrateSilo3AccountBatchContainsDuplicateAccountIds", "MigrateSilo3AccountAlreadyImported", "InvalidTickerLedgerDetails", "DuplicateTickerIdsToValidate", "DuplicateTickerLedgerDatasToValidate", "InvalidEntityId", "MissingLoginIds", "DuplicatedLoginIds", "FeatureFlagDisabled", "InvalidCreateAccountParameters", "InvalidAddAccountLedgersParameters", "CurrentPublicKeyNotMatching", "InvalidTrustedCollectionPublicKeySignature", "InvalidMigrationKeyMaterial", "InvalidEntityType", "DuplicatePublicKey", "InvalidVaultParameters", "BackupNotReady", "BackupAcknowledgeDenied", "ValidateTickersPostProcessingFailure" ], "type": "string" }, "Core_UserReference": { "required": [ "id", "domainId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "domainId": { "type": "string", "format": "uuid" } } }, "Core_UserUpdated": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "enum": [ "UserUpdated" ], "type": "string" } } }, "Core_V3AccountToMigrate": { "required": [ "id", "alias", "ledgerId", "lockStatus", "publicId", "customProperties" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "maxLength": 75, "minLength": 1, "type": "string" }, "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "ledgerId": { "maxLength": 100, "minLength": 1, "type": "string" }, "lockStatus": { "$ref": "#/components/schemas/Core_IntentLockStatus" }, "publicId": { "pattern": "^([A-Fa-f0-9]{4})-([0-7][A-Fa-f0-9]{7})$", "type": "string", "example": "D37D-04ACF7C4" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" } } }, "Core_ValidatedTickerKind": { "enum": [ "Native", "Contract", "Token" ], "type": "string" }, "Core_Vault": { "required": [ "id", "publicKey", "alias", "lock", "metadata" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "publicKey": { "type": "string", "format": "base64" }, "parameters": { "$ref": "#/components/schemas/Core_VaultParameters" }, "supportedDerivations": { "type": "array", "items": { "$ref": "#/components/schemas/Core_VaultDerivation" } }, "enabledKeyStrategies": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/Core_VaultKeyStrategy" } }, "alias": { "maxLength": 75, "minLength": 1, "type": "string" }, "lock": { "$ref": "#/components/schemas/Core_LockStatus" }, "metadata": { "$ref": "#/components/schemas/Core_EntityMetadata" } } }, "Core_VaultAccountKeyInformation": { "oneOf": [ { "$ref": "#/components/schemas/Core_VaultAccountKeyInformation_Random" }, { "$ref": "#/components/schemas/Core_VaultAccountKeyInformation_VaultDerived" } ], "discriminator": { "propertyName": "type", "mapping": { "Random": "#/components/schemas/Core_VaultAccountKeyInformation_Random", "VaultDerived": "#/components/schemas/Core_VaultAccountKeyInformation_VaultDerived" } }, "deprecated": true }, "Core_VaultAccountKeyInformation_Random": { "required": [ "type" ], "type": "object", "properties": { "publicKey": { "$ref": "#/components/schemas/Core_AccountPublicKey" }, "type": { "enum": [ "Random" ], "type": "string" } } }, "Core_VaultAccountKeyInformation_VaultDerived": { "required": [ "derivationPath", "type" ], "type": "object", "properties": { "publicKey": { "$ref": "#/components/schemas/Core_AccountPublicKey" }, "derivationPath": { "minLength": 1, "type": "string" }, "type": { "enum": [ "VaultDerived" ], "type": "string" } } }, "Core_VaultAccountProviderInformation_Key": { "oneOf": [ { "$ref": "#/components/schemas/Core_VaultAccountProviderInformation_Key_VaultDerived" }, { "$ref": "#/components/schemas/Core_VaultAccountProviderInformation_Key_VaultDerivedNonExtended" }, { "$ref": "#/components/schemas/Core_VaultAccountProviderInformation_Key_VaultRandom" } ], "discriminator": { "propertyName": "type", "mapping": { "VaultDerived": "#/components/schemas/Core_VaultAccountProviderInformation_Key_VaultDerived", "VaultDerivedNonExtended": "#/components/schemas/Core_VaultAccountProviderInformation_Key_VaultDerivedNonExtended", "VaultRandom": "#/components/schemas/Core_VaultAccountProviderInformation_Key_VaultRandom" } } }, "Core_VaultAccountProviderInformation_KeyId": { "enum": [ "SECP256K1_CUSTODY_1", "ED25519_CUSTODY_1", "ED25519_CUSTODY_2", "ED25519_STAKING_1" ], "type": "string" }, "Core_VaultAccountProviderInformation_Key_VaultDerived": { "required": [ "id", "derivationPath", "type" ], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/Core_VaultAccountProviderInformation_KeyId" }, "derivationPath": { "minLength": 1, "type": "string" }, "publicKey": { "$ref": "#/components/schemas/Core_AccountPublicKeyExtendedOnly" }, "type": { "enum": [ "VaultDerived" ], "type": "string" } } }, "Core_VaultAccountProviderInformation_Key_VaultDerivedNonExtended": { "required": [ "id", "derivationPath", "publicKey", "type" ], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/Core_VaultAccountProviderInformation_KeyId" }, "derivationPath": { "minLength": 1, "type": "string" }, "publicKey": { "$ref": "#/components/schemas/Core_AccountPublicKeyOnly" }, "type": { "enum": [ "VaultDerivedNonExtended" ], "type": "string" } } }, "Core_VaultAccountProviderInformation_Key_VaultRandom": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/Core_VaultAccountProviderInformation_KeyId" }, "publicKey": { "$ref": "#/components/schemas/Core_AccountPublicKey" }, "type": { "enum": [ "VaultRandom" ], "type": "string" } } }, "Core_VaultAdditionalDetails": { "required": [ "processing" ], "type": "object", "properties": { "processing": { "$ref": "#/components/schemas/Core_VaultProcessingDetails" } } }, "Core_VaultBackupParameters": { "oneOf": [ { "$ref": "#/components/schemas/Core_VaultBackupParameters_VaultHsm" }, { "$ref": "#/components/schemas/Core_VaultBackupParameters_VaultMpc" } ], "discriminator": { "propertyName": "type", "mapping": { "VaultHsm": "#/components/schemas/Core_VaultBackupParameters_VaultHsm", "VaultMpc": "#/components/schemas/Core_VaultBackupParameters_VaultMpc" } } }, "Core_VaultBackupParameters_VaultHsm": { "required": [ "vaultId", "type" ], "type": "object", "properties": { "vaultId": { "type": "string", "format": "uuid" }, "type": { "enum": [ "VaultHsm" ], "type": "string" } } }, "Core_VaultBackupParameters_VaultMpc": { "required": [ "vaultId", "type" ], "type": "object", "properties": { "vaultId": { "type": "string", "format": "uuid" }, "type": { "enum": [ "VaultMpc" ], "type": "string" } } }, "Core_VaultCreated": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "enum": [ "VaultCreated" ], "type": "string" } } }, "Core_VaultDerivation": { "enum": [ "Slip10", "SoftBip32", "None", "Bip32" ], "type": "string" }, "Core_VaultHsmBackupData": { "required": [ "acknowledged", "encryptedSeed", "hash" ], "type": "object", "properties": { "acknowledged": { "type": "boolean" }, "encryptedSeed": { "type": "string", "format": "base64" }, "hash": { "type": "string" } } }, "Core_VaultKeyStrategy": { "enum": [ "VaultHard", "VaultSoft", "Random" ], "type": "string" }, "Core_VaultMpcBackupData": { "required": [ "acknowledged", "json", "hash" ], "type": "object", "properties": { "acknowledged": { "type": "boolean" }, "json": { "type": "string" }, "hash": { "type": "string" } } }, "Core_VaultParameters": { "oneOf": [ { "$ref": "#/components/schemas/Core_VaultParameters_HSM" }, { "$ref": "#/components/schemas/Core_VaultParameters_MPC" } ], "discriminator": { "propertyName": "type", "mapping": { "HSM": "#/components/schemas/Core_VaultParameters_HSM", "MPC": "#/components/schemas/Core_VaultParameters_MPC" } } }, "Core_VaultParameters_HSM": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "HSM" ], "type": "string" } } }, "Core_VaultParameters_MPC": { "required": [ "type" ], "type": "object", "properties": { "backupEncryptionKey": { "pattern": "^0[xX](([a-fA-F0-9][a-fA-F0-9])*)$", "type": "string", "description": "0x prefixed Hex encoded backup encryption key, supported key size between 2048 and 4096 bits." }, "type": { "enum": [ "MPC" ], "type": "string" } } }, "Core_VaultProcessingDetails": { "oneOf": [ { "$ref": "#/components/schemas/Core_VaultProcessingDetails_Completed" }, { "$ref": "#/components/schemas/Core_VaultProcessingDetails_Pending" }, { "$ref": "#/components/schemas/Core_VaultProcessingDetails_Preparing" } ], "discriminator": { "propertyName": "status", "mapping": { "Completed": "#/components/schemas/Core_VaultProcessingDetails_Completed", "Pending": "#/components/schemas/Core_VaultProcessingDetails_Pending", "Preparing": "#/components/schemas/Core_VaultProcessingDetails_Preparing" } } }, "Core_VaultProcessingDetails_Completed": { "required": [ "status" ], "type": "object", "properties": { "status": { "enum": [ "Completed" ], "type": "string" } } }, "Core_VaultProcessingDetails_Pending": { "required": [ "status" ], "type": "object", "properties": { "status": { "enum": [ "Pending" ], "type": "string" } } }, "Core_VaultProcessingDetails_Preparing": { "required": [ "status" ], "type": "object", "properties": { "status": { "enum": [ "Preparing" ], "type": "string" } } }, "Core_VaultProcessingStatus": { "enum": [ "Pending", "Preparing", "Completed" ], "type": "string" }, "Core_VaultUpdated": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "enum": [ "VaultUpdated" ], "type": "string" } } }, "Core_VaultsCollection": { "required": [ "items", "count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core_ApiVault" } }, "count": { "type": "integer", "format": "int32" }, "currentStartingAfter": { "type": "string" }, "nextStartingAfter": { "type": "string" } } }, "Core_WorkflowCondition": { "oneOf": [ { "$ref": "#/components/schemas/Core_WorkflowCondition_And" }, { "$ref": "#/components/schemas/Core_WorkflowCondition_Or" }, { "$ref": "#/components/schemas/Core_WorkflowCondition_RoleQuorum" } ], "discriminator": { "propertyName": "type", "mapping": { "And": "#/components/schemas/Core_WorkflowCondition_And", "Or": "#/components/schemas/Core_WorkflowCondition_Or", "RoleQuorum": "#/components/schemas/Core_WorkflowCondition_RoleQuorum" } }, "example": { "left": { "left": { "role": "Admin", "quorum": 1, "type": "RoleQuorum" }, "right": { "role": "Trader", "quorum": 2, "type": "RoleQuorum" }, "type": "And" }, "right": { "left": { "role": "Customer", "quorum": 3, "type": "RoleQuorum" }, "right": { "role": "Manager", "quorum": 4, "type": "RoleQuorum" }, "type": "Or" } } }, "Core_WorkflowCondition_And": { "required": [ "left", "right", "type" ], "type": "object", "properties": { "left": { "$ref": "#/components/schemas/Core_WorkflowCondition" }, "right": { "$ref": "#/components/schemas/Core_WorkflowCondition" }, "type": { "enum": [ "And" ], "type": "string" } } }, "Core_WorkflowCondition_Or": { "required": [ "left", "right", "type" ], "type": "object", "properties": { "left": { "$ref": "#/components/schemas/Core_WorkflowCondition" }, "right": { "$ref": "#/components/schemas/Core_WorkflowCondition" }, "type": { "enum": [ "Or" ], "type": "string" } } }, "Core_WorkflowCondition_RoleQuorum": { "required": [ "role", "quorum", "type" ], "type": "object", "properties": { "role": { "maxLength": 50, "minLength": 1, "pattern": "[a-z0-9\\-]+", "type": "string" }, "quorum": { "minimum": 1, "type": "integer", "format": "int32" }, "type": { "enum": [ "RoleQuorum" ], "type": "string" } } }, "Core_WorkflowProgress": { "required": [ "stepProgress", "policyReference" ], "type": "object", "properties": { "stepProgress": { "type": "array", "items": { "$ref": "#/components/schemas/Core_WorkflowStep" } }, "policyReference": { "$ref": "#/components/schemas/Core_PolicyReference" } } }, "Core_WorkflowStep": { "required": [ "state", "decisions" ], "type": "object", "properties": { "state": { "$ref": "#/components/schemas/Core_WorkflowStepStatus" }, "decisions": { "type": "array", "items": { "$ref": "#/components/schemas/Core_DecisionPayload" } } } }, "Core_WorkflowStepStatus": { "enum": [ "Open", "Approved", "Failed", "Rejected" ], "type": "string" }, "Core_XrplCurrency": { "oneOf": [ { "$ref": "#/components/schemas/Core_XrplCurrency_Currency" }, { "$ref": "#/components/schemas/Core_XrplCurrency_MultiPurposeToken" }, { "$ref": "#/components/schemas/Core_XrplCurrency_TickerId" } ], "discriminator": { "propertyName": "type", "mapping": { "Currency": "#/components/schemas/Core_XrplCurrency_Currency", "MultiPurposeToken": "#/components/schemas/Core_XrplCurrency_MultiPurposeToken", "TickerId": "#/components/schemas/Core_XrplCurrency_TickerId" } } }, "Core_XrplCurrency_Currency": { "required": [ "code", "issuer", "type" ], "type": "object", "properties": { "code": { "maxLength": 100, "minLength": 1, "type": "string" }, "issuer": { "maxLength": 35, "minLength": 25, "type": "string" }, "type": { "enum": [ "Currency" ], "type": "string" } } }, "Core_XrplCurrency_MultiPurposeToken": { "required": [ "issuanceId", "type" ], "type": "object", "properties": { "issuanceId": { "pattern": "^[A-Fa-f0-9]*$", "type": "string", "description": "XRPL MPToken Issuance ID (192-bit integer hex encoded)" }, "type": { "enum": [ "MultiPurposeToken" ], "type": "string" } } }, "Core_XrplCurrency_TickerId": { "required": [ "tickerId", "type" ], "type": "object", "properties": { "tickerId": { "type": "string", "format": "uuid" }, "type": { "enum": [ "TickerId" ], "type": "string" } } }, "Core_XrplFee": { "required": [ "multiplier" ], "type": "object", "properties": { "multiplier": { "type": "string", "description": "This field is a large integer and represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." } } }, "Core_XrplFeeStrategy": { "oneOf": [ { "$ref": "#/components/schemas/Core_XrplFeeStrategy_Priority" }, { "$ref": "#/components/schemas/Core_XrplFeeStrategy_SpecifiedAdditionalFee" } ], "discriminator": { "propertyName": "type", "mapping": { "Priority": "#/components/schemas/Core_XrplFeeStrategy_Priority", "SpecifiedAdditionalFee": "#/components/schemas/Core_XrplFeeStrategy_SpecifiedAdditionalFee" } } }, "Core_XrplFeeStrategy_Priority": { "required": [ "priority", "type" ], "type": "object", "properties": { "priority": { "$ref": "#/components/schemas/Core_FeePriority" }, "type": { "enum": [ "Priority" ], "type": "string" } } }, "Core_XrplFeeStrategy_SpecifiedAdditionalFee": { "required": [ "drops", "type" ], "type": "object", "properties": { "drops": { "type": "string", "description": "This field is a large integer and represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "SpecifiedAdditionalFee" ], "type": "string" } } }, "Core_XrplMemo": { "type": "object", "properties": { "memoData": { "pattern": "^[A-Fa-f0-9]*$", "type": "string", "description": "Hex encoded string." }, "memoFormat": { "pattern": "^[A-Fa-f0-9]*$", "type": "string", "description": "Hex encoded string. The encoded string must only characters defined in RFC 3986 URLs" }, "memoType": { "pattern": "^[A-Fa-f0-9]*$", "type": "string", "description": "Hex encoded string. The encoded string must only characters defined in RFC 3986 URLs" } } }, "Core_XrplOperation": { "oneOf": [ { "$ref": "#/components/schemas/Core_XrplOperation_AccountSet" }, { "$ref": "#/components/schemas/Core_XrplOperation_Clawback" }, { "$ref": "#/components/schemas/Core_XrplOperation_DepositPreauth" }, { "$ref": "#/components/schemas/Core_XrplOperation_MPTokenAuthorize" }, { "$ref": "#/components/schemas/Core_XrplOperation_OfferCreate" }, { "$ref": "#/components/schemas/Core_XrplOperation_Payment" }, { "$ref": "#/components/schemas/Core_XrplOperation_TrustSet" } ], "discriminator": { "propertyName": "type", "mapping": { "AccountSet": "#/components/schemas/Core_XrplOperation_AccountSet", "Clawback": "#/components/schemas/Core_XrplOperation_Clawback", "DepositPreauth": "#/components/schemas/Core_XrplOperation_DepositPreauth", "MPTokenAuthorize": "#/components/schemas/Core_XrplOperation_MPTokenAuthorize", "OfferCreate": "#/components/schemas/Core_XrplOperation_OfferCreate", "Payment": "#/components/schemas/Core_XrplOperation_Payment", "TrustSet": "#/components/schemas/Core_XrplOperation_TrustSet" } } }, "Core_XrplOperation_AccountSet": { "required": [ "type" ], "type": "object", "properties": { "setFlag": { "$ref": "#/components/schemas/Core_Xrpl_AccountSetFlag" }, "clearFlag": { "$ref": "#/components/schemas/Core_Xrpl_AccountSetFlag" }, "transferRate": { "type": "integer", "format": "int32" }, "type": { "enum": [ "AccountSet" ], "type": "string" } } }, "Core_XrplOperation_Clawback": { "required": [ "currency", "holder", "value", "type" ], "type": "object", "properties": { "currency": { "$ref": "#/components/schemas/Core_XrplCurrency" }, "holder": { "$ref": "#/components/schemas/Core_TransactionDestination" }, "value": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "Clawback" ], "type": "string" } } }, "Core_XrplOperation_DepositPreauth": { "required": [ "type" ], "type": "object", "properties": { "authorize": { "$ref": "#/components/schemas/Core_TransactionDestination" }, "unauthorize": { "$ref": "#/components/schemas/Core_TransactionDestination" }, "type": { "enum": [ "DepositPreauth" ], "type": "string" } } }, "Core_XrplOperation_MPTokenAuthorize": { "required": [ "issuanceId", "flags", "type" ], "type": "object", "properties": { "issuanceId": { "pattern": "^[A-Fa-f0-9]*$", "type": "string", "description": "XRPL MPToken Issuance ID (192-bit integer hex encoded)" }, "flags": { "type": "array", "items": { "$ref": "#/components/schemas/Core_Xrpl_MPTokenAuthorizeFlag" } }, "type": { "enum": [ "MPTokenAuthorize" ], "type": "string" } } }, "Core_XrplOperation_OfferCreate": { "required": [ "flags", "takerGets", "takerPays", "type" ], "type": "object", "properties": { "flags": { "type": "array", "items": { "$ref": "#/components/schemas/Core_Xrpl_OfferCreateFlag" } }, "takerGets": { "$ref": "#/components/schemas/Core_Xrpl_AssetQuantity" }, "takerPays": { "$ref": "#/components/schemas/Core_Xrpl_AssetQuantity" }, "type": { "enum": [ "OfferCreate" ], "type": "string" } } }, "Core_XrplOperation_Payment": { "required": [ "destination", "amount", "type" ], "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/Core_TransactionDestination" }, "amount": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "destinationTag": { "maximum": 4294967295, "minimum": 0, "type": "integer", "format": "int64" }, "currency": { "$ref": "#/components/schemas/Core_XrplCurrency" }, "type": { "enum": [ "Payment" ], "type": "string" } } }, "Core_XrplOperation_TrustSet": { "required": [ "flags", "limitAmount", "type" ], "type": "object", "properties": { "flags": { "type": "array", "items": { "$ref": "#/components/schemas/Core_Xrpl_TrustSetFlag" } }, "limitAmount": { "$ref": "#/components/schemas/Core_Xrpl_LimitAmount" }, "enableRippling": { "type": "boolean" }, "type": { "enum": [ "TrustSet" ], "type": "string" } } }, "Core_XrplTickerProperties": { "oneOf": [ { "$ref": "#/components/schemas/Core_XrplTickerProperties_FungibleToken" }, { "$ref": "#/components/schemas/Core_XrplTickerProperties_MultiPurposeToken" }, { "$ref": "#/components/schemas/Core_XrplTickerProperties_Native" } ], "discriminator": { "propertyName": "type", "mapping": { "FungibleToken": "#/components/schemas/Core_XrplTickerProperties_FungibleToken", "MultiPurposeToken": "#/components/schemas/Core_XrplTickerProperties_MultiPurposeToken", "Native": "#/components/schemas/Core_XrplTickerProperties_Native" } } }, "Core_XrplTickerProperties_FungibleToken": { "required": [ "currencyCode", "issuer", "type" ], "type": "object", "properties": { "currencyCode": { "maxLength": 100, "minLength": 1, "type": "string" }, "issuer": { "maxLength": 35, "minLength": 25, "type": "string" }, "type": { "enum": [ "FungibleToken" ], "type": "string" } } }, "Core_XrplTickerProperties_MultiPurposeToken": { "required": [ "issuanceId", "type" ], "type": "object", "properties": { "issuanceId": { "pattern": "^[A-Fa-f0-9]*$", "type": "string", "description": "XRPL MPToken Issuance ID (192-bit integer hex encoded)" }, "type": { "enum": [ "MultiPurposeToken" ], "type": "string" } } }, "Core_XrplTickerProperties_Native": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "Native" ], "type": "string" } } }, "Core_Xrpl_AccountSetFlag": { "enum": [ "asfGlobalFreeze", "asfNoFreeze", "asfRequireAuth", "asfAllowTrustLineClawback", "asfAccountTxnID", "asfDepositAuth", "asfRequireDest", "asfDefaultRipple" ], "type": "string" }, "Core_Xrpl_AssetQuantity": { "required": [ "amount" ], "type": "object", "properties": { "currency": { "$ref": "#/components/schemas/Core_XrplCurrency" }, "amount": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." } } }, "Core_Xrpl_DeprecatedTransactionDestination": { "oneOf": [ { "$ref": "#/components/schemas/Core_TransactionDestination_Account" }, { "$ref": "#/components/schemas/Core_TransactionDestination_Address" }, { "$ref": "#/components/schemas/Core_TransactionDestination_Endpoint" } ], "discriminator": { "propertyName": "type", "mapping": { "Account": "#/components/schemas/Core_TransactionDestination_Account", "Address": "#/components/schemas/Core_TransactionDestination_Address", "Endpoint": "#/components/schemas/Core_TransactionDestination_Endpoint" } }, "deprecated": true }, "Core_Xrpl_LimitAmount": { "required": [ "currency", "value" ], "type": "object", "properties": { "currency": { "$ref": "#/components/schemas/Core_XrplCurrency" }, "value": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." } } }, "Core_Xrpl_MPTokenAuthorizeFlag": { "enum": [ "tfMPTUnauthorize" ], "type": "string" }, "Core_Xrpl_OfferCreateFlag": { "enum": [ "tfImmediateOrCancel", "tfFillOrKill", "tfSell" ], "type": "string" }, "Core_Xrpl_TrustSetFlag": { "enum": [ "tfSetFreeze", "tfClearFreeze", "tfSetfAuth" ], "type": "string" }, "Core_v0_AcknowledgeBackup": { "required": [ "backupId", "type" ], "type": "object", "properties": { "backupId": { "type": "string", "format": "uuid" }, "type": { "enum": [ "v0_AcknowledgeBackup" ], "type": "string" } } }, "Core_v0_AddAccountLedgers": { "required": [ "reference", "type" ], "type": "object", "properties": { "reference": { "$ref": "#/components/schemas/Core_EntityIdAndRevision" }, "ledgerIds": { "type": "array", "items": { "maxLength": 100, "minLength": 1, "type": "string" } }, "type": { "enum": [ "v0_AddAccountLedgers" ], "type": "string" } } }, "Core_v0_AddTrustedPublicKeysForMigration": { "required": [ "newCollectionSigningPublicKey", "newMessageSigningPublicKey", "newApiSigningPublicKey", "newKeyMaterial", "currentCollectionSigningPublicKey", "currentCollectionSigningPublicKeySignature", "type" ], "type": "object", "properties": { "newCollectionSigningPublicKey": { "type": "string", "format": "base64" }, "newMessageSigningPublicKey": { "type": "string", "format": "base64" }, "newApiSigningPublicKey": { "type": "string", "format": "base64" }, "newKeyMaterial": { "maxLength": 5000, "minLength": 1, "type": "string" }, "currentCollectionSigningPublicKey": { "type": "string", "format": "base64" }, "currentCollectionSigningPublicKeySignature": { "type": "string", "format": "base64" }, "type": { "enum": [ "v0_AddTrustedPublicKeysForMigration" ], "type": "string" } } }, "Core_v0_AttemptTransactionOrderCancellation": { "required": [ "targetTransactionOrderId", "replacementTransactionOrderId", "reason", "type" ], "type": "object", "properties": { "targetTransactionOrderId": { "type": "string", "format": "uuid" }, "replacementTransactionOrderId": { "type": "string", "format": "uuid" }, "reason": { "maxLength": 200, "minLength": 1, "type": "string" }, "maximumFee": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "type": { "enum": [ "v0_AttemptTransactionOrderCancellation" ], "type": "string" } } }, "Core_v0_CreateAccount": { "required": [ "id", "alias", "providerDetails", "lock", "customProperties", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "maxLength": 75, "minLength": 1, "type": "string" }, "providerDetails": { "$ref": "#/components/schemas/Core_v0_CreateAccountProviderDetailsPayload" }, "ledgerId": { "maxLength": 100, "minLength": 1, "type": "string", "deprecated": true }, "ledgerIds": { "type": "array", "items": { "maxLength": 100, "minLength": 1, "type": "string" } }, "lock": { "$ref": "#/components/schemas/Core_IntentLockStatus" }, "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" }, "type": { "enum": [ "v0_CreateAccount" ], "type": "string" } } }, "Core_v0_CreateAccountProviderDetailsPayload": { "oneOf": [ { "$ref": "#/components/schemas/Core_v0_CreateAccountProviderDetailsPayload_Vault" } ], "discriminator": { "propertyName": "type", "mapping": { "Vault": "#/components/schemas/Core_v0_CreateAccountProviderDetailsPayload_Vault" } } }, "Core_v0_CreateAccountProviderDetailsPayload_Vault": { "required": [ "vaultId", "keyStrategy", "type" ], "type": "object", "properties": { "vaultId": { "type": "string", "format": "uuid" }, "keyStrategy": { "$ref": "#/components/schemas/Core_AccountKeyStrategy" }, "type": { "enum": [ "Vault" ], "type": "string" } } }, "Core_v0_CreateBackup": { "required": [ "id", "parameters", "customProperties", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "parameters": { "$ref": "#/components/schemas/Core_VaultBackupParameters" }, "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" }, "type": { "enum": [ "v0_CreateBackup" ], "type": "string" } } }, "Core_v0_CreateDomain": { "required": [ "id", "alias", "lock", "permissions", "customProperties", "users", "policies", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "maxLength": 75, "minLength": 1, "type": "string" }, "lock": { "$ref": "#/components/schemas/Core_IntentLockStatus" }, "governingStrategy": { "$ref": "#/components/schemas/Core_GoverningStrategy" }, "permissions": { "$ref": "#/components/schemas/Core_Permissions" }, "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/Core_CreateDomainGenesisUser" } }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/Core_CreateDomainGenesisPolicy" } }, "childrenDomainIds": { "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid" } }, "type": { "enum": [ "v0_CreateDomain" ], "type": "string" } } }, "Core_v0_CreateEndpoint": { "required": [ "id", "address", "trustScore", "ledgerId", "alias", "lock", "customProperties", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "address": { "maxLength": 512, "minLength": 1, "type": "string" }, "trustScore": { "maximum": 100, "minimum": 0, "type": "integer", "format": "int32" }, "ledgerId": { "maxLength": 100, "minLength": 1, "type": "string" }, "parameters": { "$ref": "#/components/schemas/Core_EndpointLedgerParameters" }, "alias": { "maxLength": 75, "minLength": 1, "type": "string" }, "lock": { "$ref": "#/components/schemas/Core_IntentLockStatus" }, "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" }, "type": { "enum": [ "v0_CreateEndpoint" ], "type": "string" } } }, "Core_v0_CreateLedger": { "required": [ "id", "alias", "parameters", "customProperties", "type" ], "type": "object", "properties": { "id": { "type": "string" }, "alias": { "maxLength": 200, "minLength": 1, "type": "string" }, "parameters": { "$ref": "#/components/schemas/Core_LedgerParameters" }, "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" }, "type": { "enum": [ "v0_CreateLedger" ], "type": "string" } } }, "Core_v0_CreatePolicy": { "required": [ "id", "alias", "rank", "scope", "scriptingEngine", "lock", "customProperties", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "maxLength": 75, "minLength": 1, "type": "string" }, "rank": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" }, "intentTypes": { "type": "array", "items": { "$ref": "#/components/schemas/Core_IntentType" } }, "scope": { "$ref": "#/components/schemas/Core_PolicyScope" }, "scriptingEngine": { "$ref": "#/components/schemas/Core_ScriptingEngine" }, "condition": { "$ref": "#/components/schemas/Core_PolicyCondition" }, "workflow": { "type": "array", "items": { "$ref": "#/components/schemas/Core_WorkflowCondition" } }, "lock": { "$ref": "#/components/schemas/Core_IntentLockStatus" }, "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" }, "type": { "enum": [ "v0_CreatePolicy" ], "type": "string" } } }, "Core_v0_CreateTicker": { "required": [ "ledgerId", "kind", "name", "ledgerDetails", "type" ], "type": "object", "properties": { "ledgerId": { "maxLength": 100, "minLength": 1, "type": "string" }, "kind": { "$ref": "#/components/schemas/Core_TickerKind" }, "name": { "maxLength": 100, "minLength": 1, "type": "string" }, "decimals": { "type": "integer", "format": "int32" }, "symbol": { "maxLength": 100, "minLength": 1, "type": "string" }, "ledgerDetails": { "$ref": "#/components/schemas/Core_TickerLedgerDetails" }, "type": { "enum": [ "v0_CreateTicker" ], "type": "string" } } }, "Core_v0_CreateTransactionOrder": { "required": [ "id", "accountId", "parameters", "customProperties", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "ledgerId": { "maxLength": 100, "minLength": 1, "type": "string" }, "parameters": { "$ref": "#/components/schemas/Core_TransactionOrderParameters" }, "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" }, "type": { "enum": [ "v0_CreateTransactionOrder" ], "type": "string" } } }, "Core_v0_CreateTransferOrder": { "required": [ "id", "accountId", "tickerId", "outputs", "feeStrategy", "customProperties", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "tickerId": { "type": "string", "format": "uuid" }, "outputs": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/Core_CreateTransferOrderOutput" } }, "feeStrategy": { "$ref": "#/components/schemas/Core_FeePriority" }, "maximumFee": { "minimum": 0, "type": "string", "description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision." }, "preferredAddressForChange": { "$ref": "#/components/schemas/Core_PreferredAddressForChange" }, "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" }, "type": { "enum": [ "v0_CreateTransferOrder" ], "type": "string" } } }, "Core_v0_CreateUser": { "required": [ "id", "alias", "publicKey", "roles", "lock", "customProperties", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "maxLength": 75, "minLength": 1, "type": "string" }, "publicKey": { "type": "string", "format": "base64" }, "roles": { "minItems": 1, "type": "array", "items": { "maxLength": 50, "minLength": 1, "pattern": "[a-z0-9\\-]+", "type": "string" } }, "lock": { "$ref": "#/components/schemas/Core_IntentLockStatus" }, "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" }, "loginIds": { "type": "array", "items": { "$ref": "#/components/schemas/Core_LoginId" }, "description": "Domain-unique `loginId`-`loginProviderId` pairs. Must be specified for login and match pre-configured values." }, "type": { "enum": [ "v0_CreateUser" ], "type": "string" } } }, "Core_v0_CreateVault": { "required": [ "id", "alias", "publicKey", "lock", "customProperties", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "maxLength": 75, "minLength": 1, "type": "string" }, "parameters": { "$ref": "#/components/schemas/Core_VaultParameters" }, "publicKey": { "type": "string", "format": "base64" }, "lock": { "$ref": "#/components/schemas/Core_IntentLockStatus" }, "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" }, "type": { "enum": [ "v0_CreateVault" ], "type": "string" } } }, "Core_v0_ExecuteExtension": { "required": [ "payload", "type" ], "type": "object", "properties": { "payload": { "$ref": "#/components/schemas/Core_v0_ExecuteExtension_Payloads" }, "type": { "enum": [ "v0_ExecuteExtension" ], "type": "string" } } }, "Core_v0_LockAccount": { "required": [ "reference", "type" ], "type": "object", "properties": { "reference": { "$ref": "#/components/schemas/Core_EntityIdAndRevision" }, "type": { "enum": [ "v0_LockAccount" ], "type": "string" } } }, "Core_v0_LockDomain": { "required": [ "reference", "type" ], "type": "object", "properties": { "reference": { "$ref": "#/components/schemas/Core_EntityIdAndRevision" }, "type": { "enum": [ "v0_LockDomain" ], "type": "string" } } }, "Core_v0_LockEndpoint": { "required": [ "reference", "type" ], "type": "object", "properties": { "reference": { "$ref": "#/components/schemas/Core_EntityIdAndRevision" }, "type": { "enum": [ "v0_LockEndpoint" ], "type": "string" } } }, "Core_v0_LockPolicy": { "required": [ "reference", "type" ], "type": "object", "properties": { "reference": { "$ref": "#/components/schemas/Core_EntityIdAndRevision" }, "type": { "enum": [ "v0_LockPolicy" ], "type": "string" } } }, "Core_v0_LockTicker": { "required": [ "reference", "type" ], "type": "object", "properties": { "reference": { "$ref": "#/components/schemas/Core_EntityIdAndRevision" }, "type": { "enum": [ "v0_LockTicker" ], "type": "string" } } }, "Core_v0_LockUser": { "required": [ "reference", "type" ], "type": "object", "properties": { "reference": { "$ref": "#/components/schemas/Core_EntityIdAndRevision" }, "type": { "enum": [ "v0_LockUser" ], "type": "string" } } }, "Core_v0_LockVault": { "required": [ "reference", "type" ], "type": "object", "properties": { "reference": { "$ref": "#/components/schemas/Core_EntityIdAndRevision" }, "type": { "enum": [ "v0_LockVault" ], "type": "string" } } }, "Core_v0_MigrateSilo3AccountBatch": { "required": [ "vaultId", "wasColdSilo", "wasTestSilo", "accounts", "type" ], "type": "object", "properties": { "vaultId": { "type": "string", "format": "uuid" }, "wasColdSilo": { "type": "boolean" }, "wasTestSilo": { "type": "boolean" }, "accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Core_V3AccountToMigrate" } }, "type": { "enum": [ "v0_MigrateSilo3AccountBatch" ], "type": "string" } } }, "Core_v0_NotarizeData": { "required": [ "data", "type" ], "type": "object", "properties": { "data": { "maxLength": 10000, "minLength": 1, "type": "string" }, "type": { "enum": [ "v0_NotarizeData" ], "type": "string" } } }, "Core_v0_ReleaseQuarantinedTransfers": { "required": [ "accountId", "transferIds", "type" ], "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid" }, "transferIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "type": { "enum": [ "v0_ReleaseQuarantinedTransfers" ], "type": "string" } } }, "Core_v0_SetSystemProperty": { "required": [ "value", "type" ], "type": "object", "properties": { "revision": { "minimum": 1, "type": "integer", "format": "int64" }, "value": { "$ref": "#/components/schemas/Core_ReadWriteSystemPropertyKeyValue" }, "type": { "enum": [ "v0_SetSystemProperty" ], "type": "string" } } }, "Core_v0_SignManifest": { "required": [ "id", "accountId", "content", "customProperties", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "ledgerId": { "maxLength": 100, "minLength": 1, "type": "string" }, "content": { "$ref": "#/components/schemas/Core_ManifestContent" }, "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" }, "type": { "enum": [ "v0_SignManifest" ], "type": "string" } } }, "Core_v0_UnlockAccount": { "required": [ "reference", "type" ], "type": "object", "properties": { "reference": { "$ref": "#/components/schemas/Core_EntityIdAndRevision" }, "type": { "enum": [ "v0_UnlockAccount" ], "type": "string" } } }, "Core_v0_UnlockDomain": { "required": [ "reference", "type" ], "type": "object", "properties": { "reference": { "$ref": "#/components/schemas/Core_EntityIdAndRevision" }, "type": { "enum": [ "v0_UnlockDomain" ], "type": "string" } } }, "Core_v0_UnlockEndpoint": { "required": [ "reference", "type" ], "type": "object", "properties": { "reference": { "$ref": "#/components/schemas/Core_EntityIdAndRevision" }, "type": { "enum": [ "v0_UnlockEndpoint" ], "type": "string" } } }, "Core_v0_UnlockPolicy": { "required": [ "reference", "type" ], "type": "object", "properties": { "reference": { "$ref": "#/components/schemas/Core_EntityIdAndRevision" }, "type": { "enum": [ "v0_UnlockPolicy" ], "type": "string" } } }, "Core_v0_UnlockTicker": { "required": [ "reference", "type" ], "type": "object", "properties": { "reference": { "$ref": "#/components/schemas/Core_EntityIdAndRevision" }, "type": { "enum": [ "v0_UnlockTicker" ], "type": "string" } } }, "Core_v0_UnlockUser": { "required": [ "reference", "type" ], "type": "object", "properties": { "reference": { "$ref": "#/components/schemas/Core_EntityIdAndRevision" }, "type": { "enum": [ "v0_UnlockUser" ], "type": "string" } } }, "Core_v0_UnlockVault": { "required": [ "reference", "type" ], "type": "object", "properties": { "reference": { "$ref": "#/components/schemas/Core_EntityIdAndRevision" }, "type": { "enum": [ "v0_UnlockVault" ], "type": "string" } } }, "Core_v0_UpdateAccount": { "required": [ "reference", "alias", "customProperties", "type" ], "type": "object", "properties": { "reference": { "$ref": "#/components/schemas/Core_EntityIdAndRevision" }, "alias": { "maxLength": 75, "minLength": 1, "type": "string" }, "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" }, "type": { "enum": [ "v0_UpdateAccount" ], "type": "string" } } }, "Core_v0_UpdateDomain": { "required": [ "reference", "alias", "customProperties", "type" ], "type": "object", "properties": { "reference": { "$ref": "#/components/schemas/Core_EntityIdAndRevision" }, "alias": { "maxLength": 75, "minLength": 1, "type": "string" }, "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" }, "type": { "enum": [ "v0_UpdateDomain" ], "type": "string" } } }, "Core_v0_UpdateDomainPermissions": { "required": [ "reference", "permissions", "type" ], "type": "object", "properties": { "reference": { "$ref": "#/components/schemas/Core_EntityIdAndRevision" }, "permissions": { "$ref": "#/components/schemas/Core_Permissions" }, "type": { "enum": [ "v0_UpdateDomainPermissions" ], "type": "string" } } }, "Core_v0_UpdateEndpoint": { "required": [ "reference", "address", "trustScore", "alias", "customProperties", "type" ], "type": "object", "properties": { "reference": { "$ref": "#/components/schemas/Core_EntityIdAndRevision" }, "address": { "maxLength": 512, "minLength": 1, "type": "string" }, "trustScore": { "maximum": 100, "minimum": 0, "type": "integer", "format": "int32" }, "ledgerId": { "maxLength": 100, "minLength": 1, "type": "string", "deprecated": true }, "parameters": { "$ref": "#/components/schemas/Core_EndpointLedgerParameters" }, "alias": { "maxLength": 75, "minLength": 1, "type": "string" }, "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" }, "type": { "enum": [ "v0_UpdateEndpoint" ], "type": "string" } } }, "Core_v0_UpdateLedger": { "required": [ "reference", "alias", "parameters", "customProperties", "type" ], "type": "object", "properties": { "reference": { "$ref": "#/components/schemas/Core_EntityStringIdAndRevision" }, "alias": { "maxLength": 200, "minLength": 1, "type": "string" }, "parameters": { "$ref": "#/components/schemas/Core_LedgerParameters" }, "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" }, "type": { "enum": [ "v0_UpdateLedger" ], "type": "string" } } }, "Core_v0_UpdatePolicy": { "required": [ "reference", "alias", "rank", "scope", "scriptingEngine", "customProperties", "type" ], "type": "object", "properties": { "reference": { "$ref": "#/components/schemas/Core_EntityIdAndRevision" }, "alias": { "maxLength": 75, "minLength": 1, "type": "string" }, "rank": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" }, "intentTypes": { "type": "array", "items": { "$ref": "#/components/schemas/Core_IntentType" } }, "scope": { "$ref": "#/components/schemas/Core_PolicyScope" }, "scriptingEngine": { "$ref": "#/components/schemas/Core_ScriptingEngine" }, "condition": { "$ref": "#/components/schemas/Core_PolicyCondition" }, "workflow": { "type": "array", "items": { "$ref": "#/components/schemas/Core_WorkflowCondition" } }, "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" }, "type": { "enum": [ "v0_UpdatePolicy" ], "type": "string" } } }, "Core_v0_UpdateTicker": { "required": [ "reference", "name", "customProperties", "type" ], "type": "object", "properties": { "reference": { "$ref": "#/components/schemas/Core_EntityIdAndRevision" }, "name": { "maxLength": 100, "minLength": 1, "type": "string" }, "decimals": { "type": "integer", "format": "int32" }, "symbol": { "maxLength": 100, "minLength": 1, "type": "string" }, "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" }, "type": { "enum": [ "v0_UpdateTicker" ], "type": "string" } } }, "Core_v0_UpdateUser": { "required": [ "reference", "alias", "roles", "customProperties", "type" ], "type": "object", "properties": { "reference": { "$ref": "#/components/schemas/Core_EntityIdAndRevision" }, "alias": { "maxLength": 75, "minLength": 1, "type": "string" }, "roles": { "minItems": 1, "type": "array", "items": { "maxLength": 50, "minLength": 1, "pattern": "[a-z0-9\\-]+", "type": "string" } }, "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" }, "loginIds": { "type": "array", "items": { "$ref": "#/components/schemas/Core_LoginId" }, "description": "Domain-unique `loginId`-`loginProviderId` pairs. Must be specified for login and match pre-configured values." }, "type": { "enum": [ "v0_UpdateUser" ], "type": "string" } } }, "Core_v0_UpdateVault": { "required": [ "reference", "alias", "customProperties", "type" ], "type": "object", "properties": { "reference": { "$ref": "#/components/schemas/Core_EntityIdAndRevision" }, "alias": { "maxLength": 75, "minLength": 1, "type": "string" }, "parameters": { "$ref": "#/components/schemas/Core_VaultParameters" }, "description": { "maxLength": 250, "minLength": 0, "type": "string" }, "customProperties": { "$ref": "#/components/schemas/Core_StringsMap" }, "type": { "enum": [ "v0_UpdateVault" ], "type": "string" } } }, "Core_v0_ValidateTickers": { "required": [ "tickers", "type" ], "type": "object", "properties": { "tickers": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/Core_TickerToValidate" } }, "type": { "enum": [ "v0_ValidateTickers" ], "type": "string" } } }, "CoreExtensions_ErrorMessage": { "required": [ "message", "reason" ], "type": "object", "properties": { "reason": { "type": "string" }, "message": { "type": "string" } }, "additionalProperties": false }, "CoreExtensions_ErrorMessages": { "required": [ "additionalDetails", "message", "reason" ], "type": "object", "properties": { "reason": { "type": "string" }, "message": { "type": "string" }, "additionalDetails": { "type": "array", "items": { "$ref": "#/components/schemas/CoreExtensions_ErrorMessage" } } }, "additionalProperties": false }, "CoreExtensions_IntentLockStatus": { "enum": [ "Unlocked", "Locked" ], "type": "string" }, "CoreExtensions_InvitationAnswerIn": { "required": [ "publicKey" ], "type": "object", "properties": { "publicKey": { "type": "string" } }, "additionalProperties": false }, "CoreExtensions_InvitationIn": { "required": [ "numberSecondsOfValidity", "user" ], "type": "object", "properties": { "user": { "$ref": "#/components/schemas/CoreExtensions_UserEditIn" }, "numberSecondsOfValidity": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CoreExtensions_InvitationOut": { "required": [ "code", "id", "metadata", "status", "user", "validUntil" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "status": { "$ref": "#/components/schemas/CoreExtensions_InvitationStatus" }, "validUntil": { "type": "string", "format": "date-time" }, "user": { "$ref": "#/components/schemas/CoreExtensions_UserEditOut" }, "metadata": { "$ref": "#/components/schemas/CoreExtensions_Metadata" } }, "additionalProperties": false }, "CoreExtensions_InvitationPaginationResult": { "required": [ "count", "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CoreExtensions_InvitationOut" } }, "count": { "type": "integer", "format": "int32" }, "currentStartingAfter": { "type": "string", "format": "uuid", "nullable": true }, "nextStartingAfter": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "CoreExtensions_InvitationStatus": { "enum": [ "Pending", "DeviceRegistered", "Expired", "Cancelled", "Completed" ], "type": "string" }, "CoreExtensions_InvitationStatusQuery": { "enum": [ "Pending", "DeviceRegistered", "Expired", "Cancelled", "Completed", "Active" ], "type": "string" }, "CoreExtensions_Metadata": { "required": [ "createdAt", "createdBy", "lastModifiedAt" ], "type": "object", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "lastModifiedAt": { "type": "string", "format": "date-time" }, "createdBy": { "$ref": "#/components/schemas/CoreExtensions_UserReference" } }, "additionalProperties": false }, "CoreExtensions_PublicInvitationOut": { "required": [ "status", "user" ], "type": "object", "properties": { "user": { "$ref": "#/components/schemas/CoreExtensions_PublicUserInvitationOut" }, "status": { "$ref": "#/components/schemas/CoreExtensions_InvitationStatus" } }, "additionalProperties": false }, "CoreExtensions_PublicUserInvitationOut": { "required": [ "alias" ], "type": "object", "properties": { "alias": { "type": "string" } }, "additionalProperties": false }, "CoreExtensions_SortBy": { "enum": [ "Code", "ValidUntil", "CreatedAt", "LastModifiedAt", "Alias" ], "type": "string" }, "CoreExtensions_SortOrder": { "enum": [ "ASC", "DESC" ], "type": "string" }, "CoreExtensions_UserEditIn": { "required": [ "alias", "customProperties", "id", "lock", "roles" ], "type": "object", "properties": { "alias": { "type": "string" }, "customProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "description": { "type": "string", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "lock": { "$ref": "#/components/schemas/CoreExtensions_IntentLockStatus" }, "roles": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "CoreExtensions_UserEditOut": { "required": [ "alias", "customProperties", "domainId", "id", "lock", "roles" ], "type": "object", "properties": { "alias": { "type": "string" }, "customProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "description": { "type": "string", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "domainId": { "type": "string", "format": "uuid" }, "lock": { "$ref": "#/components/schemas/CoreExtensions_IntentLockStatus" }, "roles": { "type": "array", "items": { "type": "string" } }, "publicKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CoreExtensions_UserReference": { "required": [ "domainId", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "domainId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "Flows_AdressesOut": { "required": [ "address", "createdAt", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "address": { "type": "string", "readOnly": true }, "tag": { "type": "string", "nullable": true, "readOnly": true }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true } }, "additionalProperties": false }, "Flows_Author": { "required": [ "domainId", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "domainId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "Flows_BalanceOut": { "required": [ "decimals", "externalTickerName", "lastUpdatedAt", "totalAmount" ], "type": "object", "properties": { "tickerId": { "type": "string", "format": "uuid", "nullable": true }, "externalTickerName": { "type": "string" }, "totalAmount": { "type": "string" }, "decimals": { "type": "integer", "format": "int32" }, "lastUpdatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Flows_BinanceConnectionOut": { "required": [ "apiKey", "secret", "type" ], "type": "object", "properties": { "apiKey": { "minLength": 1, "type": "string" }, "secret": { "minLength": 1, "type": "string" }, "type": { "enum": [ "Binance" ], "type": "string" } }, "additionalProperties": false }, "Flows_BinanceConnectionParametersIn": { "required": [ "apiKey", "secret", "type" ], "type": "object", "properties": { "apiKey": { "minLength": 1, "type": "string" }, "secret": { "minLength": 1, "type": "string" }, "type": { "enum": [ "Binance" ], "type": "string" } }, "additionalProperties": false }, "Flows_BitstampConnectionOut": { "required": [ "apiKey", "secret", "type" ], "type": "object", "properties": { "apiKey": { "minLength": 1, "type": "string" }, "secret": { "minLength": 1, "type": "string" }, "type": { "enum": [ "Bitstamp" ], "type": "string" } }, "additionalProperties": false }, "Flows_BitstampConnectionParametersIn": { "required": [ "apiKey", "secret", "type" ], "type": "object", "properties": { "apiKey": { "minLength": 1, "type": "string" }, "secret": { "minLength": 1, "type": "string" }, "type": { "enum": [ "Bitstamp" ], "type": "string" } }, "additionalProperties": false }, "Flows_CoinbaseProConnectionOut": { "required": [ "apiKey", "password", "secret", "type" ], "type": "object", "properties": { "apiKey": { "minLength": 1, "type": "string" }, "secret": { "minLength": 1, "type": "string" }, "password": { "minLength": 1, "type": "string" }, "type": { "enum": [ "Coinbasepro" ], "type": "string" } }, "additionalProperties": false }, "Flows_CoinbaseProConnectionParametersIn": { "required": [ "apiKey", "password", "secret", "type" ], "type": "object", "properties": { "apiKey": { "minLength": 1, "type": "string" }, "secret": { "minLength": 1, "type": "string" }, "password": { "minLength": 1, "type": "string" }, "type": { "enum": [ "Coinbasepro" ], "type": "string" } }, "additionalProperties": false }, "Flows_ConnectionOutParameters": { "required": [ "type" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/Flows_KrakenConnectionOut" }, { "$ref": "#/components/schemas/Flows_BinanceConnectionOut" }, { "$ref": "#/components/schemas/Flows_CoinbaseProConnectionOut" }, { "$ref": "#/components/schemas/Flows_BitstampConnectionOut" } ], "additionalProperties": false, "discriminator": { "propertyName": "type", "mapping": { "Kraken": "#/components/schemas/Flows_KrakenConnectionOut", "Binance": "#/components/schemas/Flows_BinanceConnectionOut", "Coinbasepro": "#/components/schemas/Flows_CoinbaseProConnectionOut", "Bitstamp": "#/components/schemas/Flows_BitstampConnectionOut" } } }, "Flows_ConnectionState": { "enum": [ "Connected", "Disconnected", "ConnectionError", "InvalidConnection" ], "type": "string" }, "Flows_ConnectionType": { "enum": [ "Kraken", "Binance", "Bitstamp", "Coinbasepro" ], "type": "string" }, "Flows_ExternalAccountOut": { "required": [ "alias", "id", "metadata", "providerDetails" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "type": "string" }, "ledgerId": { "type": "string", "nullable": true }, "providerDetails": { "$ref": "#/components/schemas/Flows_ProviderDetails" }, "metadata": { "$ref": "#/components/schemas/Flows_MetadataOut" } }, "additionalProperties": false }, "Flows_ExternalAccountSortBy": { "enum": [ "id", "alias", "createdAt", "lastModifiedAt" ], "type": "string" }, "Flows_FlowsTransactionOrderType": { "enum": [ "Transfer", "Trade" ], "type": "string" }, "Flows_GuidNullableAdressesOutPaginationResult": { "required": [ "count", "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Flows_AdressesOut" } }, "count": { "type": "integer", "format": "int32" }, "currentStartingAfter": { "type": "string", "format": "uuid", "nullable": true }, "nextStartingAfter": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "Flows_GuidNullableExternalAccountOutPaginationResult": { "required": [ "count", "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Flows_ExternalAccountOut" } }, "count": { "type": "integer", "format": "int32" }, "currentStartingAfter": { "type": "string", "format": "uuid", "nullable": true }, "nextStartingAfter": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "Flows_GuidNullableTransactionOrderOutPaginationResult": { "required": [ "count", "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Flows_TransactionOrderOut" } }, "count": { "type": "integer", "format": "int32" }, "currentStartingAfter": { "type": "string", "format": "uuid", "nullable": true }, "nextStartingAfter": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "Flows_GuidNullableTransferOutPaginationResult": { "required": [ "count", "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Flows_TransferOut" } }, "count": { "type": "integer", "format": "int32" }, "currentStartingAfter": { "type": "string", "format": "uuid", "nullable": true }, "nextStartingAfter": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "Flows_KrakenConnectionOut": { "required": [ "apiKey", "secret", "type" ], "type": "object", "properties": { "apiKey": { "minLength": 1, "type": "string" }, "secret": { "minLength": 1, "type": "string" }, "type": { "enum": [ "Kraken" ], "type": "string" } }, "additionalProperties": false }, "Flows_KrakenConnectionParametersIn": { "required": [ "apiKey", "secret", "type" ], "type": "object", "properties": { "apiKey": { "minLength": 1, "type": "string" }, "secret": { "minLength": 1, "type": "string" }, "type": { "enum": [ "Kraken" ], "type": "string" } }, "additionalProperties": false }, "Flows_MetadataOut": { "required": [ "createdAt", "createdBy", "lastModifiedAt", "lastModifiedBy" ], "type": "object", "properties": { "description": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "$ref": "#/components/schemas/Flows_Author" }, "lastModifiedAt": { "type": "string", "format": "date-time" }, "lastModifiedBy": { "$ref": "#/components/schemas/Flows_Author" }, "customProperties": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Flows_OrderOutSortBy": { "enum": [ "id", "externalAccountId", "createdAt", "lastModifiedAt" ], "type": "string" }, "Flows_OrderStatus": { "enum": [ "Failed", "Pending", "Processing", "Completed" ], "type": "string" }, "Flows_PairOut": { "required": [ "baseExternalTickerName", "basePrecision", "externalPairName", "quoteExternalTickerName", "quotePrecision" ], "type": "object", "properties": { "externalPairName": { "type": "string", "readOnly": true }, "baseExternalTickerName": { "type": "string", "readOnly": true }, "quoteExternalTickerName": { "type": "string", "readOnly": true }, "basePrecision": { "type": "integer", "format": "int32", "readOnly": true }, "quotePrecision": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "Flows_PairPriceOut": { "required": [ "baseExternalTickerName", "estimatedPrice", "lastUpdatedAt", "quoteExternalTickerName" ], "type": "object", "properties": { "baseExternalTickerName": { "type": "string" }, "quoteExternalTickerName": { "type": "string" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "estimatedPrice": { "type": "string" } }, "additionalProperties": false }, "Flows_Processing": { "required": [ "hint", "status" ], "type": "object", "properties": { "hint": { "type": "string" }, "status": { "$ref": "#/components/schemas/Flows_OrderStatus" } }, "additionalProperties": false }, "Flows_ProviderConnectionOut": { "required": [ "alias", "connectionState", "domainId", "id", "parameters" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "domainId": { "type": "string", "format": "uuid", "readOnly": true }, "alias": { "type": "string", "readOnly": true }, "parameters": { "$ref": "#/components/schemas/Flows_ConnectionOutParameters" }, "connectionState": { "$ref": "#/components/schemas/Flows_ConnectionState" } }, "additionalProperties": false }, "Flows_ProviderConnectionParametersIn": { "required": [ "type" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/Flows_KrakenConnectionParametersIn" }, { "$ref": "#/components/schemas/Flows_BinanceConnectionParametersIn" }, { "$ref": "#/components/schemas/Flows_CoinbaseProConnectionParametersIn" }, { "$ref": "#/components/schemas/Flows_BitstampConnectionParametersIn" } ], "additionalProperties": false, "discriminator": { "propertyName": "type", "mapping": { "Kraken": "#/components/schemas/Flows_KrakenConnectionParametersIn", "Binance": "#/components/schemas/Flows_BinanceConnectionParametersIn", "Coinbasepro": "#/components/schemas/Flows_CoinbaseProConnectionParametersIn", "Bitstamp": "#/components/schemas/Flows_BitstampConnectionParametersIn" } } }, "Flows_ProviderConnectionParametersInCreateProviderConnectionIn": { "required": [ "alias", "domainId", "parameters" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true }, "domainId": { "type": "string", "format": "uuid" }, "alias": { "minLength": 1, "type": "string" }, "parameters": { "$ref": "#/components/schemas/Flows_ProviderConnectionParametersIn" } }, "additionalProperties": false }, "Flows_ProviderConnectionParametersInUpdateProviderConnectionIn": { "required": [ "alias", "parameters" ], "type": "object", "properties": { "alias": { "type": "string" }, "parameters": { "$ref": "#/components/schemas/Flows_ProviderConnectionParametersIn" } }, "additionalProperties": false }, "Flows_ProviderDetails": { "required": [ "connectionId", "externalId", "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Flows_ProviderType" }, "externalId": { "type": "string" }, "connectionId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "Flows_ProviderType": { "enum": [ "Flows" ], "type": "string" }, "Flows_SortOrder": { "enum": [ "ASC", "DESC" ], "type": "string" }, "Flows_TradeDirection": { "enum": [ "Buy", "Sell" ], "type": "string" }, "Flows_TransactionDestinationType": { "enum": [ "Account", "Endpoint", "Address", "ExternalAccount" ], "type": "string" }, "Flows_TransactionDryRunEstimate": { "required": [ "externalTickerName", "fee", "minimum" ], "type": "object", "properties": { "fee": { "type": "string" }, "minimum": { "type": "string" }, "externalTickerName": { "type": "string" } }, "additionalProperties": false }, "Flows_TransactionDryRunOut": { "required": [ "estimate", "result" ], "type": "object", "properties": { "result": { "$ref": "#/components/schemas/Flows_TransactionDryRunResult" }, "estimate": { "$ref": "#/components/schemas/Flows_TransactionDryRunEstimate" } }, "additionalProperties": false }, "Flows_TransactionDryRunOutType": { "enum": [ "Success", "Failure" ], "type": "string" }, "Flows_TransactionDryRunParameters": { "required": [ "type" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/Flows_TransactionDryRunTransferInParameters" }, { "$ref": "#/components/schemas/Flows_TransactionDryRunTradeInParameters" } ], "additionalProperties": false, "discriminator": { "propertyName": "type", "mapping": { "Transfer": "#/components/schemas/Flows_TransactionDryRunTransferInParameters", "Trade": "#/components/schemas/Flows_TransactionDryRunTradeInParameters" } } }, "Flows_TransactionDryRunParametersTransactionDryRunIn": { "required": [ "externalAccountId", "parameters" ], "type": "object", "properties": { "externalAccountId": { "type": "string", "format": "uuid" }, "parameters": { "$ref": "#/components/schemas/Flows_TransactionDryRunParameters" } }, "additionalProperties": false }, "Flows_TransactionDryRunResult": { "required": [ "hint", "type" ], "type": "object", "properties": { "hint": { "type": "string" }, "type": { "$ref": "#/components/schemas/Flows_TransactionDryRunOutType" } }, "additionalProperties": false }, "Flows_TransactionDryRunTradeInParameters": { "required": [ "baseExternalTickerName", "direction", "quantity", "quoteExternalTickerName", "type" ], "type": "object", "properties": { "baseExternalTickerName": { "minLength": 1, "type": "string" }, "quoteExternalTickerName": { "minLength": 1, "type": "string" }, "quantity": { "minLength": 1, "type": "string" }, "direction": { "$ref": "#/components/schemas/Flows_TradeDirection" }, "type": { "enum": [ "Trade" ], "type": "string" } }, "additionalProperties": false }, "Flows_TransactionDryRunTransferInParameters": { "required": [ "amount", "destination", "externalTickerName", "type" ], "type": "object", "properties": { "externalTickerName": { "minLength": 1, "type": "string" }, "amount": { "minLength": 1, "type": "string" }, "destination": { "$ref": "#/components/schemas/Flows_TransactionOrderDestinationInOut" }, "type": { "enum": [ "Transfer" ], "type": "string" } }, "additionalProperties": false }, "Flows_TransactionDryRunType": { "enum": [ "Transfer", "Trade" ], "type": "string" }, "Flows_TransactionKind": { "enum": [ "Fee", "Transfer", "Trade" ], "type": "string" }, "Flows_TransactionOrderAccountDestination": { "required": [ "accountId", "type" ], "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid" }, "tag": { "type": "string", "nullable": true }, "type": { "enum": [ "Account" ], "type": "string" } }, "additionalProperties": false }, "Flows_TransactionOrderAddressDestination": { "required": [ "address", "type" ], "type": "object", "properties": { "address": { "minLength": 1, "type": "string" }, "tag": { "type": "string", "nullable": true }, "type": { "enum": [ "Address" ], "type": "string" } }, "additionalProperties": false }, "Flows_TransactionOrderDestinationInOut": { "required": [ "type" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/Flows_TransactionOrderAccountDestination" }, { "$ref": "#/components/schemas/Flows_TransactionOrderEndpointDestination" }, { "$ref": "#/components/schemas/Flows_TransactionOrderAddressDestination" }, { "$ref": "#/components/schemas/Flows_TransactionOrderExternalAccountDestination" } ], "properties": { "tag": { "type": "string", "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "type", "mapping": { "Account": "#/components/schemas/Flows_TransactionOrderAccountDestination", "Endpoint": "#/components/schemas/Flows_TransactionOrderEndpointDestination", "Address": "#/components/schemas/Flows_TransactionOrderAddressDestination", "ExternalAccount": "#/components/schemas/Flows_TransactionOrderExternalAccountDestination" } } }, "Flows_TransactionOrderEndpointDestination": { "required": [ "endpointId", "type" ], "type": "object", "properties": { "endpointId": { "type": "string", "format": "uuid" }, "tag": { "type": "string", "nullable": true }, "type": { "enum": [ "Endpoint" ], "type": "string" } }, "additionalProperties": false }, "Flows_TransactionOrderExternalAccountDestination": { "required": [ "externalAccountId", "type" ], "type": "object", "properties": { "externalAccountId": { "type": "string", "format": "uuid" }, "tag": { "type": "string", "nullable": true }, "type": { "enum": [ "ExternalAccount" ], "type": "string" } }, "additionalProperties": false }, "Flows_TransactionOrderOut": { "required": [ "domainId", "externalAccountId", "id", "metadata", "parameters", "processing" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "domainId": { "type": "string", "format": "uuid" }, "externalAccountId": { "type": "string", "format": "uuid" }, "parameters": { "$ref": "#/components/schemas/Flows_TransactionOrderParametersOut" }, "metadata": { "$ref": "#/components/schemas/Flows_MetadataOut" }, "processing": { "$ref": "#/components/schemas/Flows_Processing" } }, "additionalProperties": false }, "Flows_TransactionOrderParametersOut": { "required": [ "type" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/Flows_TransactionTransferOrderParametersOut" }, { "$ref": "#/components/schemas/Flows_TransactionTradeOrderParametersOut" } ], "additionalProperties": false, "discriminator": { "propertyName": "type", "mapping": { "Transfer": "#/components/schemas/Flows_TransactionTransferOrderParametersOut", "Trade": "#/components/schemas/Flows_TransactionTradeOrderParametersOut" } } }, "Flows_TransactionOutSortBy": { "enum": [ "id", "registeredAt" ], "type": "string" }, "Flows_TransactionTradeOrderParametersOut": { "required": [ "baseExternalTickerName", "direction", "quantity", "quoteExternalTickerName", "type" ], "type": "object", "properties": { "baseExternalTickerName": { "minLength": 1, "type": "string" }, "quoteExternalTickerName": { "minLength": 1, "type": "string" }, "direction": { "$ref": "#/components/schemas/Flows_TradeDirection" }, "quantity": { "minLength": 1, "type": "string" }, "price": { "type": "string", "nullable": true }, "cost": { "type": "string", "nullable": true }, "type": { "enum": [ "Trade" ], "type": "string" } }, "additionalProperties": false }, "Flows_TransactionTransferOrderParametersOut": { "required": [ "amount", "destination", "externalTickerName", "type" ], "type": "object", "properties": { "amount": { "minLength": 1, "type": "string" }, "externalTickerName": { "minLength": 1, "type": "string" }, "destination": { "$ref": "#/components/schemas/Flows_TransactionOrderDestinationInOut" }, "type": { "enum": [ "Transfer" ], "type": "string" } }, "additionalProperties": false }, "Flows_TransferOut": { "required": [ "externalTickerName", "id", "kind", "registeredAt", "value" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "transactionOrderId": { "type": "string", "format": "uuid", "nullable": true }, "ledgerTransactionId": { "type": "string", "nullable": true }, "senders": { "type": "array", "items": { "$ref": "#/components/schemas/Flows_TransactionOrderDestinationInOut" }, "nullable": true }, "recipient": { "$ref": "#/components/schemas/Flows_TransactionOrderDestinationInOut" }, "value": { "type": "string" }, "registeredAt": { "type": "string", "format": "date-time" }, "kind": { "$ref": "#/components/schemas/Flows_TransactionKind" }, "externalTickerName": { "type": "string" } }, "additionalProperties": false }, "VirtualAccounting_Actor": { "required": [ "type" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/VirtualAccounting_ActorAddress" }, { "$ref": "#/components/schemas/VirtualAccounting_ActorVirtualAccount" } ], "additionalProperties": false, "discriminator": { "propertyName": "type", "mapping": { "Address": "#/components/schemas/VirtualAccounting_ActorAddress", "VirtualAccount": "#/components/schemas/VirtualAccounting_ActorVirtualAccount" } } }, "VirtualAccounting_ActorAddress": { "required": [ "type" ], "properties": { "address": { "minLength": 1, "type": "string" }, "type": { "enum": [ "Address" ], "type": "string" } } }, "VirtualAccounting_ActorType": { "enum": [ "Address", "VirtualAccount" ], "type": "string" }, "VirtualAccounting_ActorVirtualAccount": { "required": [ "type" ], "properties": { "virtualAccountId": { "type": "string", "format": "uuid" }, "virtualLedgerId": { "type": "string", "format": "uuid" }, "type": { "enum": [ "VirtualAccount" ], "type": "string" } } }, "VirtualAccounting_Balance": { "required": [ "amount", "reserved", "tickerId" ], "type": "object", "properties": { "tickerId": { "type": "string", "format": "uuid" }, "amount": { "type": "string" }, "reserved": { "type": "string" } }, "additionalProperties": false }, "VirtualAccounting_BalanceCollectionResponse": { "required": [ "count", "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/VirtualAccounting_Balance" } }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "VirtualAccounting_CustodyAccountDepositIdentificationSourceIn": { "required": [ "type" ], "properties": { "id": { "type": "string", "format": "uuid" }, "provisioningStrategy": { "$ref": "#/components/schemas/VirtualAccounting_ProvisioningStrategyBase" }, "type": { "enum": [ "CustodyAccount" ], "type": "string" } } }, "VirtualAccounting_CustodyAccountExclusionList": { "required": [ "exclusionReason", "type" ], "properties": { "exclusionReason": { "minLength": 1, "type": "string" }, "custodyAccountId": { "type": "string", "format": "uuid" }, "custodyDomainId": { "type": "string", "format": "uuid" }, "type": { "enum": [ "CustodyAccount" ], "type": "string" } } }, "VirtualAccounting_CustodyOperation": { "required": [ "domainId", "transactionOrderId" ], "type": "object", "properties": { "transactionOrderId": { "type": "string", "format": "uuid" }, "domainId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "VirtualAccounting_DepositIdentificationSourceBase": { "required": [ "type" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/VirtualAccounting_DepositIdentificationSourceCustodyAccount" } ], "additionalProperties": false, "discriminator": { "propertyName": "type", "mapping": { "CustodyAccount": "#/components/schemas/VirtualAccounting_DepositIdentificationSourceCustodyAccount" } } }, "VirtualAccounting_DepositIdentificationSourceBaseIn": { "required": [ "type" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/VirtualAccounting_CustodyAccountDepositIdentificationSourceIn" } ], "additionalProperties": false, "discriminator": { "propertyName": "type", "mapping": { "CustodyAccount": "#/components/schemas/VirtualAccounting_CustodyAccountDepositIdentificationSourceIn" } } }, "VirtualAccounting_DepositIdentificationSourceCustodyAccount": { "required": [ "type" ], "properties": { "id": { "type": "string", "format": "uuid" }, "custodyAccountId": { "type": "string", "format": "uuid" }, "custodyDomainId": { "type": "string", "format": "uuid" }, "status": { "$ref": "#/components/schemas/VirtualAccounting_DepositIdentificationSourceStatus" }, "type": { "enum": [ "CustodyAccount" ], "type": "string" } } }, "VirtualAccounting_DepositIdentificationSourceStatus": { "enum": [ "Active", "Pending", "Inactive" ], "type": "string" }, "VirtualAccounting_DepositIdentificationSourceType": { "enum": [ "CustodyAccount" ], "type": "string" }, "VirtualAccounting_DepositIdentificationStrategy": { "enum": [ "MaximizeSegregation", "MinimizeSegregation" ], "type": "string" }, "VirtualAccounting_DepositIdentificationStrategyBase": { "required": [ "type" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/VirtualAccounting_MaximizeSegregationDepositStrategy" } ], "additionalProperties": false, "discriminator": { "propertyName": "type", "mapping": { "MaximizeSegregation": "#/components/schemas/VirtualAccounting_MaximizeSegregationDepositStrategy" } } }, "VirtualAccounting_ExclusionList": { "required": [ "exclusionReason", "type" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/VirtualAccounting_CustodyAccountExclusionList" } ], "properties": { "exclusionReason": { "minLength": 1, "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "type", "mapping": { "CustodyAccount": "#/components/schemas/VirtualAccounting_CustodyAccountExclusionList" } } }, "VirtualAccounting_ExclusionType": { "enum": [ "CustodyAccount" ], "type": "string" }, "VirtualAccounting_LedgerAddress": { "required": [ "address", "createdAt", "custodyAccountId", "custodyDomainId", "id", "ledgerId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "address": { "type": "string" }, "ledgerId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "custodyAccountId": { "type": "string", "format": "uuid" }, "custodyDomainId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "VirtualAccounting_LedgerAddressPagedCollectionResponse": { "required": [ "count", "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/VirtualAccounting_LedgerAddress" } }, "count": { "type": "integer", "format": "int32" }, "currentStartingAfter": { "type": "string", "format": "uuid", "nullable": true }, "nextStartingAfter": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "VirtualAccounting_MaximizeSegregationDepositStrategy": { "required": [ "type" ], "properties": { "type": { "enum": [ "MaximizeSegregation" ], "type": "string" } } }, "VirtualAccounting_NewProvisioningStrategy": { "required": [ "type" ], "properties": { "type": { "enum": [ "New" ], "type": "string" } } }, "VirtualAccounting_OperationIn": { "required": [ "id", "request" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "request": { "$ref": "#/components/schemas/VirtualAccounting_OperationPayload" } }, "additionalProperties": false }, "VirtualAccounting_OperationOut": { "required": [ "id", "request", "status" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "request": { "$ref": "#/components/schemas/VirtualAccounting_OperationPayload" }, "status": { "$ref": "#/components/schemas/VirtualAccounting_OperationStatus" }, "custodyOperation": { "$ref": "#/components/schemas/VirtualAccounting_CustodyOperation" } }, "additionalProperties": false }, "VirtualAccounting_OperationOutPagedCollectionResponse": { "required": [ "count", "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/VirtualAccounting_OperationOut" } }, "count": { "type": "integer", "format": "int32" }, "currentStartingAfter": { "type": "string", "format": "uuid", "nullable": true }, "nextStartingAfter": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "VirtualAccounting_OperationPayload": { "required": [ "id", "type" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/VirtualAccounting_OperationTransfer" } ], "properties": { "id": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "discriminator": { "propertyName": "type", "mapping": { "Transfer": "#/components/schemas/VirtualAccounting_OperationTransfer" } } }, "VirtualAccounting_OperationSortBy": { "enum": [ "Id", "Status" ], "type": "string" }, "VirtualAccounting_OperationStatus": { "enum": [ "Pending", "Completed", "Failed" ], "type": "string" }, "VirtualAccounting_OperationTransfer": { "required": [ "id", "type" ], "properties": { "id": { "type": "string", "format": "uuid" }, "virtualAccountId": { "type": "string", "format": "uuid" }, "tickerId": { "type": "string", "format": "uuid" }, "destination": { "$ref": "#/components/schemas/VirtualAccounting_Actor" }, "amount": { "minLength": 1, "pattern": "^\\d+$", "type": "string" }, "description": { "type": "string" }, "customProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "type": { "enum": [ "Transfer" ], "type": "string" } } }, "VirtualAccounting_OperationType": { "enum": [ "Transfer" ], "type": "string" }, "VirtualAccounting_ProvisioningStrategyBase": { "required": [ "type" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/VirtualAccounting_NewProvisioningStrategy" } ], "additionalProperties": false, "discriminator": { "propertyName": "type", "mapping": { "New": "#/components/schemas/VirtualAccounting_NewProvisioningStrategy" } } }, "VirtualAccounting_ProvisioningStrategyType": { "enum": [ "New" ], "type": "string" }, "VirtualAccounting_SortOrder": { "enum": [ "ASC", "DESC" ], "type": "string" }, "VirtualAccounting_Transfer": { "required": [ "id", "kind", "status" ], "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "$ref": "#/components/schemas/VirtualAccounting_TransferStatus" }, "operationId": { "type": "string", "format": "uuid", "nullable": true }, "custodyTransferId": { "type": "string", "format": "uuid", "nullable": true }, "tickerId": { "type": "string", "format": "uuid" }, "senders": { "type": "array", "items": { "$ref": "#/components/schemas/VirtualAccounting_Actor" } }, "recipient": { "$ref": "#/components/schemas/VirtualAccounting_Actor" }, "amount": { "type": "string" }, "registeredAt": { "type": "string", "format": "date-time" }, "kind": { "enum": [ "Transfer" ], "type": "string" } } }, "VirtualAccounting_TransferBase": { "required": [ "id", "kind", "status" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/VirtualAccounting_Transfer" } ], "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "$ref": "#/components/schemas/VirtualAccounting_TransferStatus" } }, "additionalProperties": false, "discriminator": { "propertyName": "kind", "mapping": { "Transfer": "#/components/schemas/VirtualAccounting_Transfer" } } }, "VirtualAccounting_TransferBasePagedCollectionResponse": { "required": [ "count", "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/VirtualAccounting_TransferBase" } }, "count": { "type": "integer", "format": "int32" }, "currentStartingAfter": { "type": "string", "format": "uuid", "nullable": true }, "nextStartingAfter": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "VirtualAccounting_TransferKind": { "enum": [ "Transfer" ], "type": "string" }, "VirtualAccounting_TransferSortBy": { "enum": [ "Id", "TickerId", "Status", "RegisteredAt" ], "type": "string" }, "VirtualAccounting_TransferStatus": { "enum": [ "None", "Pending", "Failed", "Completed" ], "type": "string" }, "VirtualAccounting_VaMetadata": { "required": [ "createdAt", "customProperties", "description", "lastModifiedAt" ], "type": "object", "properties": { "description": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "lastModifiedAt": { "type": "string", "format": "date-time" }, "customProperties": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "VirtualAccounting_VirtualAccountIn": { "required": [ "alias", "customProperties", "description", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "minLength": 1, "type": "string" }, "description": { "type": "string" }, "customProperties": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "VirtualAccounting_VirtualAccountOut": { "required": [ "alias", "depositIdentificationSource", "id", "metadata" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "minLength": 1, "type": "string" }, "depositIdentificationSource": { "type": "array", "items": { "$ref": "#/components/schemas/VirtualAccounting_DepositIdentificationSourceBase" } }, "metadata": { "$ref": "#/components/schemas/VirtualAccounting_VaMetadata" } }, "additionalProperties": false }, "VirtualAccounting_VirtualAccountOutPagedCollectionResponse": { "required": [ "count", "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/VirtualAccounting_VirtualAccountOut" } }, "count": { "type": "integer", "format": "int32" }, "currentStartingAfter": { "type": "string", "format": "uuid", "nullable": true }, "nextStartingAfter": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "VirtualAccounting_VirtualAccountSortBy": { "enum": [ "Id", "Alias", "VirtualLedgerId", "CreatedAt", "LastUpdatedAt" ], "type": "string" }, "VirtualAccounting_VirtualAccountUpdate": { "required": [ "alias", "customProperties", "description" ], "type": "object", "properties": { "alias": { "minLength": 1, "type": "string" }, "description": { "type": "string" }, "customProperties": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "VirtualAccounting_VirtualLedgerIn": { "required": [ "alias", "customProperties", "depositIdentificationStrategy", "description", "exclusionList", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "minLength": 1, "type": "string" }, "depositIdentificationStrategy": { "$ref": "#/components/schemas/VirtualAccounting_DepositIdentificationStrategyBase" }, "exclusionList": { "type": "array", "items": { "$ref": "#/components/schemas/VirtualAccounting_ExclusionList" } }, "description": { "type": "string" }, "customProperties": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "VirtualAccounting_VirtualLedgerOut": { "required": [ "alias", "depositIdentificationStrategy", "exclusionList", "id", "metadata" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "minLength": 1, "type": "string" }, "depositIdentificationStrategy": { "$ref": "#/components/schemas/VirtualAccounting_DepositIdentificationStrategyBase" }, "exclusionList": { "type": "array", "items": { "$ref": "#/components/schemas/VirtualAccounting_ExclusionList" } }, "metadata": { "$ref": "#/components/schemas/VirtualAccounting_VaMetadata" } }, "additionalProperties": false }, "VirtualAccounting_VirtualLedgerOutPagedCollectionResponse": { "required": [ "count", "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/VirtualAccounting_VirtualLedgerOut" } }, "count": { "type": "integer", "format": "int32" }, "currentStartingAfter": { "type": "string", "format": "uuid", "nullable": true }, "nextStartingAfter": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "VirtualAccounting_VirtualLedgerSortBy": { "enum": [ "Id", "Alias", "CreatedAt", "LastUpdatedAt" ], "type": "string" }, "VirtualAccounting_VirtualLedgerUpdate": { "required": [ "alias", "customProperties", "description", "exclusionList" ], "type": "object", "properties": { "alias": { "minLength": 1, "type": "string" }, "exclusionList": { "type": "array", "items": { "$ref": "#/components/schemas/VirtualAccounting_ExclusionList" } }, "description": { "type": "string" }, "customProperties": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "Compliance_ErrorResponse": { "required": [ "reason" ], "type": "object", "properties": { "reason": { "type": "string" }, "message": { "type": "string" } } }, "Compliance_ProviderConnectionResponse": { "type": "object", "properties": { "connectionId": { "type": "string", "format": "uuid" }, "provider": { "enum": [ "ELLIPTIC", "CHAINALYSIS" ], "type": "string" }, "status": { "enum": [ "CONNECTED", "PAUSED" ], "type": "string" }, "readyForScreening": { "type": "boolean" }, "previewScreeningEnabled": { "type": "boolean" } } }, "Compliance_Credential": { "required": [ "apiKey" ], "type": "object", "properties": { "apiKey": { "type": "string" }, "apiSecret": { "type": "string" } } }, "Compliance_ProviderConnectRequest": { "required": [ "provider" ], "type": "object", "properties": { "provider": { "enum": [ "ELLIPTIC", "CHAINALYSIS" ], "type": "string" }, "credential": { "$ref": "#/components/schemas/Compliance_Credential" } } }, "Compliance_ConfigureScreeningRulesRequest": { "required": [ "rules" ], "type": "object", "properties": { "rules": { "type": "array", "items": { "$ref": "#/components/schemas/Compliance_TransactionScreeningRule" } } } }, "Compliance_RiskLevelAction": { "required": [ "action" ], "type": "object", "properties": { "condition": { "enum": [ "EQUALS", "GREATER_THAN", "LESS_THAN", "GREATER_THAN_OR_EQUALS", "LESS_THAN_OR_EQUALS" ], "type": "string" }, "threshold": { "type": "number" }, "action": { "enum": [ "APPROVE", "REJECT", "REQUIRE_EXPLICIT_DECISION" ], "type": "string" } } }, "Compliance_TransactionScreeningRule": { "required": [ "highRisk", "lowRisk", "transactionType" ], "type": "object", "properties": { "transactionType": { "enum": [ "INCOMING", "OUTGOING" ], "type": "string" }, "lowRisk": { "$ref": "#/components/schemas/Compliance_RiskLevelAction" }, "highRisk": { "$ref": "#/components/schemas/Compliance_RiskLevelAction" }, "mediumRisk": { "$ref": "#/components/schemas/Compliance_RiskLevelAction" }, "severeRisk": { "$ref": "#/components/schemas/Compliance_RiskLevelAction" }, "unknownRisk": { "$ref": "#/components/schemas/Compliance_RiskLevelAction" }, "unknownCategory": { "$ref": "#/components/schemas/Compliance_RiskLevelAction" } } }, "Compliance_PolicyPayloadRequest": { "required": [ "lockStatus", "policyType", "transactionType" ], "type": "object", "properties": { "policyType": { "enum": [ "AUTOMATIC", "EXCEPTION" ], "type": "string" }, "transactionType": { "enum": [ "INCOMING", "OUTGOING" ], "type": "string" }, "approvalWorkflow": { "type": "object", "additionalProperties": { "type": "object" } }, "exceptionRole": { "type": "string" }, "lockStatus": { "enum": [ "Locked", "Unlocked", "Archived" ], "type": "string" } } }, "Compliance_DomainPayloadRequest": { "required": [ "domainName", "domainType", "permissions" ], "type": "object", "properties": { "domainName": { "type": "string" }, "domainType": { "enum": [ "COMPLIANCE", "BUSINESS" ], "type": "string" }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/Compliance_User" } }, "permissions": { "type": "object", "additionalProperties": { "type": "object" } }, "childrenDomainIds": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" } }, "additionalPolicies": { "type": "array", "items": { "enum": [ "ADD_POLICY_FOR_OUTGOING_ORDERS", "ADD_POLICY_FOR_AUTOMATIC_RELEASE_QUARANTINED_TRANSFERS" ], "type": "string" } } } }, "Compliance_LoginId": { "required": [ "id", "providerId" ], "type": "object", "properties": { "providerId": { "type": "string" }, "id": { "type": "string" } } }, "Compliance_User": { "required": [ "alias", "id", "lockStatus", "roles" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "alias": { "type": "string" }, "publicKey": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } }, "lockStatus": { "enum": [ "Locked", "Unlocked", "Archived" ], "type": "string" }, "loginIds": { "type": "array", "items": { "$ref": "#/components/schemas/Compliance_LoginId" } } } }, "Compliance_ValidateComplianceDomainCreationRequest": { "type": "object", "properties": { "childrenDomainIds": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "Compliance_ValidateComplianceDomainCreationResponse": { "type": "object", "properties": { "allowed": { "type": "boolean" }, "reason": { "type": "string" } } }, "Compliance_ComplianceAnalysisRequest": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Compliance_ComplianceAnalysisRequestData" } } } }, "Compliance_ComplianceAnalysisRequestData": { "type": "object", "properties": { "domainId": { "type": "string", "format": "uuid" }, "id": { "type": "string", "format": "uuid" } } }, "Compliance_ComplianceAnalysis": { "required": [ "analysisType", "ledgerId", "provider", "screeningStatus" ], "type": "object", "properties": { "provider": { "enum": [ "ELLIPTIC", "CHAINALYSIS" ], "type": "string" }, "id": { "type": "string", "format": "uuid" }, "domainId": { "type": "string", "format": "uuid" }, "intentId": { "type": "string", "format": "uuid" }, "transferId": { "type": "string", "format": "uuid" }, "transactionOrderId": { "type": "string", "format": "uuid" }, "transactionHash": { "type": "string" }, "addressHash": { "type": "string" }, "errorDetails": { "type": "string" }, "warningDetails": { "type": "string" }, "screenedAt": { "type": "string", "format": "date-time" }, "ledgerId": { "type": "string" }, "analysisType": { "enum": [ "WALLET", "TRANSACTION" ], "type": "string" }, "screeningStatus": { "type": "string" }, "riskLevel": { "enum": [ "UNKNOWN", "SEVERE", "HIGH", "MEDIUM", "LOW", "NO_RISK_DETECTED" ], "type": "string" }, "screeningDetail": { "$ref": "#/components/schemas/Compliance_JsonNode" } } }, "Compliance_ComplianceAnalysisResponse": { "required": [ "result" ], "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/Compliance_ComplianceAnalysis" } } } }, "Compliance_JsonNode": { "type": "object" }, "Compliance_WalletAnalysisRequest": { "required": [ "ledger", "provider", "tickerId", "walletAddress" ], "type": "object", "properties": { "provider": { "enum": [ "ELLIPTIC", "CHAINALYSIS" ], "type": "string" }, "walletAddress": { "type": "string" }, "transactionAmount": { "type": "number" }, "ledger": { "type": "string" }, "tickerId": { "type": "string" } } }, "Compliance_WalletAnalysisResponse": { "required": [ "ledger", "provider", "transactionType", "walletAddress" ], "type": "object", "properties": { "provider": { "enum": [ "ELLIPTIC", "CHAINALYSIS" ], "type": "string" }, "walletAddress": { "type": "string" }, "transactionAmount": { "type": "number" }, "ledger": { "type": "string" }, "transactionType": { "enum": [ "INCOMING", "OUTGOING" ], "type": "string" }, "screenedAt": { "type": "string", "format": "date-time" }, "errorDetails": { "type": "string" }, "warningDetails": { "type": "string" }, "riskLevel": { "enum": [ "UNKNOWN", "SEVERE", "HIGH", "MEDIUM", "LOW", "NO_RISK_DETECTED" ], "type": "string" }, "screeningDetail": { "$ref": "#/components/schemas/Compliance_JsonNode" } } }, "Compliance_ExceptionRoleResponse": { "required": [ "complianceDomainId", "domainId", "policyId", "transactionType" ], "type": "object", "properties": { "complianceDomainId": { "type": "string", "format": "uuid" }, "domainId": { "type": "string", "format": "uuid" }, "policyId": { "type": "string", "format": "uuid" }, "transactionType": { "enum": [ "INCOMING", "OUTGOING" ], "type": "string" }, "exceptionRole": { "type": "string" } } }, "Compliance_ConfigurationDetailResponse": { "type": "object", "properties": { "domainId": { "type": "string", "format": "uuid" }, "connectionDetails": { "type": "array", "items": { "$ref": "#/components/schemas/Compliance_ProviderConnectionResponse" } }, "configurationSteps": { "type": "array", "items": { "$ref": "#/components/schemas/Compliance_ConfigurationStepResponse" } } } }, "Compliance_ConfigurationStepResponse": { "type": "object", "properties": { "name": { "enum": [ "ADD_RISK_SETTING_RULES", "ADD_POLICY_FOR_OUTGOING_ORDERS", "ADD_POLICY_FOR_AUTOMATIC_RELEASE_QUARANTINED_TRANSFERS", "ADD_EXCEPTION_FOR_OUTGOING_ORDERS", "ADD_EXCEPTION_FOR_RELEASE_QUARANTINED_TRANSFERS" ], "type": "string" }, "mandatory": { "type": "boolean" }, "shared": { "type": "boolean" }, "configurationStepType": { "enum": [ "RISK_SETTING", "POLICY", "AGENT" ], "type": "string" }, "provider": { "enum": [ "ELLIPTIC", "CHAINALYSIS" ], "type": "string" }, "status": { "enum": [ "START", "PENDING", "VIEW" ], "type": "string" } } }, "Compliance_GetScreeningRulesResponse": { "type": "object", "properties": { "rules": { "type": "array", "items": { "$ref": "#/components/schemas/Compliance_TransactionScreeningRule" } } } }, "Compliance_ProviderConnectionsResponse": { "type": "object", "properties": { "domainId": { "type": "string", "format": "uuid" }, "complianceDomainId": { "type": "string", "format": "uuid" }, "domainType": { "enum": [ "COMPLIANCE", "BUSINESS" ], "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Compliance_ProviderConnectionResponse" } } } }, "Compliance_PolicyResponse": { "required": [ "lockStatus", "policyName", "policyType", "transactionType" ], "type": "object", "properties": { "policyName": { "type": "string" }, "policyType": { "enum": [ "AUTOMATIC", "EXCEPTION" ], "type": "string" }, "transactionType": { "enum": [ "INCOMING", "OUTGOING" ], "type": "string" }, "approvalWorkflow": { "type": "object", "additionalProperties": { "type": "object" } }, "exceptionRole": { "type": "string" }, "rank": { "type": "integer", "format": "int32" }, "error": { "type": "string" }, "lockStatus": { "enum": [ "Locked", "Unlocked", "Archived" ], "type": "string" }, "policyId": { "type": "string", "format": "uuid" } } }, "EDS_ChannelCreate": { "required": [ "createdBy", "id", "name", "supportedEventTypes", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "supportedEventTypes": { "type": "array", "items": { "type": "string" } }, "status": { "enum": [ "ACTIVE", "DISABLED" ], "type": "string" }, "maxRetries": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string", "format": "uuid" }, "type": { "type": "string" } }, "discriminator": { "propertyName": "type" } }, "EDS_WebhookChannelCreate": { "required": [ "createdBy", "id", "name", "supportedEventTypes", "url" ], "allOf": [ { "$ref": "#/components/schemas/EDS_ChannelCreate" }, { "type": "object", "properties": { "url": { "type": "string" }, "type": { "enum": [ "WEBHOOK" ], "type": "string" } } } ] }, "EDS_Channel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "domainId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "supportedEventTypes": { "type": "array", "items": { "type": "string" } }, "type": { "enum": [ "WEBHOOK" ], "type": "string" }, "status": { "enum": [ "ACTIVE", "DISABLED" ], "type": "string" }, "maxRetries": { "type": "integer", "format": "int32" }, "url": { "type": "string" }, "createdBy": { "type": "string", "format": "uuid" }, "lastUpdatedBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "errorRate": { "type": "number", "format": "double" } } }, "EDS_ChannelUpdate": { "type": "object", "properties": { "name": { "type": "string" }, "supportedEventTypes": { "type": "array", "items": { "type": "string" } }, "status": { "enum": [ "active", "disabled" ], "type": "string" }, "maxRetries": { "type": "integer", "format": "int32" }, "lastUpdatedBy": { "type": "string", "format": "uuid" } } }, "EDS_Event": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "channelId": { "type": "string", "format": "uuid" }, "channelName": { "type": "string" }, "type": { "type": "string" }, "status": { "enum": [ "PENDING", "SUCCESS", "FAILED" ], "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "retriedCount": { "type": "integer", "format": "int32" }, "payload": { "type": "string" } } }, "Flows_Intents_TransactionDestinationType": { "enum": [ "Account", "Endpoint", "Address", "ExternalAccount" ], "type": "string" }, "Flows_Intents_TransactionOrderAccountDestination": { "required": [ "accountId", "type" ], "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid" }, "tag": { "type": "string", "nullable": true }, "type": { "enum": [ "Account" ], "type": "string" } }, "additionalProperties": false }, "Flows_Intents_TransactionOrderEndpointDestination": { "required": [ "endpointId", "type" ], "type": "object", "properties": { "endpointId": { "type": "string", "format": "uuid" }, "tag": { "type": "string", "nullable": true }, "type": { "enum": [ "Endpoint" ], "type": "string" } }, "additionalProperties": false }, "Flows_Intents_TransactionOrderAddressDestination": { "required": [ "address", "type" ], "type": "object", "properties": { "address": { "minLength": 1, "type": "string" }, "tag": { "type": "string", "nullable": true }, "type": { "enum": [ "Address" ], "type": "string" } }, "additionalProperties": false }, "Flows_Intents_TransactionOrderExternalAccountDestination": { "required": [ "externalAccountId", "type" ], "type": "object", "properties": { "externalAccountId": { "type": "string", "format": "uuid" }, "tag": { "type": "string", "nullable": true }, "type": { "enum": [ "ExternalAccount" ], "type": "string" } }, "additionalProperties": false }, "Flows_Intents_TransactionOrderDestinationInOut": { "required": [ "type" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/Flows_Intents_TransactionOrderAccountDestination" }, { "$ref": "#/components/schemas/Flows_Intents_TransactionOrderEndpointDestination" }, { "$ref": "#/components/schemas/Flows_Intents_TransactionOrderAddressDestination" }, { "$ref": "#/components/schemas/Flows_Intents_TransactionOrderExternalAccountDestination" } ], "properties": { "tag": { "type": "string", "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "type", "mapping": { "Account": "#/components/schemas/Flows_Intents_TransactionOrderAccountDestination", "Endpoint": "#/components/schemas/Flows_Intents_TransactionOrderEndpointDestination", "Address": "#/components/schemas/Flows_Intents_TransactionOrderAddressDestination", "ExternalAccount": "#/components/schemas/Flows_Intents_TransactionOrderExternalAccountDestination" } } }, "Flows_Intents_FlowsTransactionOrderType": { "enum": [ "Transfer", "Trade" ], "type": "string" }, "Flows_Intents_V0CreateFlowTransferOrderParameters": { "required": [ "amount", "destination", "externalTickerName", "type" ], "type": "object", "properties": { "amount": { "minLength": 1, "type": "string" }, "externalTickerName": { "minLength": 1, "type": "string" }, "destination": { "$ref": "#/components/schemas/Flows_Intents_TransactionOrderDestinationInOut" }, "type": { "enum": [ "Transfer" ], "type": "string" } }, "additionalProperties": false }, "Flows_Intents_TradeDirection": { "enum": [ "Buy", "Sell" ], "type": "string" }, "Flows_Intents_V0CreateFlowTradeOrderParameters": { "required": [ "baseExternalTickerName", "direction", "quantity", "quoteExternalTickerName", "type" ], "type": "object", "properties": { "baseExternalTickerName": { "minLength": 1, "type": "string" }, "quoteExternalTickerName": { "minLength": 1, "type": "string" }, "direction": { "$ref": "#/components/schemas/Flows_Intents_TradeDirection" }, "quantity": { "minLength": 1, "type": "string" }, "type": { "enum": [ "Trade" ], "type": "string" } }, "additionalProperties": false }, "Flows_Intents_V0CreateFlowTransactionOrderParameters": { "required": [ "type" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/Flows_Intents_V0CreateFlowTransferOrderParameters" }, { "$ref": "#/components/schemas/Flows_Intents_V0CreateFlowTradeOrderParameters" } ], "additionalProperties": false, "discriminator": { "propertyName": "type", "mapping": { "Transfer": "#/components/schemas/Flows_Intents_V0CreateFlowTransferOrderParameters", "Trade": "#/components/schemas/Flows_Intents_V0CreateFlowTradeOrderParameters" } } }, "Flows_Intents_TypeDiscriminator": { "enum": [ "Flows_v0_CreateTransactionOrder" ], "type": "string" }, "Flows_Intents_V0CreateFlowTransactionOrder": { "required": [ "customProperties", "description", "externalAccountId", "id", "parameters", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "externalAccountId": { "type": "string", "format": "uuid" }, "parameters": { "$ref": "#/components/schemas/Flows_Intents_V0CreateFlowTransactionOrderParameters" }, "description": { "type": "string" }, "customProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "type": { "$ref": "#/components/schemas/Flows_Intents_TypeDiscriminator" } }, "additionalProperties": false }, "Core_v0_ExecuteExtension_Payloads": { "oneOf": [ { "$ref": "#/components/schemas/Flows_Intents_V0CreateFlowTransactionOrder" } ], "discriminator": { "propertyName": "type", "mapping": { "Flows_v0_CreateTransactionOrder": "#/components/schemas/Flows_Intents_V0CreateFlowTransactionOrder" } } } }, "securitySchemes": { "httpAuth": { "type": "http", "scheme": "bearer" }, "bearer-jwt": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } }, "tags": [ { "name": "Overview", "description": "*Ripple Custody* exposes a complete set of APIs to administer and operate the system programmatically. The below entities are at the core of the system:\r\n- **intents** represent requests to execute an action within the system that may eventually be executed if fully approved;\r\n- **domains** define segregated sets of entities (e.g., users, policies and accounts) with guaranteed isolation from each other;\r\n- **users** are human or technical consumers of the service;\r\n- **policies** are operational rules defining the required (multi-)approval workflow for the execution of particular intents;\r\n- **vaults** are logical key stores responsible for the building and signing of outgoing transactions;\r\n- **accounts** are particular sets of addresses within a vault for which balance(s) and transactions are tracked;\r\n- **transaction orders** are orders to transfer digital assets or request an operation on the ledger;\r\n- **transactions** are incoming or outgoing ledger transactions that have been detected on the ledger or shall be broadcast;\r\n- **transfers** are the financial representation of their corresponding **transactions**;\r\n- **endpoints** associate ledger addresses with human-readable aliases to keep track of whitelisted and blacklisted addresses;\r\n- **ledgers** are accounting systems that are supported and tracked;\r\n- **tickers** define the detected currencies and their respective symbols and parameters;\r\n- **events** are the notification payloads generated through user actions, system signals, and ledger updates.\r\n- **requests** allow to follow the progress of a user request and identify a possible failure.\r\n\r\nBecause the security of digital assets is paramount, *Harmonize* leverages multiple security protocols ensuring a proper management of the keys, of the signature process, of user authentication, of the application of governance policies and overall of data integrity system-wide. Notably, \r\n- every request to mutate the system, as modelled through an **intent**, must be signed by all parties involved, such that an end-to-end secure link is set between the API consumer and the core of *Harmonize*;\r\n- every request to mutate the system is subject to programmable **policies** that regulate the exact quorum of users being authorized to approve and execute the **intent**;\r\n- every critical entity is protected by a data integrity protocol. Entities are versioned and stored as part of a Merkle tree whose root is signed for any mutation of the data. Any data tampering attempt at the database level or in transit is identified and fails at runtime. All such protected entites are wrapped into a `data` envelope and augmented with a `signature` field at the API level to allow a validation of the data integrity from the outside the system. This is particularly relevant to validate, for instance, the integrity of deposit addresses of a given account.\r\n\r\nMost entity types rely on a common pattern exposing the following fields:\r\n - `id`: a user-defined unique identifier (UUID); once defined, an id cannot be modified\r\n - `metadata.revision`: a system-enforced revision number set to 1 for the creation of the entity, and incremented at every entity update\r\n - `metadata.description`: an optional user-defined description of the entity\r\n - `metadata.createdAt`: a system-enforced timestamp marking the creation time of the entity\r\n - `metadata.createdBy`: a system-enforced reference to the creator of the entity\r\n - `metadata.lastModifiedAt`: a system-enforced timestamp marking the last update time of the entity\r\n - `metadata.lastModifiedBy`: a system-enforced reference to the last updater of the entity\r\n - `metadata.customProperties`: a user-defined key-value store to attach arbitrary data to the entity, such as a correlation identifier; customProperties are part of the evaluation context of policies conditions and may be used to trigger particular approval workflows\r\n\r\nTogether, `id` and `metadata.revision` are the basis of the anti-replay model in *Harmonize*.\r\n\r\nMost entities also expose a `lock` flag to make the entity read-only and prevent its use during runtime:\r\n- `lock`: lock status of an entity, which may be `Locked` or `Unlocked`; an `Unlocked` entity inherits the lock of its hierarchical parent and a `Locked` entity (with its dependent entities) may not be used at runtime.\r\n\r\nLocking a **domain** will lock all its inner entities as well as subdomains; locking a **user** will prevent it from submitting any request to the system or to access the service; locking a **policy** will ignore it entirely in the context of the policy selection; locking a **vault** will lock all its related **accounts**; locking an **account** will prevent the execution of transactional operations; locking an **endpoint** will prevent its use as a transaction order destination.\r\n\r\nFor requests returning a list of entities, pagination is enabled by default. The request may include a `limit` parameter to properly quantify the size of the response, a `startingAfter` parameter to define the anchor point, `sortBy` to define a possible sorting property, `sortOrder` to specify the direction of the sorting (resp. \"ASC\", \"DESC\") and possibly filtering criterions that may be entity-specific.\r\n\r\nResponses are packaged within a list of `items` and a pointer to the next page is exposed as property `nextStartingAfter`.\r\n\r\n" }, { "name": "Genesis", "description": "The **genesis** is the process by which an Harmonize environment is initialized. Upon system deployment, it is mandatory to define a **primary domain**, together with a suitable set of **users** and **policies**, such that the system can be operated using regular workflows. At minimum, one user and one policy must be defined, but a whole array of users and policies can be defined in order to render the Harmonize bootstrapping an atomic process.\r\n\r\nThe input request body contains two sections, namely the `rootDomainSetup` and the `cryptoSetup`. The former is akin to a regular new domain creation payload, while the latter is used to select the cryptographic algorithms to be used by the system.\r\n\r\nOf particular importance, at genesis level, is the setting up of a **breakglass**, i.e., a protection mechanism against possible mis-usage of the policy engine that will allow to restore the system in case of wrong user manipulation. Enabling this feature is achieved by setting the property `governingStrategy` to `CoerceDescendants`. More information on this feature can be found in the developer documentation.\r\n\r\nCalls to the genesis route are not authenticated, since the system has no active users at this stage.\r\n\r\nRunning Genesis on a new installation includes two properties in the `GenesisSucceeded` notary event:\r\n- `genesis`: a data structure holding the notary signed original genesis payload\r\n- `createdEntitiesReferences`: with key information on the data created" }, { "name": "Domains", "description": "A **domain** defines a segregated set of entities (e.g., users, policies and accounts) with guaranteed isolation from each other. It also maintains the read access permissions of the domain users.\r\n\r\n**Domains** are organized as part of a domain hierarchy, or tree: at the top of the hierarchy stands the root domain, which is defined at system genesis with the first **users** and **policies**. From the root domain down, subdomains can be created. The hierarchical structure ensures that any **intent** processed by the system must satisfy the **policies** of the **domain** in which the intent is to be executed, but also of all ancestors **domains** up to the root.\r\n\r\n**Domain** segregation may be used to isolate the operations of different departments, subsidiaries, or possibly clients, of the custodian and provide them with the ability to define their own respective users, policies, and accounts independently.\r\n\r\nThe locking of a **domain** prevents the execution of any **intent** within the **domain** or any of its subdomains." }, { "name": "Vaults", "description": "A **vault** is a component that maintains secret key material and is responsible for the creation and signing process of outgoing ledger transactions.\r\n\r\nA **vault** executes **transaction orders** once they are fully approved and delivers the signed ledger **transaction** to the system for broadcast. A single instance of *Harmonize* can hold multiple **vaults**, which may provide complementary features (e.g., various distributed ledger protocols), key stores (e.g., different hardware vendors or multi-party computation-based algorithms), or key isolation (e.g., connected, or air-gapped). For example, a system can leverage a hot vault (for hot accounts) and an air-gapped vault (for cold accounts). **Accounts** within the system are associated with specific vaults.\r\n\r\nThe registration of the public key of a vault, `publicKey`, allows the system to verify any information returned by the vault.\r\n\r\nThe locking of a **vault** prevents the execution of any **transaction order** related to the specific **vault**." }, { "name": "Ledgers", "description": "A **ledger** is an accounting system, such as a blockchain, that is supported and tracked.\r\n\r\nA **ledger** is defined by its `parameters`, which describe its protocol and configuration. For any supported protocol, multiple ledgers instances may be registered. This allows derivative ledgers, such as testnets, forks, or permissioned instances to be connected to *Harmonize* natively. " }, { "name": "Tickers", "description": "A **ticker** defines a detected currency and its respective symbol, number and parameters.\r\n\r\nIn particular, the number of `decimals` of a particular ticker is critical to the proper encoding of transfer amounts." }, { "name": "Accounts", "description": "An **account** tracks the balance(s) and transactions history of a data source. In the context of a distributed ledger, it relies on a set of keys and addresses provided by its **vault**.\r\n\r\nFor multi-address ledger protocols, accounts may generate and track multiple separate addresses transparently. For multi-currency protocols, a single account may have multiple balances corresponding to each respective asset owned by the **account**.\r\n\r\nAn **account** ensures the quarantine of all incoming transfers, such that their release is suject to a formal **policy**. It also manages balance reserves to ensure fully approved transaction orders become executable with little delay.\r\n\r\nThe locking of an **account** prevents the execution of any **transaction order** related to the specific **account**, as well as the release of quarantined incoming **transfers**." }, { "name": "External accounts", "description": "**External account** APIs are used to connect to a third party custodian, typically a trading venue, to instruct trading orders directly from Harmonize. The following calls allow to setup a connection with an external provider, list the external accounts and their balances." }, { "name": "Endpoints", "description": "An **endpoint** associates ledger addresses with human-readable aliases to keep track of whitelisted and blacklisted addresses. It is also used to register smart contract addresses and possibly associate an ABI to them.\r\n\r\nAn **endpoint** may be used as a destination to a **transaction order**, therefore acting as a form of address book entry. *Harmonize* ensures a secure mapping of the **endpoint** to its underlying address when preparing the **transaction** for execution.\r\n\r\nAn **endpoint** may also be used to validate the destination of a **transaction order** within a policy and to trigger specific approval workflows depending on the attributes of the **endpoint**. For instance, a **policy** may enforce a simplified approval workflow when the destination **endpoint** is marked as whitelisted, or may require an exceptional set of approvers when it is marked as blacklisted.\r\n\r\nLastly, endpoints may also be used to attach meta information to an address. This is the case of smart contract addresses, for instance, which may be attached to the interface, or ABI, of the contract, such that the methods and properties of the contract are known to the system.\r\n\r\nThe locking of an **endpoint** prevents its use in any context." }, { "name": "Transactions", "description": "A **transaction order** is an order to transfer assets or request an operation on the ledger. In the simplest case, it relates to the transfer of a native cryptocurrency; in more advanced cases, it can apply to the execution of smart contract methods and other on-ledger features.\r\n\r\n**Transaction orders** may differ from one ledger protocol to another, but they at least define the account origin, and normally have an amount and a destination address; for some protocols, a single transaction may include multiple destinations and amounts, possibly denominated in various currencies.\r\n\r\n**Transaction orders** rely on property `parameters` to define ledger-specific transaction order parameters.\r\n\r\nWe present below the transaction order parameters for Bitcoin:\r\n - `outputs`: sequence of pairs of destination and amount;\r\n - `feeStrategy`: fee calculation strategy, which may be `Low`, `Medium` or `High`; the actual fee amount corresponding to the selected strategy is automatically set by the system at execution time based on a network metrics;\r\n - `maximumFee`: maximum fee the user is willing to pay to execute the transaction; in rare occasions, *Harmonize* may decide to rebroadcast a transaction with higher fees to ensure inclusion within the ledger, as long as `maximumFee` has not been reached.\r\n\r\nFor an exhaustive list corresponding to each respective ledger protocol, we refer to the reference manual.\r\n\r\n*Harmonize* supports multiple types of destinations for **transaction orders**:\r\n - ledger address: a ledger address is a protocol-level address, whose format may differ from one ledger protocol to another;\r\n - account: an account destination is an **account** `id`, which is guaranteed to implicitly resolve to an address of the account; for protocols supporting multiple addresses per account, no guarantee is provided over which account address the resolution leads to;\r\n - endpoint: an endpoint destination is an **endpoint** `id`, which is guaranteed to implicitly resolve to the address of the endpoint.\r\n\r\nOnce a **transaction order** is fully approved the order becomes executable. The corresponding **vault** may capture the pending **transaction order** and build and sign a corresponding ledger transaction.\r\n\r\n**Transactions** are incoming or outgoing ledger transactions that have been detected on the ledger or shall be broadcast. **Transfers** are the financial representation of their corresponding **transactions**. " }, { "name": "Intents", "description": "An **intent** represents a request to execute an action within the system, which shall eventually be executed if fully approved. In *Harmonize*, all security-critical operations follow the below execution lifecycle:\r\n1. a user submits a properly signed intent to execute an action;\r\n2. *Harmonize* browses through the **policies**, sorted by `rank`, and selects the first **policy** with matching `intentTypes` and `condition`;\r\n3. *Harmonize* validates that the **policy** authorizes the author of the intent to submit it and sets the full approval `workflow` required for execution;\r\n4. *Harmonize* waits for the required quorum of approvals as defined in the selected **policy** `workflow`;\r\n5. Once fully approved, *Harmonize* executes the intent and mutates the state of the system, possibly triggering the execution of a side effect such as the processing of a transaction.\r\n\r\nThe author of an intent defines, in particular, the following fields:\r\n- `payload`, which sets the `type` of the intent and the details of the operation to process;\r\n- `expiry`, which sets an expiration time to the intent;\r\n- `targetDomainId`, which sets the domain in which to execute the intent (either in the current domain or within a descendant domain);\r\n- `type`, which defines whether the intent is an original submission (`Propose`), an intention to approve an existing intent (`Approve`) or an intention to reject an existing intent (`Reject`).\r\n\r\nThere exist four intent types for most entities in the system, as prefixed by:\r\n- **Create** to create an entity of a given type;\r\n- **Update** to update the definition of an entity;\r\n- **Lock** to lock an entity;\r\n- **Unlock** to unlock an entity.\r\n\r\nExceptions exist, such as for the release of quarantined **transfers**, which has its dedicated intent called **ReleaseQuarantinedTransfers**.\r\n\r\nA generic intent, named **NotarizeData**, allows the submission of intents not related to internal processes of *Harmonize*. Such **intents** may be used to trigger external effects to extend the capabilities of the system, such as to initiate fiat payment orders or trading orders." }, { "name": "Policies", "description": "A **policy** is an operational rule defining the required approval `workflow` for the execution of a particular **intent**. It regulates user entitlements and, if properly configured, ensures that the governance is properly distributed and the system has no single point of compromise. \r\n\r\nIn particular, **policies** regulate the approval `workflow` for the creation and update of\r\n- **domains**,\r\n- **users** and their related roles,\r\n- **policies** and their related approval workflows (i.e., creating and updating **policies** is itself subject to a **policy**),\r\n- **accounts**,\r\n- **vaults**,\r\n- **endpoints**,\r\n- **transaction orders.**\r\n\r\n**Policies** may also regulate other interactions with the system, such as the release of quarantined, incoming **transfers**.\r\n\r\n**Policies** may be refined to cover precise use cases using the property `condition`. A `condition` can be any combination of predicates over the context parameters, which are injected into the evaluation context of the condition at runtime. Such parameters depend on the intent type and other factors. In particular, an **intent** related to a **transaction order** includes information such as the amount, destination(s) address, and source account of the order; an **intent** related to a **user** includes the roles of the user, its alias, etc. For more information about context parameters, we refer to the reference manual.\r\n\r\nBecause there may be many **policies**, multiple of which may apply to a given **intent**, **policies** are sorted according to property `rank` such that the highest rank policy to match a particular intent is selected.\r\n\r\n**Policies** may be defined such as to regulate **intents** within the current domain, or **intents** initiated within a subdomain, or both, with property `scope`. We refer to the reference manual for more information on supervision and governance delegation.\r\n\r\nThe property `workflow` defines the approval workflow that should be satisfied for an intent to be approved. Each **policy** may have a different approval workflow, which consists in a sequence of steps, each composed of a combination of user roles. For an intent to be executed, all steps of the workflow shall sequentially receive enough approvals (quorum) to evaluate positively. The quorum can't exceed 2000 approvals per step. A single rejection fails the execution of the intent.\r\n\r\nThe locking of a **policy** ignores it entirely in the process of the policy selection." }, { "name": "Users", "description": "A **user** is a human or technical consumer of the *Harmonize* service. \r\n\r\nA user is associated with a public key, which is registered into the system alongside a set of roles. The roles relate to the permissions a user has to access the various entities within the system (as defined within a particular **domain**) as well as to propose, approve and reject the execution of intents (as defined by the approval workflow of a policy).\r\n\r\nUsers have, in particular, the following properties:\r\n - `publicKey`: the public key used to authenticate any user request\r\n - `roles`: a collection of human-readable strings defining the roles of a user\r\n\r\nThe private key corresponding to `publicKey` is generated on the user-side, either within the mobile approval terminal or programmatically, and is never communicated to the system. We emphasize here that a user key pair is merely used to authenticate the user and approve the execution of **intents**; it is unrelated to the account keys securing the accounts on the ledger. The loss of a **user** key is dealt with by locking the user and creating a new user with a rotated key.\r\n\r\nThe locking of a **user** prevents its access to the platform entirely." }, { "name": "User invitations", "description": "**User invitations** are an alternative method to create users. With a user invitation, there is no need for the user to manually share its public key as the process is fully automated in the backend. Moreover it is possible to create invitations that have an expiration date." }, { "name": "Events", "description": "An **event** is a notification payload generated through user actions, system signals, and ledger updates.\r\n\r\nEvents are the notification payloads generated through user actions, system signals, and ledger updates.\r\n\r\nEvent payloads follow a common pattern including the following fields:\r\n- `id`, a unique identifier for the event,\r\n- `domainId`, a reference to the domain where the event has been issued,\r\n- `sequenceNumber`, a strictly increasing sequence number (but possibly non contiguous),\r\n- `savedAt`, a timestamp, and\r\n- `payload`, additional information depending on the event type." }, { "name": "Requests", "description": "A **request** allows to follow the progress of a user request and identify a possible failure. \r\n\r\nMost requests to the system return a `requestId` in the response body, which may be used to inquire on the status of the request.\r\n\r\nIt is also possible and encouraged to provide a user-defined requestId using the `requestId` HTTP header when submitting intents or when approving/refusing them, this has several advantages:\r\n- If the connection is interrupted between the request and the response the `requestId` will still be known by the caller, which can then check if the request has been submitted to Harmonize or not\r\n- If the caller retries to submit another request with an already-used `requestId`, Harmonize will prevent this by returning an error, in order to avoid the involuntary replay of a request\r\n\r\n**Users** satisfying any of the below conditions are allowed to read a **request** status:\r\n- user is the originator of the request (even if it does not have a read access to `requests`)\r\n- user is in the originator domain and has a role granting him read access to `requests`\r\n- user is in the target domain and has a role granting him read access to `requests`\r\n\r\nA **request** will return, in particular, the following fields:\r\n- `lastModifiedAt`, which tracks the last update timestamp of the request;\r\n- `status`, which may be `Processing`, `Succeeded` or `Failed`; a `Failed` status also exposes an additional field detailing the failure reason.\r\n- `history`, which tracks all the intermediate steps of the user request, with details regarding the source component, the status, an eventual hint in case of failure, and a timestamp;" }, { "name": "SystemProperties", "description": "A **SystemProperty** defines a key value secure collection dedicated to store system-wide values.\r\nThere are system-defined ones and user-defined ones, access to all is available by properties API. \r\nUser defined one could be created and updated by using SetSystemProperty indent. " }, { "name": "Invitations", "description": "**User invitations** are an alternative method to create users. With a user invitation, there is no need for the user to manually share its public key as the process is fully automated in the backend. Moreover it is possible to create invitations that have an expiration date." }, { "name": "External account trading", "description": "**External account** refers to account held at exchanges or sub-custodians. The trading APIs allow to obtaining pairs and pricing offered by the exchange." }, { "name": "External account transactions", "description": "**External account** refers to account held at exchanges or sub-custodians. The transactions APIs allow to monitoring and listing of orders and transactions that are instructed to the sub-custodian." }, { "name": "VirtualAccounting" }, { "name": "Compliance", "description": "Compliance APIs enable the creation of compliance-related domains, integration with compliance providers, management of risk score configurations, and execution of compliance analyses. They facilitate the creation of compliance policies, as well as the management of compliance users and agents to automate compliance checks effectively." }, { "name": "Event Distribution Service", "description": "Event Distribution Service (EDS) APIs" } ] }