HashKey DID
  • Introduction
  • FAQ
  • Terminology
  • Developers
    • Guides
      • Register
      • Query
      • Libraries
      • Credential API Rule
    • API Reference
      • OpenAPI
      • OpenAPI For Dfinity
  • Protocol
    • Resolver
    • KYC
    • Multi-Chain
    • Credential
    • DID as NFT
    • Deployment
    • Contract API Reference
      • Registry
      • BasicInfo
      • PublicResolver
      • KYC
      • LayerZero
      • Credential
  • How to
    • Become an issuer
    • Edit issuer info
    • Issue a credential
      • Step 1: Deploy a contract
      • Step 2: Create a credential and submit
        • Claim rules
      • Step 3: Issue a credential
    • Manage your credentials
  • Support
    • Brand Kit
Powered by GitBook
On this page
  • 1. Own a HashKey DID
  • 2. White list
  • 3. Custom API
  1. How to
  2. Issue a credential
  3. Step 2: Create a credential and submit

Claim rules

PreviousStep 2: Create a credential and submitNextStep 3: Issue a credential

Last updated 2 years ago

There are three types of rules you can use:

You can choose any one, two or all of them. We will explain each rule below.

1. Own a HashKey DID

For each credential, this rule can only be used once. This rule means only users with a HashKey DID are eligible to claim the credential.

2. White list

For each credential, this rule can only be used once. __This rule means only users in the whitelist are able to claim the credential. The whitelist can only be set after adding this rule.

Rule description: ****This is a required field. A specific description of this rule will be displayed to the users.

Event URL: ****This is an optional field. If you have an additional link for this rule, please add them here.

3. Custom API

For each credential, this rule can be used multiple times. __This rule means only users who meet the API requirements are able to claim the credential.

Rule description: ****This is a required field. A specific description of this rule will be displayed to the users.

Event URL: ****This is an optional field. If you have an additional link for this rule, please add them here.

API Test Module: ****In the Custom API rules, we also provide the API Test Module. You could enter an address to test whether this API is usable. We currently only support addresses starting with 0x.


If any White list rule is added, The whitelist can be added after the credential is created. For how to add a whitelist, please refer to ''.

API Endpoint: ****This is a required field. You need to enter a full API URL. For API writing methods, please refer to '' for details.

Manage your credential
Credential API Rule
Own a Hashket DID
White list
Custom API