swagger.json

{
    "swagger": "2.0",
    "info": {
        "contact": {}
    },
    "paths": {
        "/api/data/sync": {
            "post": {
                "description": "blacklist an address",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "summary": "blacklist an address",
                "parameters": [
                    {
                        "type": "string",
                        "description": "Application ID",
                        "name": "appid",
                        "in": "header",
                        "required": true
                    },
                    {
                        "type": "string",
                        "description": "Timestamp of the request",
                        "name": "timestamp",
                        "in": "header",
                        "required": true
                    },
                    {
                        "type": "string",
                        "description": "A unique nonce for the request",
                        "name": "nonce",
                        "in": "header",
                        "required": true
                    },
                    {
                        "type": "string",
                        "description": "Query string parameters included in the request",
                        "name": "queryString",
                        "in": "header",
                        "required": true
                    },
                    {
                        "type": "string",
                        "description": "Signature for request validation",
                        "name": "signature",
                        "in": "header",
                        "required": true
                    },
                    {
                        "description": "Blacklist request",
                        "name": "request",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/db.BlacklistedAddress"
                        }
                    }
                ],
                "responses": {}
            }
        },
        "/screen/{address}": {
            "get": {
                "description": "Screen an address using Chainalysis API to determine if it's high risk",
                "consumes": [
                    "application/json",
                    "application/json"
                ],
                "produces": [
                    "application/json",
                    "application/json"
                ],
                "tags": [
                    "Address Screening"
                ],
                "summary": "Screen an address for risk",
                "parameters": [
                    {
                        "type": "string",
                        "description": "Address to be screened",
                        "name": "address",
                        "in": "path",
                        "required": true
                    }
                ],
                "responses": {}
            }
        }
    },
    "definitions": {
        "db.BlacklistedAddress": {
            "type": "object",
            "properties": {
                "address": {
                    "type": "string"
                },
                "createdAt": {
                    "type": "string"
                },
                "id": {
                    "type": "string"
                },
                "network": {
                    "type": "string"
                },
                "remark": {
                    "type": "string"
                },
                "tag": {
                    "type": "string"
                },
                "type": {
                    "type": "string"
                },
                "updatedAt": {
                    "type": "string"
                }
            }
        }
    }
}