> For the complete documentation index, see [llms.txt](https://docs.guild.xyz/guild/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.guild.xyz/guild/how-to-setup-requirements/custom-api-call.md).

# Custom API call

Check external APIs to verify member data or conditions not available on Guild. Perfect for integrating with custom databases, third-party services, or proprietary verification systems.

#### Setting up Custom API Call requirements:

* In the role editor, click **"Add requirements"** and select **Custom API Call**
* Enter the **URL** of your API endpoint, including any path and query parameters
* Use the literal template token `<ACCOUNT_ID>` anywhere you need to insert the user's wallet address:
  * Example: `https://my-api.com/wallets/<ACCOUNT_ID>/balance`
  * When verified: Guild replaces `<ACCOUNT_ID>` with the actual wallet address like `0x123..`
* If needed, add **Body of the request** - JSON data to send with your API call
* If needed, add **Headers of the request** - Custom headers like authentication tokens or content types
  * Click **"+ Add more"** to include multiple headers
* Select the **HTTP method** (GET, POST)
* Set the **Key** - Specify which field in the API response to check (e.g., `status`, `verified`, `balance`)
* Set the **Value** - Define what the response value should be (you can choose from equal, greater than, less than, etc.)
* Add custom image and name for the requirement if you want
* Click **"Add requirement"**

{% hint style="danger" %}
API calls made by Guild are public and can be reproduced by anyone with technical knowledge. Do not rely on this feature for sensitive data or assume the requests are private.
{% endhint %}

When members verify requirements, Guild calls your specified API endpoint and checks if the response contains the expected key-value pair. The member's wallet address is automatically inserted wherever you use `<ACCOUNT_ID>`.

Please ensure your API endpoint can handle Guild's verification requests and returns consistent JSON responses. Consider rate limiting and authentication for security.


---

# 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.guild.xyz/guild/how-to-setup-requirements/custom-api-call.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.