Verifiable Credential

Please generate access token before proceeding. Once you generated the access_token, you can pass this token as bearer authorization token in the header for all APIs.

Issue a verifiable credential

An issuer may issue a verifiable credential to a subject using this API. The credential document is signed by issuer's identity key and its status is registered on the blockchain.

Entity Studio SSI API base URL: https://api.entity.hypersign.id

post

/api/v1/credential/issue

Authorizations

Header parameters

Authorizationstring

Bearer <access_token>

Originstring

Origin as you set in application cors

Body

schemaIdstring

schemaId for credential Schema

subjectDidstringrequired

holder did of the credential

issuerDidstringrequired

issuerDid of the credential

expirationDatestringrequired

Date in ISOString format

Example: 2027-12-10T18:30:00.000Z

namespacestringrequired

Namespace to be added in vcId.

Example: testnet

verificationMethodIdstringrequired

Verification Method id for did updation

Example: did:hid:testnet:........#key-${idx}

persistbooleanrequired

Persist in edv

Example: true

fieldsobjectrequired

Credential Data fields

Example: {"name":"Random name"}

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/credential/issue' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "schemaId": "text",
    "subjectDid": "text",
    "issuerDid": "text",
    "expirationDate": "2027-12-10T18:30:00.000Z",
    "namespace": "testnet",
    "verificationMethodId": "did:hid:testnet:........#key-${idx}",
    "persist": "true",
    "fields": {
      "name": "Random name"
    }
  }'

201

400

404

201

{
  "persist": true,
  "credentialDocument": {
    "id": "vc:hid:testnet:......",
    "expirationDate": "2027-12-10T18:30:00Z",
    "issuanceDate": "2027-12-10T18:30:00Z",
    "issuer": "did:hid:testnet:..........",
    "type": [
      "VerifiableCredential",
      "nameschema"
    ],
    "@context": [
      "https://www.w3.org/2018/credentials/v1",
      {
        "hs": "https://api.jagrat.hypersign.id/hypersign-protocol/hidnode/ssi/schema/sch:hid:testnet:...........:1.0:"
      },
      {
        "name": "hs:name"
      },
      "https://w3id.org/security/suites/ed25519-2020/v1"
    ],
    "credentialSubject": {
      "id": "did:hid:testnet:..............."
    },
    "credentialSchema": {
      "id": "sch:hid:testnet:...............",
      "type": "JsonSchemaValidator2018"
    },
    "credentialStatus": {
      "id": "https://api.jagrat.hypersign.id/hypersign-protocol/hidnode/ssi/credential/vc:hid:testnet:...............",
      "type": "CredentialStatusList2017"
    },
    "proof": {
      "type": "Ed25519Signature2020",
      "created": "2023-01-25T17:01:02Z",
      "verificationMethod": "did:hid:testnet:...............#key-${id}",
      "proofPurpose": "assertionMethod",
      "proofValue": "z5LairjrBYkc5FtP.......................EXFHm37aDvcMtCvnYfmvQ"
    }
  },
  "credentialStatus": {
    "issuer": "did:hid:testnet:..............",
    "issuanceDate": "2023-01-25T16:59:21Z",
    "expirationDate": "2023-01-25T16:59:21Z",
    "credentialHash": "ae93886f2a............3f6d1c6ae4..........393d43730",
    "claim": {
      "id": "vc:hid:testnet:................",
      "currentStatus": "vc:hid:testnet:................",
      "statusReason": "Credential is active"
    }
  }
}

Credential Created

NOTE: A developer may choose to store the verifiable credential in application's data vault securely or they may not to. Pass true for request body property persist to store the credential document, false otherwise.

Verify an issued verifiable credential document

A signed verifiable credential must has signature of the issuer. Any one may verify an issued credential document. The verification result state the following facts:

• This document was issued by intended issuer

• This document have not been tampered

• This document have not been revoked

post

/api/v1/credential/verify

Authorizations

Header parameters

Authorizationstring

Bearer <access_token>

Originstring

Origin as you set in application cors

Body

credentialDocumentall ofrequired

