The Sandbox environment enables you to familiarize yourself and experiment with the Middesk API before going live in a Production environment. Listed below are some key differences between the two environments:
Middesk provides a rich set of information for its Businesses. In Production, a Business could have a significant number of Resources associated with it such as multiple registration records, multiple addresses, multiple officers, and so on. The Sandbox environment provides enough information to build an integration, but the variance in the data that is returned is limited in order to address the most common integration use cases.
As referenced in the Lifecycle of a Business section, Middesk transitions a Business through multiple statuses, from
in_review. The Sandbox environment supports all of these statuses, with the exception of the
in_audit status. When building in Sandbox, it's important to take this difference into consideration.
Businesses can be created in Batches in both the Sandbox and Production environments. Use this feature to create many businesses at once, and provide attributes as detailed in the table above to trigger different verification scenarios as desired.
Classifications can be created for Sandbox businesses if a website URL is inputted or as stand-alone classifications. For both products, the possible inputs to get different results are described below:
|Contains ||Includes a result in a high-risk category.|
|Anything else||Results only in low-risk categories.|
To test subscriptions, create a business with the inputs described below. The business will automatically have a subscription with the corresponding event type. After a minute, the business and its records will be updated accordingly to simulate the occurrence of that event, which you can receive by creating a webhook or polling for updates.
|Event Type||Input Field||Value||Description|
|Business Name||A new Watchlist Result will be created for the Business|
|TI||The TIN will initially be unknown and then become verified.|
Each Middesk user has a role that allows for specific capabilities:
- Member: Basic team member; can create and view Businesses
- Developer: Includes all Member privileges as well as the ability to view (and edit where appropriate) API Keys, Webhooks, APILogs, and IPAllowLists
- Admin: All privileges; includes Developer privileges as well as the ability to add team members and to create business batches)
Updated 8 months ago