GraphQL Reference

Schema Types

Table of Contents

Query

The query root of Ownera's GraphQL interface.

FieldArgumentTypeDescription
assetsAssets!

Look up Assets, Optional provide Filters or Aggregates.

filter[Filter!]
aggregate[Aggregate!]
paginatePaginateInput
orderByAssetOrderInput
usersUsers!

Look up Users, Optional provide Filter or Aggregate.

filter[Filter!]
aggregate[Aggregate!]
paginatePaginateInput
receiptsReceipts!

Look up a receipt by a Filter (mandatory).

filter[Filter]
paginatePaginateInput
issuersIssuers!

Look up Issuers, Optional provide Filter.

filter[Filter!]
paginatePaginateInput
certificatesCertificates!

Look up Certificates, Optional provide Filter or Aggregate.

filter[Filter!]
aggregate[Aggregate!]
paginatePaginateInput
organizationsOrganizations!

Look up Organizations, Optional provide Filter or Aggregate.

filter[Filter!]
aggregate[Aggregate!]
paginatePaginateInput
plansExecutionsPlans!

Look up Execution Plans, Optional provide Filter.

filter[Filter!]
paginatePaginateInput
orderByExecutionPlanOrder
workflowsWorkflows!

Look up Workflows, Optional provide Filter.

filter[Filter!]
paginatePaginateInput
orderByWorkflowOrder
ledgersLedgerBindings!
filter[Filter!]
paginatePaginateInput
custodyProvidersCustodyProviders!
filter[Filter!]
paginatePaginateInput
approvalConfigsApprovalConfigs!
paginatePaginateInput
pinningConfigPinningConfigs
assetDatasAssetDatas!

Look up Asset Data, Optional provide Filter.

filter[Filter!]
paginatePaginateInput
dataProvidersDataProviderBindings!

Look up Data Provider bindings.

filter[Filter!]
paginatePaginateInput
dataRulesDataRules!

Look up Data Rules that map identifiers to data providers.

filter[Filter!]
paginatePaginateInput
financialAssetsFinancialAssets!

Look up FinancialAssets aggregated by ISIN from data adapter data. Filter by isin to get a specific asset.

filter[Filter!]
paginatePaginateInput

Subscription

FieldArgumentTypeDescription
receiptAddedReceipt!
planAddedExecutionPlan!
plansChangedByExecutionPlan!
fieldNames[PlanField!]!
userHoldingAddedUser!
userHoldingChangedUser!
fieldNames[HoldingFields!]!
assetDataChangedAssetDataItem!
identifierTypeAssetDataIdentifierType
identifierValueString
dataTypes[DataType!]
intentAddedIntent!

Fires when a new intent is committed. Filters AND together; if a filter is omitted it matches everything. ownerOrgIds matches if any participant org id on the intent is in the list.

intentTypes[IntentTypes!]
assetIds[String!]
ownerOrgIds[String!]
intentChangedIntent!

Fires when an intent field listed in fieldNames changes. Same filter semantics as intentAdded.

fieldNames[IntentField!]!
intentTypes[IntentTypes!]
assetIds[String!]
ownerOrgIds[String!]

Objects

AdditionalContractDetails

FieldArgumentTypeDescription
finP2PEVMOperatorDetailsFinP2PEVMOperatorDetails

AggregateResult

Result of Aggregation function applied on an Object numeric field.

FieldArgumentTypeDescription
fieldString!

The Object's field which this results refer to.

funcAggregateFunc!

The AggregateFunc which this AggregateResult refers to.

resultString!

ApprovalConfig

FieldArgumentTypeDescription
idString!

proposal approval configuration

configString!
createdAtString!

ApprovalConfigs

FieldArgumentTypeDescription
nodes[ApprovalConfig!]
pageInfoPageInfo

Keeps pagination info in-case limit input was provided

Asset

Represents an Asset in the network.

FieldArgumentTypeDescription
idString!
certificatesCertificates!

Collection of certificates associated with the Profile.

filter[Filter!]
aggregates[Aggregate!]
intentsIntents!

Collection of Intents associated with the Asset.

filter[Filter!]
aggregates[Aggregate!]
nameString!
symbolString
typeString!

Type of Asset (Share, Debt etc..)

configString!

Custom configuration for the Asset.

issuedTokensTokensBalances!

Tokens issued for the given Asset.

filter[Filter!]
aggregates[Aggregate!]
issuerIdString!

Issuer profile of the Asset.

regulationVerifiers[Verifier!]

Regulation Verifiers associated with the Asset.

organizationIdString!

Organization id to whom this profile is associated with.

metadataProfileMetadata!

Profile metadata, contains ACL information of the profile.

denominationFiatAsset!

Denomination currency of the Asset

allowedIntents[IntentTypes!]

Allowed intent types to be used on the asset

policiesAssetPolicies

Describe the policies active on the asset

ledgerAssetInfoLedgerAssetInfo

ledgerAssetInfo information

financialIdentifierFinancialIdentifier

classification standard used to identify the financial asset

versionString!

asset resource version

allowPolicyDefaultFallbackBoolean!

to fallback to default allowed policy if no specific policy is set

decimalPlacesInt!

decimal places for the asset

autoShareBoolean!

whether the asset is auto-shared

orgSettlementAccountNetworkAccount

omnibus account for the asset, if applicable

AssetDataItem

Represents financial data for an asset from a data provider

FieldArgumentTypeDescription
idString!
identifierTypeAssetDataIdentifierType!

Type of identifier used (ISIN or CAIP19)

identifierValueString!

The identifier value (e.g., US0378331005 for ISIN)

dataTypeDataType!

Type of financial data

dataString!

The actual data as JSON string

sourceString

Data provider source identifier

providerTimestampInt

Provider timestamp (epoch ms)

createdAtInt!

When the record was created

updatedAtInt!

When the record was last updated

AssetDatas

Results for asset data query.

FieldArgumentTypeDescription
nodes[AssetDataItem!]

Collection of AssetDataItem Objects, conforms to the Filter input if provided.

