> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Connecting Breach Secure Now to Neo

> Create a Breach Secure Now partner key and save it in Neo with the gateway API key

You connect Breach Secure Now once at the MSP level. Neo needs two values: your own **partner key**, and the **gateway API key** that BSN gives every partner.

## 1. Create the partner key

**1. Open the integration settings**

Sign in to the BSN portal as a **Partner Administrator**, select **Partner Profile**, then **Integrations** > **Setup**.

**2. Create a key**

Scroll below the partner integration offerings to **API Keys**. Click **Create Friendly Key**, name the key (for example "Neo Agent") and click **Generate Key**.

**3. Copy the key**

Copy the key with the copy button. It shows only once; if you lose it, delete it and generate a new one.

## 2. Find the gateway API key

The gateway API key is the `x-api-key` value printed in BSN's **Secure API Access** partner guide (step 14, item A). It is the same for every partner. If you do not have the guide, ask BSN's Operations team at [Operations@breachsecurenow.com](mailto:Operations@breachsecurenow.com).

> [!NOTE]
>
> BSN sells only through MSPs, so there is no per-client key: your partner key reads every one of your clients.

## 3. Add the keys in Neo

**1. Open Integrations**

In the Neo Dashboard, open **Integrations** and find the Breach Secure Now card, under Security Awareness Training.

**2. Save the keys**

Paste the **Gateway API key** and the **Partner key** and click **Save settings**. Neo reads your client list from BSN before saving, so a wrong key is rejected straight away.

## 4. Turn Breach Secure Now on per agent

Open the agent, go to its **Tools & Settings** tab, click **Security Awareness Training**, and expand the **Breach Secure Now** block. Pick the **Read Only** preset, or set each area yourself:

| Area | Access levels you can pick | Notes |
| - | - | - |
| **Client and User Statistics** | Disabled, Read Only | A client's totals and each user's name, email, last login, ESS, phishing fail rate, breaches and training. |
| **Clients** | Disabled, Read Only | Your active clients with their BSN client ids. |

BSN's API has no write, so no area offers Read / Write and nothing ever asks a technician.

## Use it in reports and on tickets

A scheduled agent with no ticket, such as a QBR report, can read every client: it puts each client's Employee Secure Score, phishing fail rate and dark web breaches in the report. On a ticket, an agent reads only the client mapped to the ticket's company, for example to check that a new hire shows in BSN or to list the users behind on training. Map your clients on the Organization Mapping tab first.

BSN reports each number as it stands now, with no history. To show a change over a quarter, keep the numbers each report records.

> [!TIP]
>
> If a phishing report agent should recognise BSN's simulated phishing emails, list BSN's simulation sending domains (from BSN's whitelisting guide in the partner portal) in that agent's instructions. BSN's API does not return them.

See [Breach Secure Now API](https://docs.neoagent.io/agents/tools/security/breach-secure-now-api.md) for what the agent can read.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.