GraphQL Reference

Schema Types

Table of Contents

Query

The query root of Ownera's GraphQL interface.

FieldArgumentTypeDescription
assetsAssets!

Look up Assets, Optional provide Filters or Aggregates.

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

Look up Users, Optional provide Filter or Aggregate.

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

Look up a receipt by a Filter (mandatory).

filter[Filter]
paginatePaginateInput
issuersIssuers!

Look up Issuers, Optional provide Filter.

filter[Filter!]
paginatePaginateInput
certificatesCertificates!

Look up Certificates, Optional provide Filter or Aggregate.

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

Look up Organizations, Optional provide Filter or Aggregate.

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

List of escrows

filter[Filter!]
plansExecutionsPlans!

Look up Execution Plans, Optional provide Filter.

filter[Filter!]
paginatePaginateInput
orderByExecutionPlanOrder

Objects

Account

FieldArgumentTypeDescription
identifierAccountIdentifier
assetTypeAssetType
assetAssetDetails
balanceString
withheldBalanceString
availableBalanceString

AccountInstruction

FieldArgumentTypeDescription
assetAssetDetails!

Asset type associated with the account

identifierAccountIdentifier!

AggregateResult

Result of Aggregation function applied on an Object numeric field.

FieldArgumentTypeDescription
fieldString!

The Object's field which this results refer to.

funcAggregateFunc!

The AggregateFunc which this AggregateResult refers to.

resultString!

Asset

Represents an Asset in the network.

FieldArgumentTypeDescription
idString!
certificatesCertificates!

Collection of certificates associated with the Profile.

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

Collection of Intents associated with the Asset.

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

Type of Asset (Share, Debt etc..)

configString!

Custom configuration for the Asset.

issuedTokensTokensBalances!

Tokens issued for the given Asset.

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

Issuer profile of the Asset.

regulationVerifiers[Verifier!]

Regulation Verifiers associated with the Asset.

organizationIdString!

Organization id to whom this profile is associated with.

metadataProfileMetadata!

Profile metadata, contains ACL information of the profile.

denominationFiatAsset!

Denomination currency of the Asset

AssetConversion

FieldArgumentTypeDescription
accountTypeAccountIdentifier

Type of accounts

symbols[String]

List of symbols

AssetInstruction

FieldArgumentTypeDescription
accountAccountInstruction!
destinationAccountAccountInstruction

AssetIssuer

FieldArgumentTypeDescription
issuerIdString!
assetIdString!

AssetTerm

FieldArgumentTypeDescription
assetAssetDetails!
amountString!

Total amount of asset allocated

Assets

Results for asset query.

FieldArgumentTypeDescription
nodes[Asset!]

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

aggregate[AggregateResult!]

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

pageInfoPageInfo

Keeps pagination info in-case limit input wes provided

Attachment

FieldArgumentTypeDescription
uuidString!
nameString
linkString
messageIdString!

AwaitInstruction

FieldArgumentTypeDescription
waitTimeInt!

epoch time for await instruction

BuyingIntent

FieldArgumentTypeDescription
buyerString

resource id of the buyer

signaturePolicyTypeSignaturePolicyType!

Signature policy type

signaturePolicyBuyingSignaturePolicy!
settlementInstructionBuyingSettlementInstruction!

BuyingSettlementInstruction

FieldArgumentTypeDescription
typeBuyingSettlementInstructionType!
accountAccountInstruction!

Certificate

Represents a Certificate in the network.

FieldArgumentTypeDescription
idString!
profileIdString!

Profile to whom this Certificate is associate with.

typeString!

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

providerIdString!

Service Provider Id which provided the Certificate.

issuedAtInt!
expiryInt
dataString

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

documentsDocuments!

Certificate associated documents metadata.

filter[Filter!]

Certificates

Results for certificates query.

FieldArgumentTypeDescription
nodes[Certificate!]

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

aggregate[AggregateResult!]

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

pageInfoPageInfo

Keeps pagination info in-case limit input wes provided

ConvertibleAsset

FieldArgumentTypeDescription
typeAssetType