pageInfoPageInfo

Keeps pagination info in-case limit input was provided

AssetIssuer

FieldArgumentTypeDescription
issuerIdString!
assetIdString!

AssetOrder

FieldArgumentTypeDescription
termAssetOrderTerm!
instructionAssetOrderInstruction!

AssetOrderInstruction

FieldArgumentTypeDescription
sourceAccountLedgerAccountAsset
destinationAccountLedgerAccountAsset

AssetOrderTerm

FieldArgumentTypeDescription
amountString!

AssetPolicies

FieldArgumentTypeDescription
proofProofPolicy!

AssetRefreshConfigItem

Refresh configuration for an asset's data from a provider

FieldArgumentTypeDescription
idString!
identifierTypeAssetDataIdentifierType!
identifierValueString!
dataTypeString!
refreshIntervalString!
lastRefreshAtInt
nextRefreshAtInt
providerIdString

UUID of the data provider

enabledBoolean!
createdAtInt!
updatedAtInt!

AssetTerm

FieldArgumentTypeDescription
amountString!

Total amount of asset allocated

Assets

Results for asset query.

FieldArgumentTypeDescription
nodes[Asset!]

Collection of Asset Objects, conforms to the Filter input if provided.

aggregate[AggregateResult!]

Collection of Aggregate Results, if an Aggregate input was provided.

pageInfoPageInfo

Keeps pagination info in-case limit input wes provided

Attachment

FieldArgumentTypeDescription
uuidString!
nameString
linkString
messageIdString!

AwaitInstruction

FieldArgumentTypeDescription
waitTimeInt!

epoch time for await instruction

BuyingContractDetails

FieldArgumentTypeDescription
assetAssetOrder!
settlementAssetOrder

BuyingIntent

FieldArgumentTypeDescription
buyerString

resource id of the buyer

assetTermAssetTerm!

Asset term specifies the asset information and amount of the intent

destinationFinP2PAssetAccount!

Destination account - where buyer receives the asset

settlementTermSettlementTerm

Settlement term

signaturePolicyTypeSignaturePolicyType!

Signature policy type

signaturePolicyBuyingSignaturePolicy!
settlementInstructionBuyingSettlementInstruction

BuyingSettlementInstruction

FieldArgumentTypeDescription
accountFinP2PAssetAccount

Source account where buyer pays from

Caip19Identifier

CAIP-19 format ledger identifier

FieldArgumentTypeDescription
networkString

CAIP-2 network identifier (e.g., eip155:1, solana:mainnet)

standardString

Token standard (e.g., erc20, erc721)

tokenIdString!

Token ID or contract address

Certificate

Represents a Certificate in the network.

FieldArgumentTypeDescription
idString!
profileIdString!

Profile to whom this Certificate is associate with.

typeString!

Type of Certificate (KYA,KYC,AML etc.. ).

providerIdString!

Service Provider Id which provided the Certificate.

issuedAtInt!
expiryInt
dataString

Semi-Structured Data provided as additional information for the Certificate.

documentsDocuments!

Certificate associated documents metadata.

filter[Filter!]

Certificates

Results for certificates query.

FieldArgumentTypeDescription
nodes[Certificate!]

Collection of Certificate Objects, conforms to the Filter input if provided.

aggregate[AggregateResult!]

Collection of Aggregate Results, if an Aggregate input was provided.

pageInfoPageInfo

Keeps pagination info in-case limit input wes provided

CloseAmountRate

FieldArgumentTypeDescription
repaymentVolumeString!

ContractDetails

FieldArgumentTypeDescription
networkString!
addressString!
tokenStandardString
additionalContractDetailsAdditionalContractDetails

CryptoWalletAccount

Crypto wallet account

FieldArgumentTypeDescription
addressString!

Wallet address represented as a hexadecimal string prefixed with 0x

Custodian

FieldArgumentTypeDescription
orgIdString!

CustodyProvider

FieldArgumentTypeDescription
nameString!
endpointString!
displayNameString
idempotencyLedgerIdempotencyOptions
requestTimeoutString!
backoffString!
singleRequestTimeoutString!

CustodyProviders

FieldArgumentTypeDescription
nodes[CustodyProvider!]

Collection of Custody Provider Objects, conforms to the Filter input if provided.

pageInfoPageInfo

Keeps pagination info in-case limit input was provided

DataAccess

FieldArgumentTypeDescription
targetOrgIdString!

organization id the resource shared with

accessTypeDataAccessType!

data access type

statusString!

status of the shared resource data access

DataProviderBinding

Represents a data provider binding configuration

FieldArgumentTypeDescription
idID!

Unique identifier (UUID) for the data provider

nameString!
providerTypeString!

Type of data provider: adapter (external HTTP) or finp2p (internal P2P)

endpointString!
displayNameString
requestTimeoutString!
backoffString!
dataTypes[String!]

JSON array of data type strings this provider serves

dataTypeConfigString

JSON string of per-data-type fetch configuration

createdAtInt!
updatedAtInt!

DataProviderBindings

Results for data provider query.

FieldArgumentTypeDescription
nodes[DataProviderBinding!]

Collection of DataProviderBinding Objects, conforms to the Filter input if provided.

pageInfoPageInfo

Keeps pagination info in-case limit input was provided

DataRuleItem

Represents a data rule mapping an asset identifier to a data provider

FieldArgumentTypeDescription
idString!
identifierTypeString!

Type of identifier (e.g., ISIN)

identifierValueString!

The identifier value (e.g., US0378331005)

providerIdString!

UUID of the data provider

dataTypeString!

The data type this rule covers

refreshIntervalString

Refresh interval for this rule (e.g., 1h, 24h, RT)

enabledBoolean!

Whether this rule is active

createdAtInt!

When the rule was created (epoch seconds)

updatedAtInt!

When the rule was last updated (epoch seconds)

DataRules

Results for data rules query.

FieldArgumentTypeDescription
nodes[DataRuleItem!]

Collection of DataRuleItem Objects, conforms to the Filter input if provided.

pageInfoPageInfo

