> For the complete documentation index, see [llms.txt](https://docs.udara360.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.udara360.io/core-features/e-channels/open-api.md).

# Open API

The Open API page allows you to create and manage API integrations that give third-party applications and fintech partners access to Udara360's banking services. Each integration is issued a unique client ID and secret, and configured with its own webhook, token expiry, fee settings, and transaction permissions. This is the page to come to when onboarding a new API consumer, updating an existing integration's settings, or regenerating credentials that have been compromised. This guide will walk you through all actions available on the Open API page.

## Accessing Open API

1. Log into the application using your credentials.
2. From the dashboard, navigate to **E-Channels** in the side menu.
3. Expand **E-Channels** and Select **Open API** from the dropdown list

<figure><img src="/files/eDOWaUhfA6vJFPCEEDbF" alt=""><figcaption></figcaption></figure>

## Adding an Open API Integration

1. Click the **Add** button at the top left of the page
2. Fill in the following fields in the Create Open API form:

| Field                                                    | Description                                                                                      |
| -------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| Account Number                                           | The account number linked to this API integration                                                |
| Email                                                    | The email address of the API consumer                                                            |
| Webhook URL                                              | The URL where webhook notifications will be sent                                                 |
| Webhook Username                                         | The username for webhook authentication                                                          |
| Webhook Password                                         | The password for webhook authentication                                                          |
| JWT Token Expiration (In Minutes)                        | The number of minutes before the JWT token expires                                               |
| Dynamic Account Fee GL                                   | The GL account for dynamic account fees                                                          |
| Permit Transactions On GL Accounts                       | Select Yes to allow transactions on GL accounts, or No to restrict them                          |
| Permit Transfers From Account Without Parent Customer Id | Select Yes to allow transfers from accounts without a parent customer ID, or No to restrict them |
| Special Accounts For Debit Override Access               | If the above is set to Yes, enter the specific accounts that are still permitted to transfer     |
| Notification Preference                                  | Select the preferred notification method from the dropdown                                       |
| Notify Account Record Type Scope                         | Select the account record type scope for notifications from the dropdown                         |
| Limit Report To Profile Owner                            | Toggle on to restrict report visibility to the profile owner only                                |
| Allow Outward Fee Override                               | Toggle on to allow the API integration to override the global outward transfer fee               |

3. Click **Save** to create the integration

<figure><img src="/files/hQw8ImgacYp8JcyuBvs1" alt=""><figcaption></figcaption></figure>

## Managing an Integration

In the Actions column, click the three vertical dots (⋮) next to the integration you want to action and select from the following:

| Action                   | Description                                                                                            |
| ------------------------ | ------------------------------------------------------------------------------------------------------ |
| Modify                   | Update the integration's settings                                                                      |
| View                     | View the full integration details                                                                      |
| Deactivate               | Disable the integration                                                                                |
| Regenerate Client Secret | Generate a new client secret for the integration, use this if the existing secret has been compromised |

## Filtering the Records

1. Click the **Filter** button at the top right of the page
2. Enter or select your preferred filter criteria
3. Click **Apply** to display the filtered results

<figure><img src="/files/332Ubhq2IjVPVsmkkFC0" alt=""><figcaption></figcaption></figure>

> :pushpin:Click Reset Filter to clear all applied filters and return to the full list.