Type of the asset

codeString

ISO-4217 code of the fiat currency or other common codes like BTC for cryptocurrencies

conversions[AssetConversion]

List of available conversions

CryptoWalletAccount

FieldArgumentTypeDescription
addressString!

Wallet address represented as a hexadecimal string prefixed with 0x

Cryptocurrency

FieldArgumentTypeDescription
symbolString!

Symbol of the Cryptocurrnecy

Delivered

FieldArgumentTypeDescription
_ignoreBoolean

Document

Certificate related Document metadata informaiton

FieldArgumentTypeDescription
idString!
uriString!

Locaiton of document content.

nameString!
mimeTypeString!

Documents

Results for documents query.

FieldArgumentTypeDescription
nodes[Document!]

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

ErrorState

FieldArgumentTypeDescription
codeInt!
messageString!

Escrow

Represents an Escrow in the network.

FieldArgumentTypeDescription
orgIdString!

FinP2P Organization Id of the Escrow

paymentAssetPaymentAsset!

Payment Asset

EscrowBuyingSettlementInstruction

FieldArgumentTypeDescription
expiryInt!

EscrowLoanSettlementInstruction

FieldArgumentTypeDescription
expiryInt!
escrowString!

EscrowSellingSettlementInstruction

FieldArgumentTypeDescription
whiteListedEscrows[String!]

Escrows

FieldArgumentTypeDescription
nodes[Escrow!]

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

pageInfoPageInfo

Keeps pagination info in-case limit input wes provided

ExecutionContext

FieldArgumentTypeDescription
executionPlanIdString

ExecutionPlan associated with the transaction

instructionSequenceNumberInt

The associated instruction sequence number

ExecutionOrganization

Information about organization in an Execution Plan context

FieldArgumentTypeDescription
organizationIdString!

ExecutionPlan

FieldArgumentTypeDescription
idString!

resource id of execution plan

intentIntent

Intent associated with execution plan

organizations[ExecutionOrganization!]!

organizations which participate in the execution plan

statusExecutionPlanStatus!

lifecycle status of the execution plan

instructions[ExecutionPlanInstruction]!

plan's list of instructions

approvals[PlanApproval]!

list of plan approvals

creationTimestampInt!

plan creation (timestamp in sec)

ExecutionPlanInstruction

FieldArgumentTypeDescription
sequenceInt!
organizations[ExecutionOrganization!]!
detailsInstructionDetails!
statusExecutionPlanInstructionStatus!
stateInstructionCompletionState!
approvalsInstructionApprovals!
filter[Filter!]

ExecutionPlanInstructions

FieldArgumentTypeDescription
nodes[ExecutionPlanInstruction!]

ExecutionsPlans

FieldArgumentTypeDescription
nodes[ExecutionPlan!]
pageInfoPageInfo

Keeps pagination info in-case limit input wes provided

FiatAsset

FieldArgumentTypeDescription
codeString!

ISO-4217 code of the fiat currency

FinIdAccount

FieldArgumentTypeDescription
finIdString!

FinId -- a user's public key represented as a hexadecimal string, associated with a user on the FinP2P network

orgIdString!

FinP2PAsset

FieldArgumentTypeDescription
resourceIdString!

Resource ID of the FinP2P asset

HoldInstruction

FieldArgumentTypeDescription
sourceString!

resource id of the source user

destinationString!

resource id of the destination user

sourceAccountAccountInstruction!

source account information

destinationAccountAccountInstruction!

destination account information

amountString!

asset's hold amount

Holdings

FieldArgumentTypeDescription
nodes[Account!]

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

FieldArgumentTypeDescription
codeString!

IBAN code

IncomingMessage

FieldArgumentTypeDescription
messageMessage

InstructionApproval

FieldArgumentTypeDescription
planIdString!
sequenceInt!
orgIdString!
statusString!

InstructionApprovals

Results for Instruction Approval query.

FieldArgumentTypeDescription
nodes[InstructionApproval!]

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

aggregate[AggregateResult!]

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

Intent

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