Keeps pagination info in-case limit input was provided

Delivered

FieldArgumentTypeDescription
_ignoreBoolean

Document

Certificate related Document metadata informaiton

FieldArgumentTypeDescription
idString!
uriString!

Locaiton of document content.

nameString!
mimeTypeString!

Documents

Results for documents query.

FieldArgumentTypeDescription
nodes[Document!]

Collection of Document Objects, conforms to the Filter input if provided.

EIP712Template

FieldArgumentTypeDescription
hashString!

ErrorState

FieldArgumentTypeDescription
codeInt!
messageString!

ExecutionContext

FieldArgumentTypeDescription
executionPlanIdString

ExecutionPlan associated with the transaction

instructionSequenceNumberInt

The associated instruction sequence number

ExecutionOrganization

Information about organization in an Execution Plan context

FieldArgumentTypeDescription
organizationIdString!
roles[ExecutionOrganizationRole!]

Roles this organization holds in the execution plan. An organization with only the observer role is a passive recipient of state updates.

ExecutionPlan

FieldArgumentTypeDescription
idString!

resource id of execution plan

intentIntent

Intent associated with execution plan

organizations[ExecutionOrganization!]!

organizations which participate in the execution plan

statusExecutionPlanStatus!

lifecycle status of the execution plan

instructions[ExecutionPlanInstruction]!

plan's list of instructions

contractExecutionPlanContract!

plan's contract details

approvals[PlanApproval]!

list of plan approvals

creationTimestampInt!

plan creation (timestamp in sec)

lastModifiedInt!

last time plan was modified (epoch time seconds)

versionInt!

version of the execution plan

customMetadata[KeyValuePair!]

Custom key-value metadata for tracing and reconciliation

ExecutionPlanContract

FieldArgumentTypeDescription
investors[ExecutionPlanInvestor!]!
contractDetailsExecutionPlanContractDetails

ExecutionPlanInstruction

FieldArgumentTypeDescription
sequenceInt!
organizations[ExecutionOrganization!]!
detailsInstructionDetails!
statusExecutionPlanInstructionStatus!
stateInstructionCompletionState!
approvalsInstructionApprovals!
filter[Filter!]
transitionsInstructionTransition!
versionInt!
workflows[Workflow!]!

ExecutionPlanInstructions

FieldArgumentTypeDescription
nodes[ExecutionPlanInstruction!]

ExecutionPlanInvestor

FieldArgumentTypeDescription
investorString!
roleInvestorRole!

ExecutionsPlans

FieldArgumentTypeDescription
nodes[ExecutionPlan!]
pageInfoPageInfo

Keeps pagination info in-case limit input wes provided

FiatAsset

Fiat currency asset for denomination purposes

FieldArgumentTypeDescription
codeString!

ISO-4217 code of the fiat currency

Field

FieldArgumentTypeDescription
nameString!
typeString!
valueString!

FinP2PAccount

FinP2P account - represents a user account in the FinP2P network

FieldArgumentTypeDescription
finIdString!

FinId -- a user's public key represented as a hexadecimal string

orgIdString!

Organization id of the account

custodianCustodian

Custodian for the finId

FinP2PAsset

FinP2P asset with resource ID and ledger identifier

FieldArgumentTypeDescription
resourceIdString!

Resource ID of the FinP2P asset

ledgerIdentifierLedgerIdentifier

Ledger identifier for the asset

FinP2PAssetAccount

FinP2P asset account - combines asset info with account info (matches proto FinP2PAssetAccount)

FieldArgumentTypeDescription
assetFinP2PAsset

FinP2P asset information

accountFinP2PAccount

FinP2P account information

FinP2PEVMOperatorDetails

FieldArgumentTypeDescription
finP2POperatorContractAddressString!
allowanceRequiredBoolean!

FinancialAsset

Aggregated view of a financial asset identified by ISIN

FieldArgumentTypeDescription
isinString!

ISIN identifier value (e.g., US0378331005)

dataItems[AssetDataItem!]!

Financial data items from data adapters for this ISIN

dataTypes[DataType!]
refreshConfigs[AssetRefreshConfigItem!]!

Refresh configurations for this ISIN

caip19Identifiers[String!]!

CAIP19 identifiers — asset instances on different networks/blockchains (from assetHeader data)

linkedAssets[Asset!]!

FinP2P assets linked by matching ISIN identifier (may be empty)

FinancialAssets

Results for financial asset query.

FieldArgumentTypeDescription
nodes[FinancialAsset!]
pageInfoPageInfo

FinancialIdentifier

FieldArgumentTypeDescription
typeFinancialIdentifierType!
valueString!

FullSettlement

FieldArgumentTypeDescription
amountString!

HashGroup

FieldArgumentTypeDescription
hashString!
fields[Field!]!

HashlistTemplate

FieldArgumentTypeDescription
hashString!
hashGroups[HashGroup!]!

HoldInstruction

FieldArgumentTypeDescription
sourceLedgerAccountAsset!

source account information

destinationLedgerAccountAsset

destination account information

amountString!

asset's hold amount

Holding

FieldArgumentTypeDescription
accountFinP2PAccount!
assetTypeAssetType!
assetAssetDetails!
balanceString!
withheldBalanceString!
availableBalanceString!
balanceTimestampInt!
syncedBalanceString!
syncedAvailableBalanceString!
syncedHeldBalanceString!

Holdings

FieldArgumentTypeDescription
nodes[Holding!]

Collection of Funds balance objects, conforms to the Filter input if provided.

aggregate[AggregateResult!]

Collection of Aggregate Results, if an Aggregate input was provided.

Iban

IBAN bank account

FieldArgumentTypeDescription
codeString!

IBAN code

IncomingMessage

FieldArgumentTypeDescription
messageMessage

InstructionApproval

FieldArgumentTypeDescription
planIdString!
sequenceInt!
orgIdString!
statusString!
reasonString!

InstructionApprovals

Results for Instruction Approval query.

FieldArgumentTypeDescription
nodes[InstructionApproval!]

Collection of Instruction Approval Objects, conforms to the Filter input if provided.

