Middesk subpackage_businesses API
The subpackage_businesses API from Middesk — 3 operation(s) for subpackage_businesses.
The subpackage_businesses API from Middesk — 3 operation(s) for subpackage_businesses.
openapi: 3.0.3
info:
title: Middesk subpackage_actions subpackage_businesses API
version: 1.0.0
servers:
- url: https://api.middesk.com
description: Default
tags:
- name: subpackage_businesses
paths:
/v1/businesses:
get:
operationId: list-businesses
summary: List businesses
tags:
- subpackage_businesses
parameters:
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
responses:
'200':
description: businesses list
content:
application/json:
schema:
$ref: '#/components/schemas/type_businesses:ListBusinessesResponse'
post:
operationId: create-business
summary: Create a business
tags:
- subpackage_businesses
parameters:
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
responses:
'201':
description: business created
content:
application/json:
schema:
$ref: '#/components/schemas/type_:Business'
'422':
description: invalid request
content:
application/json:
schema:
description: Any type
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
tin:
$ref: '#/components/schemas/type_businesses:BusinessRequestParamTin'
addresses:
type: array
items:
$ref: '#/components/schemas/type_businesses:BusinessRequestParamAddressesItem'
website:
$ref: '#/components/schemas/type_businesses:BusinessRequestParamWebsite'
description: Website information for the business. Required when name and addresses are not provided when ordering the web_analysis and/or industry_classification subproducts.
people:
type: array
items:
$ref: '#/components/schemas/type_:SubmittedPerson'
external_id:
type: string
unique_external_id:
type: string
tags:
type: array
items:
type: string
connection_id:
type: string
description: The ID of a connection to use as the source for this business. Pre-fills the business name and address from the connection.
orders:
type: array
items:
$ref: '#/components/schemas/type_businesses:BusinessRequestParamOrdersItem'
description: Orders to place against the business at creation time. Each order specifies a product (and optional subproducts/options) to run.
required:
- name
- addresses
/v1/businesses/{id}:
get:
operationId: get-business
summary: Retrieve a business
tags:
- subpackage_businesses
parameters:
- name: id
in: path
description: Business ID
required: true
schema:
type: string
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
responses:
'200':
description: business found
content:
application/json:
schema:
$ref: '#/components/schemas/type_:Business'
'404':
description: business not found
content:
application/json:
schema:
$ref: '#/components/schemas/type_:ErrorResponse'
patch:
operationId: update-business
summary: Update a business
tags:
- subpackage_businesses
parameters:
- name: id
in: path
description: Business ID
required: true
schema:
type: string
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
responses:
'200':
description: business updated
content:
application/json:
schema:
$ref: '#/components/schemas/type_:Business'
'404':
description: business not found
content:
application/json:
schema:
$ref: '#/components/schemas/type_:ErrorResponse'
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
status:
$ref: '#/components/schemas/type_businesses:BusinessUpdateParamStatus'
description: Status to set for the business (only final statuses allowed)
tin:
$ref: '#/components/schemas/type_businesses:BusinessUpdateParamTin'
addresses:
type: array
items:
$ref: '#/components/schemas/type_businesses:BusinessUpdateParamAddressesItem'
people:
type: array
items:
$ref: '#/components/schemas/type_:SubmittedPerson'
external_id:
type: string
unique_external_id:
type: string
tags:
type: array
items:
type: string
/v1/businesses/{id}/pdf:
get:
operationId: get-business-pdf
summary: Retrieve a business PDF
tags:
- subpackage_businesses
parameters:
- name: id
in: path
description: Business ID
required: true
schema:
type: string
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
responses:
'200':
description: Successful response
'404':
description: business not found
content:
application/json:
schema:
description: Any type
components:
schemas:
type_:AdverseMediaScreeningResultsItemItemsItemObject:
type: string
enum:
- adverse_media_item
title: AdverseMediaScreeningResultsItemItemsItemObject
type_:AdverseMediaScreeningResultsItemItemsItemFlagsRisksItem:
type: object
properties:
name:
type: string
confidence_level:
$ref: '#/components/schemas/type_:AdverseMediaScreeningResultsItemItemsItemFlagsRisksItemConfidenceLevel'
title: AdverseMediaScreeningResultsItemItemsItemFlagsRisksItem
type_:CriminalHistoryCharge:
type: object
properties:
object:
$ref: '#/components/schemas/type_:CriminalHistoryChargeObject'
category:
type: string
nullable: true
charge_type:
type: string
nullable: true
city:
type: string
nullable: true
county:
type: string
nullable: true
description:
type: string
nullable: true
dispositions:
type: array
items:
$ref: '#/components/schemas/type_:CriminalHistoryChargeDispositionsItem'
legal_code:
type: string
nullable: true
offense_date:
type: string
nullable: true
format: date
sentences:
type: array
nullable: true
items:
$ref: '#/components/schemas/type_:CriminalHistoryChargeSentencesItem'
state:
type: string
nullable: true
subcategory:
type: string
nullable: true
subsubcategory:
type: string
nullable: true
required:
- object
title: CriminalHistoryCharge
type_:CriminalHistoryRecordPerson:
type: object
properties:
dob:
type: string
nullable: true
format: date
title: CriminalHistoryRecordPerson
type_:IndustryClassificationCategoriesItemClassificationSystem:
type: string
enum:
- NAICS
- MCC
- Prohibited
title: IndustryClassificationCategoriesItemClassificationSystem
type_:TaxExemptOrganization:
type: object
properties:
object:
type: string
id:
type: string
format: uuid
ein:
type: string
name:
type: string
section:
type: string
nullable: true
ruling_date:
type: string
nullable: true
format: date
tax_period:
type: string
nullable: true
format: date
revoked_at:
type: string
nullable: true
format: date-time
title: TaxExemptOrganization
type_:Person:
type: object
properties:
object:
$ref: '#/components/schemas/type_:PersonObject'
id:
type: string
format: uuid
name:
type: string
submitted:
type: boolean
business_id:
type: string
format: uuid
titles:
type: array
items:
$ref: '#/components/schemas/type_:PersonTitlesItem'
people_bankruptcies:
type: array
items:
type: object
additionalProperties:
description: Any type
litigations:
type: array
items:
$ref: '#/components/schemas/type_:Litigation'
liens:
type: array
items:
$ref: '#/components/schemas/type_:Lien'
criminal_records:
type: array
items:
$ref: '#/components/schemas/type_:CriminalHistoryRecord'
sources:
type: array
items:
$ref: '#/components/schemas/type_:Source'
title: Person
type_:LitigationPartiesItem:
type: object
properties:
id:
type: string
format: uuid
name:
type: string
role:
$ref: '#/components/schemas/type_:LitigationPartiesItemRole'
litigation_id:
type: string
format: uuid
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
required:
- id
- name
- role
- litigation_id
title: LitigationPartiesItem
type_:MonitorEventTypesItem:
type: object
properties:
type:
type: string
enabled_at:
type: string
nullable: true
format: date-time
status:
$ref: '#/components/schemas/type_:MonitorEventTypesItemStatus'
title: MonitorEventTypesItem
type_:Loan:
type: object
properties:
object:
$ref: '#/components/schemas/type_:LoanObject'
id:
type: string
format: uuid
issued_date:
type: string
nullable: true
format: date
amount:
type: number
nullable: true
format: double
lender:
type: string
nullable: true
details:
oneOf:
- $ref: '#/components/schemas/type_:LoanDetails'
- type: 'null'
required:
- object
- id
title: Loan
type_:ReviewTaskStatus:
type: string
enum:
- success
- failure
- warning
- neutral
title: ReviewTaskStatus
type_:SubmittedAddressComponent:
type: object
properties:
address_line_1:
type: string
address_line_2:
type: string
city:
type: string
state:
$ref: '#/components/schemas/type_:SubmittedAddressComponentState'
postal_code:
type: string
country:
type: string
required:
- address_line_1
- city
- state
title: SubmittedAddressComponent
type_:WatchlistAgency:
type: object
properties:
abbr:
type: string
name:
type: string
org:
type: string
required:
- abbr
- name
- org
title: WatchlistAgency
type_:WebsiteRating:
type: object
properties:
indicators:
type: array
items:
$ref: '#/components/schemas/type_:WebsiteIndicator'
quality_rating:
$ref: '#/components/schemas/type_:WebsiteRatingQualityRating'
required:
- quality_rating
title: WebsiteRating
type_:SubmittedPerson:
type: object
properties:
name:
type: string
description: Full name of the person
title:
type: string
description: Job title or role
email:
type: string
format: email
phone:
type: string
required:
- name
title: SubmittedPerson
type_:PhoneNumberObject:
type: string
enum:
- phone_number
title: PhoneNumberObject
type_:PolicyActionResultPolicyAction:
type: object
properties:
id:
type: string
description: Policy action ID
action_type:
type: string
description: Type of action
options:
type: object
additionalProperties:
description: Any type
description: Action options
policy_version_id:
type: string
description: Policy version ID
title: PolicyActionResultPolicyAction
type_:User:
type: object
properties:
object:
type: string
id:
type: string
format: uuid
name:
type: string
email:
type: string
format: email
roles:
type: array
items:
type: string
image_url:
type: string
format: uri
directory_managed:
type: boolean
last_login_at:
type: string
nullable: true
format: date-time
settings:
type: object
additionalProperties:
description: Any type
created_at:
type: string
format: date-time
required:
- object
- id
- name
- email
- roles
- created_at
title: User
type_:EmailIndicatorRating:
type: string
enum:
- positive
- negative
- neutral
title: EmailIndicatorRating
type_:LienStatusCategory:
type: string
enum:
- active
- open
- closed
- terminated
- processing
- unknown
description: Categorized status of the lien
title: LienStatusCategory
type_:CriminalHistoryCase:
type: object
properties:
object:
$ref: '#/components/schemas/type_:CriminalHistoryCaseObject'
arrest_date:
type: string
nullable: true
format: date
case_number:
type: string
nullable: true
case_type:
type: string
nullable: true
court_county:
type: string
nullable: true
court_name:
type: string
nullable: true
file_date:
type: string
nullable: true
format: date
status:
type: string
nullable: true
title:
type: string
nullable: true
arresting_agency:
type: string
nullable: true
charges:
type: array
items:
$ref: '#/components/schemas/type_:CriminalHistoryCharge'
required:
- object
- charges
title: CriminalHistoryCase
type_:IndustryClassificationStatus:
type: string
enum:
- pending
- completed
- failed
title: IndustryClassificationStatus
type_:ProfileType:
type: string
enum:
- facebook
- google
- yelp
- bbb
- linkedin
title: ProfileType
type_:Website:
type: object
properties:
object:
$ref: '#/components/schemas/type_:WebsiteObject'
id:
type: string
format: uuid
url:
type: string
nullable: true
format: uri
description: The URL that was passed or found for the Business
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
status:
$ref: '#/components/schemas/type_:WebsiteStatus'
http_status_code:
type: integer
nullable: true
description: HTTP response status code
title:
type: string
nullable: true
description: Website page title
description:
type: string
nullable: true
description: Website meta description
domain:
oneOf:
- $ref: '#/components/schemas/type_:WebsiteDomain'
- type: 'null'
description: Domain registration and redirect information
pages:
type: array
items:
$ref: '#/components/schemas/type_:WebsitePagesItem'
description: Website pages with screenshots
parked:
type: boolean
nullable: true
description: Whether the domain is parked
submitted:
type: boolean
description: Whether the website was submitted by user
error:
type: string
nullable: true
description: Error message if website analysis failed
category:
type: string
nullable: true
description: Website category classification
platform:
type: string
nullable: true
description: Website platform (e.g., instagram.com, facebook.com)
posts_summary:
type: string
nullable: true
description: Summary of posts found on the website or linked social media profiles
reviews_summary:
type: string
nullable: true
description: Summary of reviews found on the website or linked third-party profiles
business_id:
type: string
format: uuid
business_name_match:
type: boolean
description: Whether website content matches business name
names:
type: array
items:
$ref: '#/components/schemas/type_:Name'
description: Names found on website
phone_numbers:
type: array
items:
$ref: '#/components/schemas/type_:WebsitePhoneNumber'
description: Phone numbers found on website
people:
type: array
nullable: true
items:
type: object
additionalProperties:
description: Any type
description: People found on website
addresses:
type: array
items:
$ref: '#/components/schemas/type_:WebsiteAddressesItem'
description: Addresses found on website
email_addresses:
type: array
nullable: true
items:
$ref: '#/components/schemas/type_:WebsiteEmailAddressesItem'
description: Email addresses found on website
rating:
oneOf:
- $ref: '#/components/schemas/type_:WebsiteRating'
- type: 'null'
required:
- object
- id
- url
- created_at
- updated_at
- status
- parked
- submitted
- business_id
- business_name_match
- phone_numbers
- addresses
title: Website
type_:Review:
type: object
properties:
object:
$ref: '#/components/schemas/type_:ReviewObject'
id:
type: string
format: uuid
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
completed_at:
type: string
nullable: true
format: date-time
tasks:
type: array
items:
$ref: '#/components/schemas/type_:ReviewTask'
assignee:
oneOf:
- $ref: '#/components/schemas/type_:User'
- type: 'null'
required:
- object
- id
- created_at
- updated_at
- tasks
title: Review
type_:PolicyResult:
type: object
properties:
object:
type: string
id:
type: string
description: Policy result ID
result:
type: string
description: Policy result outcome
created_at:
type: string
description: Creation timestamp
matched:
type: string
nullable: true
description: Match status
executed:
type: boolean
description: Execution status
name:
type: string
nullable: true
description: Policy name
details:
type: object
additionalProperties:
description: Any type
description: Additional details
owner_id:
type: string
description: Owner ID
owner_type:
type: string
description: Owner type
business_id:
type: string
description: Business ID
type_of:
type: string
description: Type of policy result
policy_action_results:
type: array
items:
$ref: '#/components/schemas/type_:PolicyActionResult'
title: PolicyResult
type_:LienCollateralType:
type: string
enum:
- Blanket
- Collateral
- Unknown
- All Assets and Receivables
- All Receivables
- All Assets
- Named Assets
- Unavailable
title: LienCollateralType
type_:Monitor:
type: object
properties:
object:
type: string
id:
type: string
format: uuid
created_at:
type: string
format: date-time
event_types:
type: array
items:
$ref: '#/components/schemas/type_:MonitorEventTypesItem'
required:
- object
- id
- created_at
- event_types
title: Monitor
type_:SubmittedAddressFull:
type: object
properties:
full_address:
type: string
description: Complete address as a single string
required:
- full_address
title: SubmittedAddressFull
type_:Profile:
type: object
properties:
object:
type: string
id:
type: string
format: uuid
type:
$ref: '#/components/schemas/type_:ProfileType'
external_id:
type: string
nullable: true
url:
type: string
format: uri
metadata:
$ref: '#/components/schemas/type_:ProfileMetadata'
rating:
type: number
nullable: true
format: double
rating_count:
type: integer
nullable: true
required:
- object
- id
- type
- url
title: Profile
type_:LienSecuredPartiesItemAddressesItem:
type: object
properties:
full_address:
type: string
address_line1:
type: string
address_line2:
type: string
nullable: true
city:
type: string
state:
type: string
postal_code:
type: string
title: LienSecuredPartiesItemAddressesItem
type_:ErrorResponseErrorsItem:
type: object
properties:
message:
type: string
required:
- message
title: ErrorResponseErrorsItem
type_:EmailIndicator:
type: object
properties:
type:
$ref: '#/components/schemas/type_:EmailIndicatorType'
name:
type: string
rating:
$ref: '#/components/schemas/type_:EmailIndicatorRating'
value:
type: string
description:
type: string
required:
- type
- name
- rating
- value
- description
title: EmailIndicator
type_:BusinessSubscriptionAvailabilityRegistration:
type: string
enum:
- subscribable
- account_unsubscribable
title: BusinessSubscriptionAvailabilityRegistration
type_:EmailRating:
type: object
properties:
risk_rating:
$ref: '#/components/schemas/type_:EmailRatingRiskRating'
indicators:
type: array
items:
$ref: '#/components/schemas/type_:EmailIndicator'
required:
- risk_rating
title: EmailRating
type_:PersonTitlesItem:
type: object
properties:
object:
$ref: '#/components/schemas/type_:PersonTitlesItemObject'
title:
type: string
title: PersonTitlesItem
type_:WebsiteEmailAddressesItem:
type: object
properties:
object:
$ref: '#/components/schemas/type_:WebsiteEmailAddressesItemObject'
email:
type: string
id:
type: string
format: uuid
submitted:
type: boolean
sources:
type: array
items:
$ref: '#/components/schemas/type_:Source'
title: WebsiteEmailAddressesItem
type_:AddressDeliverabilityAnalysisSubKey:
type: string
enum:
- deliverable
- undeliverable
- unknown
title: AddressDeliverabilityAnalysisSubKey
type_:Registration:
type: object
properties:
object:
type: string
id:
type: string
format: uuid
business_id:
type: string
format: uuid
name:
type: string
status:
type: string
sub_status:
type: string
nullable: true
status_details:
type: string
nullable: true
jurisdiction:
type: string
entity_type:
type: string
file_number:
type: string
addresses:
type: array
items:
type: string
officers:
type: array
items:
type: object
additionalProperties:
description: Any type
registered_agent:
type: object
additionalProperties:
description: Any type
registration_date:
type: string
format: date
state:
$ref: '#/components/schemas/type_:RegistrationState'
source:
type: string
format: uri
required:
- object
- id
- business_id
- name
- status
- jurisdiction
- entity_type
- file_number
- state
title: Registration
type_:AddressState:
type: string
enum:
- AL
- AK
- AZ
- AR
- CA
- CO
- CT
- DE
- FL
- GA
- HI
- ID
- IL
- IN
- IA
- KS
- KY
- LA
- ME
- MD
- MA
- MI
- MN
- MS
- MO
- MT
- NE
- NV
- NH
- NJ
- NM
- NY
- NC
- ND
- OH
- OK
- OR
- PA
- RI
- SC
- SD
- TN
- TX
- UT
- VT
- VA
- WA
- WV
- WI
- WY
title: AddressState
type_:AddressIndicator:
type: object
properties:
type:
$ref: '#/components/schemas/type_:AddressIndicatorType'
name:
$ref: '#/components/schemas/type_:AddressIndicatorName'
rating:
$ref: '#/components/schemas/type_:AddressIndicatorRating'
value:
type: string
description:
type: string
required:
- type
- name
- rating
- value
- description
title: AddressIndicator
type_:AdverseMediaScreeningResultsItemItemsItemFlagsSentimentsItemName:
type: string
enum:
- positive
- negative
- neutral
title: AdverseMediaScreeningResultsItemItemsItemFlagsSentimentsItemName
type_:LienAlternativeDesignation:
type: string
enum:
- buyer_seller
- bailee_bailor
- consignee_consignor
- lessee_lessor
- licensee_licensor
title: LienAlternativeDesignation
type_:Name:
type: object
properties:
object:
type: string
id:
type: string
format: uuid
name:
type: string
submitted:
type: boolean
type:
oneOf:
- $ref: '#/components/schemas/type_:NameType'
- type: 'null'
business_id:
type: string
format: uuid
sources:
type: array
items:
$ref: '#/components/schemas/type_:Source'
required:
- object
- id
- name
- submitted
- business_id
- sources
title: Name
type_:BusinessSubscriptionAvailabilityWatchlistResult:
type: string
enum:
- subscribable
- account_unsubscribable
title: BusinessSubscriptionAvailabilityWatchlistResult
type_:BankruptcyDebtorsItem:
type: object
properties:
name:
type: string
title: BankruptcyDebtorsItem
type_:ReviewTask:
type: object
properties:
category:
$ref: '#/components/schemas/type_:ReviewTaskCategory'
key:
$ref: '#/components/schemas/type_:ReviewTaskKey'
label:
$ref: '#/components/schemas/type_:ReviewTaskLabel'
message:
type: string
name:
type: string
status:
$ref: '#/components/schemas/type_:ReviewTaskStatus'
sub_label:
type: string
sources:
type: array
items:
$ref: '#/components/schemas/type_:Source'
required:
- category
- key
- label
- message
- name
- status
- sub_label
- sources
title: ReviewTask
type_:LienType:
type: string
enum:
- ucc
- state
- federal
- attachment
- judgment
description: Type of lien
title: LienType
type_:ProfileMetadata:
type: object
properties:
name:
type: string
city:
type: string
state:
type: string
full_address:
type: string
website_urls:
type: array
items:
type: string
latitude:
type: number
format: double
longitude:
type: number
format: double
phone_number:
type: string
categories:
type: array
items:
type: string
reviews:
type: array
items:
$ref: '#/components/schemas/type_:ProfileMetadataReviewsItem'
recent_posts:
type: array
items:
type: object
additionalProperties:
description: Any type
recent_reviews:
type: array
items:
type: object
additionalProperties:
description: Any type
title: ProfileMetadata
type_:WebsiteStatus:
type: string
enum:
- online
- offline
- unknown
title: WebsiteStatus
type_businesses:ListBusinessesResponse:
type: object
propert
# --- truncated at 32 KB (101 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/middesk/refs/heads/main/openapi/middesk-subpackage-businesses-api-openapi.yml