Credential Schemas

Schemas are useful when enforcing a specific structure on a collection of data like a Verifiable Credential. Data Verification schemas, for example, are used to verify that the structure and contents of a Verifiable Credential conform to a published schema. On the other hand, Data Encoding schemas are used to map the contents of a Verifiable Credential to an alternative representation format, such as a binary format used in a zero-knowledge proof.

Create Schema

Schemas are used to describe the structure of credentials, specifically the credential subject. It helps the issuer, holder, and verifier to unambiguously determine the claims contained within the credential. To create a schema, you need to define the object body using JSON schema.

Parameters

Name	In	Type	Required	Description
body	body	object	true	JSON-schema.

Create Credential Schema

Creates a JSON schema on the blockchain. More info about Schema Creation

POSThttps://api-testnet.truvera.io/schemas

Body

application/json

JSON-schema

$schemastring

The schema version, generally following the JSON-schema specification.

Example: "http://json-schema.org/draft-07/schema#"

namestring

Name of the schema.

Example: "My Schema"

descriptionstring

A brief description of the schema.

Example: "Truvera Schema Example"

typestring

Defines the type of schema. Usually 'object'.

Example: "object"

propertiesobject

The properties that define the schema.

requiredarray of string

Required fields within the schema.

additionalPropertiesboolean

Specifies whether additional properties outside the defined schema are allowed.

Example: true

Response

200400401402

Schema will be created.

Body

application/json

idstring

dataobject

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/schemas', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401402

{
  "id": "text"
}

List Schemas

Return a list of all schemas created by the authenticated user.

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	How many items to offset by for pagination
limit	query	integer	false	How many items to return at one time (max 64)

List Schemas

Get all schemas created by user. More info about List Schemas

GEThttps://api-testnet.truvera.io/schemas

Query parameters

Response

200400

All schemas by user

Body

application/json

idstring

The schema ID

Example: "https://schema.truvera.io/ExampleSchema-V5-1722512884923.json"

schemaany of

OpenAPI 3.0 null-type refVerifiableCredentialSchema (object)

uristring

The schema URI

Example: "https://schema.truvera.io/ExampleSchema-V5-1722512884923.json"

createdstring (date-time)

isOwnerboolean

Whether the current user is the owner of the schema

Example: true

ownerNamestring

The owner name

Example: "Truvera"

ownerLogostring

The owner logo

Example: "https://logo.truvera.io/owner"

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/schemas', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

[
  {
    "id": "https://schema.truvera.io/ExampleSchema-V5-1722512884923.json",
    "schema": null,
    "uri": "https://schema.truvera.io/ExampleSchema-V5-1722512884923.json",
    "created": "2025-01-09T19:51:01.898Z",
    "isOwner": true,
    "ownerName": "Truvera",
    "ownerLogo": "https://logo.truvera.io/owner"
  }
]

Get Schema

Reading a Schema from the blockchain can easily be achieved by using the get method which will return the JSON schema to a specific schema ID. The schemaIdneeds to be URL encoded (e.g. /schemas/https%3A%2F%2Fschema.dock.io%2FTestSchema-V1-1695817897561.json)

Parameters

Name	In	Type	Required	Description
schemaId	path	String	true	A URL encoded schema id.

Get Schema

Returns the JSON schema for a specific ID. More info about Get Schema By ID

GEThttps://api-testnet.truvera.io/schemas/{schemaId}

Path parameters

schemaId*Hex32 (string)

32 byte hex string. Ignoring higher base (base64) for simplicity.

Response

200400404

Schema

Body

application/json

idstring

The schema ID

Example: "https://schema.truvera.io/ExampleSchema-V5-1722512884923.json"

schemaany of

OpenAPI 3.0 null-type refVerifiableCredentialSchema (object)

uristring

The schema URI

Example: "https://schema.truvera.io/ExampleSchema-V5-1722512884923.json"

createdstring (date-time)

isOwnerboolean

Whether the current user is the owner of the schema

Example: true

ownerNamestring

The owner name

Example: "Truvera"

ownerLogostring

The owner logo

Example: "https://logo.truvera.io/owner"

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/schemas/{schemaId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404

{
  "id": "https://schema.truvera.io/ExampleSchema-V5-1722512884923.json",
  "schema": null,
  "uri": "https://schema.truvera.io/ExampleSchema-V5-1722512884923.json",
  "created": "2025-01-09T19:51:01.898Z",
  "isOwner": true,
  "ownerName": "Truvera",
  "ownerLogo": "https://logo.truvera.io/owner"
}

Delete Schema

Delete Schema

Deletes a schema from the database

DELETEhttps://api-testnet.truvera.io/schemas/{schemaId}

Path parameters

schemaId*Hex32 (string)

32 byte hex string. Ignoring higher base (base64) for simplicity.

Response

200400401404500

Schema has been deleted

Body

application/json

idstring

dataobject

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/schemas/{schemaId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200400401404500

{
  "id": "text"
}