aggregate[AggregateResult!]

Collection of Aggregate Results, if an Aggregate input was provided.

InstructionTransition

FieldArgumentTypeDescription
onSuccessTransition
onFailureTransition
onTimeoutTransition

Intent

Represent an Asset's Transaction Intent occasion in which the Asset's tokens are issued.

FieldArgumentTypeDescription
idString!
startInt!

Start time of the intent.

endInt!

End time of the intent.

statusIntentStatus!

Intent status

remainingQuantityString!

Remaining quantity in the transaction.

typeString!

Intent type: primary sale, buying or selling intent

intentIntentDetails

Intent data

customMetadata[KeyValuePair!]

Custom key-value metadata for tracing and reconciliation

metadataProfileMetadata!

Profile metadata, contains ACL information of the profile.

versionString!

intent resource version

Intents

Results for itents query.

FieldArgumentTypeDescription
nodes[Intent!]

Collection of Intent Objects, conforms to the Filter input if provided.

aggregate[AggregateResult!]

Collection of Aggregate Results, if an Aggregate input was provided.

InterestRate

FieldArgumentTypeDescription
annualPercentageRateString!

Investor

FieldArgumentTypeDescription
resourceIdString!

IssuanceContractDetails

FieldArgumentTypeDescription
assetAssetOrder!
settlementAssetOrder

IssueInstruction

FieldArgumentTypeDescription
sourceLedgerAccountAsset

source for issuance

destinationLedgerAccountAsset!

destination account for issuance

amountString!

asset's issuance amount

Issuer

Represents an Issuer in the network.

FieldArgumentTypeDescription
idString!
assetsAssets!

Assets issued by the Issuer.

filter[Filter!]
aggregates[Aggregate!]
paginatePaginateInput
outboxOutgoingMessages
filter[Filter!]

Issuers

Results for issuers query.

FieldArgumentTypeDescription
nodes[Issuer!]

Collection of Issuer Objects, conforms to the Filter input if provided.

pageInfoPageInfo

Keeps pagination info in-case limit input wes provided

KeyValuePair

FieldArgumentTypeDescription
keyString!
valueString!

LedgerAccountAsset

Ledger account asset - combines FinP2P account with optional network account

FieldArgumentTypeDescription
finp2pAccountFinP2PAssetAccount!

FinP2P asset account

networkAccountNetworkAccount

Network account (e.g., wallet)

LedgerApiKeyOptions

FieldArgumentTypeDescription
apiKeyString!

LedgerAssetInfo

FieldArgumentTypeDescription
ledgerIdentifierLedgerIdentifier
ledgerReferenceLedgerReference
ledgerBindingLedgerBinding

LedgerBinding

FieldArgumentTypeDescription
nameString!
endpointString!
idempotencyLedgerIdempotencyOptions
displayNameString
requestTimeoutString!
backoffString!
singleRequestTimeoutString!
balanceSyncAllowedBoolean!

LedgerBindings

FieldArgumentTypeDescription
nodes[LedgerBinding!]

Collection of Ledger Binding Objects, conforms to the Filter input if provided.

pageInfoPageInfo

Keeps pagination info in-case limit input wes provided

LedgerIdempotencyOptions

FieldArgumentTypeDescription
idempotentBoolean!
transientFailureCodes[String!]!

LedgerMtlsOptions

FieldArgumentTypeDescription
clientCertificateString!
caCertificateString!
keyString!

LedgerOAuthOptions

FieldArgumentTypeDescription
oauthClientIdString!
oauthClientSecretString!
oauthServerEndpointString!
algString!
jwtKeyString!

LoanContractDetails

FieldArgumentTypeDescription
assetLoanOrder!
settlementLoanOrder
instructionLoanInstruction

LoanInstruction

FieldArgumentTypeDescription
openDateInt!
closeDateInt!
loanConditionsLoanConditions!

LoanIntent

FieldArgumentTypeDescription
borrowerString!

resource id of the borrower

lenderString!

resource id of the lender

assetTermAssetTerm!

Asset term specifies the asset information and amount of the intent

borrowerAccountFinP2PAssetAccount!

Borrower's account for the loan asset

lenderAccountFinP2PAssetAccount!

Lender's account for the loan asset

settlementTermSettlementTerm

Settlement term

loanSettlementInstructionLoanSettlementInstruction

Signature policy type

loanInstructionLoanInstruction!
signaturePolicyTypeSignaturePolicyType!
signaturePolicyLoanSignaturePolicy!

LoanOrder

FieldArgumentTypeDescription
termAssetOrderTerm!
instructionLoanOrderInstruction!

LoanOrderInstruction

FieldArgumentTypeDescription
borrowerAccountLedgerAccountAsset
lenderAccountLedgerAccountAsset

LoanSettlementInstruction

FieldArgumentTypeDescription
borrowerAccountFinP2PAssetAccount

Borrower's account for settlement

lenderAccountFinP2PAssetAccount

Lender's account for settlement

ManualIntentSignaturePolicy

FieldArgumentTypeDescription
_ignoreBoolean

Message

FieldArgumentTypeDescription
idString!
subjectString!
bodyString!
timestampString!
attachments[Attachment!]!
correspondentCorrespondent!

MessageRecipient

FieldArgumentTypeDescription
destinationRecipient!
deliveryStatusDeliveryStatus

MessageRecipients

FieldArgumentTypeDescription
nodes[MessageRecipient!]

Collection of User Objects, conforms to the Filter input if provided.

Messages

FieldArgumentTypeDescription
nodes[Message!]

MoveContractDetails

FieldArgumentTypeDescription
assetAssetOrder!

MoveInstruction

FieldArgumentTypeDescription
sourceLedgerAccountAsset!

source account information

destinationLedgerAccountAsset!

destination account information

amountString!

asset's move amount

MoveIntent

FieldArgumentTypeDescription
investorString

resource id of the investor

assetTermAssetTerm!

Asset term specifies the asset information and amount of the intent

sourceFinP2PAssetAccount

