Schema Types
Table of Contents
- Query
- Subscription
- Objects
- AccountInstruction
- AdditionalContractDetails
- AggregateResult
- Asset
- AssetConversion
- AssetIdentifier
- AssetInstruction
- AssetIssuer
- AssetPolicies
- AssetTerm
- Assets
- Attachment
- AwaitInstruction
- BuyingIntent
- BuyingSettlementInstruction
- Certificate
- Certificates
- CloseAmountRate
- ContractDetails
- ConvertibleAsset
- CryptoWalletAccount
- Cryptocurrency
- Custodian
- Delivered
- Document
- Documents
- EIP712Template
- ErrorState
- Escrow
- Escrows
- ExecutionContext
- ExecutionOrganization
- ExecutionPlan
- ExecutionPlanInstruction
- ExecutionPlanInstructions
- ExecutionsPlans
- FiatAsset
- Field
- FinP2PAccount
- FinP2PAsset
- FinP2PAssetAccount
- FinP2PEVMOperatorDetails
- HashGroup
- HashlistTemplate
- HoldInstruction
- Holding
- Holdings
- Iban
- IncomingMessage
- InstructionApproval
- InstructionApprovals
- InstructionTransition
- Intent
- Intents
- InterestRate
- Investor
- IssueInstruction
- Issuer
- Issuers
- LedgerAssetInfo
- LoanAssetInstruction
- LoanInstruction
- LoanIntent
- LoanSettlementInstruction
- ManualIntentSignaturePolicy
- Message
- MessageRecipient
- MessageRecipients
- Messages
- NoProof
- NoProofPolicy
- NotDelivered
- Organization
- OrganizationAsset
- Organizations
- OutgoingMessage
- OutgoingMessages
- PageInfo
- PaymentAsset
- PendingDelivery
- PlanApproval
- PlanApprovalStatusInfo
- PlanApprovals
- PresignedBuyingIntentSignaturePolicy
- PresignedLoanIntentSignaturePolicy
- PresignedPrivateOfferIntentSignaturePolicy
- PresignedRedemptionIntentSignaturePolicy
- PresignedRequestForTransferIntentSignaturePolicy
- PresignedSellingIntentSignaturePolicy
- PrimarySale
- PrivateOfferIntent
- ProfileMetadata
- Receipt
- ReceiptState
- Receipts
- RedeemInstruction
- RedemptionConditions
- RedemptionIntent
- RedemptionSettlementInstruction
- ReleaseInstruction
- RepaymentTerm
- RequestForTransferIntent
- RevertHoldInstruction
- SellingIntent
- SellingSettlementInstruction
- SequenceTransition
- SettlementInstruction
- SettlementTerm
- Signature
- SignatureProof
- SignatureProofPolicy
- StatusTransition
- SuccessState
- TokenBalance
- TokensBalances
- TradeDetails
- TransactionDetails
- TransferInstruction
- UnknownState
- User
- Users
- Verifier
- Workflow
- WorkflowMetadata
- Workflows
- Inputs
- Enums
- ActionType
- AggregateFunc
- ApprovalStatus
- AssetIdentifierType
- AssetOrderField
- AssetType
- CertificateOrderField
- ExecutionPlanInstructionStatus
- ExecutionPlanOrderField
- ExecutionPlanStatus
- HoldingFields
- IntentStatus
- IntentTypes
- IssuerOrderField
- OperationType
- Operator
- OrganizationOrderField
- PlanField
- ReceiptOrderField
- ReceiptStatus
- SignaturePolicyType
- SignatureTemplate
- SortOrder
- UserOrderField
- WorkflowOrderField
- templateType
- Scalars
- Interfaces
- Unions
- AccountIdentifier
- AssetDetails
- BuyingSignaturePolicy
- Correspondent
- DeliveryStatus
- InstructionCompletionState
- InstructionDetails
- IntentDetails
- LedgerReference
- LoanConditions
- LoanSignaturePolicy
- PrivateOfferSignaturePolicy
- Proof
- ProofPolicy
- Recipient
- RedemptionSignaturePolicy
- RequestForTransferSignaturePolicy
- SellingSignaturePolicy
- SettlementInstructionTypeDetails
- 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 | AssetOrder | ||
| 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 | ||
| escrows | Escrows! | List of escrows | |
| filter | [Filter!] | ||
| 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 | ||
Subscription
| Field | Argument | Type | Description |
|---|---|---|---|
| receiptAdded | Receipt! | ||
| planAdded | ExecutionPlan! | ||
| plansChangedBy | ExecutionPlan! | ||
| fieldNames | [PlanField!]! | ||
| userHoldingAdded | User! | ||
| userHoldingChanged | User! | ||
| fieldNames | [HoldingFields!]! | ||
Objects
AccountInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| asset | AssetDetails! | Asset type associated with the account | |
| identifier | AccountIdentifier | ||
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! | ||
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 | |
| assetIdentifier | AssetIdentifier | classification standard used to identify the asset | |
| version | String! | asset resource version | |
AssetConversion
| Field | Argument | Type | Description |
|---|---|---|---|
| accountType | AccountIdentifier | Type of accounts | |
| symbols | [String] | List of symbols | |
AssetIdentifier
| Field | Argument | Type | Description |
|---|---|---|---|
| type | AssetIdentifierType! | ||
| value | String! | ||
AssetInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| account | AccountInstruction! | ||
| destinationAccount | AccountInstruction | ||
AssetIssuer
| Field | Argument | Type | Description |
|---|---|---|---|
| issuerId | String! | ||
| assetId | String! | ||
AssetPolicies
| Field | Argument | Type | Description |
|---|---|---|---|
| proof | ProofPolicy! | ||
AssetTerm
| Field | Argument | Type | Description |
|---|---|---|---|
| asset | AssetDetails! | ||
| 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 | |
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 | |
| assetInstruction | AssetInstruction! | Asset instruction specifies the asset source of destination account of the intent | |
| settlementTerm | SettlementTerm | Settlement term | |
| signaturePolicyType | SignaturePolicyType! | Signature policy type | |
| signaturePolicy | BuyingSignaturePolicy! | ||
| settlementInstruction | BuyingSettlementInstruction! | ||
BuyingSettlementInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| account | AccountInstruction! | ||
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 | ||
ConvertibleAsset
| Field | Argument | Type | Description |
|---|---|---|---|
| type | AssetType | Type of the asset | |
| code | String | ISO-4217 code of the fiat currency or other common codes like BTC for cryptocurrencies | |
| conversions | [AssetConversion] | List of available conversions | |
| policies | AssetPolicies | Describe the policies active on the asset | |
CryptoWalletAccount
| Field | Argument | Type | Description |
|---|---|---|---|
| address | String! | Wallet address represented as a hexadecimal string prefixed with 0x | |
Cryptocurrency
| Field | Argument | Type | Description |
|---|---|---|---|
| symbol | String! | Symbol of the Cryptocurrnecy | |
Custodian
| Field | Argument | Type | Description |
|---|---|---|---|
| orgId | String! | ||
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! | ||
Escrow
Represents an Escrow in the network.
| Field | Argument | Type | Description |
|---|---|---|---|
| orgId | String! | FinP2P Organization Id of the Escrow | |
| paymentAsset | PaymentAsset! | Payment Asset | |
| paymentAssetId | String! | Payment asset resource id | |
Escrows
| Field | Argument | Type | Description |
|---|---|---|---|
| nodes | [Escrow!] | Collection of escrow Objects, conforms to the Filter input if provided. | |
| pageInfo | PageInfo | Keeps pagination info in-case limit input wes provided | |
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! | ||
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 | |
| approvals | [PlanApproval]! | list of plan approvals | |
| creationTimestamp | Int! | plan creation (timestamp in sec) | |
| lastModified | Int! | last time plan was modified (epoch time seconds) | |
ExecutionPlanInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| sequence | Int! | ||
| organizations | [ExecutionOrganization!]! | ||
| details | InstructionDetails! | ||
| status | ExecutionPlanInstructionStatus! | ||
| state | InstructionCompletionState! | ||
| approvals | InstructionApprovals! | ||
| filter | [Filter!] | ||
| transitions | InstructionTransition! | ||
ExecutionPlanInstructions
| Field | Argument | Type | Description |
|---|---|---|---|
| nodes | [ExecutionPlanInstruction!] | ||
ExecutionsPlans
| Field | Argument | Type | Description |
|---|---|---|---|
| nodes | [ExecutionPlan!] | ||
| pageInfo | PageInfo | Keeps pagination info in-case limit input wes provided | |
FiatAsset
| 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
| Field | Argument | Type | Description |
|---|---|---|---|
| finId | String! | ||
| custodian | Custodian! | ||
FinP2PAsset
| Field | Argument | Type | Description |
|---|---|---|---|
| resourceId | String! | Resource ID of the FinP2P asset | |
FinP2PAssetAccount
| Field | Argument | Type | Description |
|---|---|---|---|
| finId | String! | FinId -- a user's public key represented as a hexadecimal string, associated with a user on the FinP2P network | |
| orgId | String! | organization id of the Asset's source ledger, the Asset's organization | |
| custodian | Custodian | custodian for the finId | |
FinP2PEVMOperatorDetails
| Field | Argument | Type | Description |
|---|---|---|---|
| finP2POperatorContractAddress | String! | ||
| allowanceRequired | Boolean! | ||
HashGroup
| Field | Argument | Type | Description |
|---|---|---|---|
| hash | String! | ||
| fields | [Field!]! | ||
HashlistTemplate
| Field | Argument | Type | Description |
|---|---|---|---|
| hash | String! | ||
| hashGroups | [HashGroup!]! | ||
HoldInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| source | String! | resource id of the source user | |
| destination | String! | resource id of the destination user | |
| sourceAccount | AccountInstruction! | source account information | |
| destinationAccount | AccountInstruction | destination account information | |
| amount | String! | asset's hold amount | |
Holding
| Field | Argument | Type | Description |
|---|---|---|---|
| account | FinP2PAssetAccount! | ||
| 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
| 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! | ||
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 | |
| 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! | ||
IssueInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| buyer | String! | resource id of the buyer | |
| destinationAccount | AccountInstruction! | buyer's account | |
| 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 | |
LedgerAssetInfo
| Field | Argument | Type | Description |
|---|---|---|---|
| tokenId | String! | ||
| ledgerReference | LedgerReference | ||
LoanAssetInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| borrowerAccount | AccountInstruction! | ||
| lenderAccount | AccountInstruction! | ||
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 | |
| assetInstruction | LoanAssetInstruction! | Asset instruction specifies the asset source of destination account of the intent | |
| settlementTerm | SettlementTerm | Settlement term | |
| loanSettlementInstruction | LoanSettlementInstruction! | Signature policy type | |
| loanInstruction | LoanInstruction! | ||
| signaturePolicyType | SignaturePolicyType! | ||
| signaturePolicy | LoanSignaturePolicy! | ||
LoanSettlementInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| borrowerAccount | AccountIdentifier | ||
| lenderAccount | AccountIdentifier | ||
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!] | ||
NoProof
| Field | Argument | Type | Description |
|---|---|---|---|
| _ignore | Boolean | ||
NoProofPolicy
| Field | Argument | Type | Description |
|---|---|---|---|
| _ignore | Boolean | ||
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 | |
PaymentAsset
Represents supported asset types and conversions in Escrow.
| Field | Argument | Type | Description |
|---|---|---|---|
| id | String | PaymentAsset id | |
| accountType | String | Type of account, f.e.: 'Escrow' | |
| assets | [ConvertibleAsset] | List of supported assets | |
| orgId | String! | payment asset orgID | |
| version | String! | payment asset resource version | |
PendingDelivery
| Field | Argument | Type | Description |
|---|---|---|---|
| _ignore | Boolean | ||
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 | ||
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 | |
| assetInstruction | AssetInstruction! | Asset instruction specifies the asset source of destination account of the intent | |
| settlementTerm | SettlementTerm | Settlement term | |
| sellingSettlementInstruction | SellingSettlementInstruction! | ||
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 | |
| assetInstruction | AssetInstruction! | Asset instruction specifies the asset source of destination account of the intent | |
| settlementTerm | SettlementTerm | Settlement term | |
| signaturePolicyType | SignaturePolicyType! | Signature policy type | |
| signaturePolicy | PrivateOfferSignaturePolicy! | ||
| sellingSettlementInstruction | SellingSettlementInstruction! | ||
ProfileMetadata
Profile Metadata (ACL).
| Field | Argument | Type | Description |
|---|---|---|---|
| acl | [String!] | ||
Receipt
| Field | Argument | Type | Description |
|---|---|---|---|
| id | String! | ||
| asset | AssetDetails! | Asset type related to holding updated | |
| source | User! | User related to source of transaction | |
| sourceAccount | AccountIdentifier | Account related to source of transaction | |
| destination | User! | Account related to destination of transaction | |
| destinationAccount | AccountIdentifier | Account related to destination 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 |
|---|---|---|---|
| sourceAccount | AccountInstruction! | source account information | |
| amount | String! | asset's release amount | |
RedemptionConditions
| Field | Argument | Type | Description |
|---|---|---|---|
| redemptionDuration | String! | ||
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 | |
| redeemAssetInstruction | AssetInstruction | Asset instruction specifies the asset source of destination account of the intent | |
| settlementTerm | SettlementTerm | Settlement term | |
| conditions | RedemptionConditions! | Intent conditions | |
| signaturePolicyType | SignaturePolicyType! | Signature policy type | |
| signaturePolicy | RedemptionSignaturePolicy! | ||
RedemptionSettlementInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| accounts | [AccountInstruction!] | ||
ReleaseInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| sourceAccount | AccountInstruction! | source account information | |
| destinationAccount | AccountInstruction! | destination account information | |
| amount | String! | asset's release amount | |
RepaymentTerm
| Field | Argument | Type | Description |
|---|---|---|---|
| repaymentVolume | String! | ||
| annualPercentageRate | String | ||
RequestForTransferIntent
| Field | Argument | Type | Description |
|---|---|---|---|
| creditor | String | resource id of the creditor | |
| debitor | String | resource id of the debitor | |
| assetTerm | AssetTerm! | Asset term specifies the asset information and amount of the intent | |
| assetInstruction | AssetInstruction! | Asset instruction specifies the asset source of destination account of the intent | |
| signaturePolicyType | SignaturePolicyType! | Signature policy type | |
| signaturePolicy | RequestForTransferSignaturePolicy! | ||
| actionType | ActionType! | Action type of the intent | |
RevertHoldInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| destinationAccount | AccountInstruction! | destination account information | |
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 | |
| assetInstruction | AssetInstruction! | Asset instruction specifies the asset source of destination account of the intent | |
| settlementTerm | SettlementTerm | Settlement term | |
| signaturePolicyType | SignaturePolicyType! | Signature policy type | |
| signaturePolicy | SellingSignaturePolicy! | ||
| sellingSettlementInstruction | SellingSettlementInstruction! | ||
SellingSettlementInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| accounts | [AccountInstruction!] | ||
SequenceTransition
| Field | Argument | Type | Description |
|---|---|---|---|
| sequence | Int! | ||
SettlementInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| details | SettlementInstructionTypeDetails! | ||
SettlementTerm
| Field | Argument | Type | Description |
|---|---|---|---|
| asset | AssetDetails! | ||
| unitValue | String! | ||
Signature
| Field | Argument | Type | Description |
|---|---|---|---|
| template | Template! | ||
| signature | String! | ||
| hashFunction | String! | ||
| templateType | templateType! | ||
SignatureProof
| Field | Argument | Type | Description |
|---|---|---|---|
| signature | Signature! | ||
SignatureProofPolicy
| Field | Argument | Type | Description |
|---|---|---|---|
| verifyingKey | String! | ||
| signatureTemplate | SignatureTemplate! | ||
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! | ||
| 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! | ||
TransferInstruction
| Field | Argument | Type | Description |
|---|---|---|---|
| source | String! | resource id of the source | |
| destination | String! | resource id of the destination | |
| sourceAccount | AccountInstruction! | source account information | |
| destinationAccount | AccountInstruction! | 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 | |
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 | |
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 | |
| expires | Int! | the time workflow expires | |
WorkflowMetadata
| Field | Argument | Type | Description |
|---|---|---|---|
| ttl | Int! | TTL of the workflow | |
| retry | Int! | ||
| currentStateRetry | Int! | ||
| traceId | String! | ||
| correlationIds | [String!] | ||
| referenceId | String! | ||
| referenceType | 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. | |
AssetOrder
| 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 |
AssetIdentifierType
| Value | Description |
|---|---|
| UNSPECIFIED | |
| ISIN | |
| CUSIP | |
| SEDOL | |
| DTI | |
| CMU | |
| FIGI | |
| CUSTOM |
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 |
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 |
HoldingFields
Fields to subscribe on
| Value | Description |
|---|---|
| Balance | |
| WithheldBalance | |
| AvailableBalance | |
| SyncedBalance | |
| SyncedAvailableBalance | |
| SyncedHeldBalance |
IntentStatus
| Value | Description |
|---|---|
| ACTIVE | |
| NON_ACTIVE | |
| CANCELLED | |
| COMPLETED | |
| EXPIRED | |
| REJECTED |
IntentTypes
| Value | Description |
|---|---|
| PRIMARY_SALE | |
| BUYING | |
| SELLING | |
| LOAN | |
| PRIVATE_OFFER | |
| REQUEST_FOR_TRANSFER |
IssuerOrderField
| Value | Description |
|---|---|
| ID | issuers order by determined by Id field |
OperationType
| Value | Description |
|---|---|
| Unknown | |
| Issue | |
| Transfer | |
| Release | |
| Hold | |
| Redeem |
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 |
WorkflowOrderField
| Value | Description |
|---|---|
| NAME | workflow order |
| STATUS | |
| REFERENCE_ID |
templateType
| Value | Description |
|---|---|
| EIP712Template | |
| HashListTemplate |
Scalars
Boolean
The Boolean scalar type represents true or false.
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
| Type | Description |
|---|---|
| CryptoWalletAccount | |
| Iban | |
| FinP2PAssetAccount |
AssetDetails
| Type | Description |
|---|---|
| FinP2PAsset | |
| FiatAsset | |
| Cryptocurrency |
BuyingSignaturePolicy
| Type | Description |
|---|---|
| PresignedBuyingIntentSignaturePolicy | |
| ManualIntentSignaturePolicy |
Correspondent
| Type | Description |
|---|---|
| AssetIssuer |
DeliveryStatus
| Type | Description |
|---|---|
| PendingDelivery | |
| Delivered | |
| NotDelivered |
InstructionCompletionState
| Type | Description |
|---|---|
| UnknownState | |
| ErrorState | |
| SuccessState |
InstructionDetails
| Type | Description |
|---|---|
| IssueInstruction | |
| TransferInstruction | |
| HoldInstruction | |
| ReleaseInstruction | |
| RevertHoldInstruction | |
| AwaitInstruction | |
| RedeemInstruction |
IntentDetails
| Type | Description |
|---|---|
| PrimarySale | |
| BuyingIntent | |
| SellingIntent | |
| LoanIntent | |
| RedemptionIntent | |
| PrivateOfferIntent | |
| RequestForTransferIntent |
LedgerReference
| Type | Description |
|---|---|
| ContractDetails |
LoanConditions
| Type | Description |
|---|---|
| RepaymentTerm | |
| InterestRate | |
| CloseAmountRate |
LoanSignaturePolicy
| Type | Description |
|---|---|
| PresignedLoanIntentSignaturePolicy |
PrivateOfferSignaturePolicy
| Type | Description |
|---|---|
| PresignedPrivateOfferIntentSignaturePolicy | |
| ManualIntentSignaturePolicy |
Proof
| Type | Description |
|---|---|
| NoProof | |
| SignatureProof |
ProofPolicy
| Type | Description |
|---|---|
| SignatureProofPolicy | |
| NoProofPolicy |
Recipient
| Type | Description |
|---|---|
| Investor |
RedemptionSignaturePolicy
| Type | Description |
|---|---|
| PresignedRedemptionIntentSignaturePolicy | |
| ManualIntentSignaturePolicy |
RequestForTransferSignaturePolicy
| Type | Description |
|---|---|
| PresignedRequestForTransferIntentSignaturePolicy | |
| ManualIntentSignaturePolicy |
SellingSignaturePolicy
| Type | Description |
|---|---|
| PresignedSellingIntentSignaturePolicy | |
| ManualIntentSignaturePolicy |
SettlementInstructionTypeDetails
| Type | Description |
|---|---|
| SellingSettlementInstruction | |
| BuyingSettlementInstruction |
SuccessStateOutput
| Type | Description |
|---|---|
| Receipt |
Template
| Type | Description |
|---|---|
| HashlistTemplate | |
| EIP712Template |
Transition
| Type | Description |
|---|---|
| StatusTransition | |
| SequenceTransition |
