Skip to content

docs: Building custom reporting flows without ChainPatrol bots #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
NikitaVr wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: Building custom reporting flows without ChainPatrol bots #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
676ab38
docs: update API Overview based on knowledge update "Building custom …
NikitaVr May 26, 2026
1d2bd57
docs: update Asset Check based on knowledge update "Building custom r…
NikitaVr May 26, 2026
efefb1d
docs: update Report Create based on knowledge update "Building custom…
NikitaVr May 26, 2026
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
4 changes: 3 additions & 1 deletion external-api/asset-check.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,12 @@ openapi: "POST /asset/check"

## Quick Start

<Note>The Asset Check API is commonly used to build custom reporting flows for platforms we don't support yet. Check domains, URLs, and addresses against ChainPatrol's blocklist to warn users about malicious content in your chat app, internal system, or custom platform.</Note>

### Authentication

Include your API key in the `X-API-KEY` header:

```bash
X-API-KEY: <api-key>
```
```
9 changes: 9 additions & 0 deletions external-api/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,12 @@ as a free service to wallets, security apps, and marketplaces.&#x20;
<Card title="Asset List" icon="list-check" href="/external-api/asset-list">
Fetch our entire allowlist/blocklist for use in your own application.
</Card>

## Custom Reporting Flows

If you want to build your own reporting flow for a platform we don't support yet (chat apps, internal systems, etc.) or can't use our Discord/Telegram/Slack bots, you can use ChainPatrol's public APIs to replicate the functionality:

- **Asset Check API** (`/external-api/asset-check`) to check the status of domains/URLs/addresses against ChainPatrol's blocklist (e.g., to warn users about malicious links in their chat or platform)
- **Report Create API** (`/external-api/report-create`) to submit reports into ChainPatrol from your own system, so reports still land in the ChainPatrol review queue and benefit from the full detection/review/takedown pipeline

This is the recommended approach for any "we want bot-like reporting but on a platform/system you don't support" use case.
4 changes: 3 additions & 1 deletion external-api/report-create.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ openapi: "POST /report/create"

The Report Create endpoint allows you to submit assets (URLs, domains, blockchain addresses, etc.) for review by the ChainPatrol team. This endpoint handles bulk submissions and provides detailed error reporting for validation failures.

<Note>This API is commonly used to build custom reporting flows for platforms we don't support yet. Submit reports from your own chat app, internal system, or custom platform directly into ChainPatrol's review queue, where they benefit from the full detection/review/takedown pipeline.</Note>

## Error Responses

### 422 Unprocessable Content
Expand Down Expand Up @@ -175,4 +177,4 @@ All assets must be valid for the report to be created

A report can only be created once per email address for a specific asset

For technical issues or questions about error responses, contact support@chainpatrol.io and include the full error response in your request.
For technical issues or questions about error responses, contact support@chainpatrol.io and include the full error response in your request.