Use the Credentials Types operations to create, read, and update the credential types used by native ShoCard applications.
Credential Types data model
Property |
Type |
Required? |
Mutable? |
Description |
cardDesignTemplate |
BLOB |
Required |
Immutable |
An SVG formatted image containing placeholders for the credentials fields that need to be displayed in the image. |
credentialTypeId |
String |
Required |
Immutable |
The UUID of the credential type. |
issuerId |
String |
Required |
Immutable |
The primary key of the issuer. |
description |
String |
Optional |
Mutable |
A description of the credential type. |
metadata |
String |
Required |
Immutable |
Serialized JSON containing the names, data types, and other metadata related to the credential being issued. |
title |
String |
Required |
Immutable |
Contains the credential name (card type) received from the native ShoCard application. Verification sites are expected to be able to request the issued credential from the ShoCard application using the title. |
Response codes
Code |
Message |
200 |
Successful operation. |
400 |
The request could not be completed. |
401 |
You do not have access to this resource. |
403 |
You do not have permissions or are not licensed to make this request. |
404 |
The requested resource was not found. |
500 |
Unexpected server error. |