Accounts

Get your business verification

Your business profile and where its review stands, or null before one is saved. A verified business can request more phone numbers, a higher sending volume, higher top-up limits and toll-free verification.

Requires account:r.

get/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

Response

Your business verification profile, or null before one is saved.

idstring 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.