FieldArgumentTypeDescription
idString!
startInt!

Start time of the intent.

endInt!

End time of the intent.

statusIntentStatus!

Intent status

assetTermAssetTerm

Asset term specifies the asset information and amount of the intent

assetInstructionAssetInstruction

Asset instruction specifies the asset source of destination account of the intent

settlementTermSettlementTerm!

Settlement term

remainingQuantityString!

Remaining quantity in the transaction.

typeString!

Intent type: primary sale, buying or selling intent

intentIntentDetails

Intent data

Intents

Results for itents query.

FieldArgumentTypeDescription
nodes[Intent!]

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

aggregate[AggregateResult!]

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

InterestRate

FieldArgumentTypeDescription
annualPercentageRateString!

Investor

FieldArgumentTypeDescription
resourceIdString!

IssueInstruction

FieldArgumentTypeDescription
buyerString!

resource id of the buyer

destinationAccountAccountInstruction!

buyer's account

amountString!

asset's issuance amount

Issuer

Represents an Issuer in the network.

FieldArgumentTypeDescription
idString!
assetsAssets!

Assets issued by the Issuer.

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

Issuers

Results for issuers query.

FieldArgumentTypeDescription
nodes[Issuer!]

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

pageInfoPageInfo

Keeps pagination info in-case limit input wes provided

LoanInstruction

FieldArgumentTypeDescription
openDateInt!
closeDateInt!
loanConditionsLoanConditions!

LoanIntent

FieldArgumentTypeDescription
borrowerString!

resource id of the borrower

lenderString!

resource id of the lender

loanSettlementInstructionLoanSettlementInstruction!

Signature policy type

loanInstructionLoanInstruction!
signaturePolicyTypeSignaturePolicyType!
signaturePolicyLoanSignaturePolicy!

LoanSettlementInstruction

FieldArgumentTypeDescription
typeLoanSettlementInstructionType!
borrowerAccountAccountIdentifier
lenderAccountAccountIdentifier

ManualIntentSignaturePolicy

FieldArgumentTypeDescription
callbackURLString!

Endpoint to contact to receive signature, callback should be able to recieve a transfer operation signature object

Message

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

MessageRecipient

FieldArgumentTypeDescription
destinationRecipient!
deliveryStatusDeliveryStatus

MessageRecipients

FieldArgumentTypeDescription
nodes[MessageRecipient!]

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

Messages

FieldArgumentTypeDescription
nodes[Message!]

NotDelivered

FieldArgumentTypeDescription
statusString!

Organization

Organization's information.

FieldArgumentTypeDescription
idString!
types[String!]

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

nameString!

Organization's name on the finp2p network.

finIdString!

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

clusterIdString!

Organization's cluster id.

assetsAssets!

Assets which the Organization act as the Primary Node.

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

Users which the Organization act as the Primary Node.

filter[Filter!]
aggregates[Aggregate!]
paginatePaginateInput

OrganizationAsset

FieldArgumentTypeDescription
assetAsset!
metadataProfileMetadata!

Organizations

Results for Organization query.

FieldArgumentTypeDescription
nodes[Organization!]

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

aggregate[AggregateResult!]

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

pageInfoPageInfo

Keeps pagination info in-case limit input wes provided

OutgoingMessage

FieldArgumentTypeDescription
messageMessage
recipientsMessageRecipients!
filter[Filter!]

OutgoingMessages

FieldArgumentTypeDescription
nodes[OutgoingMessage!]

PageInfo

FieldArgumentTypeDescription
hasNextPageBoolean!

Indicates if there are more items after the current page

endCursorString

Cursor for the end of the current page

totalCountInt!

Total count of items

totalLeftInt!

Total count of items left to be presented

PaymentAsset

Represents supported asset types and conversions in Escrow.

FieldArgumentTypeDescription
idString

PaymentAsset id

accountTypeString

Type of account, f.e.: 'Escrow'

assets[ConvertibleAsset]

List of supported assets

PendingDelivery

FieldArgumentTypeDescription
_ignoreBoolean

PlanApproval

