--- title: API Users - What they are and how to use them description: An API User is a special account created for your group that is able to access the API as a regular User would. They have much more visibility and flexibility to build on top of our API. --- [Skip to content](https://zcash-pool-faq.foundrydigital.com/api-users-what-they-are-and-how-to-use-them#main-content) English Show submenu for translations ![foundryzcashpool\_logo\_inverse (2)](https://zcash-pool-faq.foundrydigital.com/hs-fs/hubfs/foundryzcashpool_logo_inverse%20(2).png?width=250&height=79&name=foundryzcashpool_logo_inverse%20(2).png) - [Foundry Home](https://foundrydigital.com/) Open main navigation Close main navigation - [Foundry Home](https://foundrydigital.com/) - English Show submenu for translations Hello. How can we help you? - There are no suggestions because the search field is empty. 1. [Foundry ZCash Pool Knowledge Base](https://zcash-pool-faq.foundrydigital.com/?hsLang=en) 2. [API](https://zcash-pool-faq.foundrydigital.com/api?hsLang=en) # API Users - What they are and how to use them ### What is an API User? An API User is a special account created for your group that is able to access the API as a regular User would. They have much more visibility and flexibility to build on top of our API. ### Prerequisites to create an API User In order to create an API User, the Foundry Zcash Pool team will need the following: 1. **A Request**: An email requesting a new API user should be sent to [zcash-support@foundrydigital.com](mailto:zcash-support@foundrydigital.com) with the following information: 1. An **email address** that is not already in use. If you wish to reuse an email that is already taken, *plus addressing*  is a valid alternative ([Plus Addressing in Exchange Online](https://learn.microsoft.com/en-us/exchange/recipients-in-exchange-online/plus-addressing-in-exchange-online)). *For example, If* [*john.doe@example.com*](mailto:john.doe@example.com) *is in use, you can use* [*john.doe+api@example.com*](mailto:john.doe+api@example.com) *instead*. 2. **Full name** and **Preferred name**. These can be the same value. 3. The API User **role** in the pool: Owner, Technician or Accountant. 4. List of IP’s to whitelist: **Only mandatory if the role of the API User is owner.** 5. **Company name** under which the API User will be created. 2. **Group owner’s written approval**: This is unrelated to the approval-request flow inside Foundry Pool. You need to provide explicit written consent from an owner of the group. ### API User: First Steps After receiving the confirmation that the API User has been created, it will be ready for activation. #### ![:white\_check\_mark:](https://foundrydigitalllc.atlassian.net/gateway/api/emoji/d81a8704-03c7-4022-b055-5896edda14ac/2705/path) Activation of an API User Upon creation, the API User will receive a new email from *zcash-support@foundrydigital.com* with the subject **Verify your email,** requesting to confirm the user account. Click on **Confirm my account**. #### ![:key:](https://foundrydigitalllc.atlassian.net/gateway/api/emoji/d81a8704-03c7-4022-b055-5896edda14ac/1f511/path) Set up a Password for the API User API Users need a password to be able to obtain an Access Token that will be used to interact with the endpoints of Foundry Pool’s REST API. In order to create a password for an API User, follow these steps: 1. Navigate to [Foundry Zcash Pool](https://zcashpool.foundrydigital.com) 2. Enter the email address used for the API User 3. Click on **Forgot password?** 4. Enter the API User email in the email field and click **Continue** 5. The API User email will receive a new email from *zcash*-*support@foundrydigital.com* with the subject **Reset your password.** Follow the directions in the email to set the password for the account. 6. Login with the email and new password.![](blob:https://foundrydigitalllc.atlassian.net/eb8f69e7-5ec0-4059-8b0a-479b80718cf9#media-blob-url=true&id=9c109321-8b57-4b18-8a9b-c31138020609&collection=contentId-1418788871&contextId=1418788871&height=608&width=461&alt=)   ### How to use an API User API Users can interact with the Pool’s REST API endpoints by simply passing an Access Token as the value for the Authorization header. ⚠️ In order to **get an Access Token for an API User**, send a GET HTTP Request to the endpoint *https://api.zcashpool.foundrydigital.com/access\_token* and pass the API User email and password as values of the Email-Address and Password headers respectively. ![:blue\_book:](https://foundrydigitalllc.atlassian.net/gateway/api/emoji/d81a8704-03c7-4022-b055-5896edda14ac/1f4d8/path) [See the Access Token endpoint documentation](https://api.zcashpool.foundrydigital.com/#api-Access_Token-GetAccess_token) - [FAQs](https://zcash-pool-faq.foundrydigital.com/faqs?hsLang=en) - [Reports](https://zcash-pool-faq.foundrydigital.com/reports?hsLang=en) - [API](https://zcash-pool-faq.foundrydigital.com/api?hsLang=en) - [Controls and Security](https://zcash-pool-faq.foundrydigital.com/controls-and-security?hsLang=en) - [Payouts](https://zcash-pool-faq.foundrydigital.com/payouts?hsLang=en#main-content) - [Payout Addresses](https://zcash-pool-faq.foundrydigital.com/payouts?hsLang=en#payout-addresses) - [Stratum](https://zcash-pool-faq.foundrydigital.com/stratum?hsLang=en#main-content) - [Proxy](https://zcash-pool-faq.foundrydigital.com/stratum?hsLang=en#proxy) - [Workers](https://zcash-pool-faq.foundrydigital.com/workers?hsLang=en) - [Nodes](https://zcash-pool-faq.foundrydigital.com/nodes?hsLang=en) - [Alerts](https://zcash-pool-faq.foundrydigital.com/alerts?hsLang=en) - [Hashrate](https://zcash-pool-faq.foundrydigital.com/hashrate?hsLang=en) - [Sub-accounts](https://zcash-pool-faq.foundrydigital.com/sub-accounts?hsLang=en) - [Statistics](https://zcash-pool-faq.foundrydigital.com/statistics?hsLang=en#main-content) - [Shares](https://zcash-pool-faq.foundrydigital.com/statistics?hsLang=en#shares) - [Mining](https://zcash-pool-faq.foundrydigital.com/mining?hsLang=en) - [Feedback](https://zcash-pool-faq.foundrydigital.com/feedback?hsLang=en) - [Users](https://zcash-pool-faq.foundrydigital.com/users?hsLang=en) - [Foundry Home](https://foundrydigital.com/) ## Foundry Digital LLC Copyright © 2026, Foundry Digital LLC