Credential Schema APIs

Get credential schema by tags

GEThttps://sunbirdrc.dev/api/v1/credential-schema

Query parameters

Response

201400500

Credential Schemas

Body

application/json

schemaobject

tagsarray of string

statusenum

DRAFTPUBLISHEDREVOKED

createdAtstring

updatedAtstring

createdBystring

updatedBystring

Request

JavaScriptCurlPython

const response = await fetch('https://sunbirdrc.dev/api/v1/credential-schema', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

201

[
  {
    "schema": {
      "type": "text",
      "id": "did:cred-schema:MDP8AsFhHzhwUvGNuYkX7T/06e126d1-fa44-4882-a243-1e326fbe21db;version=1.1",
      "version": "text",
      "name": "text",
      "author": "text",
      "authored": "text",
      "schema": "{\"$schema\":\"https://json-schema.org/draft/2020-12/schema\",\"description\":\"Email\",\"type\":\"object\",\"properties\":{\"emailAddress\":{\"type\":\"string\",\"format\":\"email\"}},\"required\":[\"emailAddress\"],\"additionalProperties\":false}"
    },
    "tags": [
      "text"
    ],
    "status": "DRAFT",
    "createdAt": "text",
    "updatedAt": "text",
    "createdBy": "text",
    "updatedBy": "text"
  }
]

Create credential schema

POSThttps://sunbirdrc.dev/api/v1/credential-schema

Body

appliation/json

Payload

schemaobject

tagsarray of string

statusenum

DRAFTPUBLISHEDREVOKED

Response

201400500

Credential Schema successfully created!

Body

application/json

schemaobject

tagsarray of string

statusenum

DRAFTPUBLISHEDREVOKED

createdAtstring

updatedAtstring

createdBystring

updatedBystring

Request

JavaScriptCurlPython

const response = await fetch('https://sunbirdrc.dev/api/v1/credential-schema', {
    method: 'POST',
    headers: {
      "Content-Type": "appliation/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "schema": {
    "type": "text",
    "id": "did:cred-schema:MDP8AsFhHzhwUvGNuYkX7T/06e126d1-fa44-4882-a243-1e326fbe21db;version=1.1",
    "version": "text",
    "name": "text",
    "author": "text",
    "authored": "text",
    "schema": "{\"$schema\":\"https://json-schema.org/draft/2020-12/schema\",\"description\":\"Email\",\"type\":\"object\",\"properties\":{\"emailAddress\":{\"type\":\"string\",\"format\":\"email\"}},\"required\":[\"emailAddress\"],\"additionalProperties\":false}"
  },
  "tags": [
    "text"
  ],
  "status": "DRAFT",
  "createdAt": "text",
  "updatedAt": "text",
  "createdBy": "text",
  "updatedBy": "text"
}

Get credential schema by id

GEThttps://sunbirdrc.dev/api/v1/credential-schema/{id}

Path parameters

id*string

Response

200400500

Response

Body

application/json

schemaobject

tagsarray of string

statusenum

DRAFTPUBLISHEDREVOKED

createdAtstring

updatedAtstring

createdBystring

updatedBystring

Request

JavaScriptCurlPython

const response = await fetch('https://sunbirdrc.dev/api/v1/credential-schema/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "schema": {
    "type": "text",
    "id": "did:cred-schema:MDP8AsFhHzhwUvGNuYkX7T/06e126d1-fa44-4882-a243-1e326fbe21db;version=1.1",
    "version": "text",
    "name": "text",
    "author": "text",
    "authored": "text",
    "schema": "{\"$schema\":\"https://json-schema.org/draft/2020-12/schema\",\"description\":\"Email\",\"type\":\"object\",\"properties\":{\"emailAddress\":{\"type\":\"string\",\"format\":\"email\"}},\"required\":[\"emailAddress\"],\"additionalProperties\":false}"
  },
  "tags": [
    "text"
  ],
  "status": "DRAFT",
  "createdAt": "text",
  "updatedAt": "text",
  "createdBy": "text",
  "updatedBy": "text"
}

Update credential schema by id

If the schema is updated, a new semver will be generated and the old one will be deprecated. If only metadata (like tags/status) is updated, the semver will not be generated

PUThttps://sunbirdrc.dev/api/v1/credential-schema/{id}

Path parameters

id*string

Body

appliation/json

Payload

schemaobject

tagsarray of string

statusenum

DRAFTPUBLISHEDREVOKED

Response

200400500

Credential Schema successfully updated!

Body

application/json

schemaobject

tagsarray of string

statusenum

DRAFTPUBLISHEDREVOKED

createdAtstring

updatedAtstring

createdBystring

updatedBystring

deprecatedIdstring

returns back the id of the schema that was deprecated

Request

JavaScriptCurlPython

const response = await fetch('https://sunbirdrc.dev/api/v1/credential-schema/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "appliation/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "schema": {
    "type": "text",
    "id": "did:cred-schema:MDP8AsFhHzhwUvGNuYkX7T/06e126d1-fa44-4882-a243-1e326fbe21db;version=1.1",
    "version": "text",
    "name": "text",
    "author": "text",
    "authored": "text",
    "schema": "{\"$schema\":\"https://json-schema.org/draft/2020-12/schema\",\"description\":\"Email\",\"type\":\"object\",\"properties\":{\"emailAddress\":{\"type\":\"string\",\"format\":\"email\"}},\"required\":[\"emailAddress\"],\"additionalProperties\":false}"
  },
  "tags": [
    "text"
  ],
  "status": "DRAFT",
  "createdAt": "text",
  "updatedAt": "text",
  "createdBy": "text",
  "updatedBy": "text",
  "deprecatedId": "text"
}

