1 of 1

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.

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

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

optionsSchemaPostOption (object)

create_transaction_for_endorserboolean

Create transaction for endorser (optional, default false). Use this for agents who don't specify an author role but want to create a transaction for an endorser to sign.

Example: false

endorser_connection_idstring

Connection identifier (optional) (this is an example). You can set this if you know the endorser's connection id you want to use. If not specified then the agent will attempt to find an endorser connection.

Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

schemaAnonCredsSchema (object)

attrNamesarray of string

Schema attribute names

itemsstring

Attribute name

Example: "score"

issuerIdstring

Issuer Identifier of the credential definition or schema

Example: "did:(method):WgWxqztrNooG92RXvxSTWv"

namestring

Schema name

Example: "Example schema"

versionstring

Schema version

Example: "1.0"

Response

Body

job_idstring

registration_metadataobject

schema_metadataobject

schema_stateSchemaState (object)

schemaAnonCredsSchema (object)

attrNamesarray of string

Schema attribute names

itemsstring

Attribute name

Example: "score"

issuerIdstring

Issuer Identifier of the credential definition or schema

Example: "did:(method):WgWxqztrNooG92RXvxSTWv"

namestring

Schema name

Example: "Example schema"

versionstring

Schema version

Example: "1.0"

schema_idstring

Schema identifier

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

stateenum

finishedfailedactionwait

Request

Response

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

Body

resolution_metadataobject

schemaAnonCredsSchema (object)

attrNamesarray of string

Schema attribute names

itemsstring

Attribute name

Example: "score"

issuerIdstring

Issuer Identifier of the credential definition or schema

Example: "did:(method):WgWxqztrNooG92RXvxSTWv"

namestring

Schema name

Example: "Example schema"

versionstring

Schema version

Example: "1.0"

schema_idstring

Schema identifier

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

schema_metadataobject

Request

Response

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

Body

resolution_metadataobject

schemaAnonCredsSchema (object)

attrNamesarray of string

Schema attribute names

itemsstring

Attribute name

Example: "score"

issuerIdstring

Issuer Identifier of the credential definition or schema

Example: "did:(method):WgWxqztrNooG92RXvxSTWv"

namestring

Schema name

Example: "Example schema"

versionstring

Schema version

Example: "1.0"

schema_idstring

Schema identifier

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

schema_metadataobject

Request

Response

Create a schema on the connected datastore

POST/anoncreds/schema

Body

optionsSchemaPostOption (object)

create_transaction_for_endorserboolean

Create transaction for endorser (optional, default false). Use this for agents who don't specify an author role but want to create a transaction for an endorser to sign.

Example: false

endorser_connection_idstring

Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

schemaAnonCredsSchema (object)

attrNamesarray of string

Schema attribute names

itemsstring

Attribute name

Example: "score"

issuerIdstring

Issuer Identifier of the credential definition or schema

Example: "did:(method):WgWxqztrNooG92RXvxSTWv"

namestring

Schema name

Example: "Example schema"

versionstring

Schema version

Example: "1.0"

Response

Body

job_idstring

registration_metadataobject

schema_metadataobject

schema_stateSchemaState (object)

schemaAnonCredsSchema (object)

attrNamesarray of string

Schema attribute names

itemsstring

Attribute name

Example: "score"

issuerIdstring

Issuer Identifier of the credential definition or schema

Example: "did:(method):WgWxqztrNooG92RXvxSTWv"

namestring

Schema name

Example: "Example schema"

versionstring

Schema version

Example: "1.0"

schema_idstring

Schema identifier

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

stateenum

finishedfailedactionwait

Request

Response

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

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

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

{
  "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"
  }
}