post https://api.middesk.com/v1/business_batches
This endpoint is used to create a new Business Batch. Once created, the Business Batch will automatically begin the process of verifying the legitimacy of all Businesses specified in the batch concurrently. Results for a business batch can be retrieved using the List all Businesses endpoint and passing the business_batch_id returned by this endpoint as a query parameter.
CSV Format
The first row in your CSV should include all Column Titles for which you'd like to provide information (minimally all required headers, you may leave optional columns out entirely). Every following row should be a sequence of values associated to each Column Title.
Any potential errors due to invalid column values are explained in the Errors column.
| Column Title | Description | Example | Required | Errors |
|---|---|---|---|---|
| name | The Business name | Middesk | Required | Name can't be blank |
| address | The full Business address | 577 Howard St, San Francisco, CA 94105 | Required if address components are not provided | Address can't be blank |
| address_line1, address2_line1 ... address4_line1 | The Business street address | 577 Howard St | Required if address is not provided | N/A |
| address_line2, address2_line2 ... address4_line2 | The Business secondary street address (e.g. Floor #, Suite #) | Suite 400 | Required if address is not provided | N/A |
| address_city, address2_city ... address4_city | The city in which the Business operates | San Francisco | Required if address is not provided | N/A |
| address_state, address2_state ... address4_state | The state in which the Business operates. Please use a two character state abbreviation | CA | Required if address is not provided | N/A |
| address_postal_code, address2_postal_code ... address4_postal_code | The postal code in which the Business operates | 94105 | Required if address is not provided | N/A |
| person_name1, person_name2 ... person_name9 | The name of a person associated with the Business | Kyle Mack | Not Required | N/A |
| person_dob1, person_dob2 ... person_dob9 | The date of birth of a person associated with the Business | 2023-10-12 | Not Required | N/A |
| person_first_name1, person_first_name2 ... person_first_name9 | The first name of a person associated with the Business | Kyle | Not Required | N/A |
| person_middle_name1, person_middle_name2 .. person_middle_name9 | The middle name of a person associated with the Business | June | Not Required | N/A |
| person_last_name1, person_last_name2 .. person_last_name9 | The last name of a person associated with the Business | Mack | Not Required | N/A |
| person_ssn1, person_ssn2.., person_ssn9 | The SSN of a person associated with the Business | XXXXXXXXX | Not Required | N/A |
| person_email1, person_email2.., person_email9 | The email of a person associated with the Business. (KYC) | [email protected] | Required if KYC emailrisk is enabled. | Must be a valid email |
| person_phone_number1, person_phone_number2.., person_phone_number9 | The phone number of a person associated with the Business. (KYC) | 13470000000 | Required if KYC phonerisk is enabled | Must be a valid phone number |
| person_address1_address_line1, person_address2_address_line1.., person_address9_address_line1 | Address line 1 of a person associated with the Business (KYC) | 123 Main Street | Required if ordering KYC | N/A |
| person_address1_address_line2, person_address2_address_line2.., person_address9_address_line2 | Address line 2 of a person associated with the Business (KYC) | Apt B | Not Required | N/A |
| person_address1_city, person_address2_city.., person_address9_city | Address city (KYC) | San Francisco | Required if ordering KYC | N/A |
| person_address1_state, person_address2_state., person_address9_state | Address state | California | Required if ordering KYC | Must be a valid US state. |
| person_address1_postal_code, person_address2_postal_code., person_address9_postal_code | Address postal code | 94110 | Required if ordering KYC | Must be a valid postal code. |
| person_document_uuid1, person_document_uuid2.., person_document_uuid9 | Document UUID of the person associated with the Business (KYC) | 67853995-e2e2-4cd4-af94-18489f7c45b8 | Required if KYC document verification module is enabled | Must be a valid UUID |
| person_device_session_id1, person_device_session_id2.., person_device_session_id9 | Device session ID of the person associated with the Business | Required if KYC device risk module is enabled | ||
| external_id | A custom id that can be attached to this | 12345678 | Not Required | The custom id must be unique in the collection of businesses you submit within the batch. |
| phone_number | The phone number associated with the Business | 6507970487 | Not Required | N/A |
| tin | The Tax Identification Number (TIN) of the Business | 123410000 | Not Required | N/A |
| website | The website of the Business | https://www.middesk.com | Not Required | N/A |
| dba_name | The "Doing Business As" name | Middesk | Not Required | |
| order_product1, order_product2, order_product3, order_product4 | Orders to submit for the business in that row. Up to 20 orders may be submitted per row. If no orders are specified then the desired orders will be inferred based on account setting and what fields were provided. | website | Not Required |