Source account when the move intent is submitted from the source side

destinationFinP2PAssetAccount

Destination account when the move intent is submitted from the destination side

signaturePolicyTypeSignaturePolicyType!

Signature policy type

signaturePolicyMoveSignaturePolicy!

NetworkAccount

Network account - represents external network accounts like wallets

FieldArgumentTypeDescription
walletWalletAccount

Wallet account if present

NoProof

FieldArgumentTypeDescription
_ignoreBoolean

NoProofPolicy

FieldArgumentTypeDescription
_ignoreBoolean

NoSettlement

FieldArgumentTypeDescription
_ignoreBoolean

NodeAddress

FieldArgumentTypeDescription
addressString!

address value

portInt!

node port

schemas[HttpSchemas!]!

supported http schemas

NotDelivered

FieldArgumentTypeDescription
statusString!

Organization

Organization's information.

FieldArgumentTypeDescription
idString!
types[String!]

Organization's supported types, e.g. Primary, Escrow

nameString!

Organization's name on the finp2p network.

finIdString!

Organization's finp2p public key represented as a hexadecimal string.

clusterIdString!

Organization's cluster id.

assetsAssets!

Assets which the Organization act as the Primary Node.

filter[Filter!]
aggregates[Aggregate!]
paginatePaginateInput
usersUsers!

Users which the Organization act as the Primary Node.

filter[Filter!]
aggregates[Aggregate!]
paginatePaginateInput

OrganizationAsset

FieldArgumentTypeDescription
assetAsset!
metadataProfileMetadata!

Organizations

Results for Organization query.

FieldArgumentTypeDescription
nodes[Organization!]

Collection of Organization Objects, conforms to the Filter input if provided.

aggregate[AggregateResult!]

Collection of Aggregate Results, if an Aggregate input was provided.

pageInfoPageInfo

Keeps pagination info in-case limit input wes provided

OutgoingMessage

FieldArgumentTypeDescription
messageMessage
recipientsMessageRecipients!
filter[Filter!]

OutgoingMessages

FieldArgumentTypeDescription
nodes[OutgoingMessage!]

PageInfo

FieldArgumentTypeDescription
hasNextPageBoolean!

Indicates if there are more items after the current page

endCursorString

Cursor for the end of the current page

totalCountInt!

Total count of items

totalLeftInt!

Total count of items left to be presented

PartialSettlement

FieldArgumentTypeDescription
unitValueString!

PendingDelivery

FieldArgumentTypeDescription
_ignoreBoolean

PinningConfig

FieldArgumentTypeDescription
idString!

pinning config unique id

nodes[PinningConfigNodeEntry!]!

pinning service configuration data

PinningConfigNodeEntry

FieldArgumentTypeDescription
idString!

entry unique id

tokenString!
addresses[NodeAddress!]!

PinningConfigs

FieldArgumentTypeDescription
nodes[PinningConfig!]

pinning service configuration data

PlanApproval

FieldArgumentTypeDescription
planIdString!
orgIdString!
statusApprovalStatus!
statusInfoPlanApprovalStatusInfo!

PlanApprovalStatusInfo

FieldArgumentTypeDescription
codeInt!
messageString!

PlanApprovals

Results for Plan Approval query.

FieldArgumentTypeDescription
nodes[PlanApproval!]

Collection of Plan Approval Objects, conforms to the Filter input if provided.

aggregate[AggregateResult!]

Collection of Aggregate Results, if an Aggregate input was provided.

PresignedBuyingIntentSignaturePolicy

FieldArgumentTypeDescription
_ignoreBoolean

PresignedLoanIntentSignaturePolicy

FieldArgumentTypeDescription
_ignoreBoolean

PresignedMoveIntentSignaturePolicy

FieldArgumentTypeDescription
_ignoreBoolean

PresignedPrivateOfferIntentSignaturePolicy

FieldArgumentTypeDescription
_ignoreBoolean

PresignedRedemptionIntentSignaturePolicy

FieldArgumentTypeDescription
_ignoreBoolean

PresignedRequestForTransferIntentSignaturePolicy

FieldArgumentTypeDescription
_ignoreBoolean

PresignedSellingIntentSignaturePolicy

FieldArgumentTypeDescription
_ignoreBoolean

PrimarySale

FieldArgumentTypeDescription
issuerIdString!

Issuer id

assetTermAssetTerm!

Asset term specifies the asset information and amount of the intent

sourceFinP2PAssetAccount!

Source account - issuer's account from which asset is sold

settlementTermSettlementTerm

Settlement term

sellingSettlementInstructionSellingSettlementInstruction

PrivateOfferContractDetails

FieldArgumentTypeDescription
assetAssetOrder!
settlementAssetOrder

PrivateOfferIntent

FieldArgumentTypeDescription
buyerString

resource id of the buyer

sellerString

resource id of the seller

assetTermAssetTerm!

Asset term specifies the asset information and amount of the intent

sourceFinP2PAssetAccount!

Source account - seller's account from which asset is sold

settlementTermSettlementTerm

Settlement term

signaturePolicyTypeSignaturePolicyType!

Signature policy type

signaturePolicyPrivateOfferSignaturePolicy!
sellingSettlementInstructionSellingSettlementInstruction

ProfileMetadata

Profile Metadata (ACL).

FieldArgumentTypeDescription
acl[String!]
dataAccess[DataAccess!]

Shared resources data access given to which org

Receipt

FieldArgumentTypeDescription
idString!
sourceString

Source owner resource ID

sourceAccountLedgerAccountAsset

Source account of transaction

destinationString

Destination owner resource ID

destinationAccountLedgerAccountAsset

Destination account of transaction

quantityString!

Number of asset units with the transaction

tradeDetailsTradeDetails

Trade details associated with the transaction

operationIdString

Operation id

transactionIdString

Underlying transaction id

operationTypeOperationType

Operation type

timestampString!

Receipt timestamp

statusReceiptStatus!

Receipt status

proofProof

Ledger proof

ReceiptState

FieldArgumentTypeDescription
receiptReceipt!

Receipts

