Tutorials

Register as a Verifier

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

Create new Verifier

Register new Verifier

POST/api/v1/verifiers/registration

Body

multipart/form-data

A full JSON object of Verifier registration data

verifierIdstring

namestring

descriptionstring

contactstring

websitestring

verifierLogofile

Response

200

A JSON object of Verifier

Body

application/json

any

Request

JavaScriptCurl

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

Edit Verifier information

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

Update verifier profile

Update verifier profile

PUT/api/v1/verifiers/{verifierId}/profiles

Authorization

Authorization

Path parameters

verifierId*string

DID of Verifier

Body

multipart/form-data

A full JSON object of Verifier registration data

namestring

descriptionstring

contactstring

websitestring

verifierLogofile

Response

200

A JSON object of Verifier

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('/api/v1/verifiers/{verifierId}/profiles', {
    method: 'PUT',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Create operators with roles

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

Each Verifiers 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.

Find Verifier's Operators

Query all operators of an Verifier

GET/api/v1/verifiers/{verifierId}/operators

Path parameters

verifierId*string

DID of Verifier

Response

200

A JSON object

Body

application/json

operatorsarray of object

Request

JavaScriptCurl

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

Response

{
  "operators": [
    {
      "operatorId": "text",
      "createdAt": "2024-04-29"
    }
  ]
}

Add a Operator

Add new Operator for an Verifier

POST/api/v1/verifiers/{verifierId}/operators

Authorization

Authorization

Path parameters

verifierId*string

DID of Verifier

Body

application/json

DID of Operator

operatorIdstring

Response

200

A JSON object of Operator

Body

application/json

operatorIdstring

createdAtstring (date)

Request

JavaScriptCurl

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

Response

{
  "operatorId": "text",
  "createdAt": "2024-04-29"
}

Remove a Operator

Remove existing Operator for an Verifier

DELETE/api/v1/verifiers/{verifierId}/operators/{operatorId}

Authorization

Authorization

Path parameters

verifierId*string

DID of Verifier

operatorId*string

DID of OperatorId

Response

200

A JSON object of Operator

Body

application/json

object

Request

JavaScriptCurl

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

Create/Manage Services

Each Service consists of a set of requirements so that the Verifier can utilize them for their authentication/authorization process. The Holders will generate ZK attestation based on these requirements in order to be granted access for the service.

Create new Service

Register new Service

POST/api/v1/services

Authorization

Authorization

Body

application/json

A JSON form of Service

titleString

verifierIdstring

descriptionstring

requirementsarray of Requirement (object)

activeboolean

networkstring

nameString

networkIdstring

Response

200

A JSON object of Service

Body

application/json

any

Request

JavaScriptCurl

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

A registered service can not be deleted. Instead, the Verifier can activate/deactivate services to indicate which services are currently supported.

Activate/Deactivate Service

Toggle active status of a service

PUT/api/v1/services/{serviceId}/active

Authorization

Authorization

Path parameters

serviceId*string

Unique ID of Service

Response

200

A JSON object of update result

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('/api/v1/services/{serviceId}/active', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Resources

pageIdentity SDKpageServices' API Specification

ziden-devGitHub