For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Contact SalesGet Support
HomeGuidesAPI reference
HomeGuidesAPI reference
  • Get started
    • Quickstart—Verify a Business
    • Quickstart—Register an entity for payroll taxes
    • Learn how Middesk works
      • Lifecycle of a Business
      • How Middesk matches data
      • Review insights
      • Use rulesets or policies
      • Create orders
      • Use the sandbox and production environments
      • Use the enhanced sandbox
    • Security
    • Changelog
  • Build with Middesk
    • Get your API keys
    • Understand API changes
    • Status codes and errors reference
    • Implement webhooks
    • Secure webhooks
    • Use GraphQL
    • Connect MCP
  • Verify a business (KYB)
    • Verify TIN
    • Verify name and address
    • Verify Secretary of State status
    • Verify owners and officers
    • Screen for sanctions and watchlists
    • Search for adverse media
    • Search for Politically Exposed Persons
    • Implement KYC
    • Discover connections
    • Evaluate online presence
    • Assess credit risk
    • Accelerate onboarding
    • Monitor business activity
    • Manage business entities
    • Work with agents
LogoLogo
Contact SalesGet Support
On this page
  • How enhanced sandbox mode works
  • Pre-built scenario templates
  • Simulated outcomes supported by verification type
  • How to use enhanced sandbox mode
Get startedLearn how Middesk works

Use the enhanced sandbox

Was this page helpful?
Previous

Security

Next
Built with

Testing with the standard sandbox requires memorizing specific business names and input values to trigger specific verification outcomes. The enhanced sandbox removes that friction. Define your own test businesses, select expected results, and save reusable scenarios from the Dashboard.

The enhanced sandbox is not enabled by default. Contact your account manager or contact sales to request access and migrate any preexisting test cases. Once enabled, the enhanced sandbox replaces the standard sandbox.

How enhanced sandbox mode works

The enhanced sandbox is built around three core concepts:

  • Scenario templates—Pre-configured verification outcome sets (for example, all verified, TIN mismatch, watchlist hit). Select a template and the sandbox delivers that result consistently.
  • Custom test businesses—Define business details (name, address, TIN, entity type, officers) instead of using hardcoded trigger values. Combine multiple conditions in a single scenario, such as a business in good standing with a TIN mismatch, or an approximate address match with a watchlist hit.
  • Scenario library—Saved scenarios stored in your account, accessible to your entire team from Settings → Sandbox configuration. Create, view, edit, and delete scenarios as needed.

The enhanced sandbox simulates all data without performing real compliance checks. Scenarios are deterministic—the same configuration produces the same verification results every time, so you can build repeatable test workflows and debug without chasing changing data.

The enhanced sandbox does not support API access. Create and manage all scenarios through the Dashboard. For API-based sandbox testing, refer to the standard sandbox trigger values in Use the sandbox and production environments.

Pre-built scenario templates

The enhanced sandbox includes ready-to-use templates for common verification outcomes. Use these pre-built scenario templates to simulate specific outcomes on test businesses in your account.

ScenarioSimulation outcomes
Happy pathAll verifications pass
TIN mismatchTax ID does not match business records
Similar name matchClose but non-exact business name
Name not foundBusiness missing from state records
Inactive or dissolvedBusiness is no longer active
Open UCC liensOutstanding UCC filings
Federal tax lienFederal tax lien present
BankruptcyChapter 11 filing on record
Watchlist hitSanctions list match
Active litigationOngoing lawsuit
Prohibited industryHigh-risk industry classification
High-quality websiteClean, well-established web presence
Low-quality websiteSuspicious or low-trust website
Offline websiteWebsite not reachable

Simulated outcomes supported by verification type

The enhanced sandbox allows you to create simulated verification outcomes across Middesk’s supported verification types, so you can reliably reproduce specific scenarios without using real data. If a case is not covered by a pre-built test scenario template, you can build your own scenario by combining supported outcomes and reusing it for consistent end-to-end testing.

Verification typeSimulated outcomes
Business registrationActive, inactive, dissolved, not found, similar name match
TIN and EINMatch, mismatch, unknown, sole proprietor
AddressVerified, approximate, incomplete, CMRA, registered agent, deliverable, undeliverable
Liens and legal recordsUCC, federal tax, state liens; open, pending, or closed
BankruptcyChapter 7, Chapter 11, Chapter 13
LitigationCivil, contract disputes; open or closed cases
Watchlist and OFAC screeningSanctions matches, aliases, associated programs
Adverse mediaHigh risk, moderate risk, low risk
Industry classificationNAICS codes, MCC codes, prohibited industries
Website and online presenceDomain quality, domain age, social profiles, risky keywords

How to use enhanced sandbox mode

1

Switch to sandbox mode

In the Dashboard, switch to the sandbox environment using the environment selector.

2

Open sandbox configuration

Navigate to Settings → Sandbox configuration.

3

Select a scenario with business details

Click the Create new example button, select a scenario template, and input business details to pair with the scenario.

4

Submit a verification

Click the Place order button in sandbox mode, select the business from the dropdown, and order the verification on that business. The system automatically applies the pre-configured business details.

5

Review results

Middesk returns simulated verification results that match the selected scenario. Validate that your workflow handles the outcome correctly.

Get a demo
Contact your account manager or contact sales to inquire about access.