FieldArgumentTypeDescription
planIdString!
orgIdString!
statusString!

PlanApprovals

Results for Plan Approval query.

FieldArgumentTypeDescription
nodes[PlanApproval!]

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

aggregate[AggregateResult!]

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

PresignedBuyingIntentSignaturePolicy

FieldArgumentTypeDescription
transferSignatureString!

PresignedLoanIntentSignaturePolicy

FieldArgumentTypeDescription
transferSignatureString!

PresignedSellingIntentSignaturePolicy

FieldArgumentTypeDescription
wildcardTransferSignatureString!

PrimarySale

FieldArgumentTypeDescription
issuerIdString!

Issuer id

sellingSettlementInstructionSellingSettlementInstruction!

ProfileMetadata

Profile Metadata (ACL).

FieldArgumentTypeDescription
acl[String!]

Receipt

FieldArgumentTypeDescription
idString!
assetAssetDetails!

Asset type related to holding updated

sourceUser!

User related to source of transaction

sourceAccountAccountIdentifier

Account related to source of transaction

destinationUser!

Account related to destination of transaction

destinationAccountAccountIdentifier

Account related to destination of transaction

quantityString!

Number of asset units with the transaction

tradeDetailsTradeDetails

Trade details associated with the transaction

settlementRefString

Reference number related to the settlement process

transactionIdString

Underlying transaction id

operationTypeOperationType

Operation type

timestampString!

Receipt timestamp

ReceiptState

FieldArgumentTypeDescription
receiptReceipt!

Receipts

Results for receipts query.

FieldArgumentTypeDescription
nodes[Receipt!]

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

pageInfoPageInfo

Keeps pagination info in-case limit input wes provided

ReleaseInstruction

FieldArgumentTypeDescription
sourceAccountAccountInstruction!

source account information

destinationAccountAccountInstruction!

destination account information

amountString!

asset's release amount

RepaymentTerm

FieldArgumentTypeDescription
repaymentVolumeString!

SellingIntent

FieldArgumentTypeDescription
sellerString

resource id of the seller

signaturePolicyTypeSignaturePolicyType!

Signature policy type

signaturePolicySellingSignaturePolicy!
sellingSettlementInstructionSellingSettlementInstruction!

SellingSettlementInstruction

FieldArgumentTypeDescription
typeSellingSettlementInstructionType!
accounts[AccountInstruction!]

SettlementInstruction

FieldArgumentTypeDescription
typeSettlementType!
detailsSettlementInstructionTypeDetails!

SettlementTerm

FieldArgumentTypeDescription
assetAssetDetails!
unitValueString!

Subscription

FieldArgumentTypeDescription
receiptAddedReceipt!
planAddedExecutionPlan!

SuccessState

FieldArgumentTypeDescription
_ignoreBoolean

TokenBalance

Represents an Asset token balance information.

FieldArgumentTypeDescription
userIdString!
assetIdString!
quantityString!
transactionsDetails[TransactionDetails!]

TokensBalances

Results for tokens query.

FieldArgumentTypeDescription
nodes[TokenBalance!]

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

aggregate[AggregateResult!]

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

TradeDetails

FieldArgumentTypeDescription
intentIntent

Intent associated with the transaction

executionContextExecutionContext

Details of ExecutionPlan associated with the transaction

TransactionDetails

FieldArgumentTypeDescription
transactionIdString!
indexInt!
quantityString!

TransferInstruction

FieldArgumentTypeDescription
sourceString!

resource id of the source

destinationString!

resource id of the destination

sourceAccountAccountInstruction!

source account information

destinationAccountAccountInstruction!

destination account information

amountString!

asset's transfer amount

UnknownState

FieldArgumentTypeDescription
_ignoreBoolean

User

Represents an User in the network.

FieldArgumentTypeDescription
idString!
certificatesCertificates!

Collection of certificates associated with the Profile.

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

Organization id to whom this profile is associated with.

metadataProfileMetadata!

Profile metadata, contains ACL information of the profile.

publicKeyString!

User's public key.

inboxMessages!