Results for receipts query.

FieldArgumentTypeDescription
nodes[Receipt!]

Collection of Receipt Objects, conforms to the Filter input if provided.

pageInfoPageInfo

Keeps pagination info in-case limit input wes provided

RedeemInstruction

FieldArgumentTypeDescription
sourceLedgerAccountAsset!

source account information

amountString!

asset's redeem amount

RedemptionConditions

FieldArgumentTypeDescription
redemptionDurationString!

RedemptionContractDetails

FieldArgumentTypeDescription
assetAssetOrder!
settlementAssetOrder

RedemptionIntent

FieldArgumentTypeDescription
issuerIdString!

Issuer id

redemptionSettlementInstructionRedemptionSettlementInstruction

Specify settlement accounts

assetTermAssetTerm!

Asset term specifies the asset information and amount of the intent

destinationFinP2PAssetAccount

Destination account - where redeemed asset goes (to issuer)

settlementTermSettlementTerm

Settlement term

conditionsRedemptionConditions!

Intent conditions

signaturePolicyTypeSignaturePolicyType!

Signature policy type

signaturePolicyRedemptionSignaturePolicy!

RedemptionSettlementInstruction

FieldArgumentTypeDescription
accounts[FinP2PAssetAccount!]

Source accounts where payment comes from

Reference

FieldArgumentTypeDescription
workflowIdString!
referenceIdString!
referenceTypeString!

ReleaseInstruction

FieldArgumentTypeDescription
sourceLedgerAccountAsset!

source account information

destinationLedgerAccountAsset!

destination account information

amountString!

asset's release amount

RepaymentTerm

FieldArgumentTypeDescription
repaymentVolumeString!
annualPercentageRateString

RequestForTransferContractDetails

FieldArgumentTypeDescription
assetAssetOrder!

RequestForTransferIntent

FieldArgumentTypeDescription
senderString

resource id of the sender

receiverString

resource id of the receiver

assetRequestForTransferIntentAsset!
signaturePolicyRequestForTransferSignaturePolicy!
signaturePolicyTypeSignaturePolicyType!

RequestForTransferIntentAsset

FieldArgumentTypeDescription
assetTermAssetTerm!
assetInstructionRequestForTransferAssetInstruction!

RequestForTransferRequestInstruction

FieldArgumentTypeDescription
actionString!

Action type - always 'request'

receiverAccountFinP2PAssetAccount

RequestForTransferSendInstruction

FieldArgumentTypeDescription
actionString!

Action type - always 'send'

senderAccountFinP2PAssetAccount

RevertHoldInstruction

FieldArgumentTypeDescription
destinationLedgerAccountAsset!

destination account information

holdInstructionSequenceInt!

hold instruction sequence number to be reverted

SellingContractDetails

FieldArgumentTypeDescription
assetAssetOrder!
settlementAssetOrder

SellingIntent

FieldArgumentTypeDescription
sellerString

resource id of the seller

assetTermAssetTerm!

Asset term specifies the asset information and amount of the intent

sourceFinP2PAssetAccount!

Source account - seller's account from which asset is sold

settlementTermSettlementTerm

Settlement term

signaturePolicyTypeSignaturePolicyType!

Signature policy type

signaturePolicySellingSignaturePolicy!
sellingSettlementInstructionSellingSettlementInstruction

SellingSettlementInstruction

FieldArgumentTypeDescription
accounts[FinP2PAssetAccount!]

Destination accounts where seller receives payment

SequenceTransition

FieldArgumentTypeDescription
sequenceInt!

SettlementInstruction

FieldArgumentTypeDescription
detailsSettlementInstructionTypeDetails!

SettlementTerm

FieldArgumentTypeDescription
detailsSettlementTermOptionType!

Signature

FieldArgumentTypeDescription
templateTemplate!
signatureString!
hashFunctionString!
templateTypetemplateType!
templateVersionInt!

Template shape version. Defaults to 1 when the producer is on a pre-versioning finp2p-core release.

SignatureProof

FieldArgumentTypeDescription
signatureSignature!

SignatureProofPolicy

FieldArgumentTypeDescription
verifyingKeyString!
signatureTemplateSignatureTemplate!
templateVersionInt!

StatusTransition

FieldArgumentTypeDescription
statusExecutionPlanStatus!

SuccessState

FieldArgumentTypeDescription
outputSuccessStateOutput

TokenBalance

Represents an Asset token balance information.

FieldArgumentTypeDescription
userIdString!
assetIdString!
quantityString!
availableQuantityString!
heldQuantityString!
syncedQuantityString!
syncedAvailableQuantityString!
syncedHeldQuantityString!
syncedQuantityTimestampInt!
transactionsDetails[TransactionDetails!]

TokensBalances

Results for tokens query.

FieldArgumentTypeDescription
nodes[TokenBalance!]

Collection of Token Objects, conforms to the Filter input if provided.

aggregate[AggregateResult!]

Collection of Aggregate Results, if an Aggregate input was provided.

TradeDetails

FieldArgumentTypeDescription
intentIntent

Intent associated with the transaction

executionContextExecutionContext

Details of ExecutionPlan associated with the transaction

TransactionDetails

FieldArgumentTypeDescription
transactionIdString!
indexInt!
quantityString!

TransferContractDetails

FieldArgumentTypeDescription
assetAssetOrder!

TransferInstruction

FieldArgumentTypeDescription
sourceLedgerAccountAsset!

source account information

destinationLedgerAccountAsset!

destination account information

amountString!

asset's transfer amount

UnknownState

FieldArgumentTypeDescription
_ignoreBoolean

User

Represents an User in the network.

FieldArgumentTypeDescription
idString!
certificatesCertificates!

Collection of certificates associated with the Profile.

filter[Filter!]
aggregates[Aggregate!]
nameString!
holdingsHoldings!
filter[Filter!]
aggregates[Aggregate!]
organizationIdString!

Organization id to whom this profile is associated with.

metadataProfileMetadata!

Profile metadata, contains ACL information of the profile.

finIds[String!]

finIds keys associated with this investor

