CARO User Guide for VRS Providers #
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 as a VRS provider. It does neither explain any technical details of the Credentialing Service nor provide guidelines for the technical implementation of CARO.
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.
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.
Getting Started #
You must be invited to CARO before you can access the app’s dedicated Service Provider space. The web app resides on app.caro.vc.
Once you have received an email invite, accept it by following the link in the email. On the CARO log-in screen you can check your details and set a password. After log-in, you will be forwarded to the CARO Dashboard.
You must be granted access by your VRS customers before you can facilitate VRS interactions on their behalf via our APIs.
System-wide Search #
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 #
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.
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.
This screen shows a list of all VRS transactions executed under the same client ID, i.e. your Service Provider account. Each generation or verification event associated with any of your customers is listed here.
Note that CARO displays one Event status for incoming events and up to two statuses for outgoing events. This is similar to the view available to your customers. Find further explanations in the Trading Partner user guide.
Event Details #
Clicking on any of the events in the list will open a details view of this transaction. Besides some basic information, this page provides you with a developer view of the sent or received event. For Outgoing Events (Generations), you will also see a section called Counterparty Interaction. The counterparty is the trading partner at the other end of the selected VRS-facilitated exchange and may or may not be another one of your customers.
Here you can manage the appearance of your company profile within CARO.
There is also a dedicated section showing your API authentication information, which is only visible to certain user types (see FAQ). 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. However, you can rotate them yourself to increase system security, for example upon a suspected leak or in defined intervals.
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.
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.
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.
You can change the selected user’s role and access by clicking on Edit Profile.
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 https://status.caro.vc/.
You can also subscribe to updates via RSS: https://status.caro.vc/rss.
Further Resources #
Support & Feedback #
If you have already been invited to a dedicated Spherity Slack support channel, seeking assistance or offering feedback there will be the most straight-forward way for you to reach the CARO team.
Otherwise please contact [email protected] for product-related questions or feedback or [email protected] for technical queries.