Schema Types

Table of Contents

Query
Objects
Inputs
- Aggregate
- Filter
Enums
Scalars
- Boolean
- Int
- String
Interfaces
- Profile
Unions

Query

The query root of Usera's GraphQL interface.

Field	Type	Description
assets	Assets!	Look up Assets, Optional provide Filters or Aggregates.
filter	[Filter!]
aggregate	[Aggregate!]
users	Users!	Look up Users, Optional provide Filter or Aggregate.
filter	[Filter!]
aggregate	[Aggregate!]
receipt	Receipt	Look up a receipt by ID (mandatory).
transactionId	String!
issuers	Issuers!	Look up Issuers, Optional provide Filter.
filter	[Filter!]
certificates	Certificates!	Look up Certificates, Optional provide Filter or Aggregate.
filter	[Filter!]
aggregate	[Aggregate!]
organizations	Organizations!	Look up Organizations, Optional provide Filter or Aggregate.
filter	[Filter!]
aggregate	[Aggregate!]
escrows	Escrows!	List of escrows
filter	[Filter!]

Objects

Account

Field	Argument	Type	Description
asset		AssetDetails!	Asset type associated with the account
identifier		AccountIdentifier!

AggregateResult

Result of Aggregation function applied on an Object numeric field.

Field	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	Type	Description
id	String!
certificates	Certificates!	Collection of certificatess associated with the Profile.
filter	[Filter!]
aggregates	[Aggregate!]
intents	Intents!	Collection of Intents associated with the Asset.
filter	[Filter!]
aggregates	[Aggregate!]
name	String!
type	String!	Type of Asset (Share, Debt etc..)
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

AssetConversion

Field	Argument	Type	Description
accountType		AccountIdentifier	Type of accounts
symbols		[String]	List of symbols

AssetInstruction

Field	Argument	Type	Description
account		Account!

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.

BuyingIntent

Field	Type	Description
buyer	String	resource id of the buyer
signaturePolicyType	SignaturePolicyType!	Signature policy type
signaturePolicy	BuyingSignaturePolicy!
settlementInstruction	BuyingSettlementInstruction!

BuyingSettlementInstruction

Field	Argument	Type	Description
type		BuyingSettlementInstructionType!
account		Account!

Certificate

Represents a Certificate in the network.

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

ConvertibleAsset

Field	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

CryptoWalletAccount

Field	Argument	Type	Description
address		String!	Wallet address

Cryptocurrency

Field	Argument	Type	Description
symbol		String!	Symbol of the Cryptocurrnecy

Document

Certificate related Document metadata informaiton

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

Escrow

Represents an Escrow in the network.

Field	Argument	Type	Description
orgId		String!	FinP2P Organization Id of the Escrow
paymentAsset		PaymentAsset!	Payment Asset

EscrowAccount

Field	Argument	Type	Description
accountId		String!	Escrow account identifier

EscrowBuyingSettlementInstruction

Field	Argument	Type	Description
expiry		Int!

EscrowSellingSettlementInstruction

Field	Argument	Type	Description
whiteListedEscrows		[String!]

Escrows

Field	Argument	Type	Description
nodes		[Escrow!]	Collection of escrow Objects, conforms to the Filter input if provided.

FiatAsset

Field	Argument	Type	Description
code		String!	ISO-4217 code of the fiat currency

FinIdAccount

Field	Argument	Type	Description
finId		String!	FinID publickey associated with a user on the FinP2P netowrk

FinP2PAsset

Field	Argument	Type	Description
resourceId		String!	Resource ID of the FinP2P asset

Iban

Field	Argument	Type	Description
iban		String!	IBAN code

Intent

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

Field	Type	Description
id	String!
start	Int!	Start time of the intent.
end	Int!	End time of the intent.
status	IntentStatus!	Intent status
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
remainingQuantity	String!	Remaining quantity in the transaction.
type	String!	Intent type: primary sale, buying or selling intent
intent	IntentDetails	Intent data

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.

Issuer

Represents an Issuer in the network.

Field	Type	Description
id	String!
assets	Assets!	Assets issued by the Issuer.
filter	[Filter!]
aggregates	[Aggregate!]

Issuers

Results for issuers query.

