# ChainPatrol

## Docs

- [Allowlist](https://chainpatrol.com/docs/concepts/allowlist.md): Understanding how ChainPatrol identifies and protects legitimate assets
- [Asset Scans](https://chainpatrol.com/docs/concepts/asset-scans.md): Understanding how ChainPatrol evaluates assets at specific points in time
- [Blocklist](https://chainpatrol.com/docs/concepts/blocklist.md): Understanding ChainPatrol's threat intelligence database
- [Brands](https://chainpatrol.com/docs/concepts/brands.md): Understanding brand protection in ChainPatrol
- [Detections](https://chainpatrol.com/docs/concepts/detections.md): How ChainPatrol automatically identifies potential security threats
- [Legal Docs](https://chainpatrol.com/docs/concepts/legal-docs.md): Understanding legal documentation for takedown requests
- [Metrics](https://chainpatrol.com/docs/concepts/metrics.md): Understanding how ChainPatrol measures and reports threat protection
- [Organizations](https://chainpatrol.com/docs/concepts/organizations.md): Understanding your workspace in ChainPatrol
- [Reports](https://chainpatrol.com/docs/concepts/reports.md): How suspicious or safe activity gets submitted to ChainPatrol for review
- [Reviews](https://chainpatrol.com/docs/concepts/reviews.md): How ChainPatrol evaluates and makes decisions on reported threats
- [Security Portal](https://chainpatrol.com/docs/concepts/security-portal.md): Understanding your organization's public-facing threat reporting page
- [Takedowns](https://chainpatrol.com/docs/concepts/takedowns.md): Understanding how ChainPatrol removes malicious content from the internet
- [Watchlist](https://chainpatrol.com/docs/concepts/watchlist.md): Understanding how ChainPatrol monitors assets for future action
- [Asset Changelog](https://chainpatrol.com/docs/external-api/asset-changelog.md): Asset changelog. Assets can be changed for various reasons, such as false positives, false negatives or normal reviews.
- [Asset Check](https://chainpatrol.com/docs/external-api/asset-check.md): Check asset status
- [Asset List](https://chainpatrol.com/docs/external-api/asset-list.md): List asset statuses
- [Asset Parse](https://chainpatrol.com/docs/external-api/asset-parse.md): Parse and normalize asset content to extract structured information
- [Asset Search](https://chainpatrol.com/docs/external-api/asset-search.md): Search for an asset by content or ID and get its status, associated reports, and takedown details
- [Asset Submit](https://chainpatrol.com/docs/external-api/asset-submit.md): Submit a list of assets such as domains, social profiles, or blockchain addresses. Automation will classify and assign them to appropriate organization(s).
- [Authentication](https://chainpatrol.com/docs/external-api/authentication.md)
- [List Threat Detection Results](https://chainpatrol.com/docs/external-api/detection-list.md): List threat detection results for an organization using API key authentication. Returns human-readable confidence levels (none, low, medium, high) and report status. Supports filtering by source, confidence level, asset status, and asset type. Includes pagination and search capabilities.
- [Dispute Create](https://chainpatrol.com/docs/external-api/dispute-create.md): Create a new dispute for an asset via the external API. Requires API key.
- [Create Organization Asset Group](https://chainpatrol.com/docs/external-api/organization-asset-groups-create.md): Create a new asset group for organizing your organization's assets.
- [Delete Organization Asset Group](https://chainpatrol.com/docs/external-api/organization-asset-groups-delete.md): Delete an asset group. Assets in this group will become ungrouped.
- [List Organization Asset Groups](https://chainpatrol.com/docs/external-api/organization-asset-groups-list.md): List all asset groups belonging to your organization with asset counts.
- [Update Organization Asset Group](https://chainpatrol.com/docs/external-api/organization-asset-groups-update.md): Rename an existing asset group.
- [Add Organization Assets](https://chainpatrol.com/docs/external-api/organization-assets-add.md): Batch add multiple assets to your organization's allowlist. Each asset will be automatically parsed, classified, and approved as ALLOWED status. Supports optional group assignment.
- [List Organization Assets](https://chainpatrol.com/docs/external-api/organization-assets-list.md): List all assets belonging to your organization with optional filtering by type, group, and search query. Supports pagination.
- [Remove Organization Asset](https://chainpatrol.com/docs/external-api/organization-assets-remove.md): Remove an asset from your organization's allowlist. This performs a soft delete.
- [Update Organization Asset](https://chainpatrol.com/docs/external-api/organization-assets-update.md): Update an asset's name, description, or group assignment. The asset must belong to your organization.
- [Get Organization Metrics (Deprecated)](https://chainpatrol.com/docs/external-api/organization-metrics.md): Get public metrics for one or more organizations
- [Get Organization Metrics](https://chainpatrol.com/docs/external-api/organization-metrics-list.md): Get metrics for your organization with optional date range and brand filtering. Organization is determined from your API key.
- [Get Organization Reports (Deprecated)](https://chainpatrol.com/docs/external-api/organization-reports.md): Get reports for an organization based on organization slug and filters
- [List Organization Reports](https://chainpatrol.com/docs/external-api/organization-reports-list.md): List all reports belonging to your organization with optional filtering and pagination. Organization is determined from your API key.
- [API Overview](https://chainpatrol.com/docs/external-api/overview.md)
- [Report Create](https://chainpatrol.com/docs/external-api/report-create.md): Create a new report on ChainPatrol for a particular organization
- [Takedowns List](https://chainpatrol.com/docs/external-api/takedowns-list.md): List takedowns for an organization using API key authentication
- [List Threats](https://chainpatrol.com/docs/external-api/threats-list.md): List threats for an organization using API key authentication
- [Asset Scans](https://chainpatrol.com/docs/getting-started/how-it-works/asset-scans.md): How ChainPatrol automatically evaluates and monitors potential threats across the web
- [Blocklist](https://chainpatrol.com/docs/getting-started/how-it-works/blocklist.md): Real-time, community-powered database of confirmed phishing sites and malicious assets
- [Detection Sources](https://chainpatrol.com/docs/getting-started/how-it-works/detection-sources.md): Automated monitoring systems that continuously scan the internet for threats to your brand
- [How We Use AI](https://chainpatrol.com/docs/getting-started/how-it-works/how-we-use-ai.md): Learn how ChainPatrol's AI-powered detection engine protects your brand from threats in real-time
- [Review](https://chainpatrol.com/docs/getting-started/how-it-works/review.md): How ChainPatrol evaluates and approves threat status changes through automated and human review
- [Takedown](https://chainpatrol.com/docs/getting-started/how-it-works/takedown.md): How ChainPatrol removes malicious content through coordinated takedown requests
- [Watchlist](https://chainpatrol.com/docs/getting-started/how-it-works/watchlist.md): How ChainPatrol monitors assets to detect when they become malicious or go offline
- [Brand Impersonation](https://chainpatrol.com/docs/getting-started/what-we-do/brand-impersonation.md): Understanding brand impersonation attacks and how to protect against them
- [General Phishing](https://chainpatrol.com/docs/getting-started/what-we-do/general-phishing.md): Understanding phishing attacks and common attack vectors
- [Introduction](https://chainpatrol.com/docs/getting-started/what-we-do/introduction.md): Protecting your Brand and Staff from Phishing and Impersonation Attacks
- [Address](https://chainpatrol.com/docs/glossary/asset-types/address.md): Represents a wallet address or smart contract address on the Ethereum blockchain.
- [Page](https://chainpatrol.com/docs/glossary/asset-types/page.md): Represents a page link to be reported
- [URL](https://chainpatrol.com/docs/glossary/asset-types/url.md): Represents a domain or subdomain to be reported
- [Canary Tokens](https://chainpatrol.com/docs/integration/canary-tokens.md): Use Canary Tokens to notify ChainPatrol when your website is cloned and have them blocked immediately
- [Discord Bot](https://chainpatrol.com/docs/integration/discord.md): A Discord bot that can be used submit scam reports to ChainPatrol
- [GitHub](https://chainpatrol.com/docs/integration/github.md): Connect your GitHub repositories to ChainPatrol to protect your community from scam links and malicious content
- [Intercom](https://chainpatrol.com/docs/integration/intercom.md): Connect your Intercom workspace to ChainPatrol to report suspicious URLs and protect against phishing
- [Slack Bot](https://chainpatrol.com/docs/integration/slack.md): A Slack bot that can be used to submit scam reports to ChainPatrol
- [Telegram Bot](https://chainpatrol.com/docs/integration/telegram.md): A Telegram bot that can be used to submit scam reports to ChainPatrol
- [Vercel](https://chainpatrol.com/docs/integration/vercel.md): Connect your Vercel team to ChainPatrol to protect your deployments from impersonation
- [Webhooks](https://chainpatrol.com/docs/integration/webhooks.md): Use webhooks to notify your wallet about changes to ChainPatrol's global blocklist
- [Zapier](https://chainpatrol.com/docs/integration/zapier.md): Use Zapier to automate your ChainPatrol workflows
- [Onboarding Requirements](https://chainpatrol.com/docs/protect-your-brand/onboarding-requirements.md): Information ChainPatrol needs to protect your organization from threats
- [Ongoing Communication](https://chainpatrol.com/docs/protect-your-brand/ongoing-communication.md): How to stay connected with ChainPatrol for effective brand protection
- [Services Setup](https://chainpatrol.com/docs/protect-your-brand/services-setup.md): Configure ChainPatrol security services for your organization
- [Who Should Be Involved in Brand Protection](https://chainpatrol.com/docs/protect-your-brand/who-should-be-involved.md): Key stakeholders and team members essential for effective brand protection
- [Constructor](https://chainpatrol.com/docs/sdk/chainpatrol-client/constructor.md): Creates a new instance of the `ChainPatrolClient` class.
- [asset.check](https://chainpatrol.com/docs/sdk/chainpatrol-client/instance-methods/asset-check.md): Check the threat status of individual assets
- [asset.list](https://chainpatrol.com/docs/sdk/chainpatrol-client/instance-methods/asset-list.md): Retrieve lists of assets with filtering options
- [asset.submit](https://chainpatrol.com/docs/sdk/chainpatrol-client/instance-methods/asset-submit.md): Submit assets for threat classification and organization assignment
- [Overview](https://chainpatrol.com/docs/sdk/chainpatrol-client/overview.md): ChainPatrolClient is used to construct a client that connects to the ChainPatrol API
- [Overview](https://chainpatrol.com/docs/sdk/overview.md): Use our JavaScript SDK to interact with ChainPatrol's APIs
- [Quickstart](https://chainpatrol.com/docs/sdk/quickstart.md): Get started using the ChainPatrol SDK in your application
- [Overview](https://chainpatrol.com/docs/sdk/relay/overview.md): Relay messages between browser extensions and web pages.
- [on()](https://chainpatrol.com/docs/sdk/relay/static-methods/on.md): Listen for events from the ChainPatrol Relay.
- [run()](https://chainpatrol.com/docs/sdk/relay/static-methods/run.md): Starts the relay in the current JS context.
- [send()](https://chainpatrol.com/docs/sdk/relay/static-methods/send.md): Send an event to the ChainPatrol relay.
- [Browser](https://chainpatrol.com/docs/sdk/storage/browser.md)
- [Extension](https://chainpatrol.com/docs/sdk/storage/extension.md)
- [Memory](https://chainpatrol.com/docs/sdk/storage/memory.md)
- [Overview](https://chainpatrol.com/docs/sdk/storage/overview.md): Adapters for storing cached data for the Threat Detector
- [Constructor](https://chainpatrol.com/docs/sdk/threat-detector/constructor.md)
- [allow()](https://chainpatrol.com/docs/sdk/threat-detector/instance-methods/allow.md): Use this method to add a domain to the allowlist
- [block()](https://chainpatrol.com/docs/sdk/threat-detector/instance-methods/block.md): Use this method to add a domain to the blocklist
- [ignore()](https://chainpatrol.com/docs/sdk/threat-detector/instance-methods/ignore.md): Use this method to ignore a domain when the user chooses to continue at their own risk after seeing a warning
- [url()](https://chainpatrol.com/docs/sdk/threat-detector/instance-methods/url.md): Use this method to check a URL to see if it is malicious.
- [Overview](https://chainpatrol.com/docs/sdk/threat-detector/overview.md): ThreatDetector is used to detect Phishing and Scam websites using ChainPatrol's APIs.

## OpenAPI Specs

- [openapi](https://chainpatrol.com/docs/openapi)