SIREN

The Scam-Investigation-Registry-Engine (SIREN) is an open registry of fraud-associated wallets.

Introduction:

This documentation provides information about the SIREN API, which can be used to verify if a wallet address is suspicious or not. By utilizing this API, developers can integrate a feature into their applications or systems to analyze wallet addresses and determine if they exhibit any suspicious or potentially fraudulent behavior. The API provides valuable insights and data that can help in identifying and mitigating risks associated with fraudulent activities in the cryptocurrency ecosystem. Services that interact with the registry can take the necessary action on these associated wallets, such as denial of services.

Requirements

To access our API, you must include the following headers in your request:

• x-api-key: Your API key, which has been shared with you.

• x-user-email: The email address associated with your account.

Make sure to include these headers in all requests to our API. If you have any questions or need assistance, please contact our support team.

API Key and Email:

• The API key is a 16-character alphanumeric string, which will be provided to you. Keep it safe and confidential.

• The email associated with your account should be included as the value for the x-user-email header in all requests to our API.

URL for API

The base URL for our API is:

<https://api.xerberus.io/public/v1/{endpoint}>

You should replace {endpoint} with the specific endpoint you are hitting.

Endpoint

/wallet/suspicious/status

Make sure to include the required headers in your request:

• x-api-key: Your API key.

• x-user-email: Your email address associated with your account.

Here is an example of how to make the request using axios with NodeJS:

axios.get('<https://api.xerberus.io/public/v1/wallet/suspicious/status?address=><exampleaddress>', {
  headers: {
    'x-api-key': 'your-api-key',
    'x-user-email': 'your-email'
  }
})
  .then(response => console.log(response.data))
  .catch(error => console.error(error));

Response Explanation

Key	Explanation
address	The address provided by user (if payment address, returns stake key)
label	Label provided by a researcher or another person
scam_chance	Numeric chance of this wallet being a scam
note	Description or other important information (256 char max)
aml	Boolean flag if wallet is flagged for AML compliance
submit_user	User or researcher who submitted the label
submission_date	Timestamp of submission
veri_user	User or researcher who verified the label
veri_date	Timestamp of verification

---