SVX Documentation
HomepageAPISDK
Current
Current
  • Docs
  • Concepts
    • Digital Identity and Why It's Important
    • Digital Wallets
    • Ecosystems
    • Information Security
    • Personal Data & Attributes
    • Privacy- and Security-by-design
    • Secure Data Storage
    • Selective Disclosure / ZKP
    • Tokens and Tokenisation
    • Verifiable Credentials
    • Terminology
  • Platform
    • Secure Value Exchange
    • Authorisation, Tenant & Organisation Manager (ATOM)
    • Credential Service
    • Decentralised Identifiers (DIDs)
    • Keys
    • Tenants, Organisations, and End-Users
    • Vault
      • Enterprise Vault
    • Portal
    • Supported Standards
  • Guides
    • Onboarding to SVX
    • API Guides
      • Credentials
        • Credential Schemas
        • Credential Types
        • Issue Credentials
        • Presentation Definitions
        • Presentations
      • DIDs
        • DID Resolver
        • DID Registrar
        • DID Methods
          • did:key
          • did:web
          • did:ebsi
          • did:indy
        • DID Controller Keypair
      • OpenID Connect
        • For Verifiable Presentation
      • Users
        • Inviting End-Users
        • Authenticating End-Users
      • Vault
        • Items and Slots
        • Connections and Sharing
        • Classification Hierarchies
        • Attachments
        • On-sharing & Client Tasks
        • Account Delegation
      • Machine-2-Machine Communication
    • Portal Tutorials
      • Tenant Administrators
        • Onboard to a Tenancy
        • Dashboard and Navigation
        • Manage Tenancy
        • Manage Tenant Administrators
        • Manage Organisations
        • Manage Organisation Administrators
        • Credential Schemas
        • Applications
        • End Users
      • Organisation Administrators
        • Manage Organisation
        • Onboarding and Organisation Setup
        • Dashboard and Navigation
        • Manage Organisation Administrators
        • Credential Templates
        • View Credentials
        • Verification Templates
        • Verification Requests
        • Connections
        • Applications
    • Wallet Tutorials
      • Wallet Set Up
      • Provider Registration
      • Organisation Configuration
      • Credentials
      • Requests
      • Security
      • Wallet Recovery
  • Tools
    • Meeco SDK & CLI
    • Cryppo SDK & CLI
  • Releases
    • 2.1.1
    • 2.1.0
    • 2.0.0
    • 1.4.3
    • 1.4.2
    • 1.4.1
    • 1.4.0
    • 1.3.8
    • 1.3.7
    • 1.3.6
    • 1.3.5
    • 1.3.4
    • 1.3.3
    • 1.3.2
    • 1.3.0
    • 1.2.5
    • 1.2.4
    • 1.2.3
    • 1.2.2
    • 1.2.1
    • 1.2.0
    • 1.1.0
    • 1.0.0
    • Legacy API-of-Me
  • Policies
    • Privacy
    • Developer Policy
Powered by GitBook
On this page
  • Tenants
  • Organisations
  • Credentials
  • Additional Credential Service Information
  • Enterprise Vault
  • Additional Enterprise Vault Information

Was this helpful?

Edit on GitHub
  1. Platform

Portal

Last updated 5 months ago

Was this helpful?

The Secure Value Exchange (SVX) Portal is a user-friendly interface that allows users to undertake processes enabled by the SVX API. Following an initial onboarding invitation, Tenant and Organisation Administrators can self-service in order to complete their desired workflows. Depending on their associated , an Administrator can undertake the following tasks:

  • Manage their Tenant / Organisation

  • Invite and manage other Administrators

  • Utilise the Credential Service to:

    • Create and manage credential schemas

    • Create and manage credential templates

    • View issued and revoked credentials

    • Create and manage verification templates

    • View and manage verification requests

    • View and manage request responses

  • Utilise the Enterprise Vault to:

    • Create and manage connections

    • View items being shared

  • Create and manage Applications

Tenants

Role, Administrators & Activity

Responsibilities

During onboarding, all users of the Portal must agree to Meeco’s Terms and Conditions and Privacy Policy. It is the responsibility of the Tenant Administrator(s) to ensure the Organisations within their Tenancy are acting in an ethical, responsible manner.

Organisations

Role, Administrators & Activity

When utilising credentials, Organisations can act as Issuers and/or Verifiers, thus allowing them to manage:

  • Credential Templates

  • Issued, revoked and verified credentials

  • Verification Templates

  • Verification Requests

Each time an action is undertaken, Organisation Administrators can view and / or archive the item / occurrence. This provides Organisations with fine-grained reporting and transaction management capabilities.

Responsibilities

Credentials

Credential Schemas

Credential Templates

Issue credentials

  • Student name

  • Student ID

  • Course ID

  • Subject code

  • Grade

