> ## 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.

# Breach Secure Now API

> Read each client's Breach Secure Now Employee Secure Score, phishing fail rate, dark web breaches and training, and each user's statistics. Read-only

An agent with this tool reads a client's security awareness numbers from Breach Secure Now (BSN): for a QBR or client report, to list the users behind on training, or to check a new hire on an onboarding ticket.

> [!NOTE]
>
> Automatically enabled when you configure Breach Secure Now permissions in your agent workflow. No manual toggle needed.

## What It Does

* Find the client's BSN client from the [Organization Mapping](https://docs.neoagent.io/integrations/breach-secure-now/overview.md#your-clients-are-mapped-automatically), or from your active client list when there is no ticket
* Read a client's average Employee Secure Score, phishing fail rate, active users, training and micro quiz averages
* Read the client's dark web exposure: breached employees, total breaches and BSN's risk level
* Read each user's name, email, last login, ESS, phishing fail rate, micro training completed and available, last training date, last breach date and policy acknowledgements

The agent calls BSN through the [Vendor API](https://docs.neoagent.io/agents/tools/vendor-api.md) tool, with `breach_secure_now` as the vendor id. [Sandbox](https://docs.neoagent.io/agents/tools/built-in/sandbox.md) scripts can call BSN too, under the same permissions.

## Permission Groups

| Group | Access levels | What it covers |
| - | - | - |
| **Client and User Statistics** | Disabled, Read Only | A client's totals and every user's statistics |
| **Clients** | Disabled, Read Only | Your partner account's active clients and their ids |

## Access Profiles

> [accordion] Read Only
>
> Every group Read Only. BSN's API has no write, so this is the only preset.

## On a ticket

On a ticket, the agent reads only the BSN client mapped to the ticket's company, and your client list is not sent. With no ticket company (a chat, or a scheduled agent such as a QBR report), the agent reads every client.

## What it cannot do

BSN's API cannot add or remove a user, assign training, start a phishing campaign or list BSN's phishing simulation domains. The agent reports what it found, and a technician acts in the BSN portal.


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