accounts[FinP2PAccount!]
filter[Filter!]
inboxMessages!

User's associated messages

filter[Filter!]
versionString!

user resource version

dataAccessReceived[String]

Data access permissions this resource has received from other organizations

Users

Results for asset query.

FieldArgumentTypeDescription
nodes[User!]

Collection of User Objects, conforms to the Filter input if provided.

aggregate[AggregateResult!]
pageInfoPageInfo

Keeps pagination info in-case limit input wes provided

Verifier

Regulation Verifier

FieldArgumentTypeDescription
idString

Verifier ID

nameString

Verifier Name

providerString

Provider type: REG_APP_STORE, OTHER

WalletAccount

Wallet account for blockchain wallets

FieldArgumentTypeDescription
typeString!

Type of wallet (e.g., ethereum)

addressString!

Wallet address

Workflow

FieldArgumentTypeDescription
idString!

Id of the workflow

nameString!

Name of the workflow

transitionIdString!

Current transition id of the workflow

statusString!

Current status of the workflow

versionInt!

version of the workflow

metadataWorkflowMetadata!

metadata of the workflow

references[Reference!]!

list of reference information of the workflow

expiresInt!

the time workflow expires

healthWorkflowHealth

Health status and admin information for the workflow

availableActions[WorkflowAdminAction!]!

Available admin actions for this workflow

adminMetadataWorkflowAdminMetadata

Admin operations history and metadata

creationTimestampInt!

Workflow creation timestamp

WorkflowAdminMetadata

Admin operations metadata and history

FieldArgumentTypeDescription
lastActionWorkflowAdminAction

Last admin action performed

lastActionTimestampInt

Timestamp of last admin action

lastActionByString

User who performed last action

totalActionsInt!

Total number of admin actions performed

WorkflowHealth

Health status of a workflow

FieldArgumentTypeDescription
statusWorkflowHealthStatus!

Current health status

issues[String!]!

List of health issues detected

stuckSinceInt!

health stuck since timestamp

lastAssessedInt!

Timestamp when health was last assessed

metadataWorkflowHealthMetadata

Additional health metadata

WorkflowHealthMetadata

Additional health assessment metadata

FieldArgumentTypeDescription
timeSinceLastTransitionInt

Time since last state transition

retryCountInt

Number of retry attempts

ageInt

Workflow age in seconds

WorkflowMetadata

FieldArgumentTypeDescription
ttlInt!

TTL of the workflow

retryInt!
currentStateRetryInt!
traceIdString!
correlationIds[String!]

Workflows

FieldArgumentTypeDescription
nodes[Workflow!]
pageInfoPageInfo

Keeps pagination info in-case limit input wes provided

Inputs

Aggregate

Apply an aggregation function on specified Object's field.

FieldTypeDescription
fieldString

Object's field to which apply the AggregateFunc

funcAggregateFunc!

AggregateFunc to apply on the provided Field.

AssetOrderInput

FieldTypeDescription
fieldAssetOrderField
directionSortOrder

CertificateOrder

FieldTypeDescription
fieldCertificateOrderField
directionSortOrder

ExecutionPlanOrder

FieldTypeDescription
fieldExecutionPlanOrderField
directionSortOrder

Filter

Filter capabilities that can be applied on queries which return multiple results of a given Entity. Currently filtering is available only on the fields which belongs to the Root of the entity and not on nested entities' fields.

FieldTypeDescription
keyString!

The Object's key to which apply the filter rule.

valueString!

The Value to be used by the Filter Operator.

operatorOperator!

Operator to apply on the specified key and provided value.

IssuerOrder

FieldTypeDescription
fieldIssuerOrderField
directionSortOrder

OrganizationOrder

FieldTypeDescription
fieldOrganizationOrderField
directionSortOrder

PaginateInput

FieldTypeDescription
limitInt

Number of records to return in response

skipInt

Number of pages to skip to get new cursor

afterString

Cursor field to return records after it

ReceiptOrder

FieldTypeDescription
fieldReceiptOrderField
directionSortOrder

UserOrder

FieldTypeDescription
fieldUserOrderField
directionSortOrder

WorkflowOrder

FieldTypeDescription
fieldWorkflowOrderField
directionSortOrder

Enums

ActionType

ValueDescription
send
request
unknown

AggregateFunc

Aggregation function to be applied on Object's numeric field.

ValueDescription
SUM
COUNT
AVG
MAX
MIN

ApprovalStatus

ValueDescription
Approved
Rejected
Unknown

AssetDataIdentifierType

Identifier type for asset data

ValueDescription
ISIN
CAIP19

AssetOrderField

ValueDescription
ORGANIZATION

Assets order by determined by OrganizationId field

NAME

Assets order by determined by Name field

AssetType

ValueDescription
finp2p
fiat
cryptocurrency

CertificateOrderField

ValueDescription
ID

certificates order by determined by Id field

DataAccessType

ValueDescription
Unknown
Balance

DataType

Financial data types provided by data providers

ValueDescription
assetHeader
pricing
fundamentals
ratings
corporateActions
marketData
referenceData

ExecutionOrganizationRole

Role of an organization participating in an Execution Plan

ValueDescription
contributor

Participates in plan approval and instruction execution

observer

Read-only participant; receives state updates but does not approve or execute

ExecutionPlanInstructionStatus

ValueDescription
Unknown
Pending
Completed
Failed
Approved
Rejected
Cancelled

ExecutionPlanOrderField

ValueDescription
PLAN_ID

plan order by PlanId field

CREATION_TIMESTAMP

ExecutionPlanStatus

ValueDescription
Unknown
Pending
Approved
Completed
Failed
Rejected
Halted
InProgress
Cancelled

FinancialIdentifierType

ValueDescription
UNSPECIFIED
ISIN
ISO4217
NONE

HoldingFields

Fields to subscribe on

ValueDescription
Balance
WithheldBalance
AvailableBalance
SyncedBalance
SyncedAvailableBalance
SyncedHeldBalance

HttpSchemas

ValueDescription
HTTP1_1
HTTP2

