Website object

This page describes the website object, which represents information gathered from analyzing a business’s website. Website analysis includes domain registration data, page content, screenshots, and verification of business information found on the site.

Retrieve a website

You can retrieve the website associated with a business using the Retrieve a website endpoint:

$curl https://api.middesk.com/v1/businesses/{business_id}/website \
> -u {API_KEY}:

This returns the full website object with all analyzed data for the business.

Example JSON response
1{
2 "object": "website",
3 "id": "f5dfdb7f-a946-4111-b4f0-7d7780fb72bc",
4 "business_id": "51c4b91e-f324-467b-86b5-9e0155bcc251",
5 "url": "https://www.middesk.com",
6 "status": "online",
7 "submitted": true,
8 "title": "Middesk | Background Checks on Businesses",
9 "description": "Middesk centralizes the information required to conduct risk and compliance assessments on your customers.",
10 "domain": {
11 "domain": "middesk.com",
12 "creation_date": "2018-11-20T07:02:53.000Z",
13 "expiration_date": "2019-11-20T07:02:53.000Z",
14 "registrar": {}
15 },
16 "pages": [
17 {
18 "category": "home",
19 "url": "https://www.middesk.com/",
20 "text": "Middesk is the easiest way to verify the legitimacy...",
21 "screenshot_url": "https://cdn-middesk-websites.com/10248124-home-1595276893.png"
22 },
23 {
24 "category": "terms",
25 "url": "https://www.middesk.com/terms-of-use",
26 "text": "...",
27 "screenshot_url": "https://cdn-middesk-websites.com/10248124-terms-1595276893.png"
28 },
29 {
30 "category": "privacy",
31 "url": "https://www.middesk.com/privacy-policy",
32 "text": "...",
33 "screenshot_url": "https://cdn-middesk-websites.com/10248124-privacy-1595276893.png"
34 }
35 ],
36 "parked": false,
37 "business_name_match": true,
38 "addresses": [],
39 "phone_numbers": [],
40 "error": null,
41 "category": "Standard",
42 "platform": null
43}

Website attributes

AttributeTypeDescription
objectstringThe object type. Always website.
idstring (uuid)The unique identifier for the website record.
business_idstring (uuid)The unique identifier of the associated business.
urlstringThe URL that was passed or found for the business.
statusstringThe status for the website. Possible values include online, offline, unknown.
submittedbooleanSpecifies if the website URL was submitted or found.
titlestringThe title of the website’s home page.
descriptionstringThe meta description of the website.
business_name_matchbooleanIndicates whether the business name was found on the website.
addressesobject[]Array of addresses found on the website.
phone_numbersobject[]Array of phone numbers found on the website.
posts_summarystringSummary of posts found on the website or linked social media profiles.
reviews_summarystringSummary of reviews found on the website or linked third-party profiles.
pagesobject[]Returns an array of the pages assessed by Middesk.
pages[].categorystringThe type of page.
pages[].urlstringLink to the individual page on the business website.
pages[].textstringText on the individual page on the business website.
pages[].screenshot_urlstringURL pointing to the screenshot for the page.
parkedbooleanSpecifies if a website is a parked domain. A parked domain is a registered domain name that does not have services running on it, or contains no meaningful content about a business. Parked domains commonly function to reserve the domain name for future development.
domainobjectInformation regarding the domain registrar.
domain.domainstringThe provided domain.
domain.creation_datestringWhen the domain was originally registered.
domain.expiration_datestringWhen the registration for the domain expires.
domain.registrarobjectInformation containing more details about the registrar.
domain.registrar.namestring
domain.registrar.organizationstring
domain.registrar.urlstring
errorstringSpecifies any errors encountered while processing the website. Possible values:
malformed_url-submitted URL is malformed.
blocklisted_url_top_level_domain-submitted URL contains blocked top level domain like .example or .test.
blocklisted_url_second_level_domain-submitted URL contains blocked second level domain, like example.com or test.com
business_website_not_found-Middesk was unable to find a website for the business.
categorystringSpecifies the category of the website into the following possible values:
Standard-default value.
Social Media-website is a social media profile, like a Facebook page.
Third-party Platform-website is a page on a third-party platform, like a Yelp page.
Marketplace Storefront-website is a storefront, like an Etsy seller page.
platformstringSpecifies the platform of the website (for example, yelp.com). Populated if the category is not Standard.
risky_keywords_resultsobject[]Information about any risky keyword hits for a given category found in the business’s web presence.
risky_keywords_results[].categorystringThe type of risky keyword.
risky_keywords_results[].explanationstringThe reason why the category was included in the results.
risky_keywords_results[].severitystringThe seriousness of the category of the risky keyword. Possible values:
prohibited
needs_review
ignore
risky_keywords_results[].sourcesobject[]Information about any matching keywords that fall under the category for the parent risky_keywords_result.
risky_keywords_results[].sources[].urlstringThe business website or third-party profile that contains the reference to the matched risky keyword.
risky_keywords_results[].sources[].matched_keywordsstring[]List of one or more of the matched risky keywords.
risky_keywords_results[].sources[].text_snippetstringText from the website containing the risky keyword(s).
risky_keywords_results[].sources[].source_typestringDescription of the source where the keyword was found. Possible values:
google_places_review
facebook_post
linkedin_post
instagram_recent_post
instagram_top_post
yelp_review
google_places_profile
facebook_profile
linkedin_profile
instagram_profile
yelp_profile
website
not_elsewhere_specified
risky_keywords_results[].sources[].posted_atstringDate the source was posted. Only available for post and review source types. If not available it will be null.

Website status values

StatusDescription
onlineThe website is accessible and responding normally.
offlineThe website could not be reached or is not responding.
unknownThe website status could not be determined.

Parked domains

A domain is considered “parked” when it:

  • Displays a placeholder page from a domain registrar
  • Shows generic advertising content
  • Has no meaningful business content
  • Redirects to a domain parking service

Parked domains may indicate that a business does not have an active web presence, which can be a risk indicator in some verification scenarios.

Get a demo
Contact your account manager or contact sales to inquire about access.