> For the complete documentation index, see [llms.txt](https://docs.hashkey.id/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hashkey.id/how-to/issuer-a-credential/step-2-create-a-credential-and-submit/claim-rules.md).

# Claim rules

There are three types of rules you can use:

* [Own a Hashket DID](#1.-own-a-hashkey-did)
* [White list](#2.-white-list)
* [Custom API](#3.-custom-api)

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.

![](/files/e7eI70vTPqUam8dEU9ky)

## 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.

![](/files/DY07Np5rpvY45msrQMjy)

**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.

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 '[Manage your credential](/how-to/manage-your-credential.md)'.

## 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.

![](/files/grxo8YcYsHqF4bjDe946)

**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 Endpoint:**\
\*\*\*\*This is a required field. You need to enter a full API URL. For API writing methods, please refer to '[Credential API Rule](/developers/guides/credential-api-rule.md)' for details.

**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.

***


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.hashkey.id/how-to/issuer-a-credential/step-2-create-a-credential-and-submit/claim-rules.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.