Tutorials

Register as an Issuer

Although anyone can become an Issuer in our Decentralized Identity solution, only registered Issuers can be found by the public through our Identity Platform.

Register new issuers

Register new issuers

POST/api/v1/issuers/register

Body

application/json

pubkeyXstring

pubkeyYstring

Response

400default

Error

Body

application/json

errorstring

messagestring

Request

JavaScriptCurl

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

Response

{
  "error": "text",
  "message": "text"
}

Create operators with roles

We utilize ZKP to enable passwordless authentication and authorization for the Issuers. By default, there are 2 roles: Admin & Operators.

Each Issuer has one unique Admin and multiple Operators, and the Admin will have the supreme privilege with on-chain actions. The Admin user can manage the list of users granted with Operator role.

Get list operator

Get list operator

GET/api/v1/issuers/{issuerId}/operators

Path parameters

issuerId*string

issuerId

Response

400default

Error

Body

application/json

errorstring

messagestring

Request

JavaScriptCurl

const response = await fetch('/api/v1/issuers/{issuerId}/operators', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "error": "text",
  "message": "text"
}

Create operator

Create operator

POST/api/v1/issuers/{issuerId}/operators

Authorization

Authorization

Path parameters

issuerId*string

issuerId

Body

application/json

operatorIdstring

Response

400default

Error

Body

application/json

errorstring

messagestring

Request

JavaScriptCurl

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

Response

{
  "error": "text",
  "message": "text"
}

Disable operator

Disable operator

DELETE/api/v1/issuers/{issuerId}/operators/{operatorId}

Authorization

Authorization

Path parameters

issuerId*string

issuerId

operatorId*string

operatorId

Response

400default

Error

Body

application/json

errorstring

messagestring

Request

JavaScriptCurl

const response = await fetch('/api/v1/issuers/{issuerId}/operators/{operatorId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "error": "text",
  "message": "text"
}

Our ZKP auth solution is implemented to support any arbitrary set of roles. If you are interested in a customized integration, feel free contact us for further discussion.

Edit Issuer information

The metadata of an Issuer (name, logo, description, etc.) can be updated.

Get Issuer infor

Get Issuer infor

GET/api/v1/issuers/{issuerId}/profile

Authorization

Authorization

Path parameters

issuerId*string

issuerId

Response

400default

Error

Body

application/json

errorstring

messagestring

Request

JavaScriptCurl

const response = await fetch('/api/v1/issuers/{issuerId}/profile', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "error": "text",
  "message": "text"
}

Create new Schemas/Register existing Schemas

Schemas are structured data in JSON format, they are used to specified data included in Identity Claims. They can be seen as document standards, i.e. identity documents, certificates, scores, etc. They help entities in the ecosystem easily resolve the claims.

The Issuers can prepare their own Schemas for the claims they want to issue, or they utilize existing Schemas in the ecosystem for their use cases.

To create a new Schema, visit this repository for further instruction.

GitHub - ziden-dev/schema-modelsGitHub

Each schema registry is dedicated to a single blockchain network, therefore, the Issuer need to select from our supported networks list for issuing claims.

Get all network

Get all network

GET/api/v1/networks

Response

400default

Error

Body

application/json

errorstring

messagestring

Request

JavaScriptCurl

const response = await fetch('/api/v1/networks', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "error": "text",
  "message": "text"
}

Then, they need to specify some addition data, i.e. expiration period, description, etc. for the schema before submitting the registration.

API create new registry

API create new registry

POST/api/v1/registries

Body

application/json

schemaHashstring

issuerIdstring

descriptionstring

expirationinteger (int64)

updatetableboolean

networkIdinteger

endpointUrlstring

Response

400default

Error

Body

application/json

errorstring

messagestring

Request

JavaScriptCurl

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

Response

{
  "error": "text",
  "message": "text"
}

A registered schema can not be deleted to avoid corruption of issued claims. Instead, the Issuer can activate/deactivate schemas to indicate which schemas are currently supported.

API active/deactive registry

API active/deactive registry

PUT/api/v1/registries/{registryId}/activate

Path parameters

registryId*string

registryId

Body

application/json

isActiveboolean

Response

400default

Error

Body

application/json

errorstring

messagestring

Request

JavaScriptCurl

const response = await fetch('/api/v1/registries/{registryId}/activate', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "error": "text",
  "message": "text"
}

Issue/Publish/Revoke Claims

The Issuer can issuer a single claim or a batch of multiple claims, newly created claims will have the "Pending" status, which mean that they are ready to be published to the blockchain networks.

Issue list claim

Issue list claim

POST/api/v1/claims/issue/{issuerId}

Authorization

Authorization

Path parameters

issuerIdstring

issuerId

Body

application/json

holderIdstring

registryIdstring

dataobject

Response

400default

Error

Body

application/json

errorstring

messagestring

Request

JavaScriptCurl

const response = await fetch('/api/v1/claims/issue/{issuerId}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {}
    ]),
});
const data = await response.json();

Response

{
  "error": "text",
  "message": "text"
}

While the claims can be created by Operators, only the Admin user can publish claims to the blockchain.

Publish all PENDING claims

Publish all PENDING claims

POST/api/v1/claims/publish/{issuerId}

Authorization

Authorization

Path parameters

issuerId*string

issuerId

Body

application/json

signatureobject

Response

400default

Error

Body

application/json

errorstring

messagestring

Request

JavaScriptCurl

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

Response

{
  "error": "text",
  "message": "text"
}

Published claims can be revoked if they need to be deprecated. Revoked or expired claims can not be used to generate a valid ZK attestation.

Revoke list claims

Revoke list claims

POST/api/v1/claims/revoke-list/{issuerId}

Authorization

Authorization

Path parameters

issuerId*string

issuerId

Body

application/json

revNoncesarray of integer (int64)

Response

400default

Error

Body

application/json

errorstring

messagestring

Request

JavaScriptCurl

const response = await fetch('/api/v1/claims/revoke-list/{issuerId}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "error": "text",
  "message": "text"
}

Revoke all PENDING_REVOKE claims

Revoke all PENDING_REVOKE claims

POST/api/v1/claims/revoke/{issuerId}

Authorization

Authorization

Path parameters

issuerId*string

issuerId

Body

application/json

signatureobject

Response

400default

Error

Body

application/json

errorstring

messagestring

Request

JavaScriptCurl

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

Response

{
  "error": "text",
  "message": "text"
}

Issuance history

The history of issuing, publishing, and revoking can be easily traced as it was recored in the blockchain.

Query claims

Query claims

GET/api/v1/claims

Query parameters

Response

400default

Error

Body

application/json

errorstring

messagestring

Request

JavaScriptCurl

const response = await fetch('/api/v1/claims', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "error": "text",
  "message": "text"
}

Resources

pageIdentity SDK

pageServices' API Specification

ziden-devGitHub