Vault Report Download

The following endpoint is to be used for downloading

/vault/reports/download/:vaultAddress

METHOD: GET

This endpoint allows you to download comprehensive security and risk reports for specific vault addresses on the Xerberus platform. The report is delivered as a PDF file accessible via a secure, time-limited download link.

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.

Payment Required

This is a paid endpoint using the x402 payment protocol:

• Price: 49 USDC

• Network: Base

Request Flow

1. API Key Validation - Your API credentials are verified

2. Vault Address Validation - The vault address format is checked and report existence is confirmed

3. Payment Processing - Payment is processed via x402 protocol (only if validation passes)

4. Report Delivery - A time-limited signed URL to the PDF report is returned

The API call is a two step process -

1. Initial call made to the API to request the resource

const axios = require('axios');

axios.get('https://api.xerberus.io/public/v1/vault/reports/download/0x31A421271414641cb5063B71594b642D2666dB6B', {
  headers: {
    'x-api-key': 'your-api-key',
    'x-user-email': '[e-mail]'
  }
})
  .then(response => {
    console.log('Response :', response.data);
  })
  .catch(error => console.error(error));

The above request will respond the following with a status code 402

{
    "x402Version": 1,
    "error": "X-PAYMENT header is required",
    "accepts": [
        {
            "scheme": "exact",
            "network": "base", // Base mainnet
            "maxAmountRequired": "",
            "resource": "https://api.xerberus.io/public/v1/reports/download/0x31A421271414641cb5063B71594b642D2666dB6B",
            "description": "Access to download research content",
            "mimeType": "",
            "payTo": "receiver_address",
            "maxTimeoutSeconds": 60,
            "asset": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
            "outputSchema": {
                "input": {
                    "type": "http",
                    "method": "GET",
                    "discoverable": true
                }
            },
            "extra": {
                "name": "USD Coin", // USDC on Base
                "version": "2"
            }
        }
    ]
}

1. A second call post payment with the X-PAYMENT header containing the signed payment payload.

const axios = require('axios');

axios.get('https://api.xerberus.io/public/v1/vault/reports/download/0x31A421271414641cb5063B71594b642D2666dB6B', {
  headers: {
    'x-api-key': 'your-api-key',
    'x-user-email': '[e-mail]',
    'X-PAYMENT': `payment_payload`
  }
})
  .then(response => {
    console.log('Download URL:', response.data.data);
  })
  .catch(error => console.error(error));

This will give the final response

{
  status: 'success',
  data: 'https://example.com/link-to-report'
}

The download URL remains active for 5 minutes. Users are advised to initiate the download immediately after the link is issued.

Error Responses

Invalid Vault Address Format

Status Code: 400 Bad Request

{
  "status": "error",
  "message": "Invalid vault address format",
  "error": "Validation error details"
}

Report Not Found

Status Code: 404 Not Found

{
  "status": "error",
  "message": "Report not found for vault address: 0x..."
}

Internal Server Error

Status Code: 500 Internal Server Error

{
  "status": "error",
  "message": "Validation failed",
  "error": "Error details"
}

Important

• No charges for invalid requests: The validation middleware ensures that payment is only processed for valid vault addresses with existing reports

• Time-limited access: The signed URL expires in 5 minutes for security purposes

• One-time payment: Each request requires a separate payment