> For the complete documentation index, see [llms.txt](https://guardient.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://guardient.gitbook.io/docs/getting-started/introduction.md).

# Introduction

## How Does Guardient Work?

It’s simple:

1. **You send a request** from your backend to our API with details about the user trying to access your service.
2. **We analyze the request**, checking things like email, IP, and phone number against our up-to-date threat databases.
3. **You get a trust score and reasons**, so you can decide to allow, flag, or block the user—based on your own rules.

No client-side scripts required, no cookies—just a quick server-to-server check that helps you stop bad actors before they cause damage.

## Let's Start!

{% stepper %}
{% step %}

### Create your first project

Visit our new project link to create your new project. If you are not logged in already, you will be requested to. If everything goes well you will be redirected to our dashboard page.

<figure><img src="/files/cWaOxnotJLgFeOggeRFS" alt=""><figcaption><p>Guardient's Dashboard Page</p></figcaption></figure>
{% endstep %}

{% step %}

### Get your API key

To access Guardient's API, you must authenticate using API keys. Each project has a unique API key. To locate your project's API key, navigate to the settings page on the left side of your dashboard

After that, you will see a field containing your API key. To view it, just click on it. You will need this API key later on.

<figure><img src="/files/sNqqLi4tHKJSTdXlTTuU" alt=""><figcaption><p>How to get your api key.</p></figcaption></figure>
{% endstep %}

{% step %}

### Integrating guardient

To integrate Guardient into your service or website, please visit our [integration page](/docs/getting-started/integration.md) or scroll down and click the "Next" button to continue.
{% endstep %}

{% step %}

### Do a test run (optional)

To expedite the process, you can manually verify users via our dashboard. Navigate to the "Check User" page and enter the email, IP address, and phone number.

<figure><img src="/files/uNnFzLyoxwVeYrDK5TGb" alt=""><figcaption><p>Manually checking a user</p></figcaption></figure>
{% endstep %}
{% endstepper %}


---

# 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://guardient.gitbook.io/docs/getting-started/introduction.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.