Once the Organisation Administrator has filled in all required attributes specific to the credential recipient (Holder) they are able to issue the credential. For further details on how to issue a credential, see the Issue / Revoke Credentials tutorial.

Revoke credentials

When revoking a credential, an Organisation Administrator simply locates the credential in the list of issued credentials, and selects the option to revoke. For further details on how to revoke a credential, see the Issue / Revoke Credentials tutorial.

Verification Templates

Verification Requests

Additional Credential Service Information

Enterprise Vault

Connections

Additional Enterprise Vault Information

The Portal enables enterprises to manage their own Tenancy. Once a Tenancy has been created, Tenant Administrators can onboard Organisations and invite Organisation Administrators to join. Tenant Administrators have access to , , , and management of their account.

Note Once a Credential Schema is defined it can be made available to Organisations that will issue credentials. For more information on Credential Schemas see the .

When Organisations are onboarded to the Portal they are invited to join an existing Tenancy. As mentioned above, the Tenant governs the Tenancy in which the Organisation conducts business. Organisation Administrators manage the Organisation and, depending on their , can action workflows associated with Credentials, their Enterprise Vault, Applications and account settings.

During onboarding, all users of the Portal must agree to Meeco’s and . It is the responsibility of the Organisation Administrator(s) to ensure all Administrators are acting in an ethical, responsible manner.

The Portal provides access to credential management in a simple, user-friendly way. It enables non-technical users to engage with our Verifiable Credential workflows via an intuitive interface. Our credential service utilises the to ensure standardisation and interoperability with external systems. Additionally, when undertaking credential-based workflows via the Portal, users are engaging in industry leading privacy and security practices that are aligned with current specifications and regulations, specifically the Australian Privacy Principles and General Data Protection Regulation (GDPR) (for details see our page).

The Portal provides Tenant Administrators with the option to create Credential Schemas within their Tenancy and make them available to Organisations. With access to a library of Credential Schemas, Organisations can specify which schema is required when creating Credential and Verification Templates. When Organisations within the same ecosystem are referencing the same schemas, credential issuance and verification is accurate and standardised. For further details on how to create and manage Credential Schemas, see the .

Organisations that issue credentials (Issuers) can create Credential Templates which form the base of the credentials they will issue. Credential Templates include the associated credential schema (which determines the information required from the Holder), and credential styling information which enables customisation of credential colour schemes and logos. For further details on how to create a Credential Template, see the .

The issuance of credentials is made easy via the Portal by a simple step-by-step workflow. Issuers first select one of the Credential Templates they have created previously (see the for details). The Credential Template defines the attributes that are required to be filled in. For example, a First Aid Certificate Credential Template might include attributes such as:

Organisations that verify credentials (Verifiers) can create Verification Templates which form the base of Verification Requests. Verification Templates include the associated credential schema (which determines the information required from the Holder), and if required, a specific Issuer of these credentials can be defined. For further details on how to create a Verification Template, see the .

Note Please note that we acknowledge the term as commonly used in credential specifications, but for the purposes of our Portal, we refer to Verifiable Presentations as Verification Templates.

In order to verify credentials via the Portal, an Organisation Administrator (Verifier) creates a new Verification Request. Each request requires the Organisation Administrator to select a Verification Template which defines the credential(s) required from the Holder for verification. Once a Verification Template has been selected, the Verifier can view the request in the form of a QR Code. The QR Code can be presented to a Holder in-person, or downloaded and shared via any form of digital sharing method. For further details on how to create a Verification Requests, see the .

For detailed information about our credential service, see our information page or our .

While the Enterprise Vault (EV) can be directly utilised via the SVX API, it can also be managed by Organisation Administrators via the Portal. By providing an interface to the EV, non-technical Administrators can easily create and manage connections, including the sharing of items on behalf of their Organisation. For further information, see the overview page.

The EV allows Organisations to securely share data with end users via Vault-to-Vault connections. Organisation Administrators can invite end users to connect via a simple invitation workflow. After entering the connection’s full name into the system, they can generate an invitation code. This invitation code is then passed to the new connection which they enter into their own Vault-using application. On acceptance by the connection recipient, the connection between the two Vaults is established. For further details on establishing and managing connections, see the .

For detailed information about our EV offering, see the information page or our .

Credential Schemas
Applications
End Users
Credential Schema tutorial
Terms and Conditions
Privacy Policy
W3C Verifiable Credentials Data Model
Privacy- and Security-by-design
Credential Schemas tutorial
Credential Template tutorial
Credential Template tutorial
Verification Template tutorial
Verification Requests tutorial
Verifiable Credentials
API documentation
Enterprise Vault
Connections tutorial
Enterprise Vault
API documentation
Security Rights
Security Rights
Verifiable Presentation