Gateway Protocol API Reference
Welcome to the Gateway developer hub. You'll find comprehensive guides and documentation to help you start working with Gateway as quickly as possible, as well as support if you get stuck. Let's jump right in!
API Endpoints
# Public Sandbox Environment:
https://sandbox.protocol.mygateway.xyz/graphql
Queries
PDA
Response
Returns a PrivateDataAsset
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query PDA($id: String!) {
PDA(id: $id) {
arweaveUrl
claimHash
dataAsset {
...DecryptedPDAFragment
}
expirationDate
hash
id
idV3
issuanceDate
issuerHash
lastUpdated
ownerHash
status
transactionId
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"PDA": {
"arweaveUrl": "xyz789",
"claimHash": {},
"dataAsset": DecryptedPDA,
"expirationDate": "2007-12-03T10:15:30Z",
"hash": "abc123",
"id": "abc123",
"idV3": 987.65,
"issuanceDate": "2007-12-03T10:15:30Z",
"issuerHash": "xyz789",
"lastUpdated": "2007-12-03T10:15:30Z",
"ownerHash": "xyz789",
"status": "Expired",
"transactionId": "abc123"
}
}
}
PDACount
Response
Returns a Float!
Arguments
| Name | Description |
|---|---|
filter - FilterPDAInput
|
Example
Query
query PDACount($filter: FilterPDAInput) {
PDACount(filter: $filter)
}
Variables
{"filter": FilterPDAInput}
Response
{"data": {"PDACount": 123.45}}
PDAs
Response
Returns [PrivateDataAsset!]!
Arguments
| Name | Description |
|---|---|
filter - FilterPDAInput
|
|
order - JSON
|
Configure Ordering with PDA attributes (example: {'createdAt': 'DESC'} ) |
skip - Float
|
Skip the first N elements (default: N = 0) |
take - Float
|
Take the first N elements (default: N = 15) |
Example
Query
query PDAs(
$filter: FilterPDAInput,
$order: JSON,
$skip: Float,
$take: Float
) {
PDAs(
filter: $filter,
order: $order,
skip: $skip,
take: $take
) {
arweaveUrl
claimHash
dataAsset {
...DecryptedPDAFragment
}
expirationDate
hash
id
idV3
issuanceDate
issuerHash
lastUpdated
ownerHash
status
transactionId
}
}
Variables
{
"filter": FilterPDAInput,
"order": {},
"skip": 123.45,
"take": 123.45
}
Response
{
"data": {
"PDAs": [
{
"arweaveUrl": "abc123",
"claimHash": {},
"dataAsset": DecryptedPDA,
"expirationDate": "2007-12-03T10:15:30Z",
"hash": "abc123",
"id": "xyz789",
"idV3": 123.45,
"issuanceDate": "2007-12-03T10:15:30Z",
"issuerHash": "xyz789",
"lastUpdated": "2007-12-03T10:15:30Z",
"ownerHash": "abc123",
"status": "Expired",
"transactionId": "xyz789"
}
]
}
}
applications
Response
Returns [Application!]!
Example
Query
query Applications {
applications {
apiKey
gatewayFacilitationFee
organization {
...OrganizationFragment
}
}
}
Response
{
"data": {
"applications": [
{
"apiKey": "abc123",
"gatewayFacilitationFee": 123.45,
"organization": Organization
}
]
}
}
calculateProofCost
Response
Returns a ProofCost!
Arguments
| Name | Description |
|---|---|
requestId - String!
|
Example
Query
query CalculateProofCost($requestId: String!) {
calculateProofCost(requestId: $requestId) {
facilitationFee
totalCost
}
}
Variables
{"requestId": "xyz789"}
Response
{
"data": {
"calculateProofCost": {"facilitationFee": 987.65, "totalCost": 123.45}
}
}
checkUsernameAvailability
createDepositLink
Response
Returns a String!
Example
Query
query CreateDepositLink {
createDepositLink
}
Response
{"data": {"createDepositLink": "xyz789"}}
dataModel
Response
Returns a DataModel!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query DataModel($id: String!) {
dataModel(id: $id) {
PDAs {
...PrivateDataAssetFragment
}
allowedOrganizations {
...OrganizationFragment
}
allowedUsers {
...UserFragment
}
arweaveUrl
consumptionPrice
createdAt
createdBy {
...UserFragment
}
description
featured
group {
...DataModelGroupFragment
}
id
image
organization {
...OrganizationFragment
}
pdas {
...PrivateDataAssetFragment
}
pdasIssuedCount
permissioning
revenueGenerated
schema
tags
title
uniqueIssuersCount
verified
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"dataModel": {
"PDAs": [PrivateDataAsset],
"allowedOrganizations": [Organization],
"allowedUsers": [User],
"arweaveUrl": "abc123",
"consumptionPrice": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"createdBy": User,
"description": "xyz789",
"featured": false,
"group": DataModelGroup,
"id": "abc123",
"image": "abc123",
"organization": Organization,
"pdas": [PrivateDataAsset],
"pdasIssuedCount": 987.65,
"permissioning": "ALL",
"revenueGenerated": 987.65,
"schema": {},
"tags": ["abc123"],
"title": "abc123",
"uniqueIssuersCount": 123.45,
"verified": true
}
}
}
dataModels
Response
Returns [DataModel!]!
Arguments
| Name | Description |
|---|---|
filter - FilterDataModelInput
|
|
order - JSON
|
Configure Ordering with Data Model attributes (example: {'verified': 'DESC'} ) |
skip - Int
|
|
take - Int
|
Example
Query
query DataModels(
$filter: FilterDataModelInput,
$order: JSON,
$skip: Int,
$take: Int
) {
dataModels(
filter: $filter,
order: $order,
skip: $skip,
take: $take
) {
PDAs {
...PrivateDataAssetFragment
}
allowedOrganizations {
...OrganizationFragment
}
allowedUsers {
...UserFragment
}
arweaveUrl
consumptionPrice
createdAt
createdBy {
...UserFragment
}
description
featured
group {
...DataModelGroupFragment
}
id
image
organization {
...OrganizationFragment
}
pdas {
...PrivateDataAssetFragment
}
pdasIssuedCount
permissioning
revenueGenerated
schema
tags
title
uniqueIssuersCount
verified
}
}
Variables
{
"filter": FilterDataModelInput,
"order": {},
"skip": 987,
"take": 987
}
Response
{
"data": {
"dataModels": [
{
"PDAs": [PrivateDataAsset],
"allowedOrganizations": [Organization],
"allowedUsers": [User],
"arweaveUrl": "abc123",
"consumptionPrice": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"createdBy": User,
"description": "abc123",
"featured": true,
"group": DataModelGroup,
"id": "abc123",
"image": "xyz789",
"organization": Organization,
"pdas": [PrivateDataAsset],
"pdasIssuedCount": 987.65,
"permissioning": "ALL",
"revenueGenerated": 987.65,
"schema": {},
"tags": ["abc123"],
"title": "abc123",
"uniqueIssuersCount": 987.65,
"verified": false
}
]
}
}
dataModelsCount
Response
Returns a Float!
Arguments
| Name | Description |
|---|---|
filter - FilterDataModelInput
|
Example
Query
query DataModelsCount($filter: FilterDataModelInput) {
dataModelsCount(filter: $filter)
}
Variables
{"filter": FilterDataModelInput}
Response
{"data": {"dataModelsCount": 987.65}}
dataModelsMetadata
Response
Returns a DataModelsMetadata!
Example
Query
query DataModelsMetadata {
dataModelsMetadata {
consumptionPrice
issuedCount
tags
}
}
Response
{
"data": {
"dataModelsMetadata": {
"consumptionPrice": {},
"issuedCount": {},
"tags": ["xyz789"]
}
}
}
dataRequest
Response
Returns a DataRequest!
Arguments
| Name | Description |
|---|---|
requestId - String!
|
Example
Query
query DataRequest($requestId: String!) {
dataRequest(requestId: $requestId) {
arweaveUrl
createdAt
dataRequestTemplate {
...DataRequestTemplateFragment
}
dataUse
id
owner {
...UserFragment
}
proof {
...ProofFragment
}
status
verifier {
...UserFragment
}
verifierOrganization {
...OrganizationFragment
}
}
}
Variables
{"requestId": "xyz789"}
Response
{
"data": {
"dataRequest": {
"arweaveUrl": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"dataRequestTemplate": DataRequestTemplate,
"dataUse": "xyz789",
"id": "xyz789",
"owner": User,
"proof": Proof,
"status": "ACCEPTED",
"verifier": User,
"verifierOrganization": Organization
}
}
}
dataRequestCount
Response
Returns a Float!
Arguments
| Name | Description |
|---|---|
filter - FilterDataRequestInput
|
Example
Query
query DataRequestCount($filter: FilterDataRequestInput) {
dataRequestCount(filter: $filter)
}
Variables
{"filter": FilterDataRequestInput}
Response
{"data": {"dataRequestCount": 123.45}}
dataRequestStatus
Response
Returns a DataResourceStatus!
Arguments
| Name | Description |
|---|---|
requestId - String!
|
Example
Query
query DataRequestStatus($requestId: String!) {
dataRequestStatus(requestId: $requestId)
}
Variables
{"requestId": "abc123"}
Response
{"data": {"dataRequestStatus": "ACCEPTED"}}
dataRequestTemplate
Response
Returns a DataRequestTemplate
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query DataRequestTemplate($id: String!) {
dataRequestTemplate(id: $id) {
arweaveUrl
createdAt
dataModels {
...DataModelFragment
}
dataRequests {
...DataRequestFragment
}
dataRequestsCount
description
id
name
organization {
...OrganizationFragment
}
revenueGenerated
schema
tags
uniqueVerifiersCount
user {
...UserFragment
}
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"dataRequestTemplate": {
"arweaveUrl": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"dataModels": [DataModel],
"dataRequests": [DataRequest],
"dataRequestsCount": 123.45,
"description": "abc123",
"id": "abc123",
"name": "abc123",
"organization": Organization,
"revenueGenerated": 987.65,
"schema": {},
"tags": ["abc123"],
"uniqueVerifiersCount": 123.45,
"user": User
}
}
}
dataRequestTemplates
Response
Returns [DataRequestTemplate!]!
Arguments
| Name | Description |
|---|---|
filter - FilterDataRequestTemplateInput
|
|
order - JSON
|
|
skip - Int
|
|
take - Float
|
Example
Query
query DataRequestTemplates(
$filter: FilterDataRequestTemplateInput,
$order: JSON,
$skip: Int,
$take: Float
) {
dataRequestTemplates(
filter: $filter,
order: $order,
skip: $skip,
take: $take
) {
arweaveUrl
createdAt
dataModels {
...DataModelFragment
}
dataRequests {
...DataRequestFragment
}
dataRequestsCount
description
id
name
organization {
...OrganizationFragment
}
revenueGenerated
schema
tags
uniqueVerifiersCount
user {
...UserFragment
}
}
}
Variables
{
"filter": FilterDataRequestTemplateInput,
"order": {},
"skip": 123,
"take": 987.65
}
Response
{
"data": {
"dataRequestTemplates": [
{
"arweaveUrl": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"dataModels": [DataModel],
"dataRequests": [DataRequest],
"dataRequestsCount": 123.45,
"description": "xyz789",
"id": "xyz789",
"name": "abc123",
"organization": Organization,
"revenueGenerated": 123.45,
"schema": {},
"tags": ["abc123"],
"uniqueVerifiersCount": 987.65,
"user": User
}
]
}
}
dataRequestTemplatesCount
Response
Returns a Float!
Arguments
| Name | Description |
|---|---|
filter - FilterDataRequestTemplateInput
|
Example
Query
query DataRequestTemplatesCount($filter: FilterDataRequestTemplateInput) {
dataRequestTemplatesCount(filter: $filter)
}
Variables
{"filter": FilterDataRequestTemplateInput}
Response
{"data": {"dataRequestTemplatesCount": 987.65}}
dataRequestTemplatesMetadata
Response
Returns a DataRequestTemplatesMetadata!
Example
Query
query DataRequestTemplatesMetadata {
dataRequestTemplatesMetadata {
tags
}
}
Response
{
"data": {
"dataRequestTemplatesMetadata": {
"tags": ["abc123"]
}
}
}
dataRequests
Response
Returns [DataRequest!]!
Arguments
| Name | Description |
|---|---|
filter - FilterDataRequestInput
|
Example
Query
query DataRequests($filter: FilterDataRequestInput) {
dataRequests(filter: $filter) {
arweaveUrl
createdAt
dataRequestTemplate {
...DataRequestTemplateFragment
}
dataUse
id
owner {
...UserFragment
}
proof {
...ProofFragment
}
status
verifier {
...UserFragment
}
verifierOrganization {
...OrganizationFragment
}
}
}
Variables
{"filter": FilterDataRequestInput}
Response
{
"data": {
"dataRequests": [
{
"arweaveUrl": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"dataRequestTemplate": DataRequestTemplate,
"dataUse": "xyz789",
"id": "abc123",
"owner": User,
"proof": Proof,
"status": "ACCEPTED",
"verifier": User,
"verifierOrganization": Organization
}
]
}
}
financialTransactions
Response
Returns [FinancialTransaction!]!
Arguments
| Name | Description |
|---|---|
identifier - TransactionIdentifierInput!
|
|
skip - Int
|
|
take - Int
|
Example
Query
query FinancialTransactions(
$identifier: TransactionIdentifierInput!,
$skip: Int,
$take: Int
) {
financialTransactions(
identifier: $identifier,
skip: $skip,
take: $take
) {
action
createdAt
fee
from {
... on Organization {
...OrganizationFragment
}
... on User {
...UserFragment
}
}
id
memo
to {
... on Organization {
...OrganizationFragment
}
... on User {
...UserFragment
}
}
total
transaction {
...TransactionFragment
}
transactionId
type
updatedAt
value
wallet {
...WalletFragment
}
}
}
Variables
{
"identifier": TransactionIdentifierInput,
"skip": 123,
"take": 987
}
Response
{
"data": {
"financialTransactions": [
{
"action": "DATAMODEL_CREATE",
"createdAt": "2007-12-03T10:15:30Z",
"fee": 123.45,
"from": Organization,
"id": "abc123",
"memo": {},
"to": Organization,
"total": 123.45,
"transaction": Transaction,
"transactionId": "abc123",
"type": "DEPOSIT",
"updatedAt": "2007-12-03T10:15:30Z",
"value": 987.65,
"wallet": Wallet
}
]
}
}
findValidPDAsForRequest
Response
Returns [ValidPDAForRequest!]!
Arguments
| Name | Description |
|---|---|
requestId - String!
|
Example
Query
query FindValidPDAsForRequest($requestId: String!) {
findValidPDAsForRequest(requestId: $requestId) {
dataModel {
...DataModelFragment
}
pdas {
...PrivateDataAssetFragment
}
required
schema {
...DataRequestTemplateDataModelSchemaObjectFragment
}
validData {
...ValidDataRequestedFragment
}
}
}
Variables
{"requestId": "xyz789"}
Response
{
"data": {
"findValidPDAsForRequest": [
{
"dataModel": DataModel,
"pdas": [PrivateDataAsset],
"required": true,
"schema": DataRequestTemplateDataModelSchemaObject,
"validData": [ValidDataRequested]
}
]
}
}
findValidPDAsForRequestTemplate
Response
Returns [ValidPDAForRequest!]!
Arguments
| Name | Description |
|---|---|
requestTemplateId - String!
|
Example
Query
query FindValidPDAsForRequestTemplate($requestTemplateId: String!) {
findValidPDAsForRequestTemplate(requestTemplateId: $requestTemplateId) {
dataModel {
...DataModelFragment
}
pdas {
...PrivateDataAssetFragment
}
required
schema {
...DataRequestTemplateDataModelSchemaObjectFragment
}
validData {
...ValidDataRequestedFragment
}
}
}
Variables
{"requestTemplateId": "abc123"}
Response
{
"data": {
"findValidPDAsForRequestTemplate": [
{
"dataModel": DataModel,
"pdas": [PrivateDataAsset],
"required": false,
"schema": DataRequestTemplateDataModelSchemaObject,
"validData": [ValidDataRequested]
}
]
}
}
generatedFees
Response
Returns a Float!
Example
Query
query GeneratedFees {
generatedFees
}
Response
{"data": {"generatedFees": 123.45}}
getExplorerStats
Response
Returns an ExplorerAnalyticsSchema!
Example
Query
query GetExplorerStats {
getExplorerStats {
dataRequests
pdasIssued
totalEarnings
totalTransactions
totalUsers
uniqueIssuers
}
}
Response
{
"data": {
"getExplorerStats": {
"dataRequests": 987,
"pdasIssued": 123,
"totalEarnings": 123.45,
"totalTransactions": 987,
"totalUsers": 123,
"uniqueIssuers": 987
}
}
}
getMonthlyUserUsage
Response
Returns a UserUsageDto!
Example
Query
query GetMonthlyUserUsage {
getMonthlyUserUsage {
credentialsUsageAllowedByMonth
datamodelsUsageAllowedByMonth
monthlyCredentials
monthlyDatamodels
}
}
Response
{
"data": {
"getMonthlyUserUsage": {
"credentialsUsageAllowedByMonth": 123,
"datamodelsUsageAllowedByMonth": 123,
"monthlyCredentials": 123,
"monthlyDatamodels": 123
}
}
}
getTotalofIssuersByDataModel
getTransactionsExplorerStats
Response
Returns an ExplorerTransactionsAnalyticsSchema!
Example
Query
query GetTransactionsExplorerStats {
getTransactionsExplorerStats {
dataRequests
pdasIssued
totalEarnings
totalTransactions
uniqueIssuers
}
}
Response
{
"data": {
"getTransactionsExplorerStats": {
"dataRequests": 987,
"pdasIssued": 987,
"totalEarnings": 987.65,
"totalTransactions": 123,
"uniqueIssuers": 987
}
}
}
issuedPDAs
Response
Returns [PrivateDataAsset!]!
Arguments
| Name | Description |
|---|---|
filter - FilterPDAInput
|
|
order - JSON
|
Configure Ordering with PDA attributes (example: {'createdAt': 'DESC'} ) |
skip - Float
|
Skip the first N elements (default: N = 0) |
take - Float
|
Take the first N elements (default: N = 15) |
Example
Query
query IssuedPDAs(
$filter: FilterPDAInput,
$order: JSON,
$skip: Float,
$take: Float
) {
issuedPDAs(
filter: $filter,
order: $order,
skip: $skip,
take: $take
) {
arweaveUrl
claimHash
dataAsset {
...DecryptedPDAFragment
}
expirationDate
hash
id
idV3
issuanceDate
issuerHash
lastUpdated
ownerHash
status
transactionId
}
}
Variables
{
"filter": FilterPDAInput,
"order": {},
"skip": 123.45,
"take": 987.65
}
Response
{
"data": {
"issuedPDAs": [
{
"arweaveUrl": "xyz789",
"claimHash": {},
"dataAsset": DecryptedPDA,
"expirationDate": "2007-12-03T10:15:30Z",
"hash": "xyz789",
"id": "xyz789",
"idV3": 123.45,
"issuanceDate": "2007-12-03T10:15:30Z",
"issuerHash": "xyz789",
"lastUpdated": "2007-12-03T10:15:30Z",
"ownerHash": "xyz789",
"status": "Expired",
"transactionId": "abc123"
}
]
}
}
issuedPDAsCount
Response
Returns a Float!
Arguments
| Name | Description |
|---|---|
filter - FilterPDAInput
|
Example
Query
query IssuedPDAsCount($filter: FilterPDAInput) {
issuedPDAsCount(filter: $filter)
}
Variables
{"filter": FilterPDAInput}
Response
{"data": {"issuedPDAsCount": 123.45}}
issuersByDataModel
Response
Returns [DataModelIssuer!]!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query IssuersByDataModel($id: String!) {
issuersByDataModel(id: $id) {
count
issuer {
... on Organization {
...OrganizationFragment
}
... on User {
...UserFragment
}
}
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"issuersByDataModel": [
{"count": 123.45, "issuer": Organization}
]
}
}
issuersByDataModelCount
me
Response
Returns a User!
Example
Query
query Me {
me {
accesses {
...OrganizationAccessFragment
}
arweaveUrl
authentications {
...AuthFragment
}
createdAt
credentialsExtraCredits
dataModels {
...DataModelFragment
}
dataModelsExtraCredits
dataRequestTemplates {
...DataRequestTemplateFragment
}
deletedAt
displayName
email
gatewayId
gatewayIdLastupdate
gatewayIdUpdatedAt
hash
id
idV3
isCompleted
issuedPDAs {
...PrivateDataAssetFragment
}
issuedProofs {
...ProofFragment
}
profilePicture
receivedPDAs {
...PrivateDataAssetFragment
}
receivedProofs {
...ProofFragment
}
recipientDataRequests {
...DataRequestFragment
}
roles
status
updatedAt
verifierDataRequests {
...DataRequestFragment
}
walletId
}
}
Response
{
"data": {
"me": {
"accesses": [OrganizationAccess],
"arweaveUrl": "xyz789",
"authentications": [Auth],
"createdAt": "2007-12-03T10:15:30Z",
"credentialsExtraCredits": 987.65,
"dataModels": [DataModel],
"dataModelsExtraCredits": 123.45,
"dataRequestTemplates": [DataRequestTemplate],
"deletedAt": "2007-12-03T10:15:30Z",
"displayName": "abc123",
"email": "xyz789",
"gatewayId": "xyz789",
"gatewayIdLastupdate": "2007-12-03T10:15:30Z",
"gatewayIdUpdatedAt": "2007-12-03T10:15:30Z",
"hash": "abc123",
"id": "xyz789",
"idV3": "xyz789",
"isCompleted": false,
"issuedPDAs": [PrivateDataAsset],
"issuedProofs": [Proof],
"profilePicture": "abc123",
"receivedPDAs": [PrivateDataAsset],
"receivedProofs": [Proof],
"recipientDataRequests": [DataRequest],
"roles": ["Admin"],
"status": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"verifierDataRequests": [DataRequest],
"walletId": "xyz789"
}
}
}
myDataModelsCount
Response
Returns a Float!
Arguments
| Name | Description |
|---|---|
filter - FilterDataModelInput
|
Example
Query
query MyDataModelsCount($filter: FilterDataModelInput) {
myDataModelsCount(filter: $filter)
}
Variables
{"filter": FilterDataModelInput}
Response
{"data": {"myDataModelsCount": 987.65}}
myDataRequestTemplatesCount
Response
Returns a Float!
Arguments
| Name | Description |
|---|---|
filter - FilterDataRequestTemplateInput
|
Example
Query
query MyDataRequestTemplatesCount($filter: FilterDataRequestTemplateInput) {
myDataRequestTemplatesCount(filter: $filter)
}
Variables
{"filter": FilterDataRequestTemplateInput}
Response
{"data": {"myDataRequestTemplatesCount": 987.65}}
myFinancialTransactions
Response
Returns [FinancialTransaction!]!
Example
Query
query MyFinancialTransactions(
$organizationId: String,
$skip: Int,
$take: Int
) {
myFinancialTransactions(
organizationId: $organizationId,
skip: $skip,
take: $take
) {
action
createdAt
fee
from {
... on Organization {
...OrganizationFragment
}
... on User {
...UserFragment
}
}
id
memo
to {
... on Organization {
...OrganizationFragment
}
... on User {
...UserFragment
}
}
total
transaction {
...TransactionFragment
}
transactionId
type
updatedAt
value
wallet {
...WalletFragment
}
}
}
Variables
{
"organizationId": "abc123",
"skip": 987,
"take": 987
}
Response
{
"data": {
"myFinancialTransactions": [
{
"action": "DATAMODEL_CREATE",
"createdAt": "2007-12-03T10:15:30Z",
"fee": 987.65,
"from": Organization,
"id": "xyz789",
"memo": {},
"to": Organization,
"total": 123.45,
"transaction": Transaction,
"transactionId": "xyz789",
"type": "DEPOSIT",
"updatedAt": "2007-12-03T10:15:30Z",
"value": 987.65,
"wallet": Wallet
}
]
}
}
myFinancialTransactionsCount
Example
Query
query MyFinancialTransactionsCount($organizationId: String) {
myFinancialTransactionsCount(organizationId: $organizationId)
}
Variables
{"organizationId": "xyz789"}
Response
{"data": {"myFinancialTransactionsCount": 123.45}}
myPDACount
Response
Returns a Float!
Arguments
| Name | Description |
|---|---|
filter - FilterPDAInput
|
Example
Query
query MyPDACount($filter: FilterPDAInput) {
myPDACount(filter: $filter)
}
Variables
{"filter": FilterPDAInput}
Response
{"data": {"myPDACount": 123.45}}
myPDAs
Response
Returns [PrivateDataAsset!]!
Arguments
| Name | Description |
|---|---|
filter - FilterPDAInput
|
|
order - JSON
|
Configure Ordering with PDA attributes (example: {'createdAt': 'DESC'} ) |
skip - Float
|
Skip the first N elements (default: N = 0) |
take - Float
|
Take the first N elements (default: N = 15) |
Example
Query
query MyPDAs(
$filter: FilterPDAInput,
$order: JSON,
$skip: Float,
$take: Float
) {
myPDAs(
filter: $filter,
order: $order,
skip: $skip,
take: $take
) {
arweaveUrl
claimHash
dataAsset {
...DecryptedPDAFragment
}
expirationDate
hash
id
idV3
issuanceDate
issuerHash
lastUpdated
ownerHash
status
transactionId
}
}
Variables
{
"filter": FilterPDAInput,
"order": {},
"skip": 987.65,
"take": 987.65
}
Response
{
"data": {
"myPDAs": [
{
"arweaveUrl": "abc123",
"claimHash": {},
"dataAsset": DecryptedPDA,
"expirationDate": "2007-12-03T10:15:30Z",
"hash": "abc123",
"id": "abc123",
"idV3": 987.65,
"issuanceDate": "2007-12-03T10:15:30Z",
"issuerHash": "xyz789",
"lastUpdated": "2007-12-03T10:15:30Z",
"ownerHash": "xyz789",
"status": "Expired",
"transactionId": "abc123"
}
]
}
}
myTransactions
Response
Returns [Transaction!]!
Arguments
| Name | Description |
|---|---|
filter - FilterTransactionsInput
|
Example
Query
query MyTransactions($filter: FilterTransactionsInput) {
myTransactions(filter: $filter) {
action
arweaveUrl
cost
createdAt
financialTransactions {
...FinancialTransactionFragment
}
from {
... on Organization {
...OrganizationFragment
}
... on User {
...UserFragment
}
}
id
metadata {
... on DataModelMetadata {
...DataModelMetadataFragment
}
... on OrganizationMetadata {
...OrganizationMetadataFragment
}
... on PDAMetadata {
...PDAMetadataFragment
}
... on ProofMetadata {
...ProofMetadataFragment
}
... on RequestMetadata {
...RequestMetadataFragment
}
... on RequestTemplateMetadata {
...RequestTemplateMetadataFragment
}
... on UserMetadata {
...UserMetadataFragment
}
}
to {
... on Organization {
...OrganizationFragment
}
... on User {
...UserFragment
}
}
updatedAt
}
}
Variables
{"filter": FilterTransactionsInput}
Response
{
"data": {
"myTransactions": [
{
"action": "DATAMODEL_CREATE",
"arweaveUrl": "abc123",
"cost": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"financialTransactions": [FinancialTransaction],
"from": Organization,
"id": "abc123",
"metadata": DataModelMetadata,
"to": Organization,
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
myWallet
Example
Query
query MyWallet($organizationId: String) {
myWallet(organizationId: $organizationId) {
balance
moneyIn
moneyInSummary {
...FinancialSummaryOutputFragment
}
moneyOut
moneyOutSummary {
...FinancialSummaryOutputFragment
}
}
}
Variables
{"organizationId": "xyz789"}
Response
{
"data": {
"myWallet": {
"balance": 123.45,
"moneyIn": 987.65,
"moneyInSummary": [FinancialSummaryOutput],
"moneyOut": 987.65,
"moneyOutSummary": [FinancialSummaryOutput]
}
}
}
organization
Response
Returns an Organization
Arguments
| Name | Description |
|---|---|
input - OrganizationIdentificationInput!
|
Example
Query
query Organization($input: OrganizationIdentificationInput!) {
organization(input: $input) {
accesses {
...OrganizationAccessFragment
}
arweaveUrl
createdAt
dataModels {
...DataModelFragment
}
dataRequestTemplates {
...DataRequestTemplateFragment
}
description
gatewayId
id
idV3
image
name
receivedProofs {
...ProofFragment
}
updatedAt
usernameUpdatedAt
verified
verifierDataRequests {
...DataRequestFragment
}
walletId
website
}
}
Variables
{"input": OrganizationIdentificationInput}
Response
{
"data": {
"organization": {
"accesses": [OrganizationAccess],
"arweaveUrl": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"dataModels": [DataModel],
"dataRequestTemplates": [DataRequestTemplate],
"description": "xyz789",
"gatewayId": "abc123",
"id": "xyz789",
"idV3": "xyz789",
"image": "abc123",
"name": "abc123",
"receivedProofs": [Proof],
"updatedAt": "2007-12-03T10:15:30Z",
"usernameUpdatedAt": "2007-12-03T10:15:30Z",
"verified": false,
"verifierDataRequests": [DataRequest],
"walletId": "xyz789",
"website": "abc123"
}
}
}
organizations
Response
Returns [Organization!]!
Arguments
| Name | Description |
|---|---|
filter - FilterOrganizationInput
|
|
skip - Float
|
|
take - Float
|
Example
Query
query Organizations(
$filter: FilterOrganizationInput,
$skip: Float,
$take: Float
) {
organizations(
filter: $filter,
skip: $skip,
take: $take
) {
accesses {
...OrganizationAccessFragment
}
arweaveUrl
createdAt
dataModels {
...DataModelFragment
}
dataRequestTemplates {
...DataRequestTemplateFragment
}
description
gatewayId
id
idV3
image
name
receivedProofs {
...ProofFragment
}
updatedAt
usernameUpdatedAt
verified
verifierDataRequests {
...DataRequestFragment
}
walletId
website
}
}
Variables
{
"filter": FilterOrganizationInput,
"skip": 987.65,
"take": 123.45
}
Response
{
"data": {
"organizations": [
{
"accesses": [OrganizationAccess],
"arweaveUrl": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"dataModels": [DataModel],
"dataRequestTemplates": [DataRequestTemplate],
"description": "xyz789",
"gatewayId": "xyz789",
"id": "xyz789",
"idV3": "abc123",
"image": "xyz789",
"name": "xyz789",
"receivedProofs": [Proof],
"updatedAt": "2007-12-03T10:15:30Z",
"usernameUpdatedAt": "2007-12-03T10:15:30Z",
"verified": false,
"verifierDataRequests": [DataRequest],
"walletId": "xyz789",
"website": "abc123"
}
]
}
}
proof
Example
Query
query Proof($id: String!) {
proof(id: $id) {
arweaveUrl
createdAt
data {
...DecryptedProofFragment
}
dataRequest {
...DataRequestFragment
}
facilitationFee
hash
id
owner {
...UserFragment
}
proofHash
status
totalCost
updatedAt
verifier {
...UserFragment
}
verifierOrganization {
...OrganizationFragment
}
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"proof": {
"arweaveUrl": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"data": DecryptedProof,
"dataRequest": DataRequest,
"facilitationFee": 987.65,
"hash": "xyz789",
"id": "abc123",
"owner": User,
"proofHash": {},
"status": "ACTIVE",
"totalCost": 987.65,
"updatedAt": "2007-12-03T10:15:30Z",
"verifier": User,
"verifierOrganization": Organization
}
}
}
proofs
Response
Returns [Proof!]!
Arguments
| Name | Description |
|---|---|
filter - FilterProofInput
|
|
order - JSON
|
|
skip - Float
|
|
take - Float
|
Example
Query
query Proofs(
$filter: FilterProofInput,
$order: JSON,
$skip: Float,
$take: Float
) {
proofs(
filter: $filter,
order: $order,
skip: $skip,
take: $take
) {
arweaveUrl
createdAt
data {
...DecryptedProofFragment
}
dataRequest {
...DataRequestFragment
}
facilitationFee
hash
id
owner {
...UserFragment
}
proofHash
status
totalCost
updatedAt
verifier {
...UserFragment
}
verifierOrganization {
...OrganizationFragment
}
}
}
Variables
{
"filter": FilterProofInput,
"order": {},
"skip": 123.45,
"take": 987.65
}
Response
{
"data": {
"proofs": [
{
"arweaveUrl": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"data": DecryptedProof,
"dataRequest": DataRequest,
"facilitationFee": 987.65,
"hash": "abc123",
"id": "abc123",
"owner": User,
"proofHash": {},
"status": "ACTIVE",
"totalCost": 987.65,
"updatedAt": "2007-12-03T10:15:30Z",
"verifier": User,
"verifierOrganization": Organization
}
]
}
}
proofsByPDAIds
Response
Returns [Proof!]!
Arguments
| Name | Description |
|---|---|
pdaIds - [String!]!
|
|
skip - Float
|
|
take - Float
|
Example
Query
query ProofsByPDAIds(
$pdaIds: [String!]!,
$skip: Float,
$take: Float
) {
proofsByPDAIds(
pdaIds: $pdaIds,
skip: $skip,
take: $take
) {
arweaveUrl
createdAt
data {
...DecryptedProofFragment
}
dataRequest {
...DataRequestFragment
}
facilitationFee
hash
id
owner {
...UserFragment
}
proofHash
status
totalCost
updatedAt
verifier {
...UserFragment
}
verifierOrganization {
...OrganizationFragment
}
}
}
Variables
{
"pdaIds": ["xyz789"],
"skip": 987.65,
"take": 987.65
}
Response
{
"data": {
"proofsByPDAIds": [
{
"arweaveUrl": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"data": DecryptedProof,
"dataRequest": DataRequest,
"facilitationFee": 987.65,
"hash": "abc123",
"id": "abc123",
"owner": User,
"proofHash": {},
"status": "ACTIVE",
"totalCost": 987.65,
"updatedAt": "2007-12-03T10:15:30Z",
"verifier": User,
"verifierOrganization": Organization
}
]
}
}
receivedProofs
Response
Returns [Proof!]!
Example
Query
query ReceivedProofs(
$order: JSON,
$organizationId: String,
$skip: Float,
$take: Float
) {
receivedProofs(
order: $order,
organizationId: $organizationId,
skip: $skip,
take: $take
) {
arweaveUrl
createdAt
data {
...DecryptedProofFragment
}
dataRequest {
...DataRequestFragment
}
facilitationFee
hash
id
owner {
...UserFragment
}
proofHash
status
totalCost
updatedAt
verifier {
...UserFragment
}
verifierOrganization {
...OrganizationFragment
}
}
}
Variables
{
"order": {},
"organizationId": "xyz789",
"skip": 987.65,
"take": 987.65
}
Response
{
"data": {
"receivedProofs": [
{
"arweaveUrl": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"data": DecryptedProof,
"dataRequest": DataRequest,
"facilitationFee": 123.45,
"hash": "xyz789",
"id": "abc123",
"owner": User,
"proofHash": {},
"status": "ACTIVE",
"totalCost": 987.65,
"updatedAt": "2007-12-03T10:15:30Z",
"verifier": User,
"verifierOrganization": Organization
}
]
}
}
receivedProofsCount
requestsReceived
Response
Returns [DataRequest!]!
Arguments
| Name | Description |
|---|---|
filter - FilterDataRequestInput
|
|
order - JSON
|
Configure Ordering with Data Request attributes |
skip - Float
|
Skip the first N elements (default: N = 0). Default = 0 |
take - Float
|
Take the first N elements (default: N = 10). Default = 10 |
Example
Query
query RequestsReceived(
$filter: FilterDataRequestInput,
$order: JSON,
$skip: Float,
$take: Float
) {
requestsReceived(
filter: $filter,
order: $order,
skip: $skip,
take: $take
) {
arweaveUrl
createdAt
dataRequestTemplate {
...DataRequestTemplateFragment
}
dataUse
id
owner {
...UserFragment
}
proof {
...ProofFragment
}
status
verifier {
...UserFragment
}
verifierOrganization {
...OrganizationFragment
}
}
}
Variables
{
"filter": FilterDataRequestInput,
"order": {},
"skip": 0,
"take": 10
}
Response
{
"data": {
"requestsReceived": [
{
"arweaveUrl": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"dataRequestTemplate": DataRequestTemplate,
"dataUse": "xyz789",
"id": "abc123",
"owner": User,
"proof": Proof,
"status": "ACCEPTED",
"verifier": User,
"verifierOrganization": Organization
}
]
}
}
requestsReceivedCount
Response
Returns a Float!
Arguments
| Name | Description |
|---|---|
filter - FilterDataRequestInput
|
Example
Query
query RequestsReceivedCount($filter: FilterDataRequestInput) {
requestsReceivedCount(filter: $filter)
}
Variables
{"filter": FilterDataRequestInput}
Response
{"data": {"requestsReceivedCount": 987.65}}
requestsSent
Response
Returns [DataRequest!]!
Arguments
| Name | Description |
|---|---|
filter - FilterDataRequestInput
|
|
order - JSON
|
Configure Ordering with Data Request attributes |
skip - Float
|
Skip the first N elements (default: N = 0) |
take - Float
|
Take the first N elements (default: N = 10) |
Example
Query
query RequestsSent(
$filter: FilterDataRequestInput,
$order: JSON,
$skip: Float,
$take: Float
) {
requestsSent(
filter: $filter,
order: $order,
skip: $skip,
take: $take
) {
arweaveUrl
createdAt
dataRequestTemplate {
...DataRequestTemplateFragment
}
dataUse
id
owner {
...UserFragment
}
proof {
...ProofFragment
}
status
verifier {
...UserFragment
}
verifierOrganization {
...OrganizationFragment
}
}
}
Variables
{
"filter": FilterDataRequestInput,
"order": {},
"skip": 987.65,
"take": 123.45
}
Response
{
"data": {
"requestsSent": [
{
"arweaveUrl": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"dataRequestTemplate": DataRequestTemplate,
"dataUse": "xyz789",
"id": "xyz789",
"owner": User,
"proof": Proof,
"status": "ACCEPTED",
"verifier": User,
"verifierOrganization": Organization
}
]
}
}
requestsSentCount
Response
Returns a Float!
Arguments
| Name | Description |
|---|---|
filter - FilterDataRequestInput
|
Example
Query
query RequestsSentCount($filter: FilterDataRequestInput) {
requestsSentCount(filter: $filter)
}
Variables
{"filter": FilterDataRequestInput}
Response
{"data": {"requestsSentCount": 987.65}}
sentProofs
Example
Query
query SentProofs(
$order: JSON,
$skip: Float,
$take: Float
) {
sentProofs(
order: $order,
skip: $skip,
take: $take
) {
arweaveUrl
createdAt
data {
...DecryptedProofFragment
}
dataRequest {
...DataRequestFragment
}
facilitationFee
hash
id
owner {
...UserFragment
}
proofHash
status
totalCost
updatedAt
verifier {
...UserFragment
}
verifierOrganization {
...OrganizationFragment
}
}
}
Variables
{"order": {}, "skip": 123.45, "take": 123.45}
Response
{
"data": {
"sentProofs": [
{
"arweaveUrl": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"data": DecryptedProof,
"dataRequest": DataRequest,
"facilitationFee": 123.45,
"hash": "xyz789",
"id": "abc123",
"owner": User,
"proofHash": {},
"status": "ACTIVE",
"totalCost": 123.45,
"updatedAt": "2007-12-03T10:15:30Z",
"verifier": User,
"verifierOrganization": Organization
}
]
}
}
sentProofsCount
Response
Returns a Float!
Example
Query
query SentProofsCount {
sentProofsCount
}
Response
{"data": {"sentProofsCount": 987.65}}
templateByDataRequest
Response
Returns a DataRequestTemplate
Arguments
| Name | Description |
|---|---|
requestID - String!
|
Example
Query
query TemplateByDataRequest($requestID: String!) {
templateByDataRequest(requestID: $requestID) {
arweaveUrl
createdAt
dataModels {
...DataModelFragment
}
dataRequests {
...DataRequestFragment
}
dataRequestsCount
description
id
name
organization {
...OrganizationFragment
}
revenueGenerated
schema
tags
uniqueVerifiersCount
user {
...UserFragment
}
}
}
Variables
{"requestID": "abc123"}
Response
{
"data": {
"templateByDataRequest": {
"arweaveUrl": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"dataModels": [DataModel],
"dataRequests": [DataRequest],
"dataRequestsCount": 987.65,
"description": "xyz789",
"id": "abc123",
"name": "xyz789",
"organization": Organization,
"revenueGenerated": 123.45,
"schema": {},
"tags": ["xyz789"],
"uniqueVerifiersCount": 123.45,
"user": User
}
}
}
transaction
Response
Returns a Transaction!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query Transaction($id: String!) {
transaction(id: $id) {
action
arweaveUrl
cost
createdAt
financialTransactions {
...FinancialTransactionFragment
}
from {
... on Organization {
...OrganizationFragment
}
... on User {
...UserFragment
}
}
id
metadata {
... on DataModelMetadata {
...DataModelMetadataFragment
}
... on OrganizationMetadata {
...OrganizationMetadataFragment
}
... on PDAMetadata {
...PDAMetadataFragment
}
... on ProofMetadata {
...ProofMetadataFragment
}
... on RequestMetadata {
...RequestMetadataFragment
}
... on RequestTemplateMetadata {
...RequestTemplateMetadataFragment
}
... on UserMetadata {
...UserMetadataFragment
}
}
to {
... on Organization {
...OrganizationFragment
}
... on User {
...UserFragment
}
}
updatedAt
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"transaction": {
"action": "DATAMODEL_CREATE",
"arweaveUrl": "xyz789",
"cost": 987.65,
"createdAt": "2007-12-03T10:15:30Z",
"financialTransactions": [FinancialTransaction],
"from": Organization,
"id": "xyz789",
"metadata": DataModelMetadata,
"to": Organization,
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
transactions
Response
Returns [Transaction!]!
Arguments
| Name | Description |
|---|---|
filter - FilterTransactionsInput
|
Example
Query
query Transactions($filter: FilterTransactionsInput) {
transactions(filter: $filter) {
action
arweaveUrl
cost
createdAt
financialTransactions {
...FinancialTransactionFragment
}
from {
... on Organization {
...OrganizationFragment
}
... on User {
...UserFragment
}
}
id
metadata {
... on DataModelMetadata {
...DataModelMetadataFragment
}
... on OrganizationMetadata {
...OrganizationMetadataFragment
}
... on PDAMetadata {
...PDAMetadataFragment
}
... on ProofMetadata {
...ProofMetadataFragment
}
... on RequestMetadata {
...RequestMetadataFragment
}
... on RequestTemplateMetadata {
...RequestTemplateMetadataFragment
}
... on UserMetadata {
...UserMetadataFragment
}
}
to {
... on Organization {
...OrganizationFragment
}
... on User {
...UserFragment
}
}
updatedAt
}
}
Variables
{"filter": FilterTransactionsInput}
Response
{
"data": {
"transactions": [
{
"action": "DATAMODEL_CREATE",
"arweaveUrl": "abc123",
"cost": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"financialTransactions": [FinancialTransaction],
"from": Organization,
"id": "abc123",
"metadata": DataModelMetadata,
"to": Organization,
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
transactionsCount
user
Response
Returns a User
Arguments
| Name | Description |
|---|---|
input - UserIdentificationInput!
|
Example
Query
query User($input: UserIdentificationInput!) {
user(input: $input) {
accesses {
...OrganizationAccessFragment
}
arweaveUrl
authentications {
...AuthFragment
}
createdAt
credentialsExtraCredits
dataModels {
...DataModelFragment
}
dataModelsExtraCredits
dataRequestTemplates {
...DataRequestTemplateFragment
}
deletedAt
displayName
email
gatewayId
gatewayIdLastupdate
gatewayIdUpdatedAt
hash
id
idV3
isCompleted
issuedPDAs {
...PrivateDataAssetFragment
}
issuedProofs {
...ProofFragment
}
profilePicture
receivedPDAs {
...PrivateDataAssetFragment
}
receivedProofs {
...ProofFragment
}
recipientDataRequests {
...DataRequestFragment
}
roles
status
updatedAt
verifierDataRequests {
...DataRequestFragment
}
walletId
}
}
Variables
{"input": UserIdentificationInput}
Response
{
"data": {
"user": {
"accesses": [OrganizationAccess],
"arweaveUrl": "abc123",
"authentications": [Auth],
"createdAt": "2007-12-03T10:15:30Z",
"credentialsExtraCredits": 123.45,
"dataModels": [DataModel],
"dataModelsExtraCredits": 123.45,
"dataRequestTemplates": [DataRequestTemplate],
"deletedAt": "2007-12-03T10:15:30Z",
"displayName": "xyz789",
"email": "abc123",
"gatewayId": "abc123",
"gatewayIdLastupdate": "2007-12-03T10:15:30Z",
"gatewayIdUpdatedAt": "2007-12-03T10:15:30Z",
"hash": "abc123",
"id": "xyz789",
"idV3": "abc123",
"isCompleted": false,
"issuedPDAs": [PrivateDataAsset],
"issuedProofs": [Proof],
"profilePicture": "xyz789",
"receivedPDAs": [PrivateDataAsset],
"receivedProofs": [Proof],
"recipientDataRequests": [DataRequest],
"roles": ["Admin"],
"status": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"verifierDataRequests": [DataRequest],
"walletId": "xyz789"
}
}
}
userAuthentications
Response
Returns [AuthDataType!]!
Arguments
| Name | Description |
|---|---|
user - UserIdentificationInput!
|
Example
Query
query UserAuthentications($user: UserIdentificationInput!) {
userAuthentications(user: $user) {
address
chain
primary
}
}
Variables
{"user": UserIdentificationInput}
Response
{
"data": {
"userAuthentications": [
{
"address": "abc123",
"chain": "EVM",
"primary": false
}
]
}
}
verifiersByDataRequestTemplate
Response
Returns [DataRequestTemplateVerifier!]!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query VerifiersByDataRequestTemplate($id: String!) {
verifiersByDataRequestTemplate(id: $id) {
count
verifier {
... on Organization {
...OrganizationFragment
}
... on User {
...UserFragment
}
}
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"verifiersByDataRequestTemplate": [
{"count": 987.65, "verifier": Organization}
]
}
}
verifiersByDataRequestTemplateCount
Mutations
addEmail
Description
Add email address to your GatewayID
Response
Returns a CreateEmailNonceOutput!
Arguments
| Name | Description |
|---|---|
input - AddEmailInput!
|
Example
Query
mutation AddEmail($input: AddEmailInput!) {
addEmail(input: $input) {
code
email
}
}
Variables
{"input": AddEmailInput}
Response
{
"data": {
"addEmail": {
"code": 987,
"email": "xyz789"
}
}
}
addEmailConfirmation
Description
Confirmation of adding email to your Gateway ID. Pass a verification code generated by addEmail beforehand.
Response
Returns a SignupConfirmationOutput!
Arguments
| Name | Description |
|---|---|
input - AddEmailConfirmationInput!
|
Example
Query
mutation AddEmailConfirmation($input: AddEmailConfirmationInput!) {
addEmailConfirmation(input: $input) {
user {
...UserFragment
}
}
}
Variables
{"input": AddEmailConfirmationInput}
Response
{"data": {"addEmailConfirmation": {"user": User}}}
addMemberToOrganization
Description
Add a member to an organization
Response
Returns an OrganizationAccess!
Arguments
| Name | Description |
|---|---|
input - MemberInput!
|
Example
Query
mutation AddMemberToOrganization($input: MemberInput!) {
addMemberToOrganization(input: $input) {
id
organization {
...OrganizationFragment
}
role
user {
...UserFragment
}
}
}
Variables
{"input": MemberInput}
Response
{
"data": {
"addMemberToOrganization": {
"id": "xyz789",
"organization": Organization,
"role": "Admin",
"user": User
}
}
}
addWallet
Description
Add a SOL or EVM wallet to your GatewayID
Response
Returns a CreateWalletNonceOutput!
Arguments
| Name | Description |
|---|---|
input - CreateWalletNonceInput!
|
Example
Query
mutation AddWallet($input: CreateWalletNonceInput!) {
addWallet(input: $input) {
message
}
}
Variables
{"input": CreateWalletNonceInput}
Response
{
"data": {
"addWallet": {"message": "xyz789"}
}
}
addWalletConfirmation
Description
Confirmation of adding wallet to your Gateway ID. Sign a nonce generated by addWallet beforehand.
Response
Returns a User!
Arguments
| Name | Description |
|---|---|
input - AddWalletConfirmationInput!
|
Example
Query
mutation AddWalletConfirmation($input: AddWalletConfirmationInput!) {
addWalletConfirmation(input: $input) {
accesses {
...OrganizationAccessFragment
}
arweaveUrl
authentications {
...AuthFragment
}
createdAt
credentialsExtraCredits
dataModels {
...DataModelFragment
}
dataModelsExtraCredits
dataRequestTemplates {
...DataRequestTemplateFragment
}
deletedAt
displayName
email
gatewayId
gatewayIdLastupdate
gatewayIdUpdatedAt
hash
id
idV3
isCompleted
issuedPDAs {
...PrivateDataAssetFragment
}
issuedProofs {
...ProofFragment
}
profilePicture
receivedPDAs {
...PrivateDataAssetFragment
}
receivedProofs {
...ProofFragment
}
recipientDataRequests {
...DataRequestFragment
}
roles
status
updatedAt
verifierDataRequests {
...DataRequestFragment
}
walletId
}
}
Variables
{"input": AddWalletConfirmationInput}
Response
{
"data": {
"addWalletConfirmation": {
"accesses": [OrganizationAccess],
"arweaveUrl": "xyz789",
"authentications": [Auth],
"createdAt": "2007-12-03T10:15:30Z",
"credentialsExtraCredits": 987.65,
"dataModels": [DataModel],
"dataModelsExtraCredits": 123.45,
"dataRequestTemplates": [DataRequestTemplate],
"deletedAt": "2007-12-03T10:15:30Z",
"displayName": "xyz789",
"email": "abc123",
"gatewayId": "xyz789",
"gatewayIdLastupdate": "2007-12-03T10:15:30Z",
"gatewayIdUpdatedAt": "2007-12-03T10:15:30Z",
"hash": "abc123",
"id": "xyz789",
"idV3": "abc123",
"isCompleted": true,
"issuedPDAs": [PrivateDataAsset],
"issuedProofs": [Proof],
"profilePicture": "xyz789",
"receivedPDAs": [PrivateDataAsset],
"receivedProofs": [Proof],
"recipientDataRequests": [DataRequest],
"roles": ["Admin"],
"status": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"verifierDataRequests": [DataRequest],
"walletId": "abc123"
}
}
}
changeMemberRole
Description
Organization admins can change user role on organization. User must be a member of the organization.
Response
Returns an OrganizationAccess!
Arguments
| Name | Description |
|---|---|
input - MemberInput!
|
Example
Query
mutation ChangeMemberRole($input: MemberInput!) {
changeMemberRole(input: $input) {
id
organization {
...OrganizationFragment
}
role
user {
...UserFragment
}
}
}
Variables
{"input": MemberInput}
Response
{
"data": {
"changeMemberRole": {
"id": "xyz789",
"organization": Organization,
"role": "Admin",
"user": User
}
}
}
changePDAStatus
Description
Update the status of PDA.
Response
Returns a PrivateDataAsset!
Arguments
| Name | Description |
|---|---|
input - UpdatePDAStatusInput!
|
Example
Query
mutation ChangePDAStatus($input: UpdatePDAStatusInput!) {
changePDAStatus(input: $input) {
arweaveUrl
claimHash
dataAsset {
...DecryptedPDAFragment
}
expirationDate
hash
id
idV3
issuanceDate
issuerHash
lastUpdated
ownerHash
status
transactionId
}
}
Variables
{"input": UpdatePDAStatusInput}
Response
{
"data": {
"changePDAStatus": {
"arweaveUrl": "abc123",
"claimHash": {},
"dataAsset": DecryptedPDA,
"expirationDate": "2007-12-03T10:15:30Z",
"hash": "abc123",
"id": "abc123",
"idV3": 987.65,
"issuanceDate": "2007-12-03T10:15:30Z",
"issuerHash": "abc123",
"lastUpdated": "2007-12-03T10:15:30Z",
"ownerHash": "abc123",
"status": "Expired",
"transactionId": "abc123"
}
}
}
createApplication
Response
Returns an Application!
Arguments
| Name | Description |
|---|---|
input - CreateApplicationInput!
|
Example
Query
mutation CreateApplication($input: CreateApplicationInput!) {
createApplication(input: $input) {
apiKey
gatewayFacilitationFee
organization {
...OrganizationFragment
}
}
}
Variables
{"input": CreateApplicationInput}
Response
{
"data": {
"createApplication": {
"apiKey": "abc123",
"gatewayFacilitationFee": 987.65,
"organization": Organization
}
}
}
createDataModel
Description
Creates a new data model.
Response
Returns a DataModel!
Arguments
| Name | Description |
|---|---|
input - CreateDataModelInput!
|
Example
Query
mutation CreateDataModel($input: CreateDataModelInput!) {
createDataModel(input: $input) {
PDAs {
...PrivateDataAssetFragment
}
allowedOrganizations {
...OrganizationFragment
}
allowedUsers {
...UserFragment
}
arweaveUrl
consumptionPrice
createdAt
createdBy {
...UserFragment
}
description
featured
group {
...DataModelGroupFragment
}
id
image
organization {
...OrganizationFragment
}
pdas {
...PrivateDataAssetFragment
}
pdasIssuedCount
permissioning
revenueGenerated
schema
tags
title
uniqueIssuersCount
verified
}
}
Variables
{"input": CreateDataModelInput}
Response
{
"data": {
"createDataModel": {
"PDAs": [PrivateDataAsset],
"allowedOrganizations": [Organization],
"allowedUsers": [User],
"arweaveUrl": "xyz789",
"consumptionPrice": 987.65,
"createdAt": "2007-12-03T10:15:30Z",
"createdBy": User,
"description": "abc123",
"featured": false,
"group": DataModelGroup,
"id": "abc123",
"image": "xyz789",
"organization": Organization,
"pdas": [PrivateDataAsset],
"pdasIssuedCount": 987.65,
"permissioning": "ALL",
"revenueGenerated": 123.45,
"schema": {},
"tags": ["abc123"],
"title": "abc123",
"uniqueIssuersCount": 123.45,
"verified": false
}
}
}
createDataRequest
Response
Returns a DataRequest!
Arguments
| Name | Description |
|---|---|
input - DataRequestSchemaInput!
|
Example
Query
mutation CreateDataRequest($input: DataRequestSchemaInput!) {
createDataRequest(input: $input) {
arweaveUrl
createdAt
dataRequestTemplate {
...DataRequestTemplateFragment
}
dataUse
id
owner {
...UserFragment
}
proof {
...ProofFragment
}
status
verifier {
...UserFragment
}
verifierOrganization {
...OrganizationFragment
}
}
}
Variables
{"input": DataRequestSchemaInput}
Response
{
"data": {
"createDataRequest": {
"arweaveUrl": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"dataRequestTemplate": DataRequestTemplate,
"dataUse": "abc123",
"id": "abc123",
"owner": User,
"proof": Proof,
"status": "ACCEPTED",
"verifier": User,
"verifierOrganization": Organization
}
}
}
createDataRequestTemplate
Response
Returns a DataRequestTemplate!
Arguments
| Name | Description |
|---|---|
input - TemplateSchemaInput!
|
Example
Query
mutation CreateDataRequestTemplate($input: TemplateSchemaInput!) {
createDataRequestTemplate(input: $input) {
arweaveUrl
createdAt
dataModels {
...DataModelFragment
}
dataRequests {
...DataRequestFragment
}
dataRequestsCount
description
id
name
organization {
...OrganizationFragment
}
revenueGenerated
schema
tags
uniqueVerifiersCount
user {
...UserFragment
}
}
}
Variables
{"input": TemplateSchemaInput}
Response
{
"data": {
"createDataRequestTemplate": {
"arweaveUrl": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"dataModels": [DataModel],
"dataRequests": [DataRequest],
"dataRequestsCount": 987.65,
"description": "abc123",
"id": "abc123",
"name": "xyz789",
"organization": Organization,
"revenueGenerated": 123.45,
"schema": {},
"tags": ["abc123"],
"uniqueVerifiersCount": 123.45,
"user": User
}
}
}
createEmailNonce
Description
Create a nonce for a email to be used for login. Default Chain is EVM.
Response
Returns a CreateEmailNonceOutput!
Arguments
| Name | Description |
|---|---|
input - CreateEmailNonceInput!
|
Example
Query
mutation CreateEmailNonce($input: CreateEmailNonceInput!) {
createEmailNonce(input: $input) {
code
email
}
}
Variables
{"input": CreateEmailNonceInput}
Response
{
"data": {
"createEmailNonce": {
"code": 987,
"email": "xyz789"
}
}
}
createOrganization
Response
Returns an Organization!
Arguments
| Name | Description |
|---|---|
input - CreateOrganizationInput!
|
Example
Query
mutation CreateOrganization($input: CreateOrganizationInput!) {
createOrganization(input: $input) {
accesses {
...OrganizationAccessFragment
}
arweaveUrl
createdAt
dataModels {
...DataModelFragment
}
dataRequestTemplates {
...DataRequestTemplateFragment
}
description
gatewayId
id
idV3
image
name
receivedProofs {
...ProofFragment
}
updatedAt
usernameUpdatedAt
verified
verifierDataRequests {
...DataRequestFragment
}
walletId
website
}
}
Variables
{"input": CreateOrganizationInput}
Response
{
"data": {
"createOrganization": {
"accesses": [OrganizationAccess],
"arweaveUrl": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"dataModels": [DataModel],
"dataRequestTemplates": [DataRequestTemplate],
"description": "xyz789",
"gatewayId": "xyz789",
"id": "xyz789",
"idV3": "xyz789",
"image": "abc123",
"name": "abc123",
"receivedProofs": [Proof],
"updatedAt": "2007-12-03T10:15:30Z",
"usernameUpdatedAt": "2007-12-03T10:15:30Z",
"verified": true,
"verifierDataRequests": [DataRequest],
"walletId": "xyz789",
"website": "abc123"
}
}
}
createPDA
Response
Returns a PrivateDataAsset!
Arguments
| Name | Description |
|---|---|
input - CreatePDAInput!
|
Example
Query
mutation CreatePDA($input: CreatePDAInput!) {
createPDA(input: $input) {
arweaveUrl
claimHash
dataAsset {
...DecryptedPDAFragment
}
expirationDate
hash
id
idV3
issuanceDate
issuerHash
lastUpdated
ownerHash
status
transactionId
}
}
Variables
{"input": CreatePDAInput}
Response
{
"data": {
"createPDA": {
"arweaveUrl": "abc123",
"claimHash": {},
"dataAsset": DecryptedPDA,
"expirationDate": "2007-12-03T10:15:30Z",
"hash": "abc123",
"id": "xyz789",
"idV3": 123.45,
"issuanceDate": "2007-12-03T10:15:30Z",
"issuerHash": "xyz789",
"lastUpdated": "2007-12-03T10:15:30Z",
"ownerHash": "abc123",
"status": "Expired",
"transactionId": "xyz789"
}
}
}
createProof
Response
Returns a Proof!
Arguments
| Name | Description |
|---|---|
claims - JSON
|
PDA Claims |
requestId - String
|
PDA Request ID |
signature - String
|
Signature of the proof consent - if user is not logged in |
verifier - IdentificationInput
|
Verifier Gateway Identification |
wallet - String
|
Wallet used to sign message above (Solana only) |
Example
Query
mutation CreateProof(
$claims: JSON,
$requestId: String,
$signature: String,
$verifier: IdentificationInput,
$wallet: String
) {
createProof(
claims: $claims,
requestId: $requestId,
signature: $signature,
verifier: $verifier,
wallet: $wallet
) {
arweaveUrl
createdAt
data {
...DecryptedProofFragment
}
dataRequest {
...DataRequestFragment
}
facilitationFee
hash
id
owner {
...UserFragment
}
proofHash
status
totalCost
updatedAt
verifier {
...UserFragment
}
verifierOrganization {
...OrganizationFragment
}
}
}
Variables
{
"claims": {},
"requestId": "abc123",
"signature": "xyz789",
"verifier": IdentificationInput,
"wallet": "abc123"
}
Response
{
"data": {
"createProof": {
"arweaveUrl": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"data": DecryptedProof,
"dataRequest": DataRequest,
"facilitationFee": 987.65,
"hash": "xyz789",
"id": "xyz789",
"owner": User,
"proofHash": {},
"status": "ACTIVE",
"totalCost": 987.65,
"updatedAt": "2007-12-03T10:15:30Z",
"verifier": User,
"verifierOrganization": Organization
}
}
}
createProofMessage
createWalletNonce
Description
Create a nonce for a wallet to be used for login. Default Chain is EVM.
Response
Returns a CreateWalletNonceOutput!
Arguments
| Name | Description |
|---|---|
input - CreateWalletNonceInput!
|
Example
Query
mutation CreateWalletNonce($input: CreateWalletNonceInput!) {
createWalletNonce(input: $input) {
message
}
}
Variables
{"input": CreateWalletNonceInput}
Response
{
"data": {
"createWalletNonce": {
"message": "xyz789"
}
}
}
deleteAccount
Description
Soft Remove user account
loginEmail
Response
Returns a LoginOutput!
Arguments
| Name | Description |
|---|---|
input - LoginEmailInput!
|
Example
Query
mutation LoginEmail($input: LoginEmailInput!) {
loginEmail(input: $input) {
protocol_id
refresh_token
token
user {
...UserFragment
}
}
}
Variables
{"input": LoginEmailInput}
Response
{
"data": {
"loginEmail": {
"protocol_id": "xyz789",
"refresh_token": "abc123",
"token": "abc123",
"user": User
}
}
}
loginWallet
Response
Returns a LoginOutput!
Arguments
| Name | Description |
|---|---|
input - LoginWalletInput!
|
Example
Query
mutation LoginWallet($input: LoginWalletInput!) {
loginWallet(input: $input) {
protocol_id
refresh_token
token
user {
...UserFragment
}
}
}
Variables
{"input": LoginWalletInput}
Response
{
"data": {
"loginWallet": {
"protocol_id": "xyz789",
"refresh_token": "xyz789",
"token": "xyz789",
"user": User
}
}
}
migrateAuthMethod
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - MigrateAuthInput!
|
Example
Query
mutation MigrateAuthMethod($input: MigrateAuthInput!) {
migrateAuthMethod(input: $input)
}
Variables
{"input": MigrateAuthInput}
Response
{"data": {"migrateAuthMethod": false}}
refreshToken
Response
Returns a LoginOutput!
Arguments
| Name | Description |
|---|---|
input - RefreshTokenInput!
|
Example
Query
mutation RefreshToken($input: RefreshTokenInput!) {
refreshToken(input: $input) {
protocol_id
refresh_token
token
user {
...UserFragment
}
}
}
Variables
{"input": RefreshTokenInput}
Response
{
"data": {
"refreshToken": {
"protocol_id": "abc123",
"refresh_token": "xyz789",
"token": "xyz789",
"user": User
}
}
}
rejectDataRequest
Response
Returns a DataRequest!
Arguments
| Name | Description |
|---|---|
requestId - String!
|
Example
Query
mutation RejectDataRequest($requestId: String!) {
rejectDataRequest(requestId: $requestId) {
arweaveUrl
createdAt
dataRequestTemplate {
...DataRequestTemplateFragment
}
dataUse
id
owner {
...UserFragment
}
proof {
...ProofFragment
}
status
verifier {
...UserFragment
}
verifierOrganization {
...OrganizationFragment
}
}
}
Variables
{"requestId": "abc123"}
Response
{
"data": {
"rejectDataRequest": {
"arweaveUrl": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"dataRequestTemplate": DataRequestTemplate,
"dataUse": "xyz789",
"id": "xyz789",
"owner": User,
"proof": Proof,
"status": "ACCEPTED",
"verifier": User,
"verifierOrganization": Organization
}
}
}
removeApplication
Response
Returns an Application!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
mutation RemoveApplication($id: String!) {
removeApplication(id: $id) {
apiKey
gatewayFacilitationFee
organization {
...OrganizationFragment
}
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"removeApplication": {
"apiKey": "abc123",
"gatewayFacilitationFee": 123.45,
"organization": Organization
}
}
}
removeMemberFromOrganization
Description
Remove a member from an organization
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - TransferMemberInput!
|
Example
Query
mutation RemoveMemberFromOrganization($input: TransferMemberInput!) {
removeMemberFromOrganization(input: $input)
}
Variables
{"input": TransferMemberInput}
Response
{"data": {"removeMemberFromOrganization": false}}
transferOwnership
Description
Organization owner can transfer ownership to another user
Response
Returns an OrganizationAccess!
Arguments
| Name | Description |
|---|---|
input - TransferMemberInput!
|
Example
Query
mutation TransferOwnership($input: TransferMemberInput!) {
transferOwnership(input: $input) {
id
organization {
...OrganizationFragment
}
role
user {
...UserFragment
}
}
}
Variables
{"input": TransferMemberInput}
Response
{
"data": {
"transferOwnership": {
"id": "abc123",
"organization": Organization,
"role": "Admin",
"user": User
}
}
}
unregisterAuthMethod
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - AuthInput!
|
Example
Query
mutation UnregisterAuthMethod($input: AuthInput!) {
unregisterAuthMethod(input: $input)
}
Variables
{"input": AuthInput}
Response
{"data": {"unregisterAuthMethod": true}}
updateMyDisplayName
updateMyGatewayId
Example
Query
mutation UpdateMyGatewayId($gatewayId: String!) {
updateMyGatewayId(gatewayId: $gatewayId) {
accesses {
...OrganizationAccessFragment
}
arweaveUrl
authentications {
...AuthFragment
}
createdAt
credentialsExtraCredits
dataModels {
...DataModelFragment
}
dataModelsExtraCredits
dataRequestTemplates {
...DataRequestTemplateFragment
}
deletedAt
displayName
email
gatewayId
gatewayIdLastupdate
gatewayIdUpdatedAt
hash
id
idV3
isCompleted
issuedPDAs {
...PrivateDataAssetFragment
}
issuedProofs {
...ProofFragment
}
profilePicture
receivedPDAs {
...PrivateDataAssetFragment
}
receivedProofs {
...ProofFragment
}
recipientDataRequests {
...DataRequestFragment
}
roles
status
updatedAt
verifierDataRequests {
...DataRequestFragment
}
walletId
}
}
Variables
{"gatewayId": "abc123"}
Response
{
"data": {
"updateMyGatewayId": {
"accesses": [OrganizationAccess],
"arweaveUrl": "abc123",
"authentications": [Auth],
"createdAt": "2007-12-03T10:15:30Z",
"credentialsExtraCredits": 123.45,
"dataModels": [DataModel],
"dataModelsExtraCredits": 987.65,
"dataRequestTemplates": [DataRequestTemplate],
"deletedAt": "2007-12-03T10:15:30Z",
"displayName": "abc123",
"email": "abc123",
"gatewayId": "abc123",
"gatewayIdLastupdate": "2007-12-03T10:15:30Z",
"gatewayIdUpdatedAt": "2007-12-03T10:15:30Z",
"hash": "xyz789",
"id": "abc123",
"idV3": "abc123",
"isCompleted": false,
"issuedPDAs": [PrivateDataAsset],
"issuedProofs": [Proof],
"profilePicture": "abc123",
"receivedPDAs": [PrivateDataAsset],
"receivedProofs": [Proof],
"recipientDataRequests": [DataRequest],
"roles": ["Admin"],
"status": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"verifierDataRequests": [DataRequest],
"walletId": "xyz789"
}
}
}
updateMyProfilePicture
Example
Query
mutation UpdateMyProfilePicture($profilePictureUrl: String) {
updateMyProfilePicture(profilePictureUrl: $profilePictureUrl)
}
Variables
{"profilePictureUrl": "xyz789"}
Response
{
"data": {
"updateMyProfilePicture": "abc123"
}
}
updateNotificationEmail
Response
Returns a SignupConfirmationOutput!
Arguments
| Name | Description |
|---|---|
email - String!
|
Example
Query
mutation UpdateNotificationEmail($email: String!) {
updateNotificationEmail(email: $email) {
user {
...UserFragment
}
}
}
Variables
{"email": "abc123"}
Response
{"data": {"updateNotificationEmail": {"user": User}}}
updateOrganization
Response
Returns an Organization!
Arguments
| Name | Description |
|---|---|
input - UpdateOrganizationInput!
|
Example
Query
mutation UpdateOrganization($input: UpdateOrganizationInput!) {
updateOrganization(input: $input) {
accesses {
...OrganizationAccessFragment
}
arweaveUrl
createdAt
dataModels {
...DataModelFragment
}
dataRequestTemplates {
...DataRequestTemplateFragment
}
description
gatewayId
id
idV3
image
name
receivedProofs {
...ProofFragment
}
updatedAt
usernameUpdatedAt
verified
verifierDataRequests {
...DataRequestFragment
}
walletId
website
}
}
Variables
{"input": UpdateOrganizationInput}
Response
{
"data": {
"updateOrganization": {
"accesses": [OrganizationAccess],
"arweaveUrl": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"dataModels": [DataModel],
"dataRequestTemplates": [DataRequestTemplate],
"description": "abc123",
"gatewayId": "abc123",
"id": "xyz789",
"idV3": "abc123",
"image": "xyz789",
"name": "abc123",
"receivedProofs": [Proof],
"updatedAt": "2007-12-03T10:15:30Z",
"usernameUpdatedAt": "2007-12-03T10:15:30Z",
"verified": true,
"verifierDataRequests": [DataRequest],
"walletId": "xyz789",
"website": "abc123"
}
}
}
updatePDA
Response
Returns a PrivateDataAsset!
Arguments
| Name | Description |
|---|---|
input - UpdatePDAInput!
|
Example
Query
mutation UpdatePDA($input: UpdatePDAInput!) {
updatePDA(input: $input) {
arweaveUrl
claimHash
dataAsset {
...DecryptedPDAFragment
}
expirationDate
hash
id
idV3
issuanceDate
issuerHash
lastUpdated
ownerHash
status
transactionId
}
}
Variables
{"input": UpdatePDAInput}
Response
{
"data": {
"updatePDA": {
"arweaveUrl": "xyz789",
"claimHash": {},
"dataAsset": DecryptedPDA,
"expirationDate": "2007-12-03T10:15:30Z",
"hash": "xyz789",
"id": "xyz789",
"idV3": 987.65,
"issuanceDate": "2007-12-03T10:15:30Z",
"issuerHash": "abc123",
"lastUpdated": "2007-12-03T10:15:30Z",
"ownerHash": "abc123",
"status": "Expired",
"transactionId": "xyz789"
}
}
}
updateUser
Response
Returns a User!
Arguments
| Name | Description |
|---|---|
input - UpdateUserInput!
|
Example
Query
mutation UpdateUser($input: UpdateUserInput!) {
updateUser(input: $input) {
accesses {
...OrganizationAccessFragment
}
arweaveUrl
authentications {
...AuthFragment
}
createdAt
credentialsExtraCredits
dataModels {
...DataModelFragment
}
dataModelsExtraCredits
dataRequestTemplates {
...DataRequestTemplateFragment
}
deletedAt
displayName
email
gatewayId
gatewayIdLastupdate
gatewayIdUpdatedAt
hash
id
idV3
isCompleted
issuedPDAs {
...PrivateDataAssetFragment
}
issuedProofs {
...ProofFragment
}
profilePicture
receivedPDAs {
...PrivateDataAssetFragment
}
receivedProofs {
...ProofFragment
}
recipientDataRequests {
...DataRequestFragment
}
roles
status
updatedAt
verifierDataRequests {
...DataRequestFragment
}
walletId
}
}
Variables
{"input": UpdateUserInput}
Response
{
"data": {
"updateUser": {
"accesses": [OrganizationAccess],
"arweaveUrl": "abc123",
"authentications": [Auth],
"createdAt": "2007-12-03T10:15:30Z",
"credentialsExtraCredits": 987.65,
"dataModels": [DataModel],
"dataModelsExtraCredits": 987.65,
"dataRequestTemplates": [DataRequestTemplate],
"deletedAt": "2007-12-03T10:15:30Z",
"displayName": "abc123",
"email": "xyz789",
"gatewayId": "abc123",
"gatewayIdLastupdate": "2007-12-03T10:15:30Z",
"gatewayIdUpdatedAt": "2007-12-03T10:15:30Z",
"hash": "abc123",
"id": "xyz789",
"idV3": "xyz789",
"isCompleted": false,
"issuedPDAs": [PrivateDataAsset],
"issuedProofs": [Proof],
"profilePicture": "xyz789",
"receivedPDAs": [PrivateDataAsset],
"receivedProofs": [Proof],
"recipientDataRequests": [DataRequest],
"roles": ["Admin"],
"status": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"verifierDataRequests": [DataRequest],
"walletId": "abc123"
}
}
}
Types
AddEmailConfirmationInput
AddEmailInput
Fields
| Input Field | Description |
|---|---|
email - String!
|
Example
{"email": "abc123"}
AddWalletConfirmationInput
Application
Fields
| Field Name | Description |
|---|---|
apiKey - String!
|
|
gatewayFacilitationFee - Float
|
|
organization - Organization!
|
Example
{
"apiKey": "abc123",
"gatewayFacilitationFee": 123.45,
"organization": Organization
}
ApplicationType
Description
Application type. Default: Website
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"APP"
Auth
AuthDataType
Fields
| Field Name | Description |
|---|---|
address - String!
|
Authentication address (ex: example@example.com, 0x0000) |
chain - Chain
|
Chain of the wallet, if it's a crypto wallet |
primary - Boolean
|
Define if authentication method is primary |
Example
{
"address": "abc123",
"chain": "EVM",
"primary": true
}
AuthInput
AuthType
Description
Blockchain networks. Default: EVM
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"EMAIL"
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
Chain
Description
Blockchain networks. Default: EVM
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EVM"
CreateApplicationInput
Fields
| Input Field | Description |
|---|---|
domain - String!
|
Application domain |
gatewayFacilitationFee - Float
|
Gateway facilitation fee negotiated for this application |
name - String!
|
Application name |
type - ApplicationType!
|
Application type. Default = WEBSITE |
Example
{
"domain": "xyz789",
"gatewayFacilitationFee": 987.65,
"name": "xyz789",
"type": "APP"
}
CreateDataModelInput
Fields
| Input Field | Description |
|---|---|
allowedToIssue - [IdentificationInput!]
|
Users and Orgs who are allowed to issue using this Data Model. Only applicable when SPECIFIC_ID is selected as part of the permissions. |
consumptionPrice - Float
|
Payment issuer receives every time a proof containing PDA is generated |
description - String!
|
Description of the Data Model |
image - String
|
Data Model Image |
info - String
|
Data Model Information |
organization - OrganizationIdentificationInput
|
If you wish to create through an organization, pass the Gateway Username or ID of the Organization |
permissions - PermissionType!
|
Can restrict to organizations only or Specific_IDS within your network. Default is ALL |
schema - StringSchema!
|
An AJV Validator-compatible JSON Schema (draft 07) Schema example: { type: "object", properties: { name: {type: "string", title: "User name"}, age: {type: "number", minimum: 18, title: "User Age"}, }, required: ["name", "age"], additionalProperties: false, } |
tags - [String!]!
|
Tags of the Datamodel (e.g. ["tag1", "tag2", "tag3"]). Default = [] |
title - String!
|
Title of the Data Model |
Example
{
"allowedToIssue": [IdentificationInput],
"consumptionPrice": 123.45,
"description": "abc123",
"image": "abc123",
"info": "abc123",
"organization": OrganizationIdentificationInput,
"permissions": "ALL",
"schema": StringSchema,
"tags": ["xyz789"],
"title": "abc123"
}
CreateEmailNonceInput
Fields
| Input Field | Description |
|---|---|
email - String!
|
Example
{"email": "abc123"}
CreateEmailNonceOutput
CreateOrganizationInput
Fields
| Input Field | Description |
|---|---|
admins - [UserIdentificationInput!]
|
Members of the organization |
description - String!
|
Description of the organization |
image - String
|
Image of the organization |
members - [UserIdentificationInput!]
|
Members of the organization |
name - String!
|
Name of the organization |
username - String!
|
Username/GatewayID of the organization |
website - String
|
Website of the organization |
Example
{
"admins": [UserIdentificationInput],
"description": "xyz789",
"image": "abc123",
"members": [UserIdentificationInput],
"name": "abc123",
"username": "abc123",
"website": "abc123"
}
CreatePDAInput
Fields
| Input Field | Description |
|---|---|
claim - JSON
|
PDA Context information based on the selected Data Model |
dataModelId - String!
|
Datamodel ID |
description - String!
|
PDA Description |
expirationDate - DateTime
|
Expiration Date |
image - String
|
PDA Image |
organization - OrganizationIdentificationInput
|
Issuer Organization |
owner - UserIdentificationInput
|
Owner ID Identification |
title - String!
|
PDA Title |
Example
{
"claim": {},
"dataModelId": "xyz789",
"description": "abc123",
"expirationDate": "2007-12-03T10:15:30Z",
"image": "xyz789",
"organization": OrganizationIdentificationInput,
"owner": UserIdentificationInput,
"title": "xyz789"
}
CreateWalletNonceInput
CreateWalletNonceOutput
Fields
| Field Name | Description |
|---|---|
message - String!
|
Example
{"message": "abc123"}
DataModel
Fields
| Field Name | Description |
|---|---|
PDAs - [PrivateDataAsset!]!
|
|
allowedOrganizations - [Organization!]
|
Organizations that can access the Data Model |
allowedUsers - [User!]
|
Users that can access the Data Model |
arweaveUrl - String!
|
Arweave Transaction |
consumptionPrice - Float
|
Price for consumption |
createdAt - DateTime!
|
Date of the last update of the Data Model |
createdBy - User
|
Creator of the Data Model |
description - String!
|
Description of the Datamodel (searcheable) |
featured - Boolean
|
Is the Data Model featured? |
group - DataModelGroup!
|
|
id - String!
|
|
image - String
|
Data Model image |
organization - Organization
|
|
pdas - [PrivateDataAsset!]!
|
All encrypted PDAs that use this Data Model |
pdasIssuedCount - Float!
|
|
permissioning - PermissionType
|
Permission type for the Data Model |
revenueGenerated - Float!
|
|
schema - JSON!
|
An AJV Validator-compatible JSON Schema (draft 07) Schema example: { type: "object", properties: { name: {type: "string", title: "User name"}, age: {type: "number", minimum: 18, title: "User Age"}, }, required: ["name", "age"], additionalProperties: false, } |
tags - [String!]
|
Tags of the Data Model (searcheable) (e.g. ["tag1", "tag2", "tag3"]) |
title - String!
|
Title of the Datamodel |
uniqueIssuersCount - Float!
|
|
verified - Boolean!
|
Is the Data Model verified by Gateway? |
Example
{
"PDAs": [PrivateDataAsset],
"allowedOrganizations": [Organization],
"allowedUsers": [User],
"arweaveUrl": "xyz789",
"consumptionPrice": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"createdBy": User,
"description": "xyz789",
"featured": true,
"group": DataModelGroup,
"id": "abc123",
"image": "xyz789",
"organization": Organization,
"pdas": [PrivateDataAsset],
"pdasIssuedCount": 987.65,
"permissioning": "ALL",
"revenueGenerated": 123.45,
"schema": {},
"tags": ["xyz789"],
"title": "xyz789",
"uniqueIssuersCount": 987.65,
"verified": false
}
DataModelGroup
Description
Group that contains all versions of a Data Model
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
Date of the last update of the Datamodel |
dataModels - [DataModel!]!
|
List of versions of Data Models |
id - String!
|
|
official - Boolean!
|
if this Datamodel is official (approved) by Gateway (searcheable) |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"dataModels": [DataModel],
"id": "xyz789",
"official": true
}
DataModelIssuer
Fields
| Field Name | Description |
|---|---|
count - Float!
|
|
issuer - IdentifierUnion
|
Example
{"count": 987.65, "issuer": Organization}
DataModelMetadata
DataModelsMetadata
Fields
| Field Name | Description |
|---|---|
consumptionPrice - JSON!
|
|
issuedCount - JSON!
|
|
tags - [String!]!
|
List of available tags |
Example
{
"consumptionPrice": {},
"issuedCount": {},
"tags": ["abc123"]
}
DataRequest
Description
Data Request
Fields
| Field Name | Description |
|---|---|
arweaveUrl - String
|
|
createdAt - DateTime!
|
Created Date |
dataRequestTemplate - DataRequestTemplate!
|
|
dataUse - String!
|
|
id - String!
|
|
owner - User!
|
|
proof - Proof
|
|
status - DataResourceStatus!
|
|
verifier - User
|
|
verifierOrganization - Organization
|
Example
{
"arweaveUrl": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"dataRequestTemplate": DataRequestTemplate,
"dataUse": "abc123",
"id": "xyz789",
"owner": User,
"proof": Proof,
"status": "ACCEPTED",
"verifier": User,
"verifierOrganization": Organization
}
DataRequestSchemaInput
Fields
| Input Field | Description |
|---|---|
dataRequestTemplateId - String!
|
ID of Data Request Template used to generate Data Requests |
dataUse - String!
|
Reason for the data request (e.g. 'KYC', 'AML', 'Credit') |
organization - OrganizationIdentificationInput
|
Organization's identifier (e.g. GatewayID, ID) if the user wants to create as Organization. |
owner - UserIdentificationInput!
|
Person request is being sent to identifier (owner of PDA). |
Example
{
"dataRequestTemplateId": "abc123",
"dataUse": "xyz789",
"organization": OrganizationIdentificationInput,
"owner": UserIdentificationInput
}
DataRequestTemplate
Description
Data Request Template
Fields
| Field Name | Description |
|---|---|
arweaveUrl - String
|
|
createdAt - DateTime!
|
Created Date |
dataModels - [DataModel!]!
|
|
dataRequests - [DataRequest!]!
|
Data Request |
dataRequestsCount - Float!
|
|
description - String!
|
|
id - String!
|
|
name - String!
|
|
organization - Organization
|
|
revenueGenerated - Float!
|
|
schema - JSON!
|
Schema of Data Request Template |
tags - [String!]!
|
Tags of the Data Request Template (searcheable) (e.g. ["tag1", "tag2", "tag3"]) |
uniqueVerifiersCount - Float!
|
|
user - User!
|
User that created the Data Request Template |
Example
{
"arweaveUrl": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"dataModels": [DataModel],
"dataRequests": [DataRequest],
"dataRequestsCount": 987.65,
"description": "xyz789",
"id": "xyz789",
"name": "xyz789",
"organization": Organization,
"revenueGenerated": 987.65,
"schema": {},
"tags": ["xyz789"],
"uniqueVerifiersCount": 123.45,
"user": User
}
DataRequestTemplateDataModelSchemaInput
Fields
| Input Field | Description |
|---|---|
claimValidations - StringSchema
|
An AJV Validator-compatible JSON Schema (draft 07) Schema example: { type: "object", properties: { name: {type: "string", title: "User name"}, age: {type: "number", minimum: 18, title: "User Age"}, }, required: ["name", "age"], additionalProperties: false, } |
id - String!
|
Data Model Id |
issuanceDate - Date
|
Exact issuance date. Format: YYYY/MM/dd |
issuanceDateRange - RequestIssueanceDateSchemaInput
|
Range of issuance dates |
issuers - [String!]
|
List of issuers. It receives user UUID or GatewayID. |
organizations - [String!]
|
List of organizations issuers. It receives organization UUID or GatewayID. |
required - Boolean
|
Defines if the Data using this data model is required |
Example
{
"claimValidations": StringSchema,
"id": "abc123",
"issuanceDate": "2007-12-03",
"issuanceDateRange": RequestIssueanceDateSchemaInput,
"issuers": ["abc123"],
"organizations": ["abc123"],
"required": true
}
DataRequestTemplateDataModelSchemaObject
Fields
| Field Name | Description |
|---|---|
claimValidations - StringSchema
|
An AJV Validator-compatible JSON Schema (draft 07) Schema example: { type: "object", properties: { name: {type: "string", title: "User name"}, age: {type: "number", minimum: 18, title: "User Age"}, }, required: ["name", "age"], additionalProperties: false, } |
id - String!
|
Data Model Id |
issuanceDate - Date
|
Exact issuance date. Format: YYYY/MM/dd |
issuanceDateRange - RequestIssueanceDateSchemaObject
|
Range of issuance dates |
issuers - [String!]
|
List of issuers. It receives user UUID or GatewayID. |
organizations - [String!]
|
List of organizations issuers. It receives organization UUID or GatewayID. |
required - Boolean
|
Defines if the Data using this data model is required |
Example
{
"claimValidations": StringSchema,
"id": "xyz789",
"issuanceDate": "2007-12-03",
"issuanceDateRange": RequestIssueanceDateSchemaObject,
"issuers": ["abc123"],
"organizations": ["abc123"],
"required": true
}
DataRequestTemplateVerifier
Fields
| Field Name | Description |
|---|---|
count - Float!
|
|
verifier - IdentifierUnion
|
Example
{"count": 987.65, "verifier": Organization}
DataRequestTemplatesMetadata
Fields
| Field Name | Description |
|---|---|
tags - [String!]!
|
List of available tags |
Example
{"tags": ["xyz789"]}
DataResourceStatus
Description
Statuses of Data Requests
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCEPTED"
Date
Description
A date string, such as 2007-12-03, compliant with the full-date format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
Example
"2007-12-03"
DateTime
Description
A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.
Example
"2007-12-03T10:15:30Z"
DateTimeISO
Description
A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.This scalar is serialized to a string in ISO 8601 format and parsed from a string in ISO 8601 format.
Example
"2007-12-03T10:15:30Z"
DecryptedPDA
Fields
| Field Name | Description |
|---|---|
claim - JSON
|
PDA Context information |
claimArray - [PDAClaim!]!
|
|
dataModel - DataModel!
|
Data Model to validate the PDA Claim |
description - String!
|
PDA Description |
expirationDate - DateTime
|
Expiration Date |
image - String
|
PDA Image |
issuer - User!
|
Issuer of the PDA |
organization - Organization
|
Organization that issued the PDA |
owner - User!
|
Owner of the PDA |
qrCode - String
|
Qr Code from PDA |
title - String!
|
PDA Title |
Example
{
"claim": {},
"claimArray": [PDAClaim],
"dataModel": DataModel,
"description": "abc123",
"expirationDate": "2007-12-03T10:15:30Z",
"image": "xyz789",
"issuer": User,
"organization": Organization,
"owner": User,
"qrCode": "xyz789",
"title": "abc123"
}
DecryptedProof
Fields
| Field Name | Description |
|---|---|
PDAs - [DecryptedProofPDA!]!
|
Private Data Assets of the Proof |
dataModels - [DataModel!]!
|
Data Models of the Proof |
raw - JSON
|
Raw Proof Context information |
Example
{
"PDAs": [DecryptedProofPDA],
"dataModels": [DataModel],
"raw": {}
}
DecryptedProofPDA
Fields
| Field Name | Description |
|---|---|
claim - JSON!
|
Proof Context information |
claimArray - [PDAClaim!]!
|
|
dataModel - DataModel!
|
Data Model of the PDA |
description - String!
|
|
id - String!
|
|
issuanceDate - DateTime
|
Issuance Date |
issuer - User!
|
Issuer of the PDA |
lastUpdated - DateTime
|
Updated Date |
organization - Organization
|
Organization of the PDA |
owner - User!
|
Owner of the PDA |
title - String!
|
Example
{
"claim": {},
"claimArray": [PDAClaim],
"dataModel": DataModel,
"description": "xyz789",
"id": "abc123",
"issuanceDate": "2007-12-03T10:15:30Z",
"issuer": User,
"lastUpdated": "2007-12-03T10:15:30Z",
"organization": Organization,
"owner": User,
"title": "xyz789"
}
ExplorerAnalyticsSchema
ExplorerTransactionsAnalyticsSchema
FacilitationFeeInput
FilterDataModelInput
Fields
| Input Field | Description |
|---|---|
allowedIssuers - [IdentificationInput!]
|
Entities that are allowed to issue the data models |
consumptionPrice - FloatRangeDto
|
Data Models with a specific consumption price |
featured - Boolean
|
Data Models that are featured by Gateway |
ids - [String!]
|
Data Models with IDs in this list |
organization - OrganizationIdentificationInput
|
Data Models created by a specific organization |
permissioning - [PermissionType!]
|
Data Models with a specific permission(s) |
search - String
|
Data Models with a specific name |
tags - [String!]
|
Data Models with a specific tag |
user - UserIdentificationInput
|
Data Models created by a specific user |
Example
{
"allowedIssuers": [IdentificationInput],
"consumptionPrice": FloatRangeDto,
"featured": false,
"ids": ["xyz789"],
"organization": OrganizationIdentificationInput,
"permissioning": ["ALL"],
"search": "xyz789",
"tags": ["abc123"],
"user": UserIdentificationInput
}
FilterDataRequestInput
Fields
| Input Field | Description |
|---|---|
dataTemplateIds - [String!]
|
Data Template IDs |
ids - [String!]
|
Data Request ID |
owner - UserIdentificationInput
|
Data Request Owner |
status - DataResourceStatus
|
Data Request Status |
verifier - UserIdentificationInput
|
Data Request Verifier |
verifierOrganization - OrganizationIdentificationInput
|
Data Request Verifier Organization |
Example
{
"dataTemplateIds": ["abc123"],
"ids": ["xyz789"],
"owner": UserIdentificationInput,
"status": "ACCEPTED",
"verifier": UserIdentificationInput,
"verifierOrganization": OrganizationIdentificationInput
}
FilterDataRequestTemplateInput
Fields
| Input Field | Description |
|---|---|
dataTemplateIds - [String!]
|
Data Template IDs |
ids - [String!]
|
Data Request ID |
organization - OrganizationIdentificationInput
|
Organization ID |
search - String
|
|
tags - [String!]
|
|
user - UserIdentificationInput
|
Datamodels created by a specific user |
Example
{
"dataTemplateIds": ["xyz789"],
"ids": ["xyz789"],
"organization": OrganizationIdentificationInput,
"search": "abc123",
"tags": ["abc123"],
"user": UserIdentificationInput
}
FilterOrganizationInput
Fields
| Input Field | Description |
|---|---|
verified - Boolean
|
Check if organization is verified |
Example
{"verified": false}
FilterPDAInput
Fields
| Input Field | Description |
|---|---|
dataModelIds - [String!]
|
List of Data Model IDs |
ids - [String!]
|
PDA ID |
issuer - UserIdentificationInput
|
PDA Issuer |
organization - OrganizationIdentificationInput
|
PDA Organization Issuer |
owner - UserIdentificationInput
|
PDA Owner |
tags - [String!]
|
List of PDA tags |
Example
{
"dataModelIds": ["abc123"],
"ids": ["xyz789"],
"issuer": UserIdentificationInput,
"organization": OrganizationIdentificationInput,
"owner": UserIdentificationInput,
"tags": ["abc123"]
}
FilterProofInput
Fields
| Input Field | Description |
|---|---|
dataTemplateIds - [String!]
|
Data Template IDs |
facilitationFee - FacilitationFeeInput
|
|
owners - [UserIdentificationInput!]
|
Owners that have issued the proofs |
pdaIds - [String!]
|
PDA IDs |
Example
{
"dataTemplateIds": ["abc123"],
"facilitationFee": FacilitationFeeInput,
"owners": [UserIdentificationInput],
"pdaIds": ["xyz789"]
}
FilterTransactionsInput
FinancialSummaryOutput
Fields
| Field Name | Description |
|---|---|
action - FinancialTransactionAction!
|
|
amount - Float!
|
Example
{"action": "DATAMODEL_CREATE", "amount": 123.45}
FinancialTransaction
Fields
| Field Name | Description |
|---|---|
action - FinancialTransactionAction!
|
|
createdAt - DateTime
|
|
fee - Float!
|
|
from - IdentifierUnion
|
|
id - String!
|
Financial Transaction ID |
memo - JSON
|
|
to - IdentifierUnion
|
|
total - Float!
|
|
transaction - Transaction
|
|
transactionId - String
|
|
type - FinancialTransactionType!
|
|
updatedAt - DateTime
|
|
value - Float!
|
|
wallet - Wallet!
|
Example
{
"action": "DATAMODEL_CREATE",
"createdAt": "2007-12-03T10:15:30Z",
"fee": 123.45,
"from": Organization,
"id": "abc123",
"memo": {},
"to": Organization,
"total": 987.65,
"transaction": Transaction,
"transactionId": "xyz789",
"type": "DEPOSIT",
"updatedAt": "2007-12-03T10:15:30Z",
"value": 987.65,
"wallet": Wallet
}
FinancialTransactionAction
Description
Detail of the financial transaction
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DATAMODEL_CREATE"
FinancialTransactionType
Description
Type of the financial transaction
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DEPOSIT"
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
FloatRangeDto
IdentificationInput
Fields
| Input Field | Description |
|---|---|
type - IdentifierType
|
Type of the identification. Default = GATEWAY_ID |
value - String!
|
Value of the identification |
Example
{"type": "EMAIL", "value": "xyz789"}
IdentifierType
Description
User identifier type, it can be an email or a wallet address. Default: UNKNOWN
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EMAIL"
IdentifierUnion
Types
| Union Types |
|---|
Example
Organization
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
JSON
Description
The JSON scalar type represents JSON values as specified by ECMA-404.
Example
{}
LoginEmailInput
LoginOutput
LoginWalletInput
MemberInput
Fields
| Input Field | Description |
|---|---|
organization - OrganizationIdentificationInput!
|
|
role - OrganizationRole
|
Role of the User in the Organization. Default = Member |
user - UserIdentificationInput!
|
Example
{
"organization": OrganizationIdentificationInput,
"role": "Admin",
"user": UserIdentificationInput
}
MetadataUnion
Example
DataModelMetadata
MigrateAuthInput
Organization
Fields
| Field Name | Description |
|---|---|
accesses - [OrganizationAccess!]
|
Organization users and roles |
arweaveUrl - String
|
Arweave URL |
createdAt - DateTime!
|
Created date |
dataModels - [DataModel!]
|
|
dataRequestTemplates - [DataRequestTemplate!]!
|
Data Request Template |
description - String!
|
Description of the Organization |
gatewayId - String
|
GatewayID of the Organization |
id - String!
|
|
idV3 - String
|
Protocol V3 ID. Used for migration purposes. |
image - String
|
Image of the Organization |
name - String!
|
Name of the Organization |
receivedProofs - [Proof!]
|
|
updatedAt - DateTime!
|
Updated date |
usernameUpdatedAt - DateTime!
|
Username updated date |
verified - Boolean!
|
Is the organization verified |
verifierDataRequests - [DataRequest!]!
|
Data Request that I am the Verifier |
walletId - String
|
Organization account balance |
website - String
|
Example
{
"accesses": [OrganizationAccess],
"arweaveUrl": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"dataModels": [DataModel],
"dataRequestTemplates": [DataRequestTemplate],
"description": "abc123",
"gatewayId": "abc123",
"id": "xyz789",
"idV3": "xyz789",
"image": "xyz789",
"name": "xyz789",
"receivedProofs": [Proof],
"updatedAt": "2007-12-03T10:15:30Z",
"usernameUpdatedAt": "2007-12-03T10:15:30Z",
"verified": true,
"verifierDataRequests": [DataRequest],
"walletId": "abc123",
"website": "abc123"
}
OrganizationAccess
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
organization - Organization!
|
User of the Organization |
role - OrganizationRole!
|
Role of the User in the Organization |
user - User!
|
User of the Organization |
Example
{
"id": "abc123",
"organization": Organization,
"role": "Admin",
"user": User
}
OrganizationIdentificationInput
Fields
| Input Field | Description |
|---|---|
type - OrganizationIdentifierType!
|
Type of the identification |
value - String!
|
Value of the identification |
Example
{"type": "GATEWAY_ID", "value": "xyz789"}
OrganizationIdentifierType
Description
Organization identifier type, it can be an orgId or a Gateway ID. Default: UNKNOWN
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"GATEWAY_ID"
OrganizationMetadata
Fields
| Field Name | Description |
|---|---|
organization - String!
|
|
users - [String!]!
|
|
usersAdmin - [String!]!
|
|
verified - Boolean!
|
Example
{
"organization": "xyz789",
"users": ["xyz789"],
"usersAdmin": ["xyz789"],
"verified": true
}
OrganizationRole
Description
User role on a organization
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Admin"
PDAClaim
PDAMetadata
Example
{
"dataModel": "xyz789",
"expirationDate": "2007-12-03T10:15:30Z",
"issuer": "xyz789",
"pda": "abc123",
"signedBy": "abc123",
"status": "Expired"
}
PDAStatus
Description
Statuses of PDAs
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"Expired"
PermissionType
Description
Organizations or IDs that can issue a credential from specific data model
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ALL"
PrivateDataAsset
Fields
| Field Name | Description |
|---|---|
arweaveUrl - String!
|
Arweave URL |
claimHash - JSON!
|
PDA Claims |
dataAsset - DecryptedPDA
|
Decrypted Data Asset (only available to owner) |
expirationDate - DateTime
|
Expiration Date |
hash - String
|
PDA Hash |
id - String!
|
PDA ID |
idV3 - Float
|
Protocol V3 ID. Used for migration purposes. |
issuanceDate - DateTime!
|
Issuance Date |
issuerHash - String
|
Hash of PDA Issuer |
lastUpdated - DateTime!
|
Updated Date |
ownerHash - String
|
Hash of the PDA Owner |
status - PDAStatus!
|
|
transactionId - String
|
Example
{
"arweaveUrl": "abc123",
"claimHash": {},
"dataAsset": DecryptedPDA,
"expirationDate": "2007-12-03T10:15:30Z",
"hash": "abc123",
"id": "abc123",
"idV3": 123.45,
"issuanceDate": "2007-12-03T10:15:30Z",
"issuerHash": "abc123",
"lastUpdated": "2007-12-03T10:15:30Z",
"ownerHash": "xyz789",
"status": "Expired",
"transactionId": "xyz789"
}
Proof
Fields
| Field Name | Description |
|---|---|
arweaveUrl - String!
|
Arweave URL |
createdAt - DateTime!
|
Created Date |
data - DecryptedProof
|
Decrypted Proof Response |
dataRequest - DataRequest
|
Data Request |
facilitationFee - Float!
|
Facilitation Fee |
hash - String!
|
|
id - String!
|
Proof ID |
owner - User!
|
Recipient User |
proofHash - JSON!
|
Proof Hash |
status - ProofStatus!
|
|
totalCost - Float!
|
Total Cost |
updatedAt - DateTime!
|
Updated Date |
verifier - User
|
Verifier user |
verifierOrganization - Organization
|
Example
{
"arweaveUrl": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"data": DecryptedProof,
"dataRequest": DataRequest,
"facilitationFee": 123.45,
"hash": "abc123",
"id": "xyz789",
"owner": User,
"proofHash": {},
"status": "ACTIVE",
"totalCost": 123.45,
"updatedAt": "2007-12-03T10:15:30Z",
"verifier": User,
"verifierOrganization": Organization
}
ProofCost
ProofMetadata
ProofStatus
Description
Proof status type. Default: SYNCED
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
RefreshTokenInput
Fields
| Input Field | Description |
|---|---|
refresh_token - String!
|
Example
{"refresh_token": "xyz789"}
RequestIssueanceDateSchemaInput
Fields
| Input Field | Description |
|---|---|
after - DateTimeISO!
|
|
before - DateTimeISO!
|
Example
{
"after": "2007-12-03T10:15:30Z",
"before": "2007-12-03T10:15:30Z"
}
RequestIssueanceDateSchemaObject
Fields
| Field Name | Description |
|---|---|
after - DateTimeISO!
|
|
before - DateTimeISO!
|
Example
{
"after": "2007-12-03T10:15:30Z",
"before": "2007-12-03T10:15:30Z"
}
RequestMetadata
RequestTemplateMetadata
Fields
| Field Name | Description |
|---|---|
creator - String!
|
|
dataModels - [String!]!
|
|
requestTemplate - String!
|
|
signedBy - String!
|
Example
{
"creator": "xyz789",
"dataModels": ["abc123"],
"requestTemplate": "abc123",
"signedBy": "xyz789"
}
Role
Description
User role
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Admin"
SignupConfirmationOutput
Fields
| Field Name | Description |
|---|---|
user - User!
|
Example
{"user": User}
String
Description
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.
Example
"abc123"
StringSchema
Description
An AJV Validator-compatible JSON Schema (draft 07) Schema example: { type: "object", properties: { name: {type: "string", title: "User name"}, age: {type: "number", minimum: 18, title: "User Age"}, }, required: ["name", "age"], additionalProperties: false, }
Example
StringSchema
TemplateSchemaInput
Fields
| Input Field | Description |
|---|---|
dataModels - [DataRequestTemplateDataModelSchemaInput!]!
|
Request Template Data Models |
description - String!
|
Request Template Description |
organization - OrganizationIdentificationInput
|
Organization Id that wants to create the template |
tags - [String!]
|
Request Template Tags |
title - String!
|
Request Template Title |
Example
{
"dataModels": [DataRequestTemplateDataModelSchemaInput],
"description": "xyz789",
"organization": OrganizationIdentificationInput,
"tags": ["xyz789"],
"title": "xyz789"
}
Transaction
Fields
| Field Name | Description |
|---|---|
action - TransactionAction!
|
|
arweaveUrl - String
|
|
cost - Float
|
|
createdAt - DateTime
|
|
financialTransactions - [FinancialTransaction!]!
|
|
from - IdentifierUnion
|
|
id - String!
|
Transaction ID |
metadata - MetadataUnion!
|
|
to - IdentifierUnion
|
|
updatedAt - DateTime
|
Example
{
"action": "DATAMODEL_CREATE",
"arweaveUrl": "abc123",
"cost": 987.65,
"createdAt": "2007-12-03T10:15:30Z",
"financialTransactions": [FinancialTransaction],
"from": Organization,
"id": "abc123",
"metadata": DataModelMetadata,
"to": Organization,
"updatedAt": "2007-12-03T10:15:30Z"
}
TransactionAction
Description
Detail of the transaction
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DATAMODEL_CREATE"
TransactionIdentifierInput
Fields
| Input Field | Description |
|---|---|
id - String
|
|
type - TransactionIdentifierType!
|
Example
{"id": "xyz789", "type": "ORGANIZATION"}
TransactionIdentifierType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ORGANIZATION"
TransferMemberInput
Fields
| Input Field | Description |
|---|---|
organization - OrganizationIdentificationInput!
|
|
user - UserIdentificationInput!
|
Example
{
"organization": OrganizationIdentificationInput,
"user": UserIdentificationInput
}
UpdateOrganizationInput
Fields
| Input Field | Description |
|---|---|
description - String
|
Description of the organization |
id - String!
|
|
idV3 - String
|
Protocol V3 Id |
image - String
|
Image of the organization |
name - String
|
Name of the organization |
username - String
|
Username/GatewayID of the organization |
website - String
|
Website of the organization |
Example
{
"description": "xyz789",
"id": "abc123",
"idV3": "xyz789",
"image": "abc123",
"name": "xyz789",
"username": "abc123",
"website": "xyz789"
}
UpdatePDAInput
Example
{
"claim": {},
"description": "xyz789",
"id": "abc123",
"image": "abc123",
"title": "xyz789"
}
UpdatePDAStatusInput
Fields
| Input Field | Description |
|---|---|
id - String!
|
ID of PDA |
status - PDAStatus!
|
New status of PDA |
Example
{"id": "abc123", "status": "Expired"}
UpdateUserInput
Fields
| Input Field | Description |
|---|---|
displayName - String
|
User display name |
gatewayId - String
|
User Gateway ID |
idV3 - String
|
Protocol V3 ID. Used for migration purposes. Can be updated after initialized. |
profilePicture - String
|
User Profile picture |
roles - [Role!]
|
User status. Default = [User] |
status - String
|
User status |
Example
{
"displayName": "xyz789",
"gatewayId": "xyz789",
"idV3": "xyz789",
"profilePicture": "xyz789",
"roles": ["Admin"],
"status": "xyz789"
}
User
Fields
| Field Name | Description |
|---|---|
accesses - [OrganizationAccess!]
|
Organizations and roles of a user |
arweaveUrl - String
|
Arweave URL |
authentications - [Auth!]
|
|
createdAt - DateTime!
|
Created date |
credentialsExtraCredits - Float!
|
Extra credits for credentials issuance. |
dataModels - [DataModel!]
|
|
dataModelsExtraCredits - Float!
|
Extra credits for dataModels creation. |
dataRequestTemplates - [DataRequestTemplate!]!
|
Data Request Template |
deletedAt - DateTime
|
User account deleted date |
displayName - String
|
Display name |
email - String
|
User primary email. Used for communication purposes |
gatewayId - String
|
User username |
gatewayIdLastupdate - DateTime!
|
Username updated date |
gatewayIdUpdatedAt - DateTime
|
GatewayId updated date |
hash - String
|
|
id - String!
|
|
idV3 - String
|
Protocol V3 ID. Used for migration purposes. |
isCompleted - Boolean!
|
|
issuedPDAs - [PrivateDataAsset!]!
|
|
issuedProofs - [Proof!]
|
|
profilePicture - String
|
Profile picture |
receivedPDAs - [PrivateDataAsset!]!
|
|
receivedProofs - [Proof!]!
|
|
recipientDataRequests - [DataRequest!]!
|
Data Request that I am the Recipient |
roles - [Role!]!
|
User status |
status - String
|
User status |
updatedAt - DateTime!
|
Updated date |
verifierDataRequests - [DataRequest!]!
|
Data Request that I am the Verifier |
walletId - String
|
User wallet address |
Example
{
"accesses": [OrganizationAccess],
"arweaveUrl": "abc123",
"authentications": [Auth],
"createdAt": "2007-12-03T10:15:30Z",
"credentialsExtraCredits": 123.45,
"dataModels": [DataModel],
"dataModelsExtraCredits": 987.65,
"dataRequestTemplates": [DataRequestTemplate],
"deletedAt": "2007-12-03T10:15:30Z",
"displayName": "xyz789",
"email": "xyz789",
"gatewayId": "xyz789",
"gatewayIdLastupdate": "2007-12-03T10:15:30Z",
"gatewayIdUpdatedAt": "2007-12-03T10:15:30Z",
"hash": "xyz789",
"id": "xyz789",
"idV3": "xyz789",
"isCompleted": true,
"issuedPDAs": [PrivateDataAsset],
"issuedProofs": [Proof],
"profilePicture": "abc123",
"receivedPDAs": [PrivateDataAsset],
"receivedProofs": [Proof],
"recipientDataRequests": [DataRequest],
"roles": ["Admin"],
"status": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"verifierDataRequests": [DataRequest],
"walletId": "abc123"
}
UserIdentificationInput
Fields
| Input Field | Description |
|---|---|
type - UserIdentifierType!
|
Type of the identification |
value - String!
|
Value of the identification |
Example
{"type": "EMAIL", "value": "abc123"}
UserIdentifierType
Description
User identifier type, it can be an email or a wallet address. Default: UNKNOWN
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EMAIL"
UserMetadata
Fields
| Field Name | Description |
|---|---|
user - String!
|
Example
{"user": "abc123"}
UserUsageDto
ValidDataRequested
ValidPDAForRequest
Fields
| Field Name | Description |
|---|---|
dataModel - DataModel!
|
|
pdas - [PrivateDataAsset!]!
|
|
required - Boolean!
|
|
schema - DataRequestTemplateDataModelSchemaObject!
|
|
validData - [ValidDataRequested!]
|
Example
{
"dataModel": DataModel,
"pdas": [PrivateDataAsset],
"required": false,
"schema": DataRequestTemplateDataModelSchemaObject,
"validData": [ValidDataRequested]
}
Wallet
Fields
| Field Name | Description |
|---|---|
balance - Float!
|
|
moneyIn - Float!
|
|
moneyInSummary - [FinancialSummaryOutput!]!
|
|
moneyOut - Float!
|
|
moneyOutSummary - [FinancialSummaryOutput!]!
|
Example
{
"balance": 987.65,
"moneyIn": 123.45,
"moneyInSummary": [FinancialSummaryOutput],
"moneyOut": 987.65,
"moneyOutSummary": [FinancialSummaryOutput]
}