Preview credential definition from URI
Fetches the JSON document at a URI and returns it, so that you can look at it before you use the URI as credentialDefinitionUri of a credential configuration. The issuer reads the document as a JSON Schema: it resolves the $ref members, removes the $defs members and checks the result against JSON Schema draft 2020-12. It does not check claims path pointers: the create and update calls do that with the document of a credentialDefinitionUri, which must be a claims path pointer document ({"claims": [{"path": [...]}]}). The URI must be a public HTTP or HTTPS URL; the issuer waits 10 seconds at most.
Authorizations
AuthorizationstringheaderrequiredYour API key with the prefix
ApiKey:ApiKey <your-api-key>. Get an API key.Scope:
credential-definitions:read
Body
credentialDefinition Uri string<uri>requiredThe HTTP or HTTPS URL of the document. The issuer refuses an address of a private or local network.
Example:
"https://schemas.example.com/lpid.json"
Response
The document at the URI.
credentialDefinition objectThe document, with its
$refmembers resolved and without its$defsmembers.