Schema Types

Query

The query root of Usera's GraphQL interface.

FieldArgumentTypeDescription
assetsAssets!

Look up Assets, Optional provide Filters or Aggregates.

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

Look up Users, Optional provide Filter or Aggregate.

filter[Filter!]
aggregate[Aggregate!]
receiptReceipt

Look up a receipt by ID (mandatory).

transactionIdString!
issuersIssuers!

Look up Issuers, Optional provide Filter.

filter[Filter!]
certificatesCertificates!

Look up Certificates, Optional provide Filter or Aggregate.

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

Look up Organizations, Optional provide Filter or Aggregate.

filter[Filter!]
aggregate[Aggregate!]

Objects

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 certificatess 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..)

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.

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.

BuyingIntent

FieldArgumentTypeDescription
buyerString

resource id of the buyer

signaturePolicyTypeSignaturePolicyType!

Signature policy type

signaturePolicyBuyingSignaturePolicy!
publicKeyString

A public key of the intent creator

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.

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.

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.

typeString!

Intent type: primary sale, buying or selling intent

settlementConditions[SettlementCondition]!

Settlement conditions

intentIntentDetails

Intent data

quantityString!

Quantity limit of the transaction.

totalIssuedString!

Total issued token in the transaction.

statusIntentStatus!

Intent status

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.

Issuer

Represents an Issuer in the network.

FieldArgumentTypeDescription
idString!
assetsAssets!

Assets issued by the Issuer.

filter[Filter!]
aggregates[Aggregate!]

Issuers

Results for issuers query.

FieldArgumentTypeDescription
nodes[Issuer!]

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

ManualIntentSignaturePolicy

FieldArgumentTypeDescription
callbackURLString!

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

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 identification.

clusterIdString!

Organization's cluster id.

assetsAssets!

Assets which the Organization act as the Primary Node.

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

Users which the Organization act as the Primary Node.

filter[Filter!]
aggregates[Aggregate!]

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.

PresignedBuyingIntentSignaturePolicy

FieldArgumentTypeDescription
transferSignatureString!

PresignedSellingIntentSignaturePolicy

FieldArgumentTypeDescription
wildcardTransferSignatureString!

PrimarySale

FieldArgumentTypeDescription
issuerIdString!

Issuer id

ProfileMetadata

Profile Metadata (ACL).

FieldArgumentTypeDescription
acl[String!]

Receipt

FieldArgumentTypeDescription
transactionIdString!

SellingIntent

FieldArgumentTypeDescription
sellerString

resource id of the seller

signaturePolicyTypeSignaturePolicyType!

Signature policy type

signaturePolicySellingSignaturePolicy!
publicKeyString

A public key of the intent creator

SettlementCondition

FieldArgumentTypeDescription
assetIdString!

Settlement asset id

quantityString!

Per unit quantity

expiryString!

Expiry of the settlement condition

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.

TransactionDetails

FieldArgumentTypeDescription
transactionIdString!
indexInt!
quantityString!

User

Represents an User in the network.

FieldArgumentTypeDescription
idString!
certificatesCertificates!

Collection of certificatess associated with the Profile.

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

Assets token balance

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

Organizaion id to whom this profile is associated with.

metadataProfileMetadata!

Profile metadata, contains ACL information of the profile.

publicKeyString!

User's public key.

Users

Results for asset query.

FieldArgumentTypeDescription
nodes[User!]

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

aggregate[AggregateResult!]

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.

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.

Enums

AggregateFunc

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

ValueDescription
SUM
COUNT
AVG
MAX
MIN

IntentStatus

ValueDescription
ACTIVE
NON_ACTIVE

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

SignaturePolicyType

ValueDescription
PresignedPolicy
ManualPolicy

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 certificatess 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

BuyingSignaturePolicy

IntentDetails

SellingSignaturePolicy