User's associated messages

filter[Filter!]

Users

Results for asset query.

FieldArgumentTypeDescription
nodes[User!]

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

aggregate[AggregateResult!]
pageInfoPageInfo

Keeps pagination info in-case limit input wes provided

Verifier

Regulation Verifier

FieldArgumentTypeDescription
idString

Verifier ID

nameString

Verifier Name

providerString

Provider type: REG_APP_STORE, OTHER

Inputs

Aggregate

Apply an aggregation function on specified Object's field.

FieldTypeDescription
fieldString

Object's field to which apply the AggregateFunc

funcAggregateFunc!

AggregateFunc to apply on the provided Field.

AssetOrder

FieldTypeDescription
fieldAssetOrderField
directionSortOrder

CertificateOrder

FieldTypeDescription
fieldCertificateOrderField
directionSortOrder

ExecutionPlanOrder

FieldTypeDescription
fieldExecutionPlanOrderField
directionSortOrder

Filter

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

FieldTypeDescription
keyString!

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

valueString!

The Value to be used by the Filter Operator.

operatorOperator!

Operator to apply on the specified key and provided value.

IssuerOrder

FieldTypeDescription
fieldIssuerOrderField
directionSortOrder

OrganizationOrder

FieldTypeDescription
fieldOrganizationOrderField
directionSortOrder

PaginateInput

FieldTypeDescription
limitInt

Number of records to return in response

skipInt

Number of pages to skip to get new cursor

afterString

Cursor field to return records after it

ReceiptOrder

FieldTypeDescription
fieldReceiptOrderField
directionSortOrder

UserOrder

FieldTypeDescription
fieldUserOrderField
directionSortOrder

Enums

AggregateFunc

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

ValueDescription
SUM
COUNT
AVG
MAX
MIN

AssetOrderField

ValueDescription
ORGANIZATION

Assets order by determined by OrganizationId field

NAME

Assets order by determined by Name field

AssetType

ValueDescription
finp2p
fiat
cryptocurrency

CertificateOrderField

ValueDescription
ID

certificates order by determined by Id field

ExecutionPlanInstructionStatus

ValueDescription
Unknown
Pending
Completed
Failed
Approved

ExecutionPlanOrderField

ValueDescription
PLAN_ID

plan order by PlanId field

CREATION_TIMESTAMP

ExecutionPlanStatus

ValueDescription
Unknown
Pending
Approved
Completed
Failed
Rejected

IntentStatus

ValueDescription
ACTIVE
NON_ACTIVE

IssuerOrderField

ValueDescription
ID

issuers order by determined by Id field

OperationType

ValueDescription
Unknown
Issue
Transfer
Release
Hold
Redeem

Operator

Operators available to be used

ValueDescription
EQ

Equals

NEQ

Not Equals

GT

Greater Than

GTE

Greater Than or Equals

LT

Less Than

LTE

Less Than or Equals

IN

In

NIN

Not In

OrganizationOrderField

ValueDescription
ID

organizations order by determined by Id field

ReceiptOrderField

ValueDescription
ID

receipt order by determined by Id field

SettlementType

ValueDescription
Escrow

SignaturePolicyType

ValueDescription
PresignedPolicy
ManualPolicy

SortOrder

ValueDescription
ASC
DESC

UserOrderField

ValueDescription
ID

users order by determined by Id field

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.

FieldArgumentTypeDescription
idString!
certificatesCertificates!

Collection of certificates associated with the Profile.

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

Organization id to which this profile is associated with.

metadataProfileMetadata!

Profile metadata, contains ACL information of the profile.

Unions

AccountIdentifier

AssetDetails

BuyingSettlementInstructionType

BuyingSignaturePolicy

Correspondent

TypeDescription
AssetIssuer

DeliveryStatus

InstructionCompletionState

InstructionDetails

IntentDetails

LoanConditions

LoanSettlementInstructionType

LoanSignaturePolicy

Recipient

TypeDescription
Investor

SellingSettlementInstructionType

SellingSignaturePolicy

SettlementInstructionTypeDetails