---
updatedAt: 2026-10-16T15:25:34.000Z
agentTools:
  projectIndex: https://docs.corefy.com/llms.txt
---

# Create API key

**API keys** are the elements that can significantly reinforce security and data control. The main idea behind the **API key** usability is that the keys can be assigned to specific accounts and establish obligatory permissions to restrict unauthorised access.<br />In this guide, you can learn how to create the **API key** and set up the permissions appropriately.

## Create API key via Dashboard

1. Go to the **Merchants** tab and click the **Merchant account** on the grid.
2. If you have not created the **Merchant account**, go to the [Add Merchant account](https://docs.corefy.com/docs/add-merchant-account) guide to learn the details.
3. Then, navigate to the **Developers** tab of the specific **Merchant account** and click **Add API key**.
4. Fill in the **General information** block. Select the key **Type**.

<HTMLBlock>{`
<table class="custom-table_1">
  <tr>
    <td class="header-main">Key Type</td>
    <td class="header-main">Description</td>
  </tr>
  <tr>
  <td class="header-sub">Live</td>
  <td>The <strong>Live key</strong> sets access only to live permissions. Ensure you check all the preconditions via the <strong>Live key</strong> before initiating the integration process.</td>
  </tr>
  <tr>
  <td class="header-sub">Test</td>
  <td>The <strong>Test key</strong> specifies access only to test permissions. It is safe to use this key in the test environment. Its principal function is to examine and test the API integrations carefully.</td>
  </tr>
</table>
<style> 
  
  :root {
    --custom-light-head: 236, 245, 254; 
    --custom-light-sub-head: 247, 250, 252; 
    --custom-light-row: 247, 250, 252;
    --custom-dark-head: 52, 71, 84;  
    --custom-dark-sub-head: 46, 58, 66;  
    --custom-dark-row: 46, 58, 66; 
  }
  [data-color-mode="light"] .custom-table_1 {
    --table-head: rgba(var(--custom-light-head), 1); 
    --table-sub-head: rgba(var(--custom-light-sub-head), 1); 
    --table-row: rgba(var(--custom-light-row), 0); 
    --table-stripe: rgba(var(--custom-light-row), 0);
  }
  [data-color-mode="dark"] .custom-table_1 {
    --table-head: rgba(var(--custom-dark-head), 1);
    --table-sub-head: rgba(var(--custom-dark-sub-head), 1); 
    --table-row: rgba(var(--custom-dark-row), 0); 
    --table-stripe: rgba(var(--custom-dark-row), 0); 
  }
  .custom-table_1 {
    width: 100%;
    border-collapse: collapse;
    padding: 10px; 
    text-align: left; 
    vertical-align: top; 
    border: 1px solid var(--table-edges, #dfe2e5);
  }
  .custom-table_1 .header-main {
    background: var(--table-head); 
    font-weight: bold;
  }
  .custom-table_1 .header-sub {
    background: var(--table-sub-head); 
    font-weight: bold; 
  }
</style> 
`}</HTMLBlock>

<Callout icon="far fa-triangle-exclamation" theme="warn">
  You can create a **Live API key** only if your **Organisation** has been activated. If your **Organisation** is in the created status and you cannot create a **Live API key**, [get connected with a Corefy payment expert](https://corefy.com/request-a-demo) to activate your **Organisation**.
</Callout>

5. After that, you can optionally enter the key **Name** and **Description**.
6. After you start the creation of the **API key**, it is crucial to establish the permissions due to security reasons. You can use our global presets to quickly configure all permission groups:

* **Merchant scope**

<HTMLBlock>{`
<table class="custom-table_1">
  <tr>
    <td class="header-main" colspan="2">Permission type →<br> 
Entities ↓</td>
    <td class="header-main">Read-only</td>
    <td class="header-main">Write</td>
    <td class="header-main">Full access</td>
  </tr>
  <tr>
  <td class="header-sub" rowspan="2">Customer</td>
  <td>View Customer</td>
    <td>✅</td>
    <td>❌</td>
    <td>✅</td> 
  </tr>
  <tr>
    <td>Edit Customer</td>
    <td>❌</td>
    <td>✅</td>
    <td>✅</td> 
  </tr> 
  <tr>
    <td class="header-sub" rowspan="2">Currency account</td>
    <td>View Currency account</td>
    <td>✅</td> 
    <td>❌</td>
    <td>✅</td> 
  </tr>
  <tr>
   <td>Edit Currency account</td>
    <td>❌</td>
    <td>✅</td>
    <td>✅</td>
  </tr>
  <tr>
    <td class="header-sub" rowspan="2">Merchant account</td>
    <td>View Merchant account</td>
    <td>✅</td>
    <td>❌</td>
    <td>✅</td> 
  </tr>
  <tr>
   <td>Edit Merchant account</td>
    <td>❌</td>
    <td>✅</td>
    <td>✅</td>
  </tr>
</table>
<style> 
  
  :root {
    --custom-light-head: 236, 245, 254; 
    --custom-light-sub-head: 247, 250, 252; 
    --custom-light-row: 247, 250, 252;
    --custom-dark-head: 52, 71, 84;  
    --custom-dark-sub-head: 46, 58, 66;  
    --custom-dark-row: 46, 58, 66; 
  }
  [data-color-mode="light"] .custom-table_1 {
    --table-head: rgba(var(--custom-light-head), 1); 
    --table-sub-head: rgba(var(--custom-light-sub-head), 1); 
    --table-row: rgba(var(--custom-light-row), 0); 
    --table-stripe: rgba(var(--custom-light-row), 0);
  }
  [data-color-mode="dark"] .custom-table_1 {
    --table-head: rgba(var(--custom-dark-head), 1);
    --table-sub-head: rgba(var(--custom-dark-sub-head), 1); 
    --table-row: rgba(var(--custom-dark-row), 0); 
    --table-stripe: rgba(var(--custom-dark-row), 0); 
  }
  .custom-table_1 {
    width: 100%;
    border-collapse: collapse;
    padding: 10px; 
    text-align: left; 
    vertical-align: top; 
    border: 1px solid var(--table-edges, #dfe2e5);
  }
  .custom-table_1 .header-main {
    background: var(--table-head); 
    font-weight: bold;
  }
  .custom-table_1 .header-sub {
    background: var(--table-sub-head); 
    font-weight: bold; 
  }
</style>
`}</HTMLBlock>

* **Payments scope**

<HTMLBlock>{`
<table class="custom-table_1">
  <tr>
    <td class="header-main" colspan="2">Permission type →<br> 
Entities ↓</td>
    <td class="header-main">Read-only</td>
    <td class="header-main">Write</td>
    <td class="header-main">Full access</td>
  </tr>
  <tr>
  <td class="header-sub" rowspan="2">Payment route</td>
  <td>View Payment route</td>
    <td>✅</td>
    <td>❌</td>
    <td>✅</td> 
  </tr>
  <tr>
    <td>Edit Payment route</td>
    <td>❌</td>
    <td>✅</td>
    <td>✅</td> 
  </tr> 
  <tr>
    <td class="header-sub" rowspan="2">Payment statement</td>
    <td>View Payment statement </td>
    <td>✅</td>
    <td>❌</td>
    <td>✅</td> 
  </tr>
  <tr>
   <td>Edit Payment statement </td>
    <td>❌</td>
    <td>✅</td>
    <td>✅</td>
  </tr>
  <tr>
    <td class="header-sub" rowspan="2">Payment transaction</td>
    <td>View Payment transaction </td>
    <td>✅</td>
    <td>❌</td>
    <td>✅</td> 
  </tr>
  <tr>
   <td>Edit Payment transaction</td>
    <td>❌</td>
    <td>✅</td>
    <td>✅</td>
  </tr>
   <tr>
    <td class="header-sub" rowspan="2">Payment commit</td>
    <td>View Payment commit</td>
    <td>✅</td>
    <td>❌</td>
    <td>✅</td> 
  </tr>
  <tr>
   <td>Edit Payment commit</td>
    <td>❌</td>
    <td>✅</td>
    <td>✅</td>
  </tr>
   <tr>
    <td class="header-sub" rowspan="2">Payment request</td>
    <td>View Payment request</td>
    <td>✅</td>
    <td>❌</td>
    <td>✅</td> 
  </tr>
  <tr>
   <td>Edit Payment request</td>
    <td>❌</td>
    <td>✅</td>
    <td>✅</td>
  </tr>
   <tr>
    <td class="header-sub" rowspan="2">Payment command</td>
    <td>View Payment command</td>
    <td>✅</td>
    <td>❌</td>
    <td>✅</td> 
  </tr>
  <tr>
   <td>Edit Payment command</td>
    <td>❌</td>
    <td>✅</td>
    <td>✅</td>
  </tr>
   <tr>
    <td class="header-sub" rowspan="2">Payment scheme</td>
    <td>View Payment scheme</td>
    <td>✅</td>
    <td>❌</td>
    <td>✅</td> 
  </tr>
  <tr>
   <td>Edit Payment scheme</td>
    <td>❌</td>
    <td>✅</td>
    <td>✅</td>
  </tr>
</table>
<style> 
  
  :root {
    --custom-light-head: 236, 245, 254; 
    --custom-light-sub-head: 247, 250, 252; 
    --custom-light-row: 247, 250, 252;
    --custom-dark-head: 52, 71, 84;  
    --custom-dark-sub-head: 46, 58, 66;  
    --custom-dark-row: 46, 58, 66; 
  }
  [data-color-mode="light"] .custom-table_1 {
    --table-head: rgba(var(--custom-light-head), 1); 
    --table-sub-head: rgba(var(--custom-light-sub-head), 1); 
    --table-row: rgba(var(--custom-light-row), 0); 
    --table-stripe: rgba(var(--custom-light-row), 0);
  }
  [data-color-mode="dark"] .custom-table_1 {
    --table-head: rgba(var(--custom-dark-head), 1);
    --table-sub-head: rgba(var(--custom-dark-sub-head), 1); 
    --table-row: rgba(var(--custom-dark-row), 0); 
    --table-stripe: rgba(var(--custom-dark-row), 0); 
  }
  .custom-table_1 {
    width: 100%;
    border-collapse: collapse;
    padding: 10px; 
    text-align: left; 
    vertical-align: top; 
    border: 1px solid var(--table-edges, #dfe2e5);
  }
  .custom-table_1 .header-main {
    background: var(--table-head); 
    font-weight: bold;
  }
  .custom-table_1 .header-sub {
    background: var(--table-sub-head); 
    font-weight: bold; 
  }
</style>
`}</HTMLBlock>

7. In case you need a different set of permissions that should cover the specific needs, you can create a **Custom** group of permissions. Simply switch on/off the specific permissions, and the system should automatically mark the group as **Custom**.

<Callout icon="🚧" theme="warn">
  ### Pay attention!

  You can establish the permissions only when creating the **API key** without the possibility to modify it later.
</Callout>

7. After selecting all the appropriate options, click **Create API key**.
8. The system initiates opening a modal stating that the key is successfully created. It also includes the key itself. Be aware that you can view or copy it only once.

<Image src="https://files.readme.io/93c616fb9081663e35df4771ffb95504787beb9a34a6e63246004f289d09ecb9-NEW_create_api_key.gif" align="center" border={true} />