> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wavynode.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Integrate Wavy Node into your platform in minutes

This guide gets you from zero to monitoring wallet addresses and receiving compliance alerts. By the end, you'll have registered an address, run a risk scan, and know how to access your compliance reports.

## Prerequisites

* A [Wavy Node](https://wavynode.com/dashboard) account
* Your API key (available in the dashboard)
* A project with a `projectId` (found in **Project Settings**)

## Step 1: Set up your credentials

Sign up on the Wavy Node dashboard and copy your API key from **Project Settings**.

```bash highlight={1} theme={null}
export WAVYNODE_API_KEY="ApiKey wavy_your_api_key_here"
export PROJECT_ID="your_project_id"
```

<Warning>
  The `x-api-key` header must include the `ApiKey` prefix followed by your key. The correct format is:

  ```highlight={1} theme={null}
  x-api-key: ApiKey wavy_your_api_key_here
  ```

  A common mistake is sending only the key without the prefix. Requests without `ApiKey` will be rejected with an authentication error.
</Warning>

## Step 2: Check supported chains

Verify which blockchain networks are available:

```bash theme={null}
curl -H "x-api-key: $WAVYNODE_API_KEY" \
  https://api.wavynode.com/v1/chains
```

```json theme={null}
{
  "success": true,
  "data": [
    {
      "id": 42161,
      "name": "Arbitrum",
      "rpc_url": "https://arb1.arbitrum.io/rpc",
      "active": true,
      "explorer_url": "https://arbiscan.io",
      "currency_symbol": "ETH",
      "currency_decimals": 18
    }
  ]
}
```

## Step 3: Register an address for monitoring

Add a wallet address to your project so Wavy Node can monitor it:

```bash theme={null}
curl -X POST "https://api.wavynode.com/v1/projects/$PROJECT_ID/addresses" \
  -H "Content-Type: application/json" \
  -H "x-api-key: $WAVYNODE_API_KEY" \
  -d '{
    "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "description": "Main treasury wallet",
    "foreign_user_id": "user-001"
  }'
```

<Tip>
  The `foreign_user_id` links this wallet to a user in your system. When you set up an [integration](/integrations/overview), Wavy Node uses this ID to request user data for compliance reports.
</Tip>

## Step 4: Run a risk scan

Query risk analysis results for the registered address:

```bash theme={null}
curl -H "x-api-key: $WAVYNODE_API_KEY" \
  "https://api.wavynode.com/v1/projects/$PROJECT_ID/addresses/scan-risk?addresses=0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045&chainId=1"
```

```json theme={null}
{
  "success": true,
  "data": {
    "total": 1,
    "missing": 0,
    "results": [
      {
        "analysisId": "550e8400-e29b-41d4-a716-446655440000",
        "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "chainId": "1",
        "riskScore": 5,
        "riskLevel": "minimal",
        "riskReason": "Normal activity, no suspicious patterns detected",
        "suspiciousActivity": false,
        "patternsDetected": [],
        "transactionsAnalyzed": 150,
        "completedAt": "2024-02-13T10:30:00Z"
      }
    ]
  }
}
```

<Tip>
  A `riskScore` under 20 indicates minimal risk. Addresses scoring above 60 should be investigated further.
</Tip>

## Step 5: Access compliance reports

Compliance reports are generated automatically based on your project's activity and active legislations. Retrieve them with:

```bash theme={null}
curl -H "x-api-key: $WAVYNODE_API_KEY" \
  "https://api.wavynode.com/v1/reports?projectId=$PROJECT_ID&period=2026-04&countryCode=MX"
```

Download a specific report:

```bash theme={null}
curl -H "x-api-key: $WAVYNODE_API_KEY" \
  "https://api.wavynode.com/v1/reports/rpt_abc123"
```

```json theme={null}
{
  "success": true,
  "data": {
    "name": "LFPIORPI_April_2026.pdf",
    "signedUrl": "https://storage.wavynode.com/reports/...",
    "period": "2026-04"
  }
}
```

<Tip>
  Reports are available for México (MX), Colombia (CO), El Salvador (SV), and Guatemala (GT).
</Tip>

## What's next

You've registered an address and run your first risk scan. To receive real-time alerts and enable automatic compliance report generation, set up an integration:

```mermaid theme={null}
flowchart LR
    A[✅ Quickstart] --> B[Set up Wavy Node integration]
    B --> C[Scan risk on addresses]
    B --> D[Receive real-time alerts]
    B --> E[Auto-generate compliance reports]
```

<CardGroup cols={2}>
  <Card title="Set up an integration" icon="plug" href="/integrations/setup">
    Connect your app to receive webhooks and serve user data for compliance.
  </Card>

  <Card title="Risk scores" icon="gauge-high" href="/concepts/risk">
    Understand how risk scores are calculated.
  </Card>

  <Card title="Regulations" icon="scale-balanced" href="/concepts/regulations">
    Explore the regulations Wavy Node covers.
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/introduction">
    Browse all available endpoints.
  </Card>
</CardGroup>