Schema Types
Table of Contents
- Query
- Subscription
- Objects
- AdditionalContractDetails
- AggregateResult
- ApprovalConfig
- ApprovalConfigs
- Asset
- AssetDataItem
- AssetDatas
- AssetIssuer
- AssetOrder
- AssetOrderInstruction
- AssetOrderTerm
- AssetPolicies
- AssetRefreshConfigItem
- AssetTerm
- Assets
- Attachment
- AwaitInstruction
- BuyingContractDetails
- BuyingIntent
- BuyingSettlementInstruction
- Caip19Identifier
- Certificate
- Certificates
- CloseAmountRate
- ContractDetails
- CryptoWalletAccount
- Custodian
- CustodyProvider
- CustodyProviders
- DataAccess
- DataProviderBinding
- DataProviderBindings
- DataRuleItem
- DataRules
- Delivered
- Document
- Documents
- EIP712Template
- ErrorState
- ExecutionContext
- ExecutionOrganization
- ExecutionPlan
- ExecutionPlanContract
- ExecutionPlanInstruction
- ExecutionPlanInstructions
- ExecutionPlanInvestor
- ExecutionsPlans
- FiatAsset
- Field
- FinP2PAccount
- FinP2PAsset
- FinP2PAssetAccount
- FinP2PEVMOperatorDetails
- FinancialAsset
- FinancialAssets
- FinancialIdentifier
- FullSettlement
- HashGroup
- HashlistTemplate
- HoldInstruction
- Holding
- Holdings
- Iban
- IncomingMessage
- InstructionApproval
- InstructionApprovals
- InstructionTransition
- Intent
- Intents
- InterestRate
- Investor
- IssuanceContractDetails
- IssueInstruction
- Issuer
- Issuers
- KeyValuePair
- LedgerAccountAsset
- LedgerApiKeyOptions
- LedgerAssetInfo
- LedgerBinding
- LedgerBindings
- LedgerIdempotencyOptions
- LedgerMtlsOptions
- LedgerOAuthOptions
- LoanContractDetails
- LoanInstruction
- LoanIntent
- LoanOrder
- LoanOrderInstruction
- LoanSettlementInstruction
- ManualIntentSignaturePolicy
- Message
- MessageRecipient
- MessageRecipients
- Messages
- MoveContractDetails
- MoveInstruction
- MoveIntent
- NetworkAccount
- NoProof
- NoProofPolicy
- NoSettlement
- NodeAddress
- NotDelivered
- Organization
- OrganizationAsset
- Organizations
- OutgoingMessage
- OutgoingMessages
- PageInfo
- PartialSettlement
- PendingDelivery
- PinningConfig
- PinningConfigNodeEntry
- PinningConfigs
- PlanApproval
- PlanApprovalStatusInfo
- PlanApprovals
- PresignedBuyingIntentSignaturePolicy
- PresignedLoanIntentSignaturePolicy
- PresignedMoveIntentSignaturePolicy
- PresignedPrivateOfferIntentSignaturePolicy
- PresignedRedemptionIntentSignaturePolicy
- PresignedRequestForTransferIntentSignaturePolicy
- PresignedSellingIntentSignaturePolicy
- PrimarySale
- PrivateOfferContractDetails
- PrivateOfferIntent
- ProfileMetadata
- Receipt
- ReceiptState
- Receipts
- RedeemInstruction
- RedemptionConditions
- RedemptionContractDetails
- RedemptionIntent
- RedemptionSettlementInstruction
- Reference
- ReleaseInstruction
- RepaymentTerm
- RequestForTransferContractDetails
- RequestForTransferIntent
- RequestForTransferIntentAsset
- RequestForTransferRequestInstruction
- RequestForTransferSendInstruction
- RevertHoldInstruction
- SellingContractDetails
- SellingIntent
- SellingSettlementInstruction
- SequenceTransition
- SettlementInstruction
- SettlementTerm
- Signature
- SignatureProof
- SignatureProofPolicy
- StatusTransition
- SuccessState
- TokenBalance
- TokensBalances
- TradeDetails
- TransactionDetails
- TransferContractDetails
- TransferInstruction
- UnknownState
- User
- Users
- Verifier
- WalletAccount
- Workflow
- WorkflowAdminMetadata
- WorkflowHealth
- WorkflowHealthMetadata
- WorkflowMetadata
- Workflows
- Inputs
- Enums
- ActionType
- AggregateFunc
- ApprovalStatus
- AssetDataIdentifierType
- AssetOrderField
- AssetType
- CertificateOrderField
- DataAccessType
- DataType
- ExecutionOrganizationRole
- ExecutionPlanInstructionStatus
- ExecutionPlanOrderField
- ExecutionPlanStatus
- FinancialIdentifierType
- HoldingFields
- HttpSchemas
- IntentField
- IntentStatus
- IntentTypes
- InvestorRole
- IssuerOrderField
- LedgerAuthType
- OperationType
- Operator
- OrganizationOrderField
- PlanField
- ReceiptOrderField
- ReceiptStatus
- SignaturePolicyType
- SignatureTemplate
- SortOrder
- UserOrderField
- WorkflowAdminAction
- WorkflowHealthStatus
- WorkflowOrderField
- templateType
- Scalars
- Interfaces
- Unions
- AccountIdentifier
- AssetDetails
- BuyingSignaturePolicy
- Correspondent
- DeliveryStatus
- ExecutionPlanContractDetails
- InstructionCompletionState
- InstructionDetails
- IntentDetails
- LedgerAuthOptions
- LedgerIdentifier
- LedgerReference
- LoanConditions
- LoanSignaturePolicy
- MoveSignaturePolicy
- PrivateOfferSignaturePolicy
- Proof
- ProofPolicy
- Recipient
- RedemptionSignaturePolicy
- RequestForTransferAssetInstruction
- RequestForTransferSignaturePolicy
- SellingSignaturePolicy
- SettlementInstructionTypeDetails
- SettlementTermOptionType
- SuccessStateOutput
- Template
- Transition
Query
The query root of Ownera's GraphQL interface.
| Field | Argument | Type | Description |
|---|---|---|---|
| assets | Assets! | Look up Assets, Optional provide Filters or Aggregates. | |
| filter | [Filter!] | ||
| aggregate | [Aggregate!] | ||
| paginate | PaginateInput | ||
| orderBy | AssetOrderInput | ||
| users | Users! | Look up Users, Optional provide Filter or Aggregate. | |
| filter | [Filter!] | ||
| aggregate | [Aggregate!] | ||
| paginate | PaginateInput | ||
| receipts | Receipts! | Look up a receipt by a Filter (mandatory). | |
| filter | [Filter] | ||
| paginate | PaginateInput | ||
| issuers | Issuers! | Look up Issuers, Optional provide Filter. | |
| filter | [Filter!] | ||
| paginate | PaginateInput | ||
| certificates | Certificates! | Look up Certificates, Optional provide Filter or Aggregate. | |
| filter | [Filter!] | ||
| aggregate | [Aggregate!] | ||
| paginate | PaginateInput | ||
| organizations | Organizations! | Look up Organizations, Optional provide Filter or Aggregate. | |
| filter | [Filter!] | ||
| aggregate | [Aggregate!] | ||
| paginate | PaginateInput | ||
| plans | ExecutionsPlans! | Look up Execution Plans, Optional provide Filter. | |
| filter | [Filter!] | ||
| paginate | PaginateInput | ||
| orderBy | ExecutionPlanOrder | ||
| workflows | Workflows! | Look up Workflows, Optional provide Filter. | |
| filter | [Filter!] | ||
| paginate | PaginateInput | ||
| orderBy | WorkflowOrder | ||
| ledgers | LedgerBindings! | ||
| filter | [Filter!] | ||
| paginate | PaginateInput | ||
| custodyProviders | CustodyProviders! | ||
| filter | [Filter!] | ||
| paginate | PaginateInput | ||
| approvalConfigs | ApprovalConfigs! | ||
| paginate | PaginateInput | ||
| pinningConfig | PinningConfigs | ||
| assetDatas | AssetDatas! | Look up Asset Data, Optional provide Filter. | |
| filter | [Filter!] | ||
| paginate | PaginateInput | ||
| dataProviders | DataProviderBindings! | Look up Data Provider bindings. | |
| filter | [Filter!] | ||
| paginate | PaginateInput | ||
| dataRules | DataRules! | Look up Data Rules that map identifiers to data providers. | |
| filter | [Filter!] | ||
| paginate | PaginateInput | ||
| financialAssets | FinancialAssets! | Look up FinancialAssets aggregated by ISIN from data adapter data. Filter by isin to get a specific asset. | |
| filter | [Filter!] | ||
| paginate | PaginateInput | ||
Subscription
| Field | Argument | Type | Description |
|---|---|---|---|
| receiptAdded | Receipt! | ||
| planAdded | ExecutionPlan! | ||
| plansChangedBy | ExecutionPlan! | ||
| fieldNames | [PlanField!]! | ||
| userHoldingAdded | User! | ||
| userHoldingChanged | User! | ||
| fieldNames | [HoldingFields!]! | ||
| assetDataChanged | AssetDataItem! | ||
| identifierType | AssetDataIdentifierType | ||
| identifierValue | String | ||
| dataTypes | [DataType!] | ||
| intentAdded | Intent! | 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!] | ||
| intentChanged | Intent! | Fires when an intent field listed in fieldNames changes. Same filter semantics as intentAdded. | |
| fieldNames | [IntentField!]! | ||
| intentTypes | [IntentTypes!] | ||
| assetIds | [String!] | ||
| ownerOrgIds | [String!] | ||
Objects
AdditionalContractDetails
| Field | Argument | Type | Description |
|---|---|---|---|
| finP2PEVMOperatorDetails | FinP2PEVMOperatorDetails | ||
AggregateResult
Result of Aggregation function applied on an Object numeric field.
| Field | Argument | Type | Description |
|---|---|---|---|
| field | String! | The Object's field which this results refer to. | |
| func | AggregateFunc! | The AggregateFunc which this AggregateResult refers to. | |
| result | String! | ||
ApprovalConfig
| Field | Argument | Type | Description |
|---|---|---|---|
| id | String! | proposal approval configuration | |
| config | String! | ||
| createdAt | String! | ||
ApprovalConfigs
| Field | Argument | Type | Description |
|---|---|---|---|
| nodes | [ApprovalConfig!] | ||
| pageInfo | PageInfo | Keeps pagination info in-case limit input was provided | |
Asset
Represents an Asset in the network.
| Field | Argument | Type | Description |
|---|---|---|---|
| id | String! | ||
| certificates | Certificates! | Collection of certificates associated with the Profile. | |
| filter | [Filter!] | ||
| aggregates | [Aggregate!] | ||
| intents | Intents! | Collection of Intents associated with the Asset. | |
| filter | [Filter!] | ||
| aggregates | [Aggregate!] | ||
| name | String! | ||
| symbol | String | ||
| type | String! | Type of Asset (Share, Debt etc..) | |
| config | String! | Custom configuration for the Asset. | |
| issuedTokens | TokensBalances! | Tokens issued for the given Asset. | |
| filter | [Filter!] | ||
| aggregates | [Aggregate!] | ||
| issuerId | String! | Issuer profile of the Asset. | |
| regulationVerifiers | [Verifier!] | Regulation Verifiers associated with the Asset. | |
| organizationId | String! | Organization id to whom this profile is associated with. | |
| metadata | ProfileMetadata! | Profile metadata, contains ACL information of the profile. | |
| denomination | FiatAsset! | Denomination currency of the Asset | |
| allowedIntents | [IntentTypes!] | Allowed intent types to be used on the asset | |
| policies | AssetPolicies | Describe the policies active on the asset | |
| ledgerAssetInfo | LedgerAssetInfo | ledgerAssetInfo information | |
| financialIdentifier | FinancialIdentifier | classification standard used to identify the financial asset | |
| version | String! | asset resource version | |
| allowPolicyDefaultFallback | Boolean! | to fallback to default allowed policy if no specific policy is set | |
| decimalPlaces | Int! | decimal places for the asset | |
| autoShare | Boolean! | whether the asset is auto-shared | |
| orgSettlementAccount | NetworkAccount | omnibus account for the asset, if applicable | |
AssetDataItem
Represents financial data for an asset from a data provider
| Field | Argument | Type | Description |
|---|---|---|---|
| id | String! | ||
| identifierType | AssetDataIdentifierType! | Type of identifier used (ISIN or CAIP19) | |
| identifierValue | String! | The identifier value (e.g., US0378331005 for ISIN) | |
| dataType | DataType! | Type of financial data | |
| data | String! | The actual data as JSON string | |
| source | String | Data provider source identifier | |
| providerTimestamp | Int | Provider timestamp (epoch ms) | |
| createdAt | Int! | When the record was created | |
| updatedAt | Int! | When the record was last updated | |
AssetDatas
Results for asset data query.
| Field | Argument | Type | Description |
|---|---|---|---|
| nodes | [AssetDataItem!] | Collection of AssetDataItem Objects, conforms to the Filter input if provided. | |
| pageInfo | PageInfo | Keeps pagination info in-case limit input was provided | |
AssetIssuer
| Field | Argument | Type | Description |
|---|---|---|---|
| issuerId | String! | ||
| assetId | String! | ||
AssetOrder
| Field | Argument | Type | Description |
|---|---|---|---|
| term | AssetOrderTerm! | ||
| instruction | AssetOrderInstruction! | ||
AssetOrderInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| sourceAccount | LedgerAccountAsset | ||
| destinationAccount | LedgerAccountAsset | ||
AssetOrderTerm
| Field | Argument | Type | Description |
|---|---|---|---|
| amount | String! | ||
AssetPolicies
| Field | Argument | Type | Description |
|---|---|---|---|
| proof | ProofPolicy! | ||
AssetRefreshConfigItem
Refresh configuration for an asset's data from a provider
| Field | Argument | Type | Description |
|---|---|---|---|
| id | String! | ||
| identifierType | AssetDataIdentifierType! | ||
| identifierValue | String! | ||
| dataType | String! | ||
| refreshInterval | String! | ||
| lastRefreshAt | Int | ||
| nextRefreshAt | Int | ||
| providerId | String | UUID of the data provider | |
| enabled | Boolean! | ||
| createdAt | Int! | ||
| updatedAt | Int! | ||
AssetTerm
| Field | Argument | Type | Description |
|---|---|---|---|
| amount | String! | Total amount of asset allocated | |
Assets
Results for asset query.
| Field | Argument | Type | Description |
|---|---|---|---|
| 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. | |
| pageInfo | PageInfo | Keeps pagination info in-case limit input wes provided | |
Attachment
| Field | Argument | Type | Description |
|---|---|---|---|
| uuid | String! | ||
| name | String | ||
| link | String | ||
| messageId | String! | ||
AwaitInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| waitTime | Int! | epoch time for await instruction | |
BuyingContractDetails
| Field | Argument | Type | Description |
|---|---|---|---|
| asset | AssetOrder! | ||
| settlement | AssetOrder | ||
BuyingIntent
| Field | Argument | Type | Description |
|---|---|---|---|
| buyer | String | resource id of the buyer | |
| assetTerm | AssetTerm! | Asset term specifies the asset information and amount of the intent | |
| destination | FinP2PAssetAccount! | Destination account - where buyer receives the asset | |
| settlementTerm | SettlementTerm | Settlement term | |
| signaturePolicyType | SignaturePolicyType! | Signature policy type | |
| signaturePolicy | BuyingSignaturePolicy! | ||
| settlementInstruction | BuyingSettlementInstruction | ||
BuyingSettlementInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| account | FinP2PAssetAccount | Source account where buyer pays from | |
Caip19Identifier
CAIP-19 format ledger identifier
| Field | Argument | Type | Description |
|---|---|---|---|
| network | String | CAIP-2 network identifier (e.g., eip155:1, solana:mainnet) | |
| standard | String | Token standard (e.g., erc20, erc721) | |
| tokenId | String! | Token ID or contract address | |
Certificate
Represents a Certificate in the network.
| Field | Argument | Type | Description |
|---|---|---|---|
| id | String! | ||
| profileId | String! | Profile to whom this Certificate is associate with. | |
| type | String! | Type of Certificate (KYA,KYC,AML etc.. ). | |
| providerId | String! | Service Provider Id which provided the Certificate. | |
| issuedAt | Int! | ||
| expiry | Int | ||
| data | String | Semi-Structured Data provided as additional information for the Certificate. | |
| documents | Documents! | Certificate associated documents metadata. | |
| filter | [Filter!] | ||
Certificates
Results for certificates query.
| Field | Argument | Type | Description |
|---|---|---|---|
| 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. | |
| pageInfo | PageInfo | Keeps pagination info in-case limit input wes provided | |
CloseAmountRate
| Field | Argument | Type | Description |
|---|---|---|---|
| repaymentVolume | String! | ||
ContractDetails
| Field | Argument | Type | Description |
|---|---|---|---|
| network | String! | ||
| address | String! | ||
| tokenStandard | String | ||
| additionalContractDetails | AdditionalContractDetails | ||
CryptoWalletAccount
Crypto wallet account
| Field | Argument | Type | Description |
|---|---|---|---|
| address | String! | Wallet address represented as a hexadecimal string prefixed with 0x | |
Custodian
| Field | Argument | Type | Description |
|---|---|---|---|
| orgId | String! | ||
CustodyProvider
| Field | Argument | Type | Description |
|---|---|---|---|
| name | String! | ||
| endpoint | String! | ||
| displayName | String | ||
| idempotency | LedgerIdempotencyOptions | ||
| requestTimeout | String! | ||
| backoff | String! | ||
| singleRequestTimeout | String! | ||
CustodyProviders
| Field | Argument | Type | Description |
|---|---|---|---|
| nodes | [CustodyProvider!] | Collection of Custody Provider Objects, conforms to the Filter input if provided. | |
| pageInfo | PageInfo | Keeps pagination info in-case limit input was provided | |
DataAccess
| Field | Argument | Type | Description |
|---|---|---|---|
| targetOrgId | String! | organization id the resource shared with | |
| accessType | DataAccessType! | data access type | |
| status | String! | status of the shared resource data access | |
DataProviderBinding
Represents a data provider binding configuration
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID! | Unique identifier (UUID) for the data provider | |
| name | String! | ||
| providerType | String! | Type of data provider: adapter (external HTTP) or finp2p (internal P2P) | |
| endpoint | String! | ||
| displayName | String | ||
| requestTimeout | String! | ||
| backoff | String! | ||
| dataTypes | [String!] | JSON array of data type strings this provider serves | |
| dataTypeConfig | String | JSON string of per-data-type fetch configuration | |
| createdAt | Int! | ||
| updatedAt | Int! | ||
DataProviderBindings
Results for data provider query.
| Field | Argument | Type | Description |
|---|---|---|---|
| nodes | [DataProviderBinding!] | Collection of DataProviderBinding Objects, conforms to the Filter input if provided. | |
| pageInfo | PageInfo | Keeps pagination info in-case limit input was provided | |
DataRuleItem
Represents a data rule mapping an asset identifier to a data provider
| Field | Argument | Type | Description |
|---|---|---|---|
| id | String! | ||
| identifierType | String! | Type of identifier (e.g., ISIN) | |
| identifierValue | String! | The identifier value (e.g., US0378331005) | |
| providerId | String! | UUID of the data provider | |
| dataType | String! | The data type this rule covers | |
| refreshInterval | String | Refresh interval for this rule (e.g., 1h, 24h, RT) | |
| enabled | Boolean! | Whether this rule is active | |
| createdAt | Int! | When the rule was created (epoch seconds) | |
| updatedAt | Int! | When the rule was last updated (epoch seconds) | |
DataRules
Results for data rules query.
| Field | Argument | Type | Description |
|---|---|---|---|
| nodes | [DataRuleItem!] | Collection of DataRuleItem Objects, conforms to the Filter input if provided. | |
| pageInfo | PageInfo | Keeps pagination info in-case limit input was provided | |
Delivered
| Field | Argument | Type | Description |
|---|---|---|---|
| _ignore | Boolean | ||
Document
Certificate related Document metadata informaiton
| Field | Argument | Type | Description |
|---|---|---|---|
| id | String! | ||
| uri | String! | Locaiton of document content. | |
| name | String! | ||
| mimeType | String! | ||
Documents
Results for documents query.
| Field | Argument | Type | Description |
|---|---|---|---|
| nodes | [Document!] | Collection of Document Objects, conforms to the Filter input if provided. | |
EIP712Template
| Field | Argument | Type | Description |
|---|---|---|---|
| hash | String! | ||
ErrorState
| Field | Argument | Type | Description |
|---|---|---|---|
| code | Int! | ||
| message | String! | ||
ExecutionContext
| Field | Argument | Type | Description |
|---|---|---|---|
| executionPlanId | String | ExecutionPlan associated with the transaction | |
| instructionSequenceNumber | Int | The associated instruction sequence number | |
ExecutionOrganization
Information about organization in an Execution Plan context
| Field | Argument | Type | Description |
|---|---|---|---|
| organizationId | String! | ||
| 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
| Field | Argument | Type | Description |
|---|---|---|---|
| id | String! | resource id of execution plan | |
| intent | Intent | Intent associated with execution plan | |
| organizations | [ExecutionOrganization!]! | organizations which participate in the execution plan | |
| status | ExecutionPlanStatus! | lifecycle status of the execution plan | |
| instructions | [ExecutionPlanInstruction]! | plan's list of instructions | |
| contract | ExecutionPlanContract! | plan's contract details | |
| approvals | [PlanApproval]! | list of plan approvals | |
| creationTimestamp | Int! | plan creation (timestamp in sec) | |
| lastModified | Int! | last time plan was modified (epoch time seconds) | |
| version | Int! | version of the execution plan | |
| customMetadata | [KeyValuePair!] | Custom key-value metadata for tracing and reconciliation | |
ExecutionPlanContract
| Field | Argument | Type | Description |
|---|---|---|---|
| investors | [ExecutionPlanInvestor!]! | ||
| contractDetails | ExecutionPlanContractDetails | ||
ExecutionPlanInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| sequence | Int! | ||
| organizations | [ExecutionOrganization!]! | ||
| details | InstructionDetails! | ||
| status | ExecutionPlanInstructionStatus! | ||
| state | InstructionCompletionState! | ||
| approvals | InstructionApprovals! | ||
| filter | [Filter!] | ||
| transitions | InstructionTransition! | ||
| version | Int! | ||
| workflows | [Workflow!]! | ||
ExecutionPlanInstructions
| Field | Argument | Type | Description |
|---|---|---|---|
| nodes | [ExecutionPlanInstruction!] | ||
ExecutionPlanInvestor
| Field | Argument | Type | Description |
|---|---|---|---|
| investor | String! | ||
| role | InvestorRole! | ||
ExecutionsPlans
| Field | Argument | Type | Description |
|---|---|---|---|
| nodes | [ExecutionPlan!] | ||
| pageInfo | PageInfo | Keeps pagination info in-case limit input wes provided | |
FiatAsset
Fiat currency asset for denomination purposes
| Field | Argument | Type | Description |
|---|---|---|---|
| code | String! | ISO-4217 code of the fiat currency | |
Field
| Field | Argument | Type | Description |
|---|---|---|---|
| name | String! | ||
| type | String! | ||
| value | String! | ||
FinP2PAccount
FinP2P account - represents a user account in the FinP2P network
| Field | Argument | Type | Description |
|---|---|---|---|
| finId | String! | FinId -- a user's public key represented as a hexadecimal string | |
| orgId | String! | Organization id of the account | |
| custodian | Custodian | Custodian for the finId | |
FinP2PAsset
FinP2P asset with resource ID and ledger identifier
| Field | Argument | Type | Description |
|---|---|---|---|
| resourceId | String! | Resource ID of the FinP2P asset | |
| ledgerIdentifier | LedgerIdentifier | Ledger identifier for the asset | |
FinP2PAssetAccount
FinP2P asset account - combines asset info with account info (matches proto FinP2PAssetAccount)
| Field | Argument | Type | Description |
|---|---|---|---|
| asset | FinP2PAsset | FinP2P asset information | |
| account | FinP2PAccount | FinP2P account information | |
FinP2PEVMOperatorDetails
| Field | Argument | Type | Description |
|---|---|---|---|
| finP2POperatorContractAddress | String! | ||
| allowanceRequired | Boolean! | ||
FinancialAsset
Aggregated view of a financial asset identified by ISIN
| Field | Argument | Type | Description |
|---|---|---|---|
| isin | String! | 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.
| Field | Argument | Type | Description |
|---|---|---|---|
| nodes | [FinancialAsset!] | ||
| pageInfo | PageInfo | ||
FinancialIdentifier
| Field | Argument | Type | Description |
|---|---|---|---|
| type | FinancialIdentifierType! | ||
| value | String! | ||
FullSettlement
| Field | Argument | Type | Description |
|---|---|---|---|
| amount | String! | ||
HashGroup
| Field | Argument | Type | Description |
|---|---|---|---|
| hash | String! | ||
| fields | [Field!]! | ||
HashlistTemplate
| Field | Argument | Type | Description |
|---|---|---|---|
| hash | String! | ||
| hashGroups | [HashGroup!]! | ||
HoldInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| source | LedgerAccountAsset! | source account information | |
| destination | LedgerAccountAsset | destination account information | |
| amount | String! | asset's hold amount | |
Holding
| Field | Argument | Type | Description |
|---|---|---|---|
| account | FinP2PAccount! | ||
| assetType | AssetType! | ||
| asset | AssetDetails! | ||
| balance | String! | ||
| withheldBalance | String! | ||
| availableBalance | String! | ||
| balanceTimestamp | Int! | ||
| syncedBalance | String! | ||
| syncedAvailableBalance | String! | ||
| syncedHeldBalance | String! | ||
Holdings
| Field | Argument | Type | Description |
|---|---|---|---|
| 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
| Field | Argument | Type | Description |
|---|---|---|---|
| code | String! | IBAN code | |
IncomingMessage
| Field | Argument | Type | Description |
|---|---|---|---|
| message | Message | ||
InstructionApproval
| Field | Argument | Type | Description |
|---|---|---|---|
| planId | String! | ||
| sequence | Int! | ||
| orgId | String! | ||
| status | String! | ||
| reason | String! | ||
InstructionApprovals
Results for Instruction Approval query.
| Field | Argument | Type | Description |
|---|---|---|---|
| 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
| Field | Argument | Type | Description |
|---|---|---|---|
| onSuccess | Transition | ||
| onFailure | Transition | ||
| onTimeout | Transition | ||
Intent
Represent an Asset's Transaction Intent occasion in which the Asset's tokens are issued.
| Field | Argument | Type | Description |
|---|---|---|---|
| id | String! | ||
| start | Int! | Start time of the intent. | |
| end | Int! | End time of the intent. | |
| status | IntentStatus! | Intent status | |
| remainingQuantity | String! | Remaining quantity in the transaction. | |
| type | String! | Intent type: primary sale, buying or selling intent | |
| intent | IntentDetails | Intent data | |
| customMetadata | [KeyValuePair!] | Custom key-value metadata for tracing and reconciliation | |
| metadata | ProfileMetadata! | Profile metadata, contains ACL information of the profile. | |
| version | String! | intent resource version | |
Intents
Results for itents query.
| Field | Argument | Type | Description |
|---|---|---|---|
| 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
| Field | Argument | Type | Description |
|---|---|---|---|
| annualPercentageRate | String! | ||
Investor
| Field | Argument | Type | Description |
|---|---|---|---|
| resourceId | String! | ||
IssuanceContractDetails
| Field | Argument | Type | Description |
|---|---|---|---|
| asset | AssetOrder! | ||
| settlement | AssetOrder | ||
IssueInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| source | LedgerAccountAsset | source for issuance | |
| destination | LedgerAccountAsset! | destination account for issuance | |
| amount | String! | asset's issuance amount | |
Issuer
Represents an Issuer in the network.
| Field | Argument | Type | Description |
|---|---|---|---|
| id | String! | ||
| assets | Assets! | Assets issued by the Issuer. | |
| filter | [Filter!] | ||
| aggregates | [Aggregate!] | ||
| paginate | PaginateInput | ||
| outbox | OutgoingMessages | ||
| filter | [Filter!] | ||
Issuers
Results for issuers query.
| Field | Argument | Type | Description |
|---|---|---|---|
| nodes | [Issuer!] | Collection of Issuer Objects, conforms to the Filter input if provided. | |
| pageInfo | PageInfo | Keeps pagination info in-case limit input wes provided | |
KeyValuePair
| Field | Argument | Type | Description |
|---|---|---|---|
| key | String! | ||
| value | String! | ||
LedgerAccountAsset
Ledger account asset - combines FinP2P account with optional network account
| Field | Argument | Type | Description |
|---|---|---|---|
| finp2pAccount | FinP2PAssetAccount! | FinP2P asset account | |
| networkAccount | NetworkAccount | Network account (e.g., wallet) | |
LedgerApiKeyOptions
| Field | Argument | Type | Description |
|---|---|---|---|
| apiKey | String! | ||
LedgerAssetInfo
| Field | Argument | Type | Description |
|---|---|---|---|
| ledgerIdentifier | LedgerIdentifier | ||
| ledgerReference | LedgerReference | ||
| ledgerBinding | LedgerBinding | ||
LedgerBinding
| Field | Argument | Type | Description |
|---|---|---|---|
| name | String! | ||
| endpoint | String! | ||
| idempotency | LedgerIdempotencyOptions | ||
| displayName | String | ||
| requestTimeout | String! | ||
| backoff | String! | ||
| singleRequestTimeout | String! | ||
| balanceSyncAllowed | Boolean! | ||
LedgerBindings
| Field | Argument | Type | Description |
|---|---|---|---|
| nodes | [LedgerBinding!] | Collection of Ledger Binding Objects, conforms to the Filter input if provided. | |
| pageInfo | PageInfo | Keeps pagination info in-case limit input wes provided | |
LedgerIdempotencyOptions
| Field | Argument | Type | Description |
|---|---|---|---|
| idempotent | Boolean! | ||
| transientFailureCodes | [String!]! | ||
LedgerMtlsOptions
| Field | Argument | Type | Description |
|---|---|---|---|
| clientCertificate | String! | ||
| caCertificate | String! | ||
| key | String! | ||
LedgerOAuthOptions
| Field | Argument | Type | Description |
|---|---|---|---|
| oauthClientId | String! | ||
| oauthClientSecret | String! | ||
| oauthServerEndpoint | String! | ||
| alg | String! | ||
| jwtKey | String! | ||
LoanContractDetails
| Field | Argument | Type | Description |
|---|---|---|---|
| asset | LoanOrder! | ||
| settlement | LoanOrder | ||
| instruction | LoanInstruction | ||
LoanInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| openDate | Int! | ||
| closeDate | Int! | ||
| loanConditions | LoanConditions! | ||
LoanIntent
| Field | Argument | Type | Description |
|---|---|---|---|
| borrower | String! | resource id of the borrower | |
| lender | String! | resource id of the lender | |
| assetTerm | AssetTerm! | Asset term specifies the asset information and amount of the intent | |
| borrowerAccount | FinP2PAssetAccount! | Borrower's account for the loan asset | |
| lenderAccount | FinP2PAssetAccount! | Lender's account for the loan asset | |
| settlementTerm | SettlementTerm | Settlement term | |
| loanSettlementInstruction | LoanSettlementInstruction | Signature policy type | |
| loanInstruction | LoanInstruction! | ||
| signaturePolicyType | SignaturePolicyType! | ||
| signaturePolicy | LoanSignaturePolicy! | ||
LoanOrder
| Field | Argument | Type | Description |
|---|---|---|---|
| term | AssetOrderTerm! | ||
| instruction | LoanOrderInstruction! | ||
LoanOrderInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| borrowerAccount | LedgerAccountAsset | ||
| lenderAccount | LedgerAccountAsset | ||
LoanSettlementInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| borrowerAccount | FinP2PAssetAccount | Borrower's account for settlement | |
| lenderAccount | FinP2PAssetAccount | Lender's account for settlement | |
ManualIntentSignaturePolicy
| Field | Argument | Type | Description |
|---|---|---|---|
| _ignore | Boolean | ||
Message
| Field | Argument | Type | Description |
|---|---|---|---|
| id | String! | ||
| subject | String! | ||
| body | String! | ||
| timestamp | String! | ||
| attachments | [Attachment!]! | ||
| correspondent | Correspondent! | ||
MessageRecipient
| Field | Argument | Type | Description |
|---|---|---|---|
| destination | Recipient! | ||
| deliveryStatus | DeliveryStatus | ||
MessageRecipients
| Field | Argument | Type | Description |
|---|---|---|---|
| nodes | [MessageRecipient!] | Collection of User Objects, conforms to the Filter input if provided. | |
Messages
| Field | Argument | Type | Description |
|---|---|---|---|
| nodes | [Message!] | ||
MoveContractDetails
| Field | Argument | Type | Description |
|---|---|---|---|
| asset | AssetOrder! | ||
MoveInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| source | LedgerAccountAsset! | source account information | |
| destination | LedgerAccountAsset! | destination account information | |
| amount | String! | asset's move amount | |
MoveIntent
| Field | Argument | Type | Description |
|---|---|---|---|
| investor | String | resource id of the investor | |
| assetTerm | AssetTerm! | Asset term specifies the asset information and amount of the intent | |
| source | FinP2PAssetAccount | Source account when the move intent is submitted from the source side | |
| destination | FinP2PAssetAccount | Destination account when the move intent is submitted from the destination side | |
| signaturePolicyType | SignaturePolicyType! | Signature policy type | |
| signaturePolicy | MoveSignaturePolicy! | ||
NetworkAccount
Network account - represents external network accounts like wallets
| Field | Argument | Type | Description |
|---|---|---|---|
| wallet | WalletAccount | Wallet account if present | |
NoProof
| Field | Argument | Type | Description |
|---|---|---|---|
| _ignore | Boolean | ||
NoProofPolicy
| Field | Argument | Type | Description |
|---|---|---|---|
| _ignore | Boolean | ||
NoSettlement
| Field | Argument | Type | Description |
|---|---|---|---|
| _ignore | Boolean | ||
NodeAddress
| Field | Argument | Type | Description |
|---|---|---|---|
| address | String! | address value | |
| port | Int! | node port | |
| schemas | [HttpSchemas!]! | supported http schemas | |
NotDelivered
| Field | Argument | Type | Description |
|---|---|---|---|
| status | String! | ||
Organization
Organization's information.
| Field | Argument | Type | Description |
|---|---|---|---|
| id | String! | ||
| types | [String!] | Organization's supported types, e.g. Primary, Escrow | |
| name | String! | Organization's name on the finp2p network. | |
| finId | String! | Organization's finp2p public key represented as a hexadecimal string. | |
| clusterId | String! | Organization's cluster id. | |
| assets | Assets! | Assets which the Organization act as the Primary Node. | |
| filter | [Filter!] | ||
| aggregates | [Aggregate!] | ||
| paginate | PaginateInput | ||
| users | Users! | Users which the Organization act as the Primary Node. | |
| filter | [Filter!] | ||
| aggregates | [Aggregate!] | ||
| paginate | PaginateInput | ||
OrganizationAsset
| Field | Argument | Type | Description |
|---|---|---|---|
| asset | Asset! | ||
| metadata | ProfileMetadata! | ||
Organizations
Results for Organization query.
| Field | Argument | Type | Description |
|---|---|---|---|
| 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. | |
| pageInfo | PageInfo | Keeps pagination info in-case limit input wes provided | |
OutgoingMessage
| Field | Argument | Type | Description |
|---|---|---|---|
| message | Message | ||
| recipients | MessageRecipients! | ||
| filter | [Filter!] | ||
OutgoingMessages
| Field | Argument | Type | Description |
|---|---|---|---|
| nodes | [OutgoingMessage!] | ||
PageInfo
| Field | Argument | Type | Description |
|---|---|---|---|
| hasNextPage | Boolean! | Indicates if there are more items after the current page | |
| endCursor | String | Cursor for the end of the current page | |
| totalCount | Int! | Total count of items | |
| totalLeft | Int! | Total count of items left to be presented | |
PartialSettlement
| Field | Argument | Type | Description |
|---|---|---|---|
| unitValue | String! | ||
PendingDelivery
| Field | Argument | Type | Description |
|---|---|---|---|
| _ignore | Boolean | ||
PinningConfig
| Field | Argument | Type | Description |
|---|---|---|---|
| id | String! | pinning config unique id | |
| nodes | [PinningConfigNodeEntry!]! | pinning service configuration data | |
PinningConfigNodeEntry
| Field | Argument | Type | Description |
|---|---|---|---|
| id | String! | entry unique id | |
| token | String! | ||
| addresses | [NodeAddress!]! | ||
PinningConfigs
| Field | Argument | Type | Description |
|---|---|---|---|
| nodes | [PinningConfig!] | pinning service configuration data | |
PlanApproval
| Field | Argument | Type | Description |
|---|---|---|---|
| planId | String! | ||
| orgId | String! | ||
| status | ApprovalStatus! | ||
| statusInfo | PlanApprovalStatusInfo! | ||
PlanApprovalStatusInfo
| Field | Argument | Type | Description |
|---|---|---|---|
| code | Int! | ||
| message | String! | ||
PlanApprovals
Results for Plan Approval query.
| Field | Argument | Type | Description |
|---|---|---|---|
| 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
| Field | Argument | Type | Description |
|---|---|---|---|
| _ignore | Boolean | ||
PresignedLoanIntentSignaturePolicy
| Field | Argument | Type | Description |
|---|---|---|---|
| _ignore | Boolean | ||
PresignedMoveIntentSignaturePolicy
| Field | Argument | Type | Description |
|---|---|---|---|
| _ignore | Boolean | ||
PresignedPrivateOfferIntentSignaturePolicy
| Field | Argument | Type | Description |
|---|---|---|---|
| _ignore | Boolean | ||
PresignedRedemptionIntentSignaturePolicy
| Field | Argument | Type | Description |
|---|---|---|---|
| _ignore | Boolean | ||
PresignedRequestForTransferIntentSignaturePolicy
| Field | Argument | Type | Description |
|---|---|---|---|
| _ignore | Boolean | ||
PresignedSellingIntentSignaturePolicy
| Field | Argument | Type | Description |
|---|---|---|---|
| _ignore | Boolean | ||
PrimarySale
| Field | Argument | Type | Description |
|---|---|---|---|
| issuerId | String! | Issuer id | |
| assetTerm | AssetTerm! | Asset term specifies the asset information and amount of the intent | |
| source | FinP2PAssetAccount! | Source account - issuer's account from which asset is sold | |
| settlementTerm | SettlementTerm | Settlement term | |
| sellingSettlementInstruction | SellingSettlementInstruction | ||
PrivateOfferContractDetails
| Field | Argument | Type | Description |
|---|---|---|---|
| asset | AssetOrder! | ||
| settlement | AssetOrder | ||
PrivateOfferIntent
| Field | Argument | Type | Description |
|---|---|---|---|
| buyer | String | resource id of the buyer | |
| seller | String | resource id of the seller | |
| assetTerm | AssetTerm! | Asset term specifies the asset information and amount of the intent | |
| source | FinP2PAssetAccount! | Source account - seller's account from which asset is sold | |
| settlementTerm | SettlementTerm | Settlement term | |
| signaturePolicyType | SignaturePolicyType! | Signature policy type | |
| signaturePolicy | PrivateOfferSignaturePolicy! | ||
| sellingSettlementInstruction | SellingSettlementInstruction | ||
ProfileMetadata
Profile Metadata (ACL).
| Field | Argument | Type | Description |
|---|---|---|---|
| acl | [String!] | ||
| dataAccess | [DataAccess!] | Shared resources data access given to which org | |
Receipt
| Field | Argument | Type | Description |
|---|---|---|---|
| id | String! | ||
| source | String | Source owner resource ID | |
| sourceAccount | LedgerAccountAsset | Source account of transaction | |
| destination | String | Destination owner resource ID | |
| destinationAccount | LedgerAccountAsset | Destination account of transaction | |
| quantity | String! | Number of asset units with the transaction | |
| tradeDetails | TradeDetails | Trade details associated with the transaction | |
| operationId | String | Operation id | |
| transactionId | String | Underlying transaction id | |
| operationType | OperationType | Operation type | |
| timestamp | String! | Receipt timestamp | |
| status | ReceiptStatus! | Receipt status | |
| proof | Proof | Ledger proof | |
ReceiptState
| Field | Argument | Type | Description |
|---|---|---|---|
| receipt | Receipt! | ||
Receipts
Results for receipts query.
| Field | Argument | Type | Description |
|---|---|---|---|
| nodes | [Receipt!] | Collection of Receipt Objects, conforms to the Filter input if provided. | |
| pageInfo | PageInfo | Keeps pagination info in-case limit input wes provided | |
RedeemInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| source | LedgerAccountAsset! | source account information | |
| amount | String! | asset's redeem amount | |
RedemptionConditions
| Field | Argument | Type | Description |
|---|---|---|---|
| redemptionDuration | String! | ||
RedemptionContractDetails
| Field | Argument | Type | Description |
|---|---|---|---|
| asset | AssetOrder! | ||
| settlement | AssetOrder | ||
RedemptionIntent
| Field | Argument | Type | Description |
|---|---|---|---|
| issuerId | String! | Issuer id | |
| redemptionSettlementInstruction | RedemptionSettlementInstruction | Specify settlement accounts | |
| assetTerm | AssetTerm! | Asset term specifies the asset information and amount of the intent | |
| destination | FinP2PAssetAccount | Destination account - where redeemed asset goes (to issuer) | |
| settlementTerm | SettlementTerm | Settlement term | |
| conditions | RedemptionConditions! | Intent conditions | |
| signaturePolicyType | SignaturePolicyType! | Signature policy type | |
| signaturePolicy | RedemptionSignaturePolicy! | ||
RedemptionSettlementInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| accounts | [FinP2PAssetAccount!] | Source accounts where payment comes from | |
Reference
| Field | Argument | Type | Description |
|---|---|---|---|
| workflowId | String! | ||
| referenceId | String! | ||
| referenceType | String! | ||
ReleaseInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| source | LedgerAccountAsset! | source account information | |
| destination | LedgerAccountAsset! | destination account information | |
| amount | String! | asset's release amount | |
RepaymentTerm
| Field | Argument | Type | Description |
|---|---|---|---|
| repaymentVolume | String! | ||
| annualPercentageRate | String | ||
RequestForTransferContractDetails
| Field | Argument | Type | Description |
|---|---|---|---|
| asset | AssetOrder! | ||
RequestForTransferIntent
| Field | Argument | Type | Description |
|---|---|---|---|
| sender | String | resource id of the sender | |
| receiver | String | resource id of the receiver | |
| asset | RequestForTransferIntentAsset! | ||
| signaturePolicy | RequestForTransferSignaturePolicy! | ||
| signaturePolicyType | SignaturePolicyType! | ||
RequestForTransferIntentAsset
| Field | Argument | Type | Description |
|---|---|---|---|
| assetTerm | AssetTerm! | ||
| assetInstruction | RequestForTransferAssetInstruction! | ||
RequestForTransferRequestInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| action | String! | Action type - always 'request' | |
| receiverAccount | FinP2PAssetAccount | ||
RequestForTransferSendInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| action | String! | Action type - always 'send' | |
| senderAccount | FinP2PAssetAccount | ||
RevertHoldInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| destination | LedgerAccountAsset! | destination account information | |
| holdInstructionSequence | Int! | hold instruction sequence number to be reverted | |
SellingContractDetails
| Field | Argument | Type | Description |
|---|---|---|---|
| asset | AssetOrder! | ||
| settlement | AssetOrder | ||
SellingIntent
| Field | Argument | Type | Description |
|---|---|---|---|
| seller | String | resource id of the seller | |
| assetTerm | AssetTerm! | Asset term specifies the asset information and amount of the intent | |
| source | FinP2PAssetAccount! | Source account - seller's account from which asset is sold | |
| settlementTerm | SettlementTerm | Settlement term | |
| signaturePolicyType | SignaturePolicyType! | Signature policy type | |
| signaturePolicy | SellingSignaturePolicy! | ||
| sellingSettlementInstruction | SellingSettlementInstruction | ||
SellingSettlementInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| accounts | [FinP2PAssetAccount!] | Destination accounts where seller receives payment | |
SequenceTransition
| Field | Argument | Type | Description |
|---|---|---|---|
| sequence | Int! | ||
SettlementInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| details | SettlementInstructionTypeDetails! | ||
SettlementTerm
| Field | Argument | Type | Description |
|---|---|---|---|
| details | SettlementTermOptionType! | ||
Signature
| Field | Argument | Type | Description |
|---|---|---|---|
| template | Template! | ||
| signature | String! | ||
| hashFunction | String! | ||
| templateType | templateType! | ||
| templateVersion | Int! | Template shape version. Defaults to 1 when the producer is on a pre-versioning finp2p-core release. | |
SignatureProof
| Field | Argument | Type | Description |
|---|---|---|---|
| signature | Signature! | ||
SignatureProofPolicy
| Field | Argument | Type | Description |
|---|---|---|---|
| verifyingKey | String! | ||
| signatureTemplate | SignatureTemplate! | ||
| templateVersion | Int! | ||
StatusTransition
| Field | Argument | Type | Description |
|---|---|---|---|
| status | ExecutionPlanStatus! | ||
SuccessState
| Field | Argument | Type | Description |
|---|---|---|---|
| output | SuccessStateOutput | ||
TokenBalance
Represents an Asset token balance information.
| Field | Argument | Type | Description |
|---|---|---|---|
| userId | String! | ||
| assetId | String! | ||
| quantity | String! | ||
| availableQuantity | String! | ||
| heldQuantity | String! | ||
| syncedQuantity | String! | ||
| syncedAvailableQuantity | String! | ||
| syncedHeldQuantity | String! | ||
| syncedQuantityTimestamp | Int! | ||
| transactionsDetails | [TransactionDetails!] | ||
TokensBalances
Results for tokens query.
| Field | Argument | Type | Description |
|---|---|---|---|
| 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
| Field | Argument | Type | Description |
|---|---|---|---|
| intent | Intent | Intent associated with the transaction | |
| executionContext | ExecutionContext | Details of ExecutionPlan associated with the transaction | |
TransactionDetails
| Field | Argument | Type | Description |
|---|---|---|---|
| transactionId | String! | ||
| index | Int! | ||
| quantity | String! | ||
TransferContractDetails
| Field | Argument | Type | Description |
|---|---|---|---|
| asset | AssetOrder! | ||
TransferInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| source | LedgerAccountAsset! | source account information | |
| destination | LedgerAccountAsset! | destination account information | |
| amount | String! | asset's transfer amount | |
UnknownState
| Field | Argument | Type | Description |
|---|---|---|---|
| _ignore | Boolean | ||
User
Represents an User in the network.
| Field | Argument | Type | Description |
|---|---|---|---|
| id | String! | ||
| certificates | Certificates! | Collection of certificates associated with the Profile. | |
| filter | [Filter!] | ||
| aggregates | [Aggregate!] | ||
| name | String! | ||
| holdings | Holdings! | ||
| filter | [Filter!] | ||
| aggregates | [Aggregate!] | ||
| organizationId | String! | Organization id to whom this profile is associated with. | |
| metadata | ProfileMetadata! | Profile metadata, contains ACL information of the profile. | |
| finIds | [String!] | finIds keys associated with this investor | |
| accounts | [FinP2PAccount!] | ||
| filter | [Filter!] | ||
| inbox | Messages! | User's associated messages | |
| filter | [Filter!] | ||
| version | String! | user resource version | |
| dataAccessReceived | [String] | Data access permissions this resource has received from other organizations | |
Users
Results for asset query.
| Field | Argument | Type | Description |
|---|---|---|---|
| nodes | [User!] | Collection of User Objects, conforms to the Filter input if provided. | |
| aggregate | [AggregateResult!] | ||
| pageInfo | PageInfo | Keeps pagination info in-case limit input wes provided | |
Verifier
Regulation Verifier
| Field | Argument | Type | Description |
|---|---|---|---|
| id | String | Verifier ID | |
| name | String | Verifier Name | |
| provider | String | Provider type: REG_APP_STORE, OTHER | |
WalletAccount
Wallet account for blockchain wallets
| Field | Argument | Type | Description |
|---|---|---|---|
| type | String! | Type of wallet (e.g., ethereum) | |
| address | String! | Wallet address | |
Workflow
| Field | Argument | Type | Description |
|---|---|---|---|
| id | String! | Id of the workflow | |
| name | String! | Name of the workflow | |
| transitionId | String! | Current transition id of the workflow | |
| status | String! | Current status of the workflow | |
| version | Int! | version of the workflow | |
| metadata | WorkflowMetadata! | metadata of the workflow | |
| references | [Reference!]! | list of reference information of the workflow | |
| expires | Int! | the time workflow expires | |
| health | WorkflowHealth | Health status and admin information for the workflow | |
| availableActions | [WorkflowAdminAction!]! | Available admin actions for this workflow | |
| adminMetadata | WorkflowAdminMetadata | Admin operations history and metadata | |
| creationTimestamp | Int! | Workflow creation timestamp | |
WorkflowAdminMetadata
Admin operations metadata and history
| Field | Argument | Type | Description |
|---|---|---|---|
| lastAction | WorkflowAdminAction | Last admin action performed | |
| lastActionTimestamp | Int | Timestamp of last admin action | |
| lastActionBy | String | User who performed last action | |
| totalActions | Int! | Total number of admin actions performed | |
WorkflowHealth
Health status of a workflow
| Field | Argument | Type | Description |
|---|---|---|---|
| status | WorkflowHealthStatus! | Current health status | |
| issues | [String!]! | List of health issues detected | |
| stuckSince | Int! | health stuck since timestamp | |
| lastAssessed | Int! | Timestamp when health was last assessed | |
| metadata | WorkflowHealthMetadata | Additional health metadata | |
WorkflowHealthMetadata
Additional health assessment metadata
| Field | Argument | Type | Description |
|---|---|---|---|
| timeSinceLastTransition | Int | Time since last state transition | |
| retryCount | Int | Number of retry attempts | |
| age | Int | Workflow age in seconds | |
WorkflowMetadata
| Field | Argument | Type | Description |
|---|---|---|---|
| ttl | Int! | TTL of the workflow | |
| retry | Int! | ||
| currentStateRetry | Int! | ||
| traceId | String! | ||
| correlationIds | [String!] | ||
Workflows
| Field | Argument | Type | Description |
|---|---|---|---|
| nodes | [Workflow!] | ||
| pageInfo | PageInfo | Keeps pagination info in-case limit input wes provided | |
Inputs
Aggregate
Apply an aggregation function on specified Object's field.
| Field | Type | Description | |
|---|---|---|---|
| field | String | Object's field to which apply the AggregateFunc | |
| func | AggregateFunc! | AggregateFunc to apply on the provided Field. | |
AssetOrderInput
| Field | Type | Description | |
|---|---|---|---|
| field | AssetOrderField | ||
| direction | SortOrder | ||
CertificateOrder
| Field | Type | Description | |
|---|---|---|---|
| field | CertificateOrderField | ||
| direction | SortOrder | ||
ExecutionPlanOrder
| Field | Type | Description | |
|---|---|---|---|
| field | ExecutionPlanOrderField | ||
| direction | SortOrder | ||
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.
| Field | Type | Description | |
|---|---|---|---|
| key | String! | The Object's key to which apply the filter rule. | |
| value | String! | The Value to be used by the Filter Operator. | |
| operator | Operator! | Operator to apply on the specified key and provided value. | |
IssuerOrder
| Field | Type | Description | |
|---|---|---|---|
| field | IssuerOrderField | ||
| direction | SortOrder | ||
OrganizationOrder
| Field | Type | Description | |
|---|---|---|---|
| field | OrganizationOrderField | ||
| direction | SortOrder | ||
PaginateInput
| Field | Type | Description | |
|---|---|---|---|
| limit | Int | Number of records to return in response | |
| skip | Int | Number of pages to skip to get new cursor | |
| after | String | Cursor field to return records after it | |
ReceiptOrder
| Field | Type | Description | |
|---|---|---|---|
| field | ReceiptOrderField | ||
| direction | SortOrder | ||
UserOrder
| Field | Type | Description | |
|---|---|---|---|
| field | UserOrderField | ||
| direction | SortOrder | ||
WorkflowOrder
| Field | Type | Description | |
|---|---|---|---|
| field | WorkflowOrderField | ||
| direction | SortOrder | ||
Enums
ActionType
| Value | Description |
|---|---|
| send | |
| request | |
| unknown |
AggregateFunc
Aggregation function to be applied on Object's numeric field.
| Value | Description |
|---|---|
| SUM | |
| COUNT | |
| AVG | |
| MAX | |
| MIN |
ApprovalStatus
| Value | Description |
|---|---|
| Approved | |
| Rejected | |
| Unknown |
AssetDataIdentifierType
Identifier type for asset data
| Value | Description |
|---|---|
| ISIN | |
| CAIP19 |
AssetOrderField
| Value | Description |
|---|---|
| ORGANIZATION | Assets order by determined by OrganizationId field |
| NAME | Assets order by determined by Name field |
AssetType
| Value | Description |
|---|---|
| finp2p | |
| fiat | |
| cryptocurrency |
CertificateOrderField
| Value | Description |
|---|---|
| ID | certificates order by determined by Id field |
DataAccessType
| Value | Description |
|---|---|
| Unknown | |
| Balance |
DataType
Financial data types provided by data providers
| Value | Description |
|---|---|
| assetHeader | |
| pricing | |
| fundamentals | |
| ratings | |
| corporateActions | |
| marketData | |
| referenceData |
ExecutionOrganizationRole
Role of an organization participating in an Execution Plan
| Value | Description |
|---|---|
| contributor | Participates in plan approval and instruction execution |
| observer | Read-only participant; receives state updates but does not approve or execute |
ExecutionPlanInstructionStatus
| Value | Description |
|---|---|
| Unknown | |
| Pending | |
| Completed | |
| Failed | |
| Approved | |
| Rejected | |
| Cancelled |
ExecutionPlanOrderField
| Value | Description |
|---|---|
| PLAN_ID | plan order by PlanId field |
| CREATION_TIMESTAMP |
ExecutionPlanStatus
| Value | Description |
|---|---|
| Unknown | |
| Pending | |
| Approved | |
| Completed | |
| Failed | |
| Rejected | |
| Halted | |
| InProgress | |
| Cancelled |
FinancialIdentifierType
| Value | Description |
|---|---|
| UNSPECIFIED | |
| ISIN | |
| ISO4217 | |
| NONE |
HoldingFields
Fields to subscribe on
| Value | Description |
|---|---|
| Balance | |
| WithheldBalance | |
| AvailableBalance | |
| SyncedBalance | |
| SyncedAvailableBalance | |
| SyncedHeldBalance |
HttpSchemas
| Value | Description |
|---|---|
| HTTP1_1 | |
| HTTP2 |
IntentField
Fields to subscribe on
| Value | Description |
|---|---|
| Status | |
| RemainingQuantity |
IntentStatus
| Value | Description |
|---|---|
| ACTIVE | |
| NON_ACTIVE | |
| CANCELLED | |
| COMPLETED | |
| EXPIRED | |
| REJECTED |
IntentTypes
| Value | Description |
|---|---|
| PRIMARY_SALE | |
| BUYING | |
| SELLING | |
| LOAN | |
| PRIVATE_OFFER | |
| REQUEST_FOR_TRANSFER | |
| MOVE | |
| REDEMPTION |
InvestorRole
| Value | Description |
|---|---|
| BUYER | |
| SELLER | |
| LENDER | |
| BORROWER | |
| ISSUER |
IssuerOrderField
| Value | Description |
|---|---|
| ID | issuers order by determined by Id field |
LedgerAuthType
| Value | Description |
|---|---|
| OAUTH | |
| MTLS | |
| API_KEY |
OperationType
| Value | Description |
|---|---|
| Unknown | |
| Issue | |
| Transfer | |
| Release | |
| Hold | |
| Redeem | |
| Move |
Operator
Operators available to be used
| Value | Description |
|---|---|
| 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
| Value | Description |
|---|---|
| ID | organizations order by determined by Id field |
PlanField
Fields to subscribe on
| Value | Description |
|---|---|
| Status |
ReceiptOrderField
| Value | Description |
|---|---|
| ID | receipt order by determined by Id field |
ReceiptStatus
| Value | Description |
|---|---|
| Unknown | |
| Valid | |
| Invalid |
SignaturePolicyType
| Value | Description |
|---|---|
| PresignedPolicy | |
| ManualPolicy |
SignatureTemplate
| Value | Description |
|---|---|
| EIP712 | |
| HashList | |
| Unknown |
SortOrder
| Value | Description |
|---|---|
| ASC | |
| DESC |
UserOrderField
| Value | Description |
|---|---|
| ID | users order by determined by Id field |
WorkflowAdminAction
Available admin actions for workflows
| Value | Description |
|---|---|
| RESET | |
| RESUME | |
| RETRY | |
| CANCEL |
WorkflowHealthStatus
Health status enumeration
| Value | Description |
|---|---|
| HEALTHY | |
| STALE | |
| STUCK | |
| UNHEALTHY |
WorkflowOrderField
| Value | Description |
|---|---|
| NAME | workflow order |
| STATUS | |
| REFERENCE_ID | |
| HEALTH_STATUS | |
| CORRELATION_ID |
templateType
| Value | Description |
|---|---|
| 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.
| Field | Argument | Type | Description |
|---|---|---|---|
| id | String! | ||
| certificates | Certificates! | Collection of certificates associated with the Profile. | |
| filter | [Filter!] | ||
| aggregates | [Aggregate!] | ||
| organizationId | String! | Organization id to which this profile is associated with. | |
| metadata | ProfileMetadata! | Profile metadata, contains ACL information of the profile. | |
Unions
AccountIdentifier
Account identifier - supports FinP2P, crypto wallets, and IBAN
| Type | Description |
|---|---|
| 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
| Type | Description |
|---|---|
| FinP2PAsset | FinP2P asset with resource ID and ledger identifier |
BuyingSignaturePolicy
| Type | Description |
|---|---|
| PresignedBuyingIntentSignaturePolicy | |
| ManualIntentSignaturePolicy |
Correspondent
| Type | Description |
|---|---|
| AssetIssuer |
DeliveryStatus
| Type | Description |
|---|---|
| PendingDelivery | |
| Delivered | |
| NotDelivered |
ExecutionPlanContractDetails
InstructionCompletionState
| Type | Description |
|---|---|
| UnknownState | |
| ErrorState | |
| SuccessState |
InstructionDetails
| Type | Description |
|---|---|
| IssueInstruction | |
| TransferInstruction | |
| HoldInstruction | |
| ReleaseInstruction | |
| RevertHoldInstruction | |
| AwaitInstruction | |
| RedeemInstruction | |
| MoveInstruction |
IntentDetails
| Type | Description |
|---|---|
| PrimarySale | |
| BuyingIntent | |
| SellingIntent | |
| LoanIntent | |
| RedemptionIntent | |
| PrivateOfferIntent | |
| RequestForTransferIntent | |
| MoveIntent |
LedgerAuthOptions
| Type | Description |
|---|---|
| LedgerOAuthOptions | |
| LedgerMtlsOptions | |
| LedgerApiKeyOptions |
LedgerIdentifier
Ledger identifier union - currently only CAIP-19 supported
| Type | Description |
|---|---|
| Caip19Identifier | CAIP-19 format ledger identifier |
LedgerReference
| Type | Description |
|---|---|
| ContractDetails |
LoanConditions
| Type | Description |
|---|---|
| RepaymentTerm | |
| InterestRate | |
| CloseAmountRate |
LoanSignaturePolicy
| Type | Description |
|---|---|
| PresignedLoanIntentSignaturePolicy |
MoveSignaturePolicy
| Type | Description |
|---|---|
| PresignedMoveIntentSignaturePolicy | |
| ManualIntentSignaturePolicy |
PrivateOfferSignaturePolicy
| Type | Description |
|---|---|
| PresignedPrivateOfferIntentSignaturePolicy | |
| ManualIntentSignaturePolicy |
Proof
| Type | Description |
|---|---|
| NoProof | |
| SignatureProof |
ProofPolicy
| Type | Description |
|---|---|
| SignatureProofPolicy | |
| NoProofPolicy |
Recipient
| Type | Description |
|---|---|
| Investor |
RedemptionSignaturePolicy
| Type | Description |
|---|---|
| PresignedRedemptionIntentSignaturePolicy | |
| ManualIntentSignaturePolicy |
RequestForTransferAssetInstruction
| Type | Description |
|---|---|
| RequestForTransferSendInstruction | |
| RequestForTransferRequestInstruction |
RequestForTransferSignaturePolicy
| Type | Description |
|---|---|
| PresignedRequestForTransferIntentSignaturePolicy | |
| ManualIntentSignaturePolicy |
SellingSignaturePolicy
| Type | Description |
|---|---|
| PresignedSellingIntentSignaturePolicy | |
| ManualIntentSignaturePolicy |
SettlementInstructionTypeDetails
| Type | Description |
|---|---|
| SellingSettlementInstruction | |
| BuyingSettlementInstruction |
SettlementTermOptionType
| Type | Description |
|---|---|
| PartialSettlement | |
| FullSettlement | |
| NoSettlement |
SuccessStateOutput
| Type | Description |
|---|---|
| Receipt |
Template
| Type | Description |
|---|---|
| HashlistTemplate | |
| EIP712Template |
Transition
| Type | Description |
|---|---|
| StatusTransition | |
| SequenceTransition |
