Reports
Create Report
Create a new report on ChainPatrol for a particular organization
POST
Create a report
Overview
The Create Report 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. New to this endpoint? Start with Creating Reports — a step-by-step walkthrough of the whole flow, with worked examples.This endpoint needs an API key with Read & write permission. A read-only key gets
403 Forbidden. See Key permissions.Attachments
attachmentUrls accepts URLs of any evidence file, not just images — .eml and .msg
messages, PDFs, documents, and screenshots all work. Images are displayed inline on the
report; other files are listed as downloadable evidence that our takedown team can forward
to a registrar or hosting provider.
To send us the file itself rather than a link you host, upload it first with
Upload Attachment and pass the URL it returns:
Error Responses
422 Unprocessable Content
Returned when the request is syntactically valid but contains validation errors or duplicate assets. This is the most common error type and provides detailed per-asset error information.Example: Duplicate Assets
Example: Multiple Validation Errors
500 Internal Server Error
Returned for unexpected server conditions, including database errors and other technical failures. The response uses safe, generic messages to avoid exposing internal system details.Standard Error Response
Database Error Response
Best Practices
Asset Validation
- URLs: Include the full protocol (
https://orhttp://) - Domains: Use clean domain names without protocols or paths
- Blockchain Addresses: Use EIP-155 format for Ethereum addresses
- Avoid Duplicates: Each asset should appear only once per report
Error Handling
- Always check the
data.errorsarray in 422 responses for per-asset details - Use the
suggestionfield in error responses to guide users - Implement retry logic for 500 errors with exponential backoff
Performance Tips
- Batch multiple assets in a single request when possible
- Validate asset formats client-side before submission
- Handle rate limiting appropriately
Troubleshooting
Common Issues
“INVALID_FORMAT” errors:- Ensure URLs include protocol (
https://orhttp://) - Verify domain names don’t include protocols or paths
- Check blockchain address format matches EIP-155 standard
- Remove duplicate entries from the assets array
- Check for case sensitivity differences
- Verify URL normalization (trailing slashes, etc.)
- The domain is on ChainPatrol’s ignore list
- Contact disputes@chainpatrol.io to dispute this decision
- Consider reporting specific URLs instead of the entire domain
- The asset already has the status you’re requesting
- Check the current asset status before reporting
- No action needed - the asset is already in the desired state
Rate Limiting
The endpoint implements rate limiting to prevent abuse. If you encounter rate limit errors:- Implement exponential backoff in your retry logic
- Consider batching requests to reduce API calls
- Contact support for higher rate limits if needed
Notes
- Error payload shape is stable across 422 errors; check
data.errorsfor per-asset details - Provide the
organizationSlugand validassetsto minimize 500s caused by invalid state - All assets must be valid for the report to be created
- A report can’t include an asset that already has a pending proposal in another of your organization’s reports
Authorizations
Your API key. This is required by most endpoints to access our API programatically. Reach out to us at support@chainpatrol.io to get an API key for your use.
Body
application/json