Credential Issuer User Guide

CARO User Guide for Credential Issuers #

About This Document #

This document walks you through the functionalities of the CARO app, Spherity’s Credentialing Service for Authorized Trading Partners (ATP), to enable you to navigate the user interface. It does neither explain any technical details of the Credentialing Service nor provide guidelines for the technical implementation of CARO. Please refer to our API Specifications for technical guidance.

This document will be updated continuously. Please check back frequently, as new features and functionalities will be added to the application and explained here.

If you are looking for a high-level overview of CARO, download our info brochure or visit the CARO website. You may also want to peruse some essential concepts about our app.

Development Status #

The current application is a beta version, which is continuously being developed further.

If you are in the process of testing CARO, we would love to hear your feedback. Which functionalities or info screens are useful to you? What should we add or remove? How can we make your life easier? Please get in touch through one of the means detailed at the bottom of this page.

CARO Search function

The search function applies across the CARO app. It groups results into applicable categories, such as reports, events, or credentials. You can access it from any app screen by finding it in the sidebar or using the keyboard shortcut CTRL+K.

Account Selection #

CARO Account Selection

Clicking on the account selector in the sidebar opens the account overview. All Service Provider Accounts to which you have been granted user access are listed here. You can switch between accounts by clicking on the switch option for each.

Customers #

CARO VRS Customers

This screen shows a list of all customers who have granted you access to their account.

Customer Details #

Clicking on any of the customers in the list will open a details view of this customer. Besides some basic information, it includes a list of their Enterprise Identifiers.

CARO VRS Customer Details

Credentials #

Issued Credentials #

CARO Issued Credentials

This screen shows a list of all Verifiable Credentials you have issued.

Credential Details #

Clicking on any of the credentials in the list will open a details view of this credential. You will also be able to manage the revocation of the selected credential here. Find out more about our Ethereum-based revocation method in our blog article.

CARO Credential Details

Onboardings #

CARO Issued Credentials

This screen shows a list of all onboardings.

CARO manages credential requests through so-called onboardings. One onboarding is effectively mapped to the lifecycle of one Verifiable Credential. For example, a credential may need to be re-issued after expiry. Both steps, initial and subsequent issuance would be mapped against the same onboarding ID.

Onboarding Progress #

Clicking on any of the onboardings in the list will open a details view showing the progress of the credential request.

CARO Issued Credentials

Settings #

CARO Service Provider Account Settings

Here you can manage the appearance of your company profile within CARO.

There is also a dedicated section showing your API authentication information. The Client ID and Client Secret listed amongst your API authentication details are effectively your access credentials to CARO. You can use the same Client ID and Client Secret to communicate with CARO when acting on behalf of each of your VRS customers. These details pertain to your VRS account, not your customers’ accounts. These details do not change. You will use the same details for every interaction with CARO.

User Management #

CARO Service Provider User Management

This screen shows all users who have access or have been invited to your Service Provider space.

Adding New Users #

After clicking Invite New User on the main screen, you will be directed to a form to enter the new user’s email address and select their user role. Once you have confirmed the invitation, the new user will receive an email inviting them to set up their access.

CARO Service Provider Invite New User

Available User Roles #

Service Provider Manager #
  • Administration of Service Provider space
  • User and role management
Service Provider Developer #
  • as Service Provider Manager + access to client ID and secret for authentication

Managing Existing Users #

Clicking on any of the existing users on the main screen will open a details view of this user.

CARO User Details

Clicking on your own user on the main screen or in the sidebar will open a details view of your own set-up. The display here is more expansive than for other users.

CARO Own User Account Details

You can change the selected user’s role and access by clicking on Edit Profile.

CARO Administrator Change User Details

Activity Log #

Activity Log

This screen lists the actions account users have performed in your Service Provider Account, such as client key rotation or profile updates.

App Status Monitor #

The app status, including maintenance updates, can be found at

You can also subscribe to updates via RSS:

Support #

If you have already been invited to a dedicated Spherity Slack support channel, seeking assistance there will be the most straight-forward way for you to reach the CARO support team.

Otherwise please contact [email protected] for product-related questions or [email protected] for technical queries.