{"info":{"_postman_id":"cc9ce273-8b73-a3f5-1799-bda750936596","name":"Coral API","description":"*API*\n\nThe Coral API provides access to Coral's Trust Scores and Trust Score Alerts.\n\nFor more information on the service, please check out [heycoral.com](heycoral.com)\n\nFor an example Node app that you can use to clone and base your integration off of, please see our open source client on [Github](https://github.com/CoralProtocol/CoralProtocolSampleApp/blob/master/index.js)\n\n\n\nThe base url is https://api.heycoral.com/\n\nURL status code responses:\n<ul>\n<li>200 <code>OK</code> - normal response</li>\n<li>401 <code>Unauthorized</code> - api key header is invalid</li>\n<li>500 <code>Server Error</code> - something on our end</li>\n</ul>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json"},"item":[{"name":"Address Trust Score","id":"c502d430-c0bc-46a3-8122-a976fab8c4c5","request":{"method":"GET","header":[{"key":"x-api-key","value":"<api-key>"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"/trust?address={{address}}&blockchain={{blockchain}}","path":["trust"],"query":[{"key":"address","value":"{{address}}"},{"key":"blockchain","value":"{{blockchain}}"}]},"description":"Address **Trust Scores** are core components of the Coral ecosystem. They are numbers between 1 and 7 that denote how trustworthy Coral believes an address is.\n\nCurrently, scores are available for most addresses on the Ethereum (`ETH`) and Bitcoin (`BTC`) blockchains. New addresses are constantly being analyzed.\n\nIn addition to the address score, the response body will include four digit codes indicating why the address has that score.\n\n\n\n\n**Request Parameters:**\n\n`address` - The address to retrieve the score for\n\n`blockchain` - The blockchain the address is on\n\n\n\n**Response:**\n```\n{\n  \"success\": true,\n  \"data\": {\n    \"address\": {{address}},\n    \"score\": 1,\n    \"properties\": [\n      {\n        \"code\": 4000,\n        \"description\": \"Known fraudulent activity\"\n      },\n      {...},\n    ]\n  }\n}\n```"},"response":[{"id":"93da8f95-a93b-44b6-a378-ee925f1496d9","name":"Address Trust Score","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"<api-key>","description":"Your API key"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://api.heycoral.com/trust?address=0xcF983fd4a04710e20E859cd3e66a4cF9FC05b9Bd&blockchain=ETH","protocol":"https","host":["api","heycoral","com"],"path":["trust"],"query":[{"key":"address","value":"0xcF983fd4a04710e20E859cd3e66a4cF9FC05b9Bd"},{"key":"blockchain","value":"ETH"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\n  \"success\": true,\n  \"data\": {\n    \"address\": \"0xcF983fd4a04710e20E859cd3e66a4cF9FC05b9Bd\",\n    \"score\": 1,\n    \"properties\": [\n      {\n        \"code\": 4000,\n        \"description\": \"Known fraudulent activity\"\n      },\n      {\n        \"code\": 1003,\n        \"description\": \"No known tumbler interaction\"\n      },\n      {\n        \"code\": 1001,\n        \"description\": \"High activity\"\n      }\n    ]\n  }\n}"}],"_postman_id":"c502d430-c0bc-46a3-8122-a976fab8c4c5"},{"name":"Trust Score Codes","id":"f5c0362e-7594-4203-abbf-17f3aaf579be","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://api.heycoral.com/trust-score-response-codes","description":"The four digit codes indicating why an address has the Trust Score it does.\n\nThe 4000+ series codes also denote the categories of associated acitivty, if the address has a low Trust Score\n\n\n\n\n| Code \t| Description                 \t|\n|------\t|-----------------------------------------\t|\n| 1000 \t| Known custodial address                  \t|\n| 1001 \t| High clout                               \t|\n| 1002 \t| High distance from fraudulent addresses \t|\n| 1003 \t| Low interaction with asset tumblers     \t|\n| 2000 \t| Low clout                \t                |\n| 3000 \t| Close to fraudulent addresses           \t|\n| 3001 \t| Has interacted with known tumbler       \t|\n| 4000 \t| Known fraudulent activity               \t|\n| 4001 \t| Associated with a malicious social media posting               \t|\n| 4003 \t| Association with a phishing attempt               \t|\n| 4004 \t| Associated with ransomware               \t|\n| 4005 \t| Involved in exchange or wallet hack               \t|\n| 4008 \t| Associated with someone on the US Government's SDN watchlist               \t|\n| 4009 \t| Associated with blackmail               \t|"},"response":[{"id":"34425192-39fb-40aa-b083-d4405b374063","name":"Trust Score Codes","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://api.heycoral.com/trust-score-response-codes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"CF-RAY","value":"458bbea9aad257c5-IAD","name":"CF-RAY","description":"Custom header"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Security-Policy","value":"default-src 'self'","name":"Content-Security-Policy","description":"Custom header"},{"key":"Content-Type","value":"text/html; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 11 Sep 2018 17:09:55 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\"","name":"Expect-CT","description":"Custom header"},{"key":"Server","value":"cloudflare","name":"Server","description":"A name for the server"},{"key":"Set-Cookie","value":"__cfduid=d65f7cfab0f11d5cd8b17b670744013a71536685794; expires=Wed, 11-Sep-19 17:09:54 GMT; path=/; domain=.heycoral.com; HttpOnly","name":"Set-Cookie","description":"an HTTP cookie"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Powered-By","value":"Express","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[{"expires":"Wed Sep 11 2019 17:09:54 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"heycoral.com","path":"/","secure":false,"value":"d65f7cfab0f11d5cd8b17b670744013a71536685794","key":"__cfduid"}],"responseTime":null,"body":"[\n    {\n        \"code\": 1000,\n        \"description\": \"Known custodial\"\n    },\n    {\n        \"code\": 1001,\n        \"description\": \"High clout\"\n    },\n    {\n        \"code\": 1002,\n        \"description\": \"Far from fraudulent addresses\"\n    },\n    {\n        \"code\": 1003,\n        \"description\": \"No known tumbler interaction\"\n    },\n    {\n        \"code\": 2000,\n        \"description\": \"Low clout\"\n    },\n    {\n        \"code\": 3000,\n        \"description\": \"Close to fraudulent addresses\"\n    },\n    {\n        \"code\": 3001,\n        \"descripton\": \"Has interacted with known tumbler\"\n    },\n    {\n        \"code\": 3003,\n        \"description\": \"Insufficient address information available\"\n    },\n    {\n        \"code\": 4000,\n        \"description\": \"Known fraudulent activity\"\n    },\n    {\n        \"code\": 4001,\n        \"description\": \"Unspecified malicious social media posting\"\n    },\n    {\n        \"code\": 4003,\n        \"description\": \"Phishing attempt\"\n    },\n    {\n        \"code\": 4004,\n        \"description\": \"Ransomware\"\n    },\n    {\n        \"code\": 4005,\n        \"description\": \"Involved in exchange or wallet hack\"\n    },\n    {\n        \"code\": 4008,\n        \"description\": \"Banned person under OFAC's SDN list\"\n    },\n    {\n        \"code\": 4009,\n        \"description\": \"Involved in an attempt to blackmail for cryptocurrency\"\n    }\n]"}],"_postman_id":"f5c0362e-7594-4203-abbf-17f3aaf579be"},{"name":"Trust Score Alert","id":"a4c802a5-dbd3-4f6b-b351-ae81a4e3c659","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"},{"key":"x-api-key","type":"text","value":"<api-key>"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"The human readable name for this trust score alert","key":"name","type":"text","value":"test"},{"description":"The blockchain address that triggers this alert","key":"address","type":"text","value":"0x123..."},{"description":"The blockchain this address is associated with. Currently either `eth` or `btc`","key":"blockchain","type":"text","value":"eth"},{"description":"The publically availble URL that accepts `POST` webhook requests","key":"url","type":"text","value":"http://123.ngrok.io"},{"description":"The action that triggers the alert. Currently only `trust_score.change` and `fraud_instance.new` are accepted","key":"action","type":"text","value":"trust_score.change"},{"description":"An _optional_ secret that is sent in each alert, so that alert sources are verifiable client side","key":"secret","type":"text","value":"314159265"}]},"url":"https://api.heycoral.com/trust-score-alerts","description":"Coral allows you to set up an alert on a particular address that you're interested in.\n\nAlerts are triggered when the trust score for an address changes, and alerts are `POST` requests to the url specified in the original request (see below).\n\nThe payload of those `POST`ing alerts is of the form\n\n```\n{\n\tname: \"test\",\n\taddress: \"0x123...\",\n\tblockchain: \"eth\",\n\taction: \"trust_score.change\",\n\tsecret: \"314159265\"\n}\n```\n\nFor an example of how to recieve these alerts, we've published an open source [Trust Score Alert reciever](https://github.com/CoralProtocol/trust-score-alerting-webhook-server-example)"},"response":[{"id":"53856428-4d0b-4461-9548-d1cd5d7a679a","name":"Trust Score Alert","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"name\": \"test\",\n    \"address\": \"0x123...\",\n    \"blockchain\": \"eth\",\n    \"url\": \"http://123.ngrok.io\",\n    \"action\": \"trust_score.change\",\n    \"secret\": \"314159265\"\n}"},"url":"https://api.heycoral.com/trust-score-alerts"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n  \"success\": true\n  }"}],"_postman_id":"a4c802a5-dbd3-4f6b-b351-ae81a4e3c659"},{"name":"Trust Score Alert","id":"97580312-5f9d-46f3-86e9-a0d256b054ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"<api-key>","type":"text"}],"url":"https://api.heycoral.com/trust-score-alerts","description":"Get the details of trust score alerts associated with your API key"},"response":[{"id":"9cc11c9f-a36d-4021-ae2f-22fba55d24eb","name":"Trust Score Alert","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"<api-key>","type":"text"}],"url":"https://api.heycoral.com/trust-score-alerts"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[{\n      \"webhook_id\": \"0500acde-047d-4bbb-a59c-8d25f6582393\",\n      \"name\": \"test\",\n      \"address\": \"0x123...\",\n      \"blockchain\": \"eth\",\n      \"action\": \"trust_score.change\",\n      \"createdAt\": \"1544741246863\",\n      \"url\": \"http://123.ngrok.io\"\n    }]"}],"_postman_id":"97580312-5f9d-46f3-86e9-a0d256b054ee"},{"name":"Trust Score Alert","id":"2e7ce678-963e-4d03-bff0-624db247ec8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"<api-key>","type":"text"}],"url":"https://api.heycoral.com/trust-score-alerts/{{webhook_id}}","description":"Deletes webhook `{{webhook_id}}` associated with your API key"},"response":[{"id":"94ca4387-cc4c-43ab-a5b1-f9d557ac6ff2","name":"Trust Score Alert","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","type":"text","value":"<api-key>"}],"url":"https://api.heycoral.com/trust-score-alerts/{{webhook_id}}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n  \"success\": true\n}"}],"_postman_id":"2e7ce678-963e-4d03-bff0-624db247ec8e"}]}