# Overview

Documentation for Cardano Shield's API

## Introduction

Cardano Shield's APIs offer an advanced security solution for Cardano wallets. \
Our suite of robust tools enables you to integrate protection for your users, allowing you to focus on crafting your product while we handle the security aspects.

## What does the API Include?

Our API includes several security checks against a website's URL and transactions, we also provide  an easy to understand score based on risky indicators.

* **Phishing Detection**
  * Using Machine Learning and live community reports that are public via our [github](https://github.com/adabox-aio/cardano-shield)

<figure><img src="https://1707630797-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgkM1XfG0YIrx0JSX7KDY%2Fuploads%2F2vl9K6Tiy8DmukqbN9sZ%2FPhishing%20detection.png?alt=media&amp;token=56df6417-e6ca-4eb9-b40e-df8b34669b3c" alt="" width="270"><figcaption><p>An example of a visual indicator upon signing in with your wallet, we alert that the website you signed your wallet with is in our blacklist</p></figcaption></figure>

* **Transaction Summary**
  * Our transaction summary provides comprehensive insights into asset transfers and state changes resulting from a transaction. Designed for seamless integration by developers, our API responses are straightforward and easy for end users to comprehend.

<figure><img src="https://1707630797-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgkM1XfG0YIrx0JSX7KDY%2Fuploads%2Fl3JUE56Y2I5nf3JMMlS9%2FFrame%20188.png?alt=media&amp;token=91468cb5-1e05-4a8a-a353-e6cdfc8d49e2" alt="" width="270"><figcaption><p>An example of the various visual indicators that can be rendered based on the API response</p></figcaption></figure>

* **Risk Score**
  * Based on the security checks our API will also return a Transaction Risk Score, there are 3 levels of risk: Low, Medium and High.

<figure><img src="https://1707630797-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgkM1XfG0YIrx0JSX7KDY%2Fuploads%2FfC2TQhPHKezntZIuXiRM%2FTX%20RISK.png?alt=media&amp;token=3a1f312f-f11a-4257-8d76-3c3aa1b71f39" alt=""><figcaption><p>An example for a visual representation of the Risk Score Cardano Shield's API provides</p></figcaption></figure>


# Cardano Shield API

For a custom API Key, please contact <team@cardanoshield.com>, dm us on [twitter/x](https://twitter.com/CardanoShield), or raise an issue on our [github](https://github.com/adabox-aio/cardano-shield/issues)

## Wallet To Wallet Transaction Scan

{% openapi src="/files/WkZwpXGLBFXz32dIYq2G" path="/api/v1/tx/w2wscan" method="post" %}
[api-docs.json](https://1707630797-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgkM1XfG0YIrx0JSX7KDY%2Fuploads%2FwhAFEFvG71YRuKqrM9UP%2Fapi-docs.json?alt=media\&token=813739dc-9500-40dd-b0b0-c1f6210c3c01)
{% endopenapi %}

**Response Body field's explanation:**

* **addressRisk**
  * suspicious - The address has been identified as potentially malicious.
  * unknown - The address is likely not phishing, but not 100% confident.
  * blacklist - The address is in Cardano Shield's blacklist.
  * whitelist - The address is in Cardano Shield's whitelist.
* **Score**
  * low - The transaction overall risk score is Low.
  * medium - The transaction overall risk score is Medium.
  * High - The transaction overall risk score is High.

***

## dApp Transaction Scan

{% openapi src="/files/WkZwpXGLBFXz32dIYq2G" path="/api/v1/tx/scan" method="post" %}
[api-docs.json](https://1707630797-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgkM1XfG0YIrx0JSX7KDY%2Fuploads%2FwhAFEFvG71YRuKqrM9UP%2Fapi-docs.json?alt=media\&token=813739dc-9500-40dd-b0b0-c1f6210c3c01)
{% endopenapi %}

**Response Body field's explanation:**

* **domainRisk**
  * suspicious - The website has been identified as potentially phishing.
  * unknown - The website is likely not phishing, but not 100% confident.
  * blacklist - The website is in Cardano Shield's blacklist.
  * whitelist - The website is in Cardano Shield's whitelist.
* **addressRisk**
  * suspicious - The address has been identified as potentially malicious.
  * unknown - The address is likely not phishing, but not 100% confident.
  * blacklist - The address is in Cardano Shield's blacklist.
  * whitelist - The address is in Cardano Shield's whitelist.
* **receivingRisk**
  * true - There's a high probability the user is not receiving enough ADA/Tokens.
  * false - There's a high probability the user is receiving the right amount of ADA/Tokens.
* **Score**
  * low - The transaction overall risk score is Low.
  * medium - The transaction overall risk score is Medium.
  * High - The transaction overall risk score is High.

***

## URL Phishing Scan

{% openapi src="/files/WkZwpXGLBFXz32dIYq2G" path="/api/v1/url/scan" method="get" %}
[api-docs.json](https://1707630797-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgkM1XfG0YIrx0JSX7KDY%2Fuploads%2FwhAFEFvG71YRuKqrM9UP%2Fapi-docs.json?alt=media\&token=813739dc-9500-40dd-b0b0-c1f6210c3c01)
{% endopenapi %}

* suspicious - The website has been identified as potentially phishing.
* unknown - The website  is likely not phishing, but not 100% confident.
* blacklist - The website is in Cardano Shield's blacklist.
* whitelist - The website  is in Cardano Shield's whitelist.