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

# Waterfall

> Waterfall Scenario seeding parameters, nested fields, and examples

Use `waterfall` in `twins` and put this configuration under `seed_config.waterfall`.

Waterfall.io prospecting and enrichment API with contacts, companies, verified emails, phone enrichment, job-change checks, account usage, and managed API keys.

## Example seed

This is the complete Scenario request body for [creating a Scenario](https://docs.argalabs.com/api-reference/post-create-a-scenario.md). You can also import it with `arga test-runner scenarios import --file scenario.json`.

```json theme={null}
{
  "name": "Waterfall eval fixture",
  "twins": [
    "waterfall"
  ],
  "seed_config": {
    "waterfall": {
      "prospects": [
        {
          "domain": "example.com",
          "title_filter": "founder OR revenue",
          "limit": 3,
          "include_phones": true
        }
      ],
      "contacts": [
        {
          "full_name": "Ada Lovelace",
          "domain": "example.com",
          "include_phones": true
        }
      ],
      "companies": [
        {
          "domain": "example.com"
        }
      ],
      "verify_emails": [
        {
          "email": "ada@example.com"
        }
      ]
    }
  }
}
```

## Parameters

The following fields belong directly inside `seed_config.waterfall`. Required nested fields are marked in their tables. Provider-native objects can contain service-specific fields beyond the representative record shapes below.

| Parameter | Type | Description |
| - | - | - |
| `reset` | `boolean` | Enable or set reset behavior. |
| `companies` | `object[]` | Companies fixtures in provider-native format. |
| `persons` | `object[]` | Persons fixtures in provider-native format. |
| `contacts` | `object[]` | Contacts fixtures in provider-native format. |
| `prospects` | `object[]` | Prospects fixtures in provider-native format. |
| `verify_emails` | `object[]` | Verify emails fixtures in provider-native format. |
| `titles` | `object[]` | Titles fixtures in provider-native format. |
| `reveals` | `object[]` | Reveals fixtures in provider-native format. |

## Resource fields

These tables describe the record shapes used by the example. Keep native field names and casing. Map keys such as property names, IDs, and metadata keys are supplied by your fixture.

### `prospects[]`

| Parameter | Type | Description |
| - | - | - |
| `domain` | `string` | Domain. |
| `title_filter` | `string` | Title filter. |
| `limit` | `integer` | Limit. |
| `include_phones` | `boolean` | Enable or set include phones behavior. |

### `contacts[]`

| Parameter | Type | Description |
| - | - | - |
| `full_name` | `string` | Full name. |
| `domain` | `string` | Domain. |
| `include_phones` | `boolean` | Enable or set include phones behavior. |

### `companies[]`

| Parameter | Type | Description |
| - | - | - |
| `domain` | `string` | Domain. |

### `verify_emails[]`

| Parameter | Type | Description |
| - | - | - |
| `email` | `string` | Main account email address. |

## API coverage and limitations

**Twin name:** `waterfall`

**Supports**

* Waterfall API workflows for company search, people search, enrichment, verification, and account endpoints.
* API-key authentication with UUID-shaped keys such as `ad18e456-0dd7-45e1-b094-43a0361aedfa`.
* Environment-variable rewrites through the wizard for `WATERFALL_API_KEY`, `WATERFALL_API_BASE_URL`, `WATERFALL_API_URL`, and `WATERFALL_BASE_URL`.

**Known limitations**

* Waterfall data starts empty unless seeded or created through API calls.
* The twin focuses on API-compatible enrichment and verification workflows; broader Waterfall dashboard behavior is outside the primary fidelity target.
* The Waterfall twin is backend-only; there is no browsable UI surface in the Arga app.

**MCP tools:** `get_twin_catalog`, `provision_twins`, `start_url_validation`, `get_validation_results`.

See [Scenario seeding](https://docs.argalabs.com/twins/seeding.md) for saving, provisioning, and resetting fixtures.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.