IntentField

Fields to subscribe on

ValueDescription
Status
RemainingQuantity

IntentStatus

ValueDescription
ACTIVE
NON_ACTIVE
CANCELLED
COMPLETED
EXPIRED
REJECTED

IntentTypes

ValueDescription
PRIMARY_SALE
BUYING
SELLING
LOAN
PRIVATE_OFFER
REQUEST_FOR_TRANSFER
MOVE
REDEMPTION

InvestorRole

ValueDescription
BUYER
SELLER
LENDER
BORROWER
ISSUER

IssuerOrderField

ValueDescription
ID

issuers order by determined by Id field

LedgerAuthType

ValueDescription
OAUTH
MTLS
API_KEY

OperationType

ValueDescription
Unknown
Issue
Transfer
Release
Hold
Redeem
Move

Operator

Operators available to be used

ValueDescription
EQ

Equals

NEQ

Not Equals

GT

Greater Than

GTE

Greater Than or Equals

LT

Less Than

LTE

Less Than or Equals

IN

In

NIN

Not In

CONTAINS

Contains

OrganizationOrderField

ValueDescription
ID

organizations order by determined by Id field

PlanField

Fields to subscribe on

ValueDescription
Status

ReceiptOrderField

ValueDescription
ID

receipt order by determined by Id field

ReceiptStatus

ValueDescription
Unknown
Valid
Invalid

SignaturePolicyType

ValueDescription
PresignedPolicy
ManualPolicy

SignatureTemplate

ValueDescription
EIP712
HashList
Unknown

SortOrder

ValueDescription
ASC
DESC

UserOrderField

ValueDescription
ID

users order by determined by Id field

WorkflowAdminAction

Available admin actions for workflows

ValueDescription
RESET
RESUME
RETRY
CANCEL

WorkflowHealthStatus

Health status enumeration

ValueDescription
HEALTHY
STALE
STUCK
UNHEALTHY

WorkflowOrderField

ValueDescription
NAME

workflow order

STATUS
REFERENCE_ID
HEALTH_STATUS
CORRELATION_ID

templateType

ValueDescription
EIP712Template
HashListTemplate

Scalars

Boolean

The Boolean scalar type represents true or false.

ID

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Interfaces

Profile

Profile interface.

FieldArgumentTypeDescription
idString!
certificatesCertificates!

Collection of certificates associated with the Profile.

filter[Filter!]
aggregates[Aggregate!]
organizationIdString!

Organization id to which this profile is associated with.

metadataProfileMetadata!

Profile metadata, contains ACL information of the profile.

Possible Types: Asset, User

Unions

AccountIdentifier

Account identifier - supports FinP2P, crypto wallets, and IBAN

TypeDescription
CryptoWalletAccount

Crypto wallet account

Iban

IBAN bank account

FinP2PAccount

FinP2P account - represents a user account in the FinP2P network

AssetDetails

Asset details - now always FinP2P

TypeDescription
FinP2PAsset

FinP2P asset with resource ID and ledger identifier

BuyingSignaturePolicy

TypeDescription
PresignedBuyingIntentSignaturePolicy
ManualIntentSignaturePolicy

Correspondent

TypeDescription
AssetIssuer

DeliveryStatus

TypeDescription
PendingDelivery
Delivered
NotDelivered

ExecutionPlanContractDetails

TypeDescription
IssuanceContractDetails
BuyingContractDetails
SellingContractDetails
LoanContractDetails
TransferContractDetails
RedemptionContractDetails
PrivateOfferContractDetails
RequestForTransferContractDetails
MoveContractDetails

InstructionCompletionState

TypeDescription
UnknownState
ErrorState
SuccessState

InstructionDetails

TypeDescription
IssueInstruction
TransferInstruction
HoldInstruction
ReleaseInstruction
RevertHoldInstruction
AwaitInstruction
RedeemInstruction
MoveInstruction

IntentDetails

TypeDescription
PrimarySale
BuyingIntent
SellingIntent
LoanIntent
RedemptionIntent
PrivateOfferIntent
RequestForTransferIntent
MoveIntent

LedgerAuthOptions

TypeDescription
LedgerOAuthOptions
LedgerMtlsOptions
LedgerApiKeyOptions

LedgerIdentifier

Ledger identifier union - currently only CAIP-19 supported

TypeDescription
Caip19Identifier

CAIP-19 format ledger identifier

LedgerReference

TypeDescription
ContractDetails

LoanConditions

TypeDescription
RepaymentTerm
InterestRate
CloseAmountRate

LoanSignaturePolicy

TypeDescription
PresignedLoanIntentSignaturePolicy

MoveSignaturePolicy

TypeDescription
PresignedMoveIntentSignaturePolicy
ManualIntentSignaturePolicy

PrivateOfferSignaturePolicy

TypeDescription
PresignedPrivateOfferIntentSignaturePolicy
ManualIntentSignaturePolicy

Proof

TypeDescription
NoProof
SignatureProof

ProofPolicy

TypeDescription
SignatureProofPolicy
NoProofPolicy

Recipient

TypeDescription
Investor

RedemptionSignaturePolicy

TypeDescription
PresignedRedemptionIntentSignaturePolicy
ManualIntentSignaturePolicy

RequestForTransferAssetInstruction

TypeDescription
RequestForTransferSendInstruction
RequestForTransferRequestInstruction

RequestForTransferSignaturePolicy

TypeDescription
PresignedRequestForTransferIntentSignaturePolicy
ManualIntentSignaturePolicy

SellingSignaturePolicy

TypeDescription
PresignedSellingIntentSignaturePolicy
ManualIntentSignaturePolicy

SettlementInstructionTypeDetails

TypeDescription
SellingSettlementInstruction
BuyingSettlementInstruction

SettlementTermOptionType

TypeDescription
PartialSettlement
FullSettlement
NoSettlement

SuccessStateOutput

TypeDescription
Receipt

Template

TypeDescription
HashlistTemplate
EIP712Template

Transition

TypeDescription
StatusTransition
SequenceTransition