Report Create

Create a new report on ChainPatrol for a particular organization

POST /report/create

Create a report

cURL

curl --request POST \
  --url https://app.chainpatrol.io/api/v2/report/create \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "assets": [
    {
      "content": "<string>",
      "status": "BLOCKED",
      "enrichments": [
        {
          "source": "<string>",
          "output": {}
        }
      ]
    }
  ],
  "organizationSlug": "<string>",
  "discordGuildId": "<string>",
  "telegramGroupId": "<string>",
  "title": "<string>",
  "description": "<string>",
  "contactInfo": "<string>",
  "attachmentUrls": [
    "<string>"
  ],
  "externalSubmissionLink": "<string>",
  "userAgent": "<string>",
  "referrer": "<string>",
  "rawAssetsInput": "<string>"
}
'

import requests

url = "https://app.chainpatrol.io/api/v2/report/create"

payload = {
    "assets": [
        {
            "content": "<string>",
            "status": "BLOCKED",
            "enrichments": [
                {
                    "source": "<string>",
                    "output": {}
                }
            ]
        }
    ],
    "organizationSlug": "<string>",
    "discordGuildId": "<string>",
    "telegramGroupId": "<string>",
    "title": "<string>",
    "description": "<string>",
    "contactInfo": "<string>",
    "attachmentUrls": ["<string>"],
    "externalSubmissionLink": "<string>",
    "userAgent": "<string>",
    "referrer": "<string>",
    "rawAssetsInput": "<string>"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    assets: [
      {
        content: '<string>',
        status: 'BLOCKED',
        enrichments: [{source: '<string>', output: {}}]
      }
    ],
    organizationSlug: '<string>',
    discordGuildId: '<string>',
    telegramGroupId: '<string>',
    title: '<string>',
    description: '<string>',
    contactInfo: '<string>',
    attachmentUrls: ['<string>'],
    externalSubmissionLink: '<string>',
    userAgent: '<string>',
    referrer: '<string>',
    rawAssetsInput: '<string>'
  })
};

fetch('https://app.chainpatrol.io/api/v2/report/create', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.chainpatrol.io/api/v2/report/create",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'assets' => [
        [
                'content' => '<string>',
                'status' => 'BLOCKED',
                'enrichments' => [
                                [
                                                                'source' => '<string>',
                                                                'output' => [
                                                                                                                                
                                                                ]
                                ]
                ]
        ]
    ],
    'organizationSlug' => '<string>',
    'discordGuildId' => '<string>',
    'telegramGroupId' => '<string>',
    'title' => '<string>',
    'description' => '<string>',
    'contactInfo' => '<string>',
    'attachmentUrls' => [
        '<string>'
    ],
    'externalSubmissionLink' => '<string>',
    'userAgent' => '<string>',
    'referrer' => '<string>',
    'rawAssetsInput' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.chainpatrol.io/api/v2/report/create"

	payload := strings.NewReader("{\n  \"assets\": [\n    {\n      \"content\": \"<string>\",\n      \"status\": \"BLOCKED\",\n      \"enrichments\": [\n        {\n          \"source\": \"<string>\",\n          \"output\": {}\n        }\n      ]\n    }\n  ],\n  \"organizationSlug\": \"<string>\",\n  \"discordGuildId\": \"<string>\",\n  \"telegramGroupId\": \"<string>\",\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"contactInfo\": \"<string>\",\n  \"attachmentUrls\": [\n    \"<string>\"\n  ],\n  \"externalSubmissionLink\": \"<string>\",\n  \"userAgent\": \"<string>\",\n  \"referrer\": \"<string>\",\n  \"rawAssetsInput\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.chainpatrol.io/api/v2/report/create")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"assets\": [\n    {\n      \"content\": \"<string>\",\n      \"status\": \"BLOCKED\",\n      \"enrichments\": [\n        {\n          \"source\": \"<string>\",\n          \"output\": {}\n        }\n      ]\n    }\n  ],\n  \"organizationSlug\": \"<string>\",\n  \"discordGuildId\": \"<string>\",\n  \"telegramGroupId\": \"<string>\",\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"contactInfo\": \"<string>\",\n  \"attachmentUrls\": [\n    \"<string>\"\n  ],\n  \"externalSubmissionLink\": \"<string>\",\n  \"userAgent\": \"<string>\",\n  \"referrer\": \"<string>\",\n  \"rawAssetsInput\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.chainpatrol.io/api/v2/report/create")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"assets\": [\n    {\n      \"content\": \"<string>\",\n      \"status\": \"BLOCKED\",\n      \"enrichments\": [\n        {\n          \"source\": \"<string>\",\n          \"output\": {}\n        }\n      ]\n    }\n  ],\n  \"organizationSlug\": \"<string>\",\n  \"discordGuildId\": \"<string>\",\n  \"telegramGroupId\": \"<string>\",\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"contactInfo\": \"<string>\",\n  \"attachmentUrls\": [\n    \"<string>\"\n  ],\n  \"externalSubmissionLink\": \"<string>\",\n  \"userAgent\": \"<string>\",\n  \"referrer\": \"<string>\",\n  \"rawAssetsInput\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "id": 123,
  "createdAt": "<string>",
  "organization": {
    "id": 123,
    "slug": "<string>",
    "name": "<string>"
  }
}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Overview

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.

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.