credential document

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/credential/verify' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "credentialDocument": {
      "id": "vc:hid:testnet:......",
      "expirationDate": "2027-12-10T18:30:00Z",
      "issuanceDate": "2027-12-10T18:30:00Z",
      "issuer": "did:hid:testnet:..........",
      "type": [
        "VerifiableCredential",
        "nameschema"
      ],
      "@context": [
        "https://www.w3.org/2018/credentials/v1",
        {
          "hs": "https://api.jagrat.hypersign.id/hypersign-protocol/hidnode/ssi/schema/sch:hid:testnet:...........:1.0:"
        },
        {
          "name": "hs:name"
        },
        "https://w3id.org/security/suites/ed25519-2020/v1"
      ],
      "credentialSubject": {
        "id": "did:hid:testnet:..............."
      },
      "credentialSchema": {
        "id": "sch:hid:testnet:...............",
        "type": "JsonSchemaValidator2018"
      },
      "credentialStatus": {
        "id": "https://api.jagrat.hypersign.id/hypersign-protocol/hidnode/ssi/credential/vc:hid:testnet:...............",
        "type": "CredentialStatusList2017"
      },
      "proof": {
        "type": "Ed25519Signature2020",
        "created": "2023-01-25T17:01:02Z",
        "verificationMethod": "did:hid:testnet:...............#key-${id}",
        "proofPurpose": "assertionMethod",
        "proofValue": "z5LairjrBYkc5FtP.......................EXFHm37aDvcMtCvnYfmvQ"
      }
    }
  }'

200

400

404

200

{
  "verified": true,
  "results": [
    {
      "verified": true,
      "proof": {
        "type": "Ed25519Signature2020",
        "created": "2023-01-25T17:01:02Z",
        "verificationMethod": "did:hid:testnet:...............#key-${id}",
        "proofPurpose": "assertionMethod",
        "proofValue": "z5LairjrBYkc5FtP.......................EXFHm37aDvcMtCvnYfmvQ",
        "Context": [
          "https://www.w3.org/2018/credentials/v1",
          {
            "hs": "https://api.jagrat.hypersign.id/hypersign-protocol/hidnode/ssi/schema/sch:hid:testnet:z3KX4ZqoizKTaED645aV4aE8dBbnSpmQYe3xfzVBJadPY:1.0:"
          },
          {
            "name": "hs:name"
          },
          "https://w3id.org/security/suites/ed25519-2020/v1"
        ]
      },
      "verificationMethod": {
        "id": "did:hid:testnet:................................#key-${id}",
        "type": "Ed25519VerificationKey2020",
        "controller": "did:hid:method:..............",
        "publicKeyMultibase": "z28ScfSszr.............j8nCwx4DBF6nAUHu4p"
      },
      "purposeResult": {
        "valid": true
      }
    }
  ],
  "statusResult": {
    "verified": true
  }
}

verification result of credential

NOTE: Verifying a credential document is different than verifying a verifiable presentation. Verification result of later, also states that "Only intended subject holds this document and not one else".

Fetch a verifiable credential and/or its status by Id

get

/api/v1/credential/{credentialId}

Authorizations

Path parameters

credentialIdstringrequired

Query parameters

retrieveCredentialboolean

Header parameters

Authorizationstring

Bearer <access_token>

Originstring

Origin as you set in application cors

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/credential/{credentialId}' \
  --header 'Authorization: Bearer JWT'

200

404

200

{
  "persist": true,
  "retrieveCredential": true,
  "credentialDocument": {
    "id": "vc:hid:testnet:......",
    "expirationDate": "2027-12-10T18:30:00Z",
    "issuanceDate": "2027-12-10T18:30:00Z",
    "issuer": "did:hid:testnet:..........",
    "type": [
      "VerifiableCredential",
      "nameschema"
    ],
    "@context": [
      "https://www.w3.org/2018/credentials/v1",
      {
        "hs": "https://api.jagrat.hypersign.id/hypersign-protocol/hidnode/ssi/schema/sch:hid:testnet:...........:1.0:"
      },
      {
        "name": "hs:name"
      },
      "https://w3id.org/security/suites/ed25519-2020/v1"
    ],
    "credentialSubject": {
      "id": "did:hid:testnet:..............."
    },
    "credentialSchema": {
      "id": "sch:hid:testnet:...............",
      "type": "JsonSchemaValidator2018"
    },
    "credentialStatus": {
      "id": "https://api.jagrat.hypersign.id/hypersign-protocol/hidnode/ssi/credential/vc:hid:testnet:...............",
      "type": "CredentialStatusList2017"
    },
    "proof": {
      "type": "Ed25519Signature2020",
      "created": "2023-01-25T17:01:02Z",
      "verificationMethod": "did:hid:testnet:...............#key-${id}",
      "proofPurpose": "assertionMethod",
      "proofValue": "z5LairjrBYkc5FtP.......................EXFHm37aDvcMtCvnYfmvQ"
    }
  },
  "credentialStatus": {
    "issuer": "did:hid:testnet:..............",
    "issuanceDate": "2023-01-25T16:59:21Z",
    "expirationDate": "2023-01-25T16:59:21Z",
    "credentialHash": "ae93886f2a............3f6d1c6ae4..........393d43730",
    "claim": {
      "id": "vc:hid:testnet:................",
      "currentStatus": "vc:hid:testnet:................",
      "statusReason": "Credential is active"
    },
    "proof": {
      "type": "Ed25519Signature2020",
      "created": "2023-01-25T17:01:02Z",
      "verificationMethod": "did:hid:testnet:...............#key-${id}",
      "proofPurpose": "assertionMethod",
      "proofValue": "z5LairjrBYkc5FtP.......................EXFHm37aDvcMtCvnYfmvQ",
      "updated": "2023-01-25T17:01:02Z"
    }
  }
}