Field	Argument	Type	Description
nodes		[Issuer!]	Collection of Issuer Objects, conforms to the Filter input if provided.

ManualIntentSignaturePolicy

Field	Argument	Type	Description
callbackURL		String!	Endpoint to contact to receive signature, callback should be able to recieve a transfer operation signature object

Organization

Organization's information.

Field	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 identification.
clusterId	String!	Organization's cluster id.
assets	Assets!	Assets which the Organization act as the Primary Node.
filter	[Filter!]
aggregates	[Aggregate!]
users	Users!	Users which the Organization act as the Primary Node.
filter	[Filter!]
aggregates	[Aggregate!]

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.

PaymentAsset

Represents supported asset types and conversions in Escrow.

Field	Argument	Type	Description
accountType		String	Type of account, f.e.: 'Escrow'
assets		[ConvertibleAsset]	List of supported assets

PresignedBuyingIntentSignaturePolicy

Field	Argument	Type	Description
transferSignature		String!

PresignedSellingIntentSignaturePolicy

Field	Argument	Type	Description
wildcardTransferSignature		String!

PrimarySale

Field	Argument	Type	Description
issuerId		String!	Issuer id
sellingSettlementInstruction		SellingSettlementInstruction!

ProfileMetadata

Profile Metadata (ACL).

Field	Argument	Type	Description
acl		[String!]

Receipt

Field	Argument	Type	Description
transactionId		String!

SellingIntent

Field	Type	Description
seller	String	resource id of the seller
signaturePolicyType	SignaturePolicyType!	Signature policy type
signaturePolicy	SellingSignaturePolicy!
sellingSettlementInstruction	SellingSettlementInstruction!

SellingSettlementInstruction

Field	Argument	Type	Description
type		SellingSettlementInstructionType!
accounts		[Account!]

SettlementInstruction

Field	Argument	Type	Description
type		SettlementType!
details		SettlementInstructionTypeDetails!

SettlementTerm

Field	Argument	Type	Description
asset		AssetDetails!
unitValue		String!

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.

TransactionDetails

Field	Argument	Type	Description
transactionId		String!
index		Int!
quantity		String!

User

Represents an User in the network.

Field	Type	Description
id	String!
certificates	Certificates!	Collection of certificatess associated with the Profile.
filter	[Filter!]
aggregates	[Aggregate!]
name	String!
tokens	TokensBalances!	Assets token balance
filter	[Filter!]
aggregates	[Aggregate!]
organizationId	String!	Organizaion id to whom this profile is associated with.
metadata	ProfileMetadata!	Profile metadata, contains ACL information of the profile.
publicKey	String!	User's public key.

Users

Results for asset query.

Field	Argument	Type	Description
nodes		[User!]	Collection of User Objects, conforms to the Filter input if provided.
aggregate		[AggregateResult!]

Verifier

Regulation Verifier

Field	Type	Description
id	String	Verifier ID
name	String	Verifier Name
provider	String	Provider type: REG_APP_STORE, OTHER

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.

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.

Enums

AggregateFunc

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

Value	Description
SUM
COUNT
AVG
MAX
MIN

AssetType

Value	Description
finp2p
fiat
cryptocurrency

IntentStatus

Value	Description
ACTIVE
NON_ACTIVE

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

SettlementType

Value	Description
Escrow

SignaturePolicyType

Value	Description
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.

Field	Type	Description
id	String!
certificates	Certificates!	Collection of certificatess 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
FinIdAccount
EscrowAccount

AssetDetails

Type	Description
FinP2PAsset
FiatAsset
Cryptocurrency

BuyingSettlementInstructionType

Type	Description
EscrowBuyingSettlementInstruction

BuyingSignaturePolicy

Type	Description
PresignedBuyingIntentSignaturePolicy
ManualIntentSignaturePolicy

IntentDetails

Type	Description
PrimarySale
BuyingIntent
SellingIntent

SellingSettlementInstructionType

Type	Description
EscrowSellingSettlementInstruction

SellingSignaturePolicy

Type	Description
PresignedSellingIntentSignaturePolicy
ManualIntentSignaturePolicy

SettlementInstructionTypeDetails

Type	Description
SellingSettlementInstruction
BuyingSettlementInstruction