1 of 3

DID-Linked Resources

"DID-Linked Resources" are identified with a did:cheqd Decentralized Identifier with a Universally Unique Identifier (UUID) that acts as a permanently-accessible link to fetch the resources from the cheqd ledger. We refer to this as the "resource ID". Through the "resource ID" or a set of DID URL query parameters, applications are able to persistently access a digital resource on the cheqd network.

Get started

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 Credential Definition

Create Credential Definition

The request body must contain the credential_definition object with the Issuer DID and the Schema ID created in the previous steps.

To enable revocation, the options must contain the revocation flag, and the size of the revocation registry. Also, ensure that a is configured for the issuer.

Request Body

credential_definition (mandatory)

"issuerId": DID of the Issuer.

"schemaId": The AnonCreds Schema ID created by the Issuer (must be of the same DID).

"tag": Additional Name to identify the Credential Definition.

options (optional)

"support_revocation": Boolean value to indicate that the Credential can be revoked or not. (Tails server must be configured if this is set to `true`)

"revocation_registry_size": Maximum size of the Revocation Registry.

Check the new Credential Definition

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

Create AnonCreds Credential Definition

Create Credential Definition

The request body must contain the credential_definition object with the Issuer DID and the Schema ID created in the previous steps.

To enable revocation, the options must contain the revocation flag, and the size of the revocation registry. Also, ensure that a is configured for the issuer.

Request Body

credential_definition (mandatory)

"issuerId": DID of the Issuer.

"schemaId": The AnonCreds Schema ID created by the Issuer (must be of the same DID).

"tag": Additional Name to identify the Credential Definition.

options (optional)

"support_revocation": Boolean value to indicate that the Credential can be revoked or not. (Tails server must be configured if this is set to `true`)

"revocation_registry_size": Maximum size of the Revocation Registry.

Check the new Credential Definition

Create a credential definition on the connected datastore

POST/anoncreds/credential-definition

Body

credential_definitionInnerCredDef (object)

issuerId*string

Issuer Identifier of the credential definition

Example: "did:(method):WgWxqztrNooG92RXvxSTWv"

schemaId*string

Schema identifier

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

tag*string

Credential definition tag

Example: "default"

