---
title: "Update a toll-free verification application"
method: PATCH
path: "/v1/toll-free-verifications/{id}"
tags: ["Phone Numbers"]
---

# Update a toll-free verification application

`PATCH /v1/toll-free-verifications/{id}`

## Request

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

Edits an application in DRAFT, CHANGES_REQUESTED or REJECTED. Its status does not change: submit it again when you are done. Live keys only.

Requires `phone_numbers:m`.

## Path parameters

- `id` string, required

## Request body

- object: The fields to change. Application fields you send replace the stored ones (an address or contact is replaced whole); the result must still be a complete, valid application.
  - `phone_number_ids` string[]: Replaces the numbers on the application: 1 to 5 of your toll-free numbers.
  - `application` object: Any of the application's fields.
    - `business_name` string
    - `doing_business_as` string, nullable
    - `entity_type` 'SOLE_PROPRIETOR' | 'PRIVATE_PROFIT' | 'PUBLIC_PROFIT' | 'NON_PROFIT' | 'GOVERNMENT'
    - `business_registration_number` string
    - `business_registration_type` 'CRA'
    - `business_registration_country` 'CA'
    - `business_address` object
      - `line1` string, required
      - `city` string, required
      - `province` 'AB' | 'BC' | 'MB' | 'NB' | 'NL' | 'NS' | 'NT' | 'NU' | 'ON' | 'PE' | 'QC' | 'SK' | 'YT', required
      - `postal_code` string, required
    - `contact` object
      - `first_name` string, required
      - `last_name` string, required
      - `email` string, email, required
      - `phone` string, required
    - `website` string
    - `use_case` '2FA' | 'App Notifications' | 'Appointments' | 'Auctions' | 'Auto Repair Services' | 'Bank Transfers' | 'Billing' | 'Booking Confirmations' | 'Business Updates' | 'COVID-19 Alerts' | 'Career Training' | 'Chatbot' | 'Conversational / Alerts' | 'Courier Services & Deliveries' | 'Emergency Alerts' | 'Events & Planning' | 'Financial Services' | 'Fraud Alerts' | 'Fundraising' | 'General Marketing' | 'General School Updates' | 'HR / Staffing' | 'Healthcare Alerts' | 'Housing Community Updates' | 'Insurance Services' | 'Job Dispatch' | 'Legal Services' | 'Mixed' | 'Motivational Reminders' | 'Notary Notifications' | 'Order Notifications' | 'Political' | 'Public Works' | 'Real Estate Services' | 'Religious Services' | 'Repair and Diagnostics Alerts' | 'Rewards Program' | 'Surveys' | 'System Alerts' | 'Voting Reminders' | 'Waitlist Alerts' | 'Webinar Reminders' | 'Workshop Alerts'
    - `use_case_summary` string
    - `sample_messages` string[]
    - `opt_in_workflow` string
    - `opt_in_image_urls` string[]
    - `opt_in_confirmation_message` string
    - `help_message` string
    - `privacy_policy_url` string
    - `terms_url` string, nullable
    - `monthly_volume` '10' | '100' | '1,000' | '10,000' | '100,000' | '250,000' | '500,000' | '750,000' | '1,000,000' | '5,000,000' | '10,000,000+'
    - `age_gated` boolean
    - `additional_information` string, nullable

## Response `200`

The edited application.

- TollFreeVerification: A toll-free verification application: the numbers it covers, the business behind them and where it stands.
  - `id` string, 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.
  - `phone_numbers` object[], required
    - `id` string, required
    - `phone_number` string, required
  - `application` object, required: The application as stored: every field, with the business number, postal code and phone normalized.
    - `business_name` string, required
    - `doing_business_as` string, nullable, required
    - `entity_type` 'SOLE_PROPRIETOR' | 'PRIVATE_PROFIT' | 'PUBLIC_PROFIT' | 'NON_PROFIT' | 'GOVERNMENT', required
    - `business_registration_number` string, required
    - `business_address` object, required
      - `line1` string, required
      - `city` string, required
      - `province` string, required
      - `postal_code` string, required
    - `contact` object, required
      - `first_name` string, required
      - `last_name` string, required
      - `email` string, required
      - `phone` string, required
    - `website` string, required
    - `use_case` '2FA' | 'App Notifications' | 'Appointments' | 'Auctions' | 'Auto Repair Services' | 'Bank Transfers' | 'Billing' | 'Booking Confirmations' | 'Business Updates' | 'COVID-19 Alerts' | 'Career Training' | 'Chatbot' | 'Conversational / Alerts' | 'Courier Services & Deliveries' | 'Emergency Alerts' | 'Events & Planning' | 'Financial Services' | 'Fraud Alerts' | 'Fundraising' | 'General Marketing' | 'General School Updates' | 'HR / Staffing' | 'Healthcare Alerts' | 'Housing Community Updates' | 'Insurance Services' | 'Job Dispatch' | 'Legal Services' | 'Mixed' | 'Motivational Reminders' | 'Notary Notifications' | 'Order Notifications' | 'Political' | 'Public Works' | 'Real Estate Services' | 'Religious Services' | 'Repair and Diagnostics Alerts' | 'Rewards Program' | 'Surveys' | 'System Alerts' | 'Voting Reminders' | 'Waitlist Alerts' | 'Webinar Reminders' | 'Workshop Alerts', required
    - `use_case_summary` string, required
    - `sample_messages` string[], required
    - `opt_in_workflow` string, required
    - `opt_in_image_urls` string[], required
    - `opt_in_confirmation_message` string, required
    - `help_message` string, required
    - `privacy_policy_url` string, required
    - `terms_url` string, nullable, required
    - `monthly_volume` '10' | '100' | '1,000' | '10,000' | '100,000' | '250,000' | '500,000' | '750,000' | '1,000,000' | '5,000,000' | '10,000,000+', required
    - `age_gated` boolean, required
    - `additional_information` string, nullable, required
  - `fee_cents` integer, required: The verification fee for this application, in cents CAD.
  - `payment_url` string, nullable, required: While AWAITING_PAYMENT: the dashboard page where the fee is paid. Null otherwise.
  - `paid_at` string, date-time, nullable, required
  - `refunded_at` string, date-time, nullable, required
  - `reviewer_note` string, 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_reason` string, nullable, required: Why the carrier rejected the application, when it did.
  - `submitted_at` string, date-time, nullable, required
  - `decided_at` string, date-time, nullable, required: When the carrier approved or rejected it.
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required

## Other responses

- `401`: Missing, invalid, revoked or expired API key.
- `402`: The account has no balance, or a LIVE key was used before the first top-up.
- `403`: The API key lacks the permission this operation requires, or the account is suspended or closed.
- `404`: NOT_FOUND: no such resource on this account.
- `409`: VERIFICATION_NOT_EDITABLE (not in DRAFT, CHANGES_REQUESTED or REJECTED) or NUMBER_IN_OPEN_VERIFICATION.
- `422`: VALIDATION_ERROR, NOT_A_TOLL_FREE_NUMBER, or LIVE_MODE_REQUIRED for a test key.
- `429`: Rate limit reached: 100 requests per second per account, or a route-specific limit (Retry-After set where one applies).
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/honkio/apis/honkio-api.md) · [All operations](https://skmtc.dev/honkio/apis/honkio-api/llms.txt) · [OpenAPI document](https://skmtc.dev/honkio/apis/honkio-api/revisions/ce4ed3fe9691?raw)