Create orders
Orders specify what action should be performed on a business. This might be as simple as a verification or as involved as search for litigations.
A business always has one or more Orders associated with it.
Create an Order
You can create an Order through the API or in the Dashboard. Through both routes you can create an Order when you create the Business object in your Middesk account or as a follow-up step on an existing Business object.
Each Order has two fields:
- package specifies the type of Order to be fulfilled
- subproducts are optional parameters that modify the request
Orders align with Middesk’s products, so a package might be business_verification_verify with no subproducts modifier or website with a web_analysis modification (as the subproduct).
If no orders are specified you create a Business, Middesk infers the orders to add based on the fields present in the request. The default is a Business Verification - Verify report. If a website is submitted, a Website Order is added. If a person is submitted with KYC fields, depending on the account settings, a KYC Order is added.
Create an Order through the API
Create an Order in the Dashboard
To create an Order through the API:
- Use the
ordersarray when creating a Business with aPOST /businessescall - Use a
POST /businesses/{business_id}/ordersAPI call to add an Order to an existing Business
Order lifecycle
Orders progress through the following statuses:
Available order types
Verification Orders
Background check Orders
Litigation and Financial Orders
People-focused Orders
Order dependencies
Most order types require a business_verification_verify order to be present first. This establishes a prerequisite chain for order fulfillment.
