This section describes companyIds, a required parameter for Company Insight File Data.
- get - all requests to this endpoint must be
All parameters are required.
zip (int 5) The zip code of the companies, must be a valid zip code. API Endpoint
companyName (varchar 50) The complete or parital company name to be searched.
apiKey (varchar 40) The API key as provided by BizMiner staff. Used for authentication and billing.
requestId (varchar 16) An optional value to track and debug client calls. Default to 0.
hash (varchar 40) The SHA1 hashed value of:zip + companyName + apiKey using the secret provided by BizMiner at the time of providing the API key. This is used to authenticate requests. If the hash does not match server-side validation, and error response will be returned.
Successful Response Data Structure
The following is the data structure of 200 responses. For a list of unsuccessful response codes see here.
-status (HTTP code) -responseID (unique code from the server for debugging) -companies [collection] -companyId (code to be used in Company Insight File Data) -companyName (company name) ...