> For the complete documentation index, see [llms.txt](https://docs.balkan.id/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.balkan.id/getting-started/setting-up-your-tenant/application-integrations/direct-application-integrations/venminder-integration-setup.md).

# Venminder Integration Setup

{% hint style="info" %}
The Venminder API is not included with the standard Venminder subscription. Contact your Venminder Relationship Manager or Account Executive to have it enabled before you begin.
{% endhint %}

### Getting Started

Use this guide to connect Venminder to your BalkanID tenant. You will need API credentials from the Venminder Admin Panel and access to the Integrations section in BalkanID.

#### Requirements:

Before you begin, collect the following values from Venminder:

* **API Key**
* **API Secret**

### Configure Venminder within your BalkanID tenant

1. In BalkanID, go to **Integrations** and click **Add integration**.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FzaZn5f66M2EXCYYCU8Cf%2Fvenminder-add-integration.png?alt=media" alt="The BalkanID Integrations page with the Add integration button in the top right"><figcaption><p>Integrations</p></figcaption></figure></div>

2. Search for Venminder, select it, and click **Next**.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FVIN7kAY00Rq95t0y6ODI%2Fvenminder-connect-application.png?alt=media" alt="The Connect a new application step with Venminder selected"><figcaption><p>Connect a new application</p></figcaption></figure></div>

3. To find the API Key and API Secret, sign in to Venminder as a user with the **Administrator** or **API Key Manager** role.
4. Click your avatar in the top right corner and select **Admin Panel**, then open the **System Settings** tab.
5. In the **Manage API User** section, click **Add API User**. Enter an **API User Name** and **Description**, set an **Expiration Date**, and select the **Read** checkbox under API Permissions.
6. Click **Submit**, then copy the **API Key** and **Secret**. The secret is displayed only once and cannot be retrieved after you close the window.
7. In BalkanID, paste those values into the corresponding fields, then click **Next.**

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FFkt1Q5IZU9f9FGYNqEUA%2Fvenminder-direct-configuration.png?alt=media" alt="The Direct Configuration step showing the API Key and API Secret fields"><figcaption><p>Direct Configuration</p></figcaption></figure></div>

8. Fill **Optional Configuration**, if required.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FZbipc8nl8LTFl5YsVIaj%2Foptional-configuration.png?alt=media" alt="The Optional Configuration step"><figcaption><p>Optional Configuration</p></figcaption></figure></div>

9. Once you have filled in the information, click **Save**. Your integration is now configured and you will see the status of the integration displayed alongside other integrations on the Integrations page. When data is available, the integration Status column will read **Connected** and the integration Message will read **Data available**.

### What BalkanID extracts

| Type               | Description                                                                    |
| ------------------ | ------------------------------------------------------------------------------ |
| **Users**          | Internal Venminder users, with their status and enrollment state               |
| **Roles**          | The roles assigned to those users                                              |
| **Business Units** | The business units users are assigned to, which scope the records they can see |

Venminder controls access on two independent axes: a role determines what a user can do, and a business unit determines which vendor records they can see. BalkanID extracts both, along with each user's role and business unit assignments.

External Venminder contacts are not extracted. They hold no roles or business unit assignments, so they carry no access to review.

### Integration Scopes

| Read Only Scopes                                                                                                 | Lifecycle Management Scopes |
| ---------------------------------------------------------------------------------------------------------------- | --------------------------- |
| **Read** — covers the contact list and business unit information used to extract users, roles and business units | N/A                         |

{% hint style="info" %}
Venminder API keys require an expiration date. Once a key expires, syncs stop until a new key is created in Venminder and entered in BalkanID.
{% endhint %}


---

# 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.balkan.id/getting-started/setting-up-your-tenant/application-integrations/direct-application-integrations/venminder-integration-setup.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.