Error Type	Description	Resolution
DUPLICATE_ASSETS	Same asset appears multiple times in the report	Remove duplicate assets from submission
INVALID_FORMAT	Asset format is invalid	Use valid URLs, domains, or blockchain addresses
ASSET_NOT_FOUND	Asset could not be located or created	Verify asset format and accessibility
ASSET_ALREADY_CORRECT	Asset already has the requested status	No action needed - asset is already in desired state
ALREADY_PENDING_REVIEW	Asset has a pending proposal for the requested status	Wait for existing proposal to be processed
REPORT_ALREADY_EXISTS	A pending report/proposal for this asset exists	Check existing reports or wait for processing
PROCESSING_FAILED	Technical error occurred during asset processing	Retry the request or contact support
DOMAIN_NOT_ALLOWED	Asset’s domain is on the ignore list	Domain is excluded from reports per content policy
VALIDATION_ERROR	Generic validation error	Check asset format and requirements

Example: Duplicate Assets

{
  "message": "Report creation failed: Duplicate assets found. 2 asset(s) appear multiple times in the same report.",
  "code": "UNPROCESSABLE_CONTENT",
  "data": {
    "errors": [
      {
        "asset": "scam.example",
        "errorType": "DUPLICATE_ASSETS",
        "message": "This asset appears multiple times in the same report",
        "suggestion": "Remove duplicate assets from your submission - each asset should only appear once per report"
      }
    ]
  }
}

Example: Multiple Validation Errors

{
  "message": "Report creation failed: 2 of 3 assets are invalid. All assets must be valid to create a report.",
  "code": "UNPROCESSABLE_CONTENT",
  "data": {
    "errors": [
      {
        "asset": "http",
        "errorType": "INVALID_FORMAT",
        "message": "This asset couldn't be processed due to invalid format",
        "suggestion": "Use valid URLs (https://example.com), domains (example.com), or blockchain addresses (eip155:1:0x123...)"
      },
      {
        "asset": "decen-masters.com",
        "errorType": "DOMAIN_NOT_ALLOWED",
        "message": "This domain cannot be reported as it's on the ignore list",
        "suggestion": "This domain is currently excluded from reports based on our content policy. Please reach out to us if you believe this is an error"
      }
    ]
  }
}

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

{
  "message": "Unable to process your report. Please try again or contact support if the issue persists.",
  "code": "INTERNAL_SERVER_ERROR"
}

Database Error Response

{
  "message": "A database error occurred. This has been reported internally - please contact [e-mail] for assistance.",
  "code": "INTERNAL_SERVER_ERROR"
}

Best Practices

Asset Validation

URLs: Include the full protocol (https:// or http://)

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.errors array in 422 responses for per-asset details

Use the suggestion field 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:// or http://)

Verify domain names don’t include protocols or paths

Check blockchain address format matches EIP-155 standard

“DUPLICATE_ASSETS” errors:

Remove duplicate entries from the assets array

Check for case sensitivity differences

Verify URL normalization (trailing slashes, etc.)

“DOMAIN_NOT_ALLOWED” errors:

The domain is on ChainPatrol’s ignore list

Contact [e-mail] to dispute this decision

Consider reporting specific URLs instead of the entire domain

“ASSET_ALREADY_CORRECT” errors:

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.errors for per-asset details

Provide the organizationSlug and valid assets to minimize 500s caused by invalid state

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 [e-mail] and include the full error response in your request.

Authorizations

X-API-KEY · string · header · required

Your API key. This is required by most endpoints to access our API programatically. Reach out to us at [e-mail] to get an API key for your use.

Body

application/json

assets · object[] · required

Show child attributes

organizationSlug · string

discordGuildId · string

telegramGroupId · string

title · string

Minimum string length: 3

description · string

contactInfo · string

attachmentUrls · string<uri>[]

externalSubmissionLink · string<uri>

userAgent · string

referrer · string

rawAssetsInput · string

externalReporter · object

Show child attributes

Response

200

application/json

Successful response

id · number · required

createdAt · string · required

organization · object | null · required

Show child attributes