Resolved credential detail

Pass false value to parameter retrieveCredential to only retrieve status of the credential

Fetch list of verifiable credentials

get

/api/v1/credential

Authorizations

Query parameters

pagenumber · default: 1

Page value

limitnumber · default: 10

Fetch limited list of data

Header parameters

Authorizationstring

Bearer <access_token>

Originstring

Origin as you set in application cors

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/credential' \
  --header 'Authorization: Bearer JWT'

200

404

200

[
  {
    "totalCount": 12,
    "data": [
      "vc:hid:testnet:............"
    ]
  }
]

List of credentials

Update credential status of a verifiable credential

patch

/api/v1/credential/status/{credentialId}

Authorizations

Path parameters

credentialIdstringrequired

Header parameters

Authorizationstring

Bearer <access_token>

Originstring

Origin as you set in application cors

Body

namespacestringrequired

Namespace to be added in vcId.

Example: testnet

statusstringrequired

Credential status

Example: LIVE / SUSPEND / REVOKE

statusReasonstringrequired

Credential status Reason

Example: Reason

issuerDidstringrequired

issuerDid of the credential

verificationMethodIdstringrequired

Verification Method id for did updation

Example: did:hid:testnet:........#key-${idx}

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/api/v1/credential/status/{credentialId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "namespace": "testnet",
    "status": "LIVE / SUSPEND / REVOKE",
    "statusReason": "Reason",
    "issuerDid": "text",
    "verificationMethodId": "did:hid:testnet:........#key-${idx}"
  }'

200

400

404

200

{
  "persist": true,
  "retrieveCredential": true,
  "credentialDocument": {
    "id": "vc:hid:testnet:......",
    "expirationDate": "2027-12-10T18:30:00Z",
    "issuanceDate": "2027-12-10T18:30:00Z",
    "issuer": "did:hid:testnet:..........",
    "type": [
      "VerifiableCredential",
      "nameschema"
    ],
    "@context": [
      "https://www.w3.org/2018/credentials/v1",
      {
        "hs": "https://api.jagrat.hypersign.id/hypersign-protocol/hidnode/ssi/schema/sch:hid:testnet:...........:1.0:"
      },
      {
        "name": "hs:name"
      },
      "https://w3id.org/security/suites/ed25519-2020/v1"
    ],
    "credentialSubject": {
      "id": "did:hid:testnet:..............."
    },
    "credentialSchema": {
      "id": "sch:hid:testnet:...............",
      "type": "JsonSchemaValidator2018"
    },
    "credentialStatus": {
      "id": "https://api.jagrat.hypersign.id/hypersign-protocol/hidnode/ssi/credential/vc:hid:testnet:...............",
      "type": "CredentialStatusList2017"
    },
    "proof": {
      "type": "Ed25519Signature2020",
      "created": "2023-01-25T17:01:02Z",
      "verificationMethod": "did:hid:testnet:...............#key-${id}",
      "proofPurpose": "assertionMethod",
      "proofValue": "z5LairjrBYkc5FtP.......................EXFHm37aDvcMtCvnYfmvQ"
    }
  },
  "credentialStatus": {
    "issuer": "did:hid:testnet:..............",
    "issuanceDate": "2023-01-25T16:59:21Z",
    "expirationDate": "2023-01-25T16:59:21Z",
    "credentialHash": "ae93886f2a............3f6d1c6ae4..........393d43730",
    "claim": {
      "id": "vc:hid:testnet:................",
      "currentStatus": "vc:hid:testnet:................",
      "statusReason": "Credential is active"
    },
    "proof": {
      "type": "Ed25519Signature2020",
      "created": "2023-01-25T17:01:02Z",
      "verificationMethod": "did:hid:testnet:...............#key-${id}",
      "proofPurpose": "assertionMethod",
      "proofValue": "z5LairjrBYkc5FtP.......................EXFHm37aDvcMtCvnYfmvQ",
      "updated": "2023-01-25T17:01:02Z"
    }
  }
}

Credential Updated