> ## 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.

# Middesk

> Middesk Scenario seeding parameters, nested fields, and examples

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

Middesk business identity verification (KYB), TIN, review decisions, orders, monitoring, liens, payroll-tax entity registration, agent threads/runs, risk assessments and sub-accounts.

## 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": "Middesk eval fixture",
  "twins": [
    "middesk"
  ],
  "seed_config": {
    "middesk": {
      "businesses": [
        {
          "id": "Optional stable UUID",
          "name": "Business legal name",
          "status": "in_review",
          "external_id": "Optional customer identifier",
          "tags": [
            "onboarding"
          ],
          "addresses": [
            {
              "address_line1": "100 Market Street",
              "city": "San Francisco",
              "state": "CA",
              "postal_code": "94105"
            }
          ],
          "tin": {
            "tin": "123456789",
            "verified": true
          },
          "people": [
            {
              "name": "Alex Morgan",
              "titles": [
                "Owner"
              ]
            }
          ],
          "review": {
            "tasks": []
          },
          "orders": [
            {
              "product": "identity",
              "status": "completed"
            }
          ],
          "monitor": {
            "event_types": [
              "*"
            ]
          },
          "liens": [],
          "registrations": [],
          "documents": [],
          "risk_assessments": []
        }
      ],
      "agents": [
        {
          "type": "cip_orchestrator",
          "name": "Identity review"
        }
      ],
      "companies": [],
      "registration_requests": [],
      "mail": [],
      "exceptions": [],
      "jurisdictions": [],
      "questions": [],
      "signals": [],
      "webhooks": [],
      "threads": [],
      "runs": [],
      "sub_accounts": [],
      "failure_rules": [
        {
          "method": "GET",
          "path": "/v1/businesses/*",
          "status_code": 500,
          "remaining_invocations": 1
        }
      ]
    }
  }
}
```

## Parameters

The following fields belong directly inside `seed_config.middesk`. 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 |
| - | - | - |
| `businesses` | `object[]` | Businesses fixtures in provider-native format. |
| `agents` | `object[]` | Agents fixtures in provider-native format. |
| `companies` | `array` | Companies fixtures in provider-native format. |
| `registration_requests` | `array` | Registration requests fixtures in provider-native format. |
| `mail` | `array` | Mail fixtures in provider-native format. |
| `exceptions` | `array` | Exceptions fixtures in provider-native format. |
| `jurisdictions` | `array` | Jurisdictions fixtures in provider-native format. |
| `questions` | `array` | Questions fixtures in provider-native format. |
| `signals` | `array` | Signals fixtures in provider-native format. |
| `webhooks` | `array` | Webhook subscriptions or configurations. |
| `threads` | `array` | Threads fixtures in provider-native format. |
| `runs` | `array` | Runs fixtures in provider-native format. |
| `sub_accounts` | `array` | Sub accounts fixtures in provider-native format. |
| `base_time` | `string` | Reference clock for repeatable fixtures. Omit to use the current clock. |
| `credentials` | `Credential[]` | Credentials fixtures in provider-native format. Minimum entries: 1. |
| `requests_per_second` | `integer` | Requests per second. Minimum: 0. |
| `sandbox_businesses_per_minute` | `integer` | Sandbox businesses per minute. Minimum: 0. |
| `rate_limit_service_available` | `boolean` | Enable or set rate limit service available behavior. |
| `verification_delay_seconds` | `integer` | Verification delay seconds, in seconds. Minimum: 0. |
| `connections_enabled` | `boolean` | Enable or set connections enabled behavior. |
| `tin_match_available` | `boolean` | Enable or set tin match available behavior. |
| `default_secured_parties` | `object[]` | Default secured parties fixtures in provider-native format. |
| `default_collateral` | `string` | Default collateral. |
| `allowed_delivery_origins` | `string[]` | Allowed delivery origins fixtures in provider-native format. |
| `risk_enabled` | `boolean` | Enable or set risk enabled behavior. |
| `sub_accounts_enabled` | `boolean` | Enable or set sub accounts enabled behavior. |
| `international_enabled` | `boolean` | Enable or set international enabled behavior. |
| `partner_profile_required` | `boolean` | Enable or set partner profile required behavior. |
| `products` | `string[]` | Products fixtures in provider-native format. |
| `failure_rules` | `FailureRule[]` | Deterministic failure-injection rules. |
| `oauth_clients` | `object[]` | Oauth clients fixtures in provider-native format. |
| `orders` | `object[]` | Orders fixtures in provider-native format. |
| `business_batches` | `object[]` | Business batches fixtures in provider-native format. |
| `monitors` | `object[]` | Monitors fixtures in provider-native format. |
| `liens` | `object[]` | Liens fixtures in provider-native format. |
| `registrations` | `object[]` | Registrations fixtures in provider-native format. |
| `actions` | `object[]` | Actions fixtures in provider-native format. |
| `feedback` | `object[]` | Feedback fixtures in provider-native format. |
| `documents` | `object[]` | Documents fixtures in provider-native format. |
| `risk_assessments` | `object[]` | Risk assessments fixtures in provider-native format. |
| `api_keys` | `object[]` | Api keys fixtures in provider-native format. |
| `event_schemas` | `object[]` | Event schemas fixtures in provider-native format. |
| `connections` | `object[]` | Connections fixtures in provider-native format. |
| `timeline` | `object[]` | Timeline fixtures in provider-native format. |
| `names` | `object[]` | Names fixtures in provider-native format. |
| `addresses` | `object[]` | Addresses fixtures in provider-native format. |
| `people` | `object[]` | People fixtures in provider-native format. |
| `phone_numbers` | `object[]` | Phone numbers fixtures in provider-native format. |
| `email_addresses` | `object[]` | Email addresses fixtures in provider-native format. |
| `bankruptcies` | `object[]` | Bankruptcies fixtures in provider-native format. |
| `certifications` | `object[]` | Certifications fixtures in provider-native format. |
| `profiles` | `object[]` | Profiles fixtures in provider-native format. |
| `fmcsa_registrations` | `object[]` | Fmcsa registrations fixtures in provider-native format. |
| `litigations` | `object[]` | Litigations fixtures in provider-native format. |
| `policy_results` | `object[]` | Policy results fixtures in provider-native format. |
| `sources` | `object[]` | Sources fixtures in provider-native format. |
| `watchlist_results` | `object[]` | Watchlist results fixtures in provider-native format. |
| `accounts` | `object[]` | Accounts 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.

### `businesses[]`

| Parameter | Type | Description |
| - | - | - |
| `id` | `string` | Explicit resource identifier, when supported. |
| `name` | `string` | Human-readable name. |
| `status` | `string` | Status. |
| `external_id` | `string` | External id. |
| `tags` | `string[]` | Tags fixtures in provider-native format. |
| `addresses` | `object[]` | Addresses fixtures in provider-native format. |
| `tin` | `object` | Tin. |
| `people` | `object[]` | People fixtures in provider-native format. |
| `review` | `object` | Review. |
| `orders` | `object[]` | Orders fixtures in provider-native format. |
| `monitor` | `object` | Monitor. |
| `liens` | `array` | Liens fixtures in provider-native format. |
| `registrations` | `array` | Registrations fixtures in provider-native format. |
| `documents` | `array` | Documents fixtures in provider-native format. |
| `risk_assessments` | `array` | Risk assessments fixtures in provider-native format. |

### `businesses[].addresses[]`

| Parameter | Type | Description |
| - | - | - |
| `address_line1` | `string` | Address line1. |
| `city` | `string` | City. |
| `state` | `string` | State. |
| `postal_code` | `string` | Postal code. |

### `businesses[].people[]`

| Parameter | Type | Description |
| - | - | - |
| `name` | `string` | Human-readable name. |
| `titles` | `string[]` | Titles fixtures in provider-native format. |

### `businesses[].orders[]`

| Parameter | Type | Description |
| - | - | - |
| `product` | `string` | Product. |
| `status` | `string` | Status. |

### `agents[]`

| Parameter | Type | Description |
| - | - | - |
| `type` | `string` | Type. |
| `name` | `string` | Human-readable name. |

### `failure_rules[]`

| Parameter | Type | Description |
| - | - | - |
| `method` | `string` | Method. |
| `path` | `string` | Path. |
| `status_code` | `integer` | Status code. |
| `remaining_invocations` | `integer` | Remaining invocations. |

## Typed configuration objects

Named object types in the parameter table use these fields.

### Credential

| Parameter | Type | Description |
| - | - | - |
| `key` | `string` | **Required.** Key. Minimum length: 1. |
| `account_id` | `string` | Account id. |
| `environment` | `string` | Environment. |
| `scope` | `string` | Scope. |
| `active` | `boolean` | Enable or set active behavior. |

### FailureRule

| Parameter | Type | Description |
| - | - | - |
| `method` | `string` | Method. |
| `path` | `string` | Path. |
| `status_code` | `integer` | Status code. Minimum: 400. Maximum: 599. |
| `message` | `string` | Message. |
| `parameter` | `string or null` | Parameter. |
| `body` | `object or null` | Text content. |
| `headers` | `map<string, string>` | Headers keyed by identifier or resource name. |
| `remaining_invocations` | `integer` | Remaining invocations. Minimum: 1. |

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.