Get rendering templates by schema id

GEThttps://sunbirdrc.dev/api/v1/template

Query parameters

Response

200400500

Response

Body

application/json

templatestring

It should be valid string in handlebar format

schemaIdstring

Example: "did:cred-schema:MDP8AsFhHzhwUvGNuYkX7T/06e126d1-fa44-4882-a243-1e326fbe21db;version=1.1"

templateIdstring

Example: "did:cred-template:MDP8AsFhHzhwUvGNuYkX7T/06e126d1-fa44-4882-a243-1e326fbe21dc;version=1.1"

createdAtstring

updatedAtstring

createdBystring

updatedBystring

Request

JavaScriptCurlPython

const response = await fetch('https://sunbirdrc.dev/api/v1/template?schemaId=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "template": "text",
  "schemaId": "did:cred-schema:MDP8AsFhHzhwUvGNuYkX7T/06e126d1-fa44-4882-a243-1e326fbe21db;version=1.1",
  "templateId": "did:cred-template:MDP8AsFhHzhwUvGNuYkX7T/06e126d1-fa44-4882-a243-1e326fbe21dc;version=1.1",
  "createdAt": "text",
  "updatedAt": "text",
  "createdBy": "text",
  "updatedBy": "text"
}

Create redenring templates

POSThttps://sunbirdrc.dev/api/v1/template

Body

appliation/json

Payload

templatestring

It should be valid string in handlebar format

schemaIdstring

Example: "did:cred-schema:MDP8AsFhHzhwUvGNuYkX7T/06e126d1-fa44-4882-a243-1e326fbe21db;version=1.1"

Response

201400500

Rendering template successfully created!

Body

application/json

templatestring

It should be valid string in handlebar format

schemaIdstring

Example: "did:cred-schema:MDP8AsFhHzhwUvGNuYkX7T/06e126d1-fa44-4882-a243-1e326fbe21db;version=1.1"

templateIdstring

Example: "did:cred-template:MDP8AsFhHzhwUvGNuYkX7T/06e126d1-fa44-4882-a243-1e326fbe21dc;version=1.1"

