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

# Security report badge

> Embed a CodeAnt AI badge that lets visitors request a security audit report for your public repository.

Add the CodeAnt AI security report badge to your website to give customers and prospects a direct way to request the latest security audit report for a public repository.

Visitors do not need a CodeAnt AI account. After they select the badge, they enter their name, company, and corporate email address. CodeAnt AI verifies that the repository is public and has current scan data, then emails a secure link to the repository-scoped PDF report.

## Embed the badge

Replace `YOUR_ORG` and `YOUR_REPO` in the following HTML, then add it to your website:

```html theme={"system"}
<a href="https://app.codeant.ai/security-report/request?service=github&org=YOUR_ORG&repo=YOUR_ORG/YOUR_REPO">
  <img
    src="https://app.codeant.ai/codeant-security-report-v1.svg"
    alt="Monitored by CodeAnt AI"
  />
</a>
```

For example, a repository at `https://github.com/acme/widgets` uses:

```html theme={"system"}
<a href="https://app.codeant.ai/security-report/request?service=github&org=acme&repo=acme/widgets">
  <img
    src="https://app.codeant.ai/codeant-security-report-v1.svg"
    alt="Monitored by CodeAnt AI"
  />
</a>
```

## Link parameters

| Parameter | Description                                                                                                                                    |
| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `service` | Source-code provider. Supported values are `github`, `gitlab`, `bitbucket`, and `azuredevops`.                                                 |
| `org`     | Organization or workspace that owns the repository.                                                                                            |
| `repo`    | Full repository path, including the organization. For Azure DevOps, use the organization, project, and repository path expected by CodeAnt AI. |

URL-encode parameter values if they contain spaces or reserved URL characters.

## Eligibility and delivery

* The repository must be public and already have current CodeAnt AI security scan data.
* The requester must provide a corporate email address. Public and disposable email providers, including Gmail, are not eligible.
* CodeAnt AI sends a secure, direct link to a repository-scoped PDF report. The link expires after 24 hours.
* Requests are limited to five per IP address, with one request added back to the allowance every 12 minutes.

The report includes a security summary and available SAST, infrastructure-as-code, secret metadata, SCA, and SBOM details. Plaintext secret values are never included.