Run the twenty-two Business Health checks against a business described in the query string. No account, no key, nothing stored: OEX holds no record of the business and asserts nothing about it. Checks requiring a stored or verified identity report why they could not run, never as a pass. Add format=markdown for the hand-off form.

get/api/v1/business-health

Request

  • Base URL: https://veilpoint.ca
  • URL: https://veilpoint.ca/api/v1/business-health
  • Auth: none declared

Query parameters

namestring required

Required. The business name.

websitestring

Domain or URL. Worth supplying: nine checks available to the free run inspect the site, and the site is one side of every interface comparison.

addressstring

Street address, as the business would state it.

categorystring

What the business does.

descriptionstring

How the business describes itself.

phonestring

Contact telephone number.

format'markdown'

Set to 'markdown' for the document form; JSON otherwise.

Response

The envelope described above.

dataobject required

Changes

No recorded changes to this operation across all 1 revision of this API.