createdAtstring

updatedAtstring

createdBystring

updatedBystring

Request

JavaScriptCurlPython

const response = await fetch('https://sunbirdrc.dev/api/v1/template', {
    method: 'POST',
    headers: {
      "Content-Type": "appliation/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "template": "text",
  "schemaId": "did:cred-schema:MDP8AsFhHzhwUvGNuYkX7T/06e126d1-fa44-4882-a243-1e326fbe21db;version=1.1",
  "templateId": "did:cred-template:MDP8AsFhHzhwUvGNuYkX7T/06e126d1-fa44-4882-a243-1e326fbe21dc;version=1.1",
  "createdAt": "text",
  "updatedAt": "text",
  "createdBy": "text",
  "updatedBy": "text"
}

Get rendering templates by id

GEThttps://sunbirdrc.dev/api/v1/template/{id}

Path parameters

id*string

Response

200400500

Response

Body

application/json

templatestring

It should be valid string in handlebar format

schemaIdstring

Example: "did:cred-schema:MDP8AsFhHzhwUvGNuYkX7T/06e126d1-fa44-4882-a243-1e326fbe21db;version=1.1"

templateIdstring

Example: "did:cred-template:MDP8AsFhHzhwUvGNuYkX7T/06e126d1-fa44-4882-a243-1e326fbe21dc;version=1.1"

createdAtstring

updatedAtstring

createdBystring

updatedBystring

Request

JavaScriptCurlPython

const response = await fetch('https://sunbirdrc.dev/api/v1/template/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "template": "text",
  "schemaId": "did:cred-schema:MDP8AsFhHzhwUvGNuYkX7T/06e126d1-fa44-4882-a243-1e326fbe21db;version=1.1",
  "templateId": "did:cred-template:MDP8AsFhHzhwUvGNuYkX7T/06e126d1-fa44-4882-a243-1e326fbe21dc;version=1.1",
  "createdAt": "text",
  "updatedAt": "text",
  "createdBy": "text",
  "updatedBy": "text"
}

Update rendering templates by id

Create a new version of template

PUThttps://sunbirdrc.dev/api/v1/template/{id}

Path parameters

id*string

Body

appliation/json

Payload

templatestring

It should be valid string in handlebar format

schemaIdstring

Example: "did:cred-schema:MDP8AsFhHzhwUvGNuYkX7T/06e126d1-fa44-4882-a243-1e326fbe21db;version=1.1"

Response

200400500

Rendering template successfully updated!

Body

application/json

templatestring

It should be valid string in handlebar format

schemaIdstring

Example: "did:cred-schema:MDP8AsFhHzhwUvGNuYkX7T/06e126d1-fa44-4882-a243-1e326fbe21db;version=1.1"

templateIdstring

Example: "did:cred-template:MDP8AsFhHzhwUvGNuYkX7T/06e126d1-fa44-4882-a243-1e326fbe21dc;version=1.1"

createdAtstring

updatedAtstring

createdBystring

updatedBystring

Request

JavaScriptCurlPython

const response = await fetch('https://sunbirdrc.dev/api/v1/template/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "appliation/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "template": "text",
  "schemaId": "did:cred-schema:MDP8AsFhHzhwUvGNuYkX7T/06e126d1-fa44-4882-a243-1e326fbe21db;version=1.1",
  "templateId": "did:cred-template:MDP8AsFhHzhwUvGNuYkX7T/06e126d1-fa44-4882-a243-1e326fbe21dc;version=1.1",
  "createdAt": "text",
  "updatedAt": "text",
  "createdBy": "text",
  "updatedBy": "text"
}

Delete rendering templates by id

DELETEhttps://sunbirdrc.dev/api/v1/template/{id}

Path parameters

id*string

Response

200400500

Credential Schema successfully deleted!

Request

JavaScriptCurlPython

const response = await fetch('https://sunbirdrc.dev/api/v1/template/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();