Accounts

Submit your business for verification

Sends the saved profile to HonkIO staff for review (IN_REVIEW). They check it against public registries and your website, then verify it, ask for changes or decline it; you are emailed either way. A verified business that changed its details stays verified during the review; declining the changes removes the verification. Live keys only (LIVE_KEY_REQUIRED).

Requires account:w.

post/v1/business-verification/submit

Request

  • Base URL: https://api.honkio.ca
  • URL: https://api.honkio.ca/v1/business-verification/submit
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Response

The profile, now IN_REVIEW.

idstring required
status'DRAFT' | 'IN_REVIEW' | 'VERIFIED' | 'CHANGES_REQUESTED' | 'DECLINED' | 'REVOKED' required

DRAFT, then IN_REVIEW (HonkIO staff), then VERIFIED. CHANGES_REQUESTED and DECLINED can be edited and submitted again; REVOKED can only be restored by HonkIO staff. Editing a VERIFIED profile moves it back to DRAFT for another review.

verifiedboolean required

Whether the business counts as verified. It stays true while the changed details of a verified business are reviewed again (status DRAFT, IN_REVIEW or CHANGES_REQUESTED), and turns false when HonkIO staff decline the changes or revoke the verification.

verified_atstring date-time nullable required

When HonkIO staff last verified the business; null when it is not verified.

business_namestring required
doing_business_asstring nullable required
entity_type'SOLE_PROPRIETOR' | 'PRIVATE_PROFIT' | 'PUBLIC_PROFIT' | 'NON_PROFIT' | 'GOVERNMENT' required
business_registration_numberstring nullable required
websitestring nullable required
business_descriptionstring nullable required
reviewer_notestring nullable required

What HonkIO staff asked to change, or why they declined the profile.

revoked_reasonstring nullable required

Why HonkIO staff revoked the verification.

submitted_atstring date-time nullable required
reviewed_atstring date-time nullable required
revoked_atstring date-time nullable required
created_atstring date-time required
updated_atstring date-time required

Changes

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