thirdwatch_api 0.0.3

Thirdwatch API

The first version of the Thirdwatch API is an exciting step forward towards making it easier for developers to pass data to Thirdwatch. # Introduction Once you've [registered your website/app](https://thirdwatch.ai) it's easy to start sending data to Thirdwatch. All endpoints are only accessible via https and are located at `api.thirdwatch.ai`. For instance: you can send event at the moment by ```HTTP POST``` Request to the following URL with your API key in ```Header``` and ```JSON``` data in request body. ``` https://api.thirdwatch.ai/event/v1 ``` Every API request must contain ```API Key``` in header value ```X-THIRDWATCH-API-KEY``` Every event must contain your ```_userId``` (if this is not available, you can alternatively provide a ```_sessionId``` value also in ```_userId```). # Score API The Score API is use to get an up to date cutomer trust score after you have sent transaction event and order successful. This API will provide the riskiness score of the order with reasons. Some examples of when you may want to check the score are before: - Before Shippement of a package - Finalizing a money transfer - Giving access to a prearranged vacation rental - Sending voucher on mail ``` https://api.thirdwatch.ai/neo/v1/score?api_key=<your api key>&order_id=<Order id> ``` According to Score you can decide to take action Approve or Reject. Orders with score more than 70 will consider as Riskey orders. We'll provide some reasons also in rules section. ## Response score API ``` { "order_id": "OCT45671", "user_id": "ajay_245", "order_timestamp": "2017-05-09T09:40:45.717Z", "score": 82, "flag": "red", -"reasons": [ { "name": "_numOfFailedTransactions", "display_name": "Number of failed transactions", "flag": "green", "value": "0", "is_display": true }, { "name": "_accountAge", "display_name": "Account age", "flag": "red", "value": "0", "is_display": true }, { "name": "_numOfOrderSameIp", "display_name": "Number of orders from same IP", "flag": "red", "value": "11", "is_display": true } ] } ```