Accounts

Save your business verification profile

Creates the profile, or replaces it while it is DRAFT, VERIFIED, CHANGES_REQUESTED or DECLINED (BUSINESS_VERIFICATION_NOT_EDITABLE otherwise). Every field is checked. The status does not change, except that a VERIFIED profile goes back to DRAFT: submit it when it is ready. Changes to a verified business go back to HonkIO for review, and the account stays verified (verified is true) in the meantime, as it was verified: verified_details, not the changed fields, is what counts until HonkIO verifies the changes. A test key can save a profile that was never verified, but changing a verified business needs a live key (LIVE_KEY_REQUIRED).

Requires account:m.

put/v1/business-verification

Request

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

Request body

business_namestring required

The legal name: as registered with the CRA or your province, or your own name for a sole proprietorship.

doing_business_asstring nullable

The name the business trades under, when it differs from the legal name.

entity_type'SOLE_PROPRIETOR' | 'PRIVATE_PROFIT' | 'PUBLIC_PROFIT' | 'NON_PROFIT' | 'GOVERNMENT' required

The kind of organization. GET /v1/toll-free-verifications/options lists the values with labels.

business_registration_numberstring nullable

The CRA business number: 9 digits, optionally followed by a program account such as RC0001. Spaces and hyphens are ignored. Required unless entity_type is SOLE_PROPRIETOR.

websitestring required

An https link that shows the business: its website or, for a sole proprietor, a public profile such as LinkedIn or an app store listing.

business_descriptionstring required

What the business does and who it serves, 20 to 500 characters.

Response

The saved profile.

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.