optionsCredDefPostOptions (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"

revocation_registry_sizeinteger

Maximum number of credential revocations per registry

Example: 1000

support_revocationboolean

Support credential revocation

Response

Body

credential_definition_metadataobject

credential_definition_stateCredDefState (object)

credential_definitionall of

credential definition

issuerIdstring

Issuer Identifier of the credential definition or schema

Example: "did:(method):WgWxqztrNooG92RXvxSTWv"

schemaIdstring

Schema identifier

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

tagstring

The tag value passed in by the Issuer to an AnonCred's Credential Definition create and store implementation.

Example: "default"

typeenum

valueCredDefValueSchemaAnoncreds (object)

primaryall of

Primary value for credential definition

nstring

Example: "0"

Pattern: ^[0-9]*$

robject

rctxtstring

Example: "0"

Pattern: ^[0-9]*$

sstring

Example: "0"

Pattern: ^[0-9]*$

zstring

Example: "0"

Pattern: ^[0-9]*$

revocationall of

Revocation value for credential definition

gstring

Example: "1 1F14F&ECB578F 2 095E45DDF417D"

g_dashstring

Example: "1 1D64716fCDC00C 1 0C781960FA66E3D3 2 095E45DDF417D"

hstring

Example: "1 16675DAE54BFAE8 2 095E45DD417D"

h0string

Example: "1 21E5EF9476EAF18 2 095E45DDF417D"

h1string

Example: "1 236D1D99236090 2 095E45DDF417D"

h2string

Example: "1 1C3AE8D1F1E277 2 095E45DDF417D"

h_capstring

Example: "1 1B2A32CF3167 1 2490FEBF6EE55 1 0000000000000000"

htildestring

Example: "1 1D8549E8C0F8 2 095E45DDF417D"

pkstring

Example: "1 142CD5E5A7DC 1 153885BD903312 2 095E45DDF417D"

ustring

Example: "1 0C430AAB2B4710 1 1CB3A0932EE7E 1 0000000000000000"

ystring

Example: "1 153558BD903312 2 095E45DDF417D 1 0000000000000000"

credential_definition_idnullable string

credential definition id

Example: "did:(method):3:CL:20:tag"

stateenum

finishedfailedactionwait

job_idstring

registration_metadataobject

Request

Response

Retrieve an individual credential definition details

GET/anoncreds/credential-definition/{cred_def_id}

Path parameters

cred_def_id*string

Credential definition identifier

Example: "did:(method):3:CL:20:tag"

Response

Body

credential_definitionall of

credential definition

issuerIdstring

Issuer Identifier of the credential definition or schema

Example: "did:(method):WgWxqztrNooG92RXvxSTWv"

schemaIdstring

Schema identifier

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

tagstring

The tag value passed in by the Issuer to an AnonCred's Credential Definition create and store implementation.

Example: "default"

typeenum

valueCredDefValueSchemaAnoncreds (object)

primaryall of

Primary value for credential definition

nstring

Example: "0"

Pattern: ^[0-9]*$

robject

rctxtstring

Example: "0"

Pattern: ^[0-9]*$

sstring

Example: "0"

Pattern: ^[0-9]*$

zstring

Example: "0"

Pattern: ^[0-9]*$

revocationall of

Revocation value for credential definition

gstring

Example: "1 1F14F&ECB578F 2 095E45DDF417D"

g_dashstring

Example: "1 1D64716fCDC00C 1 0C781960FA66E3D3 2 095E45DDF417D"

hstring

Example: "1 16675DAE54BFAE8 2 095E45DD417D"

h0string

Example: "1 21E5EF9476EAF18 2 095E45DDF417D"

h1string

Example: "1 236D1D99236090 2 095E45DDF417D"

h2string

Example: "1 1C3AE8D1F1E277 2 095E45DDF417D"

h_capstring

Example: "1 1B2A32CF3167 1 2490FEBF6EE55 1 0000000000000000"

htildestring

Example: "1 1D8549E8C0F8 2 095E45DDF417D"

pkstring

Example: "1 142CD5E5A7DC 1 153885BD903312 2 095E45DDF417D"

ustring

Example: "1 0C430AAB2B4710 1 1CB3A0932EE7E 1 0000000000000000"

ystring

Example: "1 153558BD903312 2 095E45DDF417D 1 0000000000000000"

credential_definition_idstring

credential definition id

Example: "did:(method):3:CL:20:tag"

credential_definitions_metadataobject

resolution_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

Create a credential definition on the connected datastore

POST/anoncreds/credential-definition

Body

credential_definitionInnerCredDef (object)

issuerId*string

Issuer Identifier of the credential definition

Example: "did:(method):WgWxqztrNooG92RXvxSTWv"

schemaId*string

Schema identifier

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

tag*string

Credential definition tag

Example: "default"

optionsCredDefPostOptions (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"

revocation_registry_sizeinteger

Maximum number of credential revocations per registry

Example: 1000

support_revocationboolean

Support credential revocation

Response

Body

credential_definition_metadataobject

credential_definition_stateCredDefState (object)

credential_definitionall of

credential definition

issuerIdstring

Issuer Identifier of the credential definition or schema

Example: "did:(method):WgWxqztrNooG92RXvxSTWv"

schemaIdstring

Schema identifier

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

tagstring

The tag value passed in by the Issuer to an AnonCred's Credential Definition create and store implementation.

Example: "default"

typeenum

valueCredDefValueSchemaAnoncreds (object)

primaryall of

Primary value for credential definition

nstring

Example: "0"

Pattern: ^[0-9]*$

robject

rctxtstring

Example: "0"

Pattern: ^[0-9]*$

sstring

Example: "0"

Pattern: ^[0-9]*$

zstring

Example: "0"

Pattern: ^[0-9]*$

revocationall of

Revocation value for credential definition

gstring

Example: "1 1F14F&ECB578F 2 095E45DDF417D"

g_dashstring

Example: "1 1D64716fCDC00C 1 0C781960FA66E3D3 2 095E45DDF417D"

hstring

Example: "1 16675DAE54BFAE8 2 095E45DD417D"

h0string

Example: "1 21E5EF9476EAF18 2 095E45DDF417D"

h1string

Example: "1 236D1D99236090 2 095E45DDF417D"

h2string

Example: "1 1C3AE8D1F1E277 2 095E45DDF417D"

h_capstring

Example: "1 1B2A32CF3167 1 2490FEBF6EE55 1 0000000000000000"

htildestring

Example: "1 1D8549E8C0F8 2 095E45DDF417D"

pkstring

Example: "1 142CD5E5A7DC 1 153885BD903312 2 095E45DDF417D"

ustring

Example: "1 0C430AAB2B4710 1 1CB3A0932EE7E 1 0000000000000000"

ystring

Example: "1 153558BD903312 2 095E45DDF417D 1 0000000000000000"

credential_definition_idnullable string

credential definition id

Example: "did:(method):3:CL:20:tag"

stateenum

finishedfailedactionwait

job_idstring

registration_metadataobject

Request

Response

Retrieve an individual credential definition details

GET/anoncreds/credential-definition/{cred_def_id}

Path parameters

cred_def_id*string

Credential definition identifier

Example: "did:(method):3:CL:20:tag"

Response

Body

credential_definitionall of

credential definition

issuerIdstring

Issuer Identifier of the credential definition or schema

Example: "did:(method):WgWxqztrNooG92RXvxSTWv"

schemaIdstring

Schema identifier

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

tagstring

The tag value passed in by the Issuer to an AnonCred's Credential Definition create and store implementation.

Example: "default"

typeenum

valueCredDefValueSchemaAnoncreds (object)

primaryall of

Primary value for credential definition

nstring

Example: "0"

Pattern: ^[0-9]*$

robject

rctxtstring

Example: "0"

Pattern: ^[0-9]*$

sstring

Example: "0"

Pattern: ^[0-9]*$

zstring

Example: "0"

Pattern: ^[0-9]*$

revocationall of

Revocation value for credential definition

gstring

Example: "1 1F14F&ECB578F 2 095E45DDF417D"

g_dashstring

Example: "1 1D64716fCDC00C 1 0C781960FA66E3D3 2 095E45DDF417D"

hstring

Example: "1 16675DAE54BFAE8 2 095E45DD417D"

h0string

Example: "1 21E5EF9476EAF18 2 095E45DDF417D"

h1string

Example: "1 236D1D99236090 2 095E45DDF417D"

h2string

Example: "1 1C3AE8D1F1E277 2 095E45DDF417D"

h_capstring

Example: "1 1B2A32CF3167 1 2490FEBF6EE55 1 0000000000000000"

htildestring

Example: "1 1D8549E8C0F8 2 095E45DDF417D"

pkstring

Example: "1 142CD5E5A7DC 1 153885BD903312 2 095E45DDF417D"

ustring

Example: "1 0C430AAB2B4710 1 1CB3A0932EE7E 1 0000000000000000"

ystring

Example: "1 153558BD903312 2 095E45DDF417D 1 0000000000000000"

credential_definition_idstring

credential definition id

Example: "did:(method):3:CL:20:tag"

credential_definitions_metadataobject

resolution_metadataobject

Request

Response