API Documentation (1.0)

The Scan API Service provides endpoints to check and validate transactions and wallets for compliance and potential risks. It integrates with blockchain networks to retrieve transaction and wallet details and analyzes their safety level.

Base URL

The service is available at the following base URL:

https://anti-scamapi.starcompliance.io

• Transaction Scanning: Verify transactions for potential risks and retrieve compliance reports.
• Wallet Scanning: Analyze wallet addresses for suspicious activities or compliance concerns.
• Detailed Responses: Each API endpoint returns comprehensive information, including risk levels and report IDs for further auditing.

Transaction Scanning

• Endpoint: /api/v1/scan/transaction
• Method: POST
• Description: Checks a transaction for risks and returns a compliance report.
• Authorization: Requires API token in the Authorization header.

Wallet Scanning

• Endpoint: /api/v1/scan/wallet
• Method: POST
• Description: Scans a wallet address for suspicious activities and provides a detailed risk report.
• Authorization: Requires API token in the Authorization header.

Transaction Scanning Example

Request

{
    "hash": "0xabc123...",
    "network": "ETH",
    "token": "USDT"
}

Response

{
    "alertLevel": "HIGH",
    "amount": "5000",
    "fromAddress": "0xabc123...",
    "hash": "0xabc123...",
    "reportId": "12345",
    "toAddress": "0xdef456...",
    "scanStatus": "VERIFIED"
}

Wallet Scanning Example

Request

{
    "address": "0xdef456...",
    "network": "ETH"
}

Response

{
    "address": "0xdef456...",
    "alertLevel": "LOW",
    "reportId": "67890",
    "scanStatus": "VERIFIED"
}

All requests require an API token passed in the Authorization header:

Authorization: Bearer <API_TOKEN>

The API uses standard HTTP status codes to indicate success or failure:

• 200 OK: Successful request.
• 401 Unauthorized: API token missing or invalid.
• 403 Forbidden: Access to the resource is forbidden.
• 404 Not Found: The requested resource does not exist.

Refer to the OpenAPI YAML Specification for full technical details.

For any issues or inquiries, please contact StarCompliance Support.

API methods for submitting and checking your transactions and wallets. Responses for asynchronously processed requests will be delivered to the URL specified in the webhookUrl field, using the same schema as the synchronous response.