> For the complete documentation index, see [llms.txt](https://docs.xyb.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xyb.co/manage-employees-roles-and-permissions/define-permissions.md).

# Understanding & Creating Permissions

**Permissions** define what actions users can take within your digital banking platform, such as viewing account data, approving payments, or managing employees. They are the building blocks of access control, allowing you to tailor user capabilities based on roles and responsibilities.

### How Permissions Work

Many **core permissions are auto-created by the system** based on services like:

* Ledger
* Payments
* Accounts
* Access Management

These built-in permissions typically cover standard operations like read (`*_r`), write (`*_w`), and approve (`*_a`). These cannot be modified but are always available for use when assigning roles.

### When to Create Custom Permissions

While core permissions are system-generated, **admins can create additional permissions** to support custom workflows or more granular access control. For example, you might need a permission for:

* Viewing only flagged transactions
* Approving high-value payments over a certain threshold
* Accessing internal reporting tools

To create a new permission:

1. In the Manage Permissions screen, click **Add New**.
2. In the Add a new permission screen, select the applicable instruction.\
   ![](https://1792085566-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkIq1PGbSmC3vQR1DFPNM%2Fuploads%2Fgit-blob-8db0a8fa89f28d0a21d43ab16193794954725ef5%2Fimage.png?alt=media)
3. Type a suggestive name and description of the permission.\
   Example permissions:
   * `ledger-svc/view_large_txns_r` — View transactions over a set amount
   * `employee-svc/update_roles_w` — Edit employee role assignments
   * `chart-svc/structure_preview_r` — View chart of accounts structure without edit access

**Naming convention for permissions**

Use the following format:

```
<service-name>/<action>_<suffix>
```

* **Service Name**: identifies the module (e.g., `employee-mgmt`, `ledger`, `access-mgmt`)
* **Action**: describes what the permission allows
* **Suffix**:
  * `_r` = read/view
  * `_w` = write/create/edit

{% content-ref url="/pages/6fiDIIoZSMbzsorI0i1A" %}
[Create Roles with Permissions](/manage-employees-roles-and-permissions/create-roles-with-permissions.md)
{% endcontent-ref %}

4. Click **Add a permission** to confirm.

You can add all the necessary permissions and then proceed to creating the roles.

***

### Best Practices

* Use consistent naming conventions (e.g., `*_r` for read, `*_w` for write).
* Regularly audit inactive permissions.
* Always provide a meaningful reference to clarify what each permission does.

***


---

# 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.xyb.co/manage-employees-roles-and-permissions/define-permissions.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.