Phone Numbers

Submit a toll-free verification application

From DRAFT: moves the application to AWAITING_PAYMENT and returns payment_url, the dashboard page where the verification fee is paid; once paid it goes to HonkIO staff for review. From CHANGES_REQUESTED or REJECTED: sends the edited application back for review, at no charge. Live keys only (LIVE_MODE_REQUIRED). Needs a verified business with a CRA business number on its profile (BUSINESS_VERIFICATION_REQUIRED, or BUSINESS_NUMBER_REQUIRED when the business as HonkIO verified it has none; see verified_details on /v1/business-verification).

Requires phone_numbers:w.

post/v1/toll-free-verifications/{id}/submit

Request

  • Base URL: https://api.honkio.ca
  • URL: https://api.honkio.ca/v1/toll-free-verifications/{id}/submit
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

idstring required

Response

The application, AWAITING_PAYMENT with payment_url, or back IN_REVIEW.

idstring required
status'DRAFT' | 'AWAITING_PAYMENT' | 'IN_REVIEW' | 'CHANGES_REQUESTED' | 'SUBMITTED' | 'APPROVED' | 'REJECTED' | 'DECLINED' | 'CANCELLED' required

DRAFT, then AWAITING_PAYMENT, IN_REVIEW (HonkIO staff), SUBMITTED (with the carrier) and APPROVED. CHANGES_REQUESTED and REJECTED (by the carrier) can be edited and submitted again, and a REJECTED one can be withdrawn (CANCELLED); DECLINED (by HonkIO) and CANCELLED are final.

fee_centsinteger required

The verification fee for this application, in cents CAD.

payment_urlstring nullable required

While AWAITING_PAYMENT: the dashboard page where the fee is paid. Null otherwise.

paid_atstring date-time nullable required
refunded_atstring date-time nullable required
reviewer_notestring nullable required

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

carrier_status'pending' | 'action_needed' | 'approved' | 'rejected' | 'null' nullable required

Where the carrier's review stands once it has the application: pending, action_needed (the carrier asked HonkIO a question; nothing for you to do yet), approved or rejected. Null before it is submitted.

carrier_rejection_reasonstring nullable required

Why the carrier rejected the application, when it did.

submitted_atstring date-time nullable required
decided_atstring date-time nullable required

When the carrier approved or rejected it.

created_atstring date-time required
updated_atstring date-time required

Changes

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