Create AnonCreds Schema

To issue Verifiable Credentials, the issuer will have to first create a Schema and then a Credential Definition.

Create Schema

The request body must contain the schema object, which defines the attributes, name and version of the Schema. This will create a DID-Linked Resource of type anonCredsSchema.

Create a schema on the connected datastore

POST/anoncreds/schema

Body

application/json

optionsSchemaPostOption (object)

schemaAnonCredsSchema (object)

Response

200

Body

application/json

job_idstring

registration_metadataobject

schema_metadataobject

schema_stateSchemaState (object)

Request

JavaScriptCurlPython

const response = await fetch('/anoncreds/schema', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "job_id": "text",
  "schema_state": {
    "schema": {
      "attrNames": [
        "score"
      ],
      "issuerId": "did:(method):WgWxqztrNooG92RXvxSTWv",
      "name": "Example schema",
      "version": "1.0"
    },
    "schema_id": "did:(method):2:schema_name:1.0",
    "state": "finished"
  }
}

Request Body

options (optional)

Optional Key-Value pairs of additional options.

schema (mandatory)

"attrNames": Array of attributes for the schema definition.

"issuerId": Issuer DID, use the did created by the Issuer.

"name": Name of the Schema

"version": Version of the Schema (To update existing Schema, use same name and different version)

Check the new Schema

Retrieve an individual schemas details

GET/anoncreds/schema/{schema_id}

Path parameters

schema_id*string

Schema identifier

Example: "did:(method):2:schema_name:1.0"

Response

200

Body

application/json

resolution_metadataobject

schemaAnonCredsSchema (object)

schema_idstring

Schema identifier

Example: "did:(method):2:schema_name:1.0"

schema_metadataobject

Request

JavaScriptCurlPython

const response = await fetch('/anoncreds/schema/{schema_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "schema": {
    "attrNames": [
      "score"
    ],
    "issuerId": "did:(method):WgWxqztrNooG92RXvxSTWv",
    "name": "Example schema",
    "version": "1.0"
  },
  "schema_id": "did:(method):2:schema_name:1.0"
}