Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions content/docs/ai-agent/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: AI Agent
description: AI Agent
---

## Verification AI Agent

### Overview

The Verification AI Agent is a powerful tool that handles email verification for employment, education, and other verification purposes. This agent integrates with the Agent-to-Agent (A2A) protocol, allowing it to communicate with host AI agents and provide a seamless verification experience.

### Key Features

- **A2A Protocol Integration**: Seamlessly communicates with host AI agents
- **Remote Verification**: Processes verification requests through natural language queries
- **Push Notifications**: Provides real-time status updates on the verification requests
- **Dynamic Verification Support**: Identifies and supports various verification types (employment, education, social, etc.) based on user queries

### How it works

Verification AI Agent processes verification requests through the A2A protocol:

1. It sends email containing verification links to the specified address

2. Returns verification results to the host agent once the verification is complete in real-time using push notifications

3. The host agent can also check the status of the verification request using either the email or name of the verifying user

The agent provides several custom tools that can be called by host agents:

- **send_verification_email**: Send verification email to a user
- **check_verification_status_by_email**: Check verification status by email
- **check_verification_status_by_name**: Check verification status by name
- **push_notification_support**: Support push notifications for status updates to avoid polling




4 changes: 4 additions & 0 deletions content/docs/ai-agent/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"title": "AI Agent",
"pages": ["quickstart"]
}
54 changes: 54 additions & 0 deletions content/docs/ai-agent/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: Quickstart
description: Quickstart
---

# Verification AI Agent Quickstart

The Verification AI Agent is already deployed and ready to use through host AI agents that implement the A2A protocol. No setup is required to use the verification functionality.

The Verification AI Agent is deployed on the following url:

```
https://agent.reclaimprotocol.org/
```

## Host Agent Integration

1. Clone the [Host CLI Agent](https://github.com/google/A2A/tree/main/samples/python/hosts/cli)
2. Run the CLI Agent:
```bash
uv run hosts/cli --agent https://agent.reclaimprotocol.org
```

<Callout type="warning">
⚠️ Note: Push notifications are not enabled by default on the client. You need to set `use_push_notifications=True` and configure a push notification receiver server `push_notification_receiver=<your-push-notification-receiver-server-url>` in your client code to receive all push notifications on the client side.
</Callout>
```bash
uv run hosts/cli --agent https://agent.reclaimprotocol.org --use_push_notifications True --push_notification_receiver <your-push-notification-receiver-server-url>
```

## Using the Verification Agent

1. In the CLI Host Agent, request verification by providing:
- Email address
- Field to verify (e.g., "employment", "education")

Example:
```
- send verification email to user@example.com for Github username verification
- send verification email to user@example.com for employment verification
```

2. The Verification Agent will process your request and send a verification email to the provided email address.

3. The host agent can check the status of the verification request using either the email or name of the verifying user or get real time updates using push notifications

## Supported Features
- Sending verification emails
- Checking verification status
- Push notification support for status updates



*For more information on the A2A protocol docs [A2A Protocol](https://google.github.io/A2A/#/).*
2 changes: 1 addition & 1 deletion content/docs/meta.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"root": true,
"pages": ["index","js", "fullstack", "backend", "flutter", "react-native", "zkfetch", "inapp-sdks", "sdk", "attestor-decentralization", "advance-options", "hackathon"]
"pages": ["index","js", "fullstack", "backend", "flutter", "react-native", "zkfetch", "inapp-sdks", "sdk", "attestor-decentralization", "advance-options", "ai-agent", "hackathon"]
}