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.
If you are looking for a high-level overview of CARO, visit our website. You may also want to peruse some Essential Concepts about our app.
All our documents are updated continuously. Please check back frequently, as new features and functionalities will be added to our applications and explained here.
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.
The search function applies across the CARO app. It groups results into applicable categories, such as reports, events, or credentials. You can access it by clicking on the magnifying glass icon 🔎 in the top right corner of the app screen or by using the keyboard shortcut CTRL+K.
Clicking on the cogwheel icon ⚙️ in the top right corner of the app screen opens the global application settings. Here you can manage the security settings that apply across the entire Enterprise Account. You can check which service providers are integrated with your Enterprise Account. You can also find helpful links.
You can find your profile in the menu section Enterprise Wallet. Edit your profile as you want it to appear in the :spherity_icon_gradient: CARO network.
This screen shows a list of all customers who have granted you access to their account.
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.
<aside> ℹ️
The term VRS Events within CARO refers only to the credential processing between CARO and your VRS, not the entire VRS messaging roundtrip.
</aside>
🔖 Read more at What are VRS Events in CARO?
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.
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.
🔖 Read more at VRS Event Status.
Here you can see your API token usage, manage your API client keys, including key rotation, and access other developer tools.
Clicking on the tile with your name in the bottom left corner of the app screen opens the User Settings.
Here you can manage your profile, your own security settings, and inspect your own user activity logs.
In addition, all Enterprise Accounts to which you have been granted user access are listed here. You can move between accounts by clicking on the Switch button for each. You can also quit any account.
This screen shows all users who have access or have been invited to the Enterprise Account. You can remove existing users by clicking on the bin icon 🗑 or change their role by clicking on the pencil icon ✎.
After clicking Send Invite in the top right corner, a small form will prompt you 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 account access.