Credential Schemas Page
- Olesya Kershaw
Credential schemas enable the definition of standard, machine-readable data, leading to significant reductions in data exchange, operational, verification, and processing costs.
Examples:
To efficiently process CVs from job applicants, an employer can define a CV schema to standardize the format. All applicant CVs, received as self-attested credentials, adhere to the schema, making them easily processable by a scoring algorithm.
To simplify its client identification process, a bank with multiple branches defines a Client ID schema for a standard KYC process.
All branches (as separate agents) issue Client ID credentials based on the standardized schema, ensuring consistency and interoperability.
On the “Schemas“ page, you can create and manage schemas and credential definitions of both, your service and publicly accessible schemas from other services in the ProofSpace network.
Features | Description | Screenshots |
|---|---|---|
Create a Schema
| Creating a schema is the first step to setting the credential issuance. This will be the base of your future credential. To create a new Credential Schema, go to the “Schemas” tab and click the “Add schema” button in the right upper corner. |
|
Name a Schema | Name the schema in the “Name” field. We recommend the naming rule of capitalizing the first letter in all words, e.g., My Schema Name. You can add one of the attributes of this schema as part of your schema’s name. For example, you as a university, have numerous courses, and you want to use the same schema to issue a course completion certificate to your students. You can add a “Course Name“ attribute to your schema and name your schema “{{Course Name}} Course Completion Certificate.” Let it be a Management course. As a result, the name of the issued credential in the user’s wallet will be “Management Course completion certificate.“ |  |
Schema version | The default version of the schema is 1.0. You can change it if necessary. |  |
Public access | You can make your credential schema publicly accessible by checking the "Public Access" checkbox. Schemas with this setting become part of the ProofSpace network public schemas list. |
|
Add attribute
| Now add attributes. To add a new attribute to the schema, click the "Add attribute" button. | |
Attribute name | In the pop-up window, name the attribute in the “Name” field. We recommend the naming rule of capitalising the first letter in all words, e.g.: My Attribute Name. | |
The data type for the attribute
| Select Data type: Use "Text" for text data. Use "Date" for choosing a date from the pop-up calendar. Choose the appropriate date unit for your date type, such as years, months, days, minutes etc. Use "Phone" for phone numbers. Use "Number" for numeric values. Use "Image URL" for links to the Images (this data type is currently under development). Use "Enumerated type” (E-num) for a set of named values. |
|
Attribute description
| Describe this attribute (optional). This description will be visible on the Dashboard and in a mobile app for the attributes with Enumerated data type (E-num) | |
Multi-line | Check the “Multi line” checkbox to enable “Text” attribute editing with multi-line support (new line). | |
QR code as a source | If you want the data for this attribute to be added by a mobile app client or a dashboard user by scanning a QR/Barcode, check the “Use QR code as source” box. | |
Finish the ”Add attribute” flow | Click “Add” to proceed.
| |
Add Prepared Attribute | At the moment, it's a list of countries with ISO 3166 country names and codes which you can customize based on your requirements. |
|
Saving Schema | After all necessary attributes have been added, save the schema by clicking “Done.” | |
Save as draft Save and publish
| Select “Save draft” if you plan to add more details later, or “Save & publish” if all necessary details have been added and the schema does not require any more revision.
The saved schema cannot be deleted. | |
Upgrade Schema;
| You can create a new (upgraded version) of your schema. To do so click the "Upgrade" icon. In the new window, make all the necessary changes and click “Done.“ To add the new version of this schema in an existing interaction, you should manually remove the old schema version and then add the new schema version in the interaction settings. |
|
Copy schema (Create new schema from existing) | You can use an existing schema as the base for a new one. Click the “Copy” icon, add a name for your new schema, make the necessary changes, and then save it as usual. |
|
Find the schema | If the check box "Another service can use this schema" is not checked, you will find your schemas in the main menu's "Schemas" section under the tab "My schemas" or the "Public schemas" tab if public access to this schema has been allowed. | |
Deprecate schema | If for any reason, you don't want the particular schema to be visible in the schemas' list, you may deprecate it. Deprecated schemas still function like regular ones. To deprecate a schema, click on its name and check the “Deprecated” checkbox.
To see ALL schemas in this list again, check the "Show deprecated" checkbox on the "Schemas" page.
If you will edit such an interaction, the system automatically removes the credentials based on a deprecated schemas from the interaction's settings. To avoid it, tick the checkbox "Show deprecated."
|
|