---
title: "Verify Control"
method: POST
path: "/control/{format}"
---

# Verify Control

`POST /control/{format}`

Control the progress of your Verify requests. To cancel an existing Verify request, or to trigger the next verification event:


1. Send a Verify control request with the appropriate command (`cmd`) for what you want to achieve.

2. Check the `status` in the response.


*Note that this endpoint is available by `GET` request as well as `POST`.*

## Path parameters

- `format` 'json' | 'xml', required

## Response `200`

OK

- union
  - ControlResponse — Success
    - `command` 'cancel' | 'trigger_next_event' — The `cmd` you sent in the request.
    - `status` string — `cmd` | Code | Description -- | -- | -- Any | 0 | Success
  - ControlErrorResponse — Error
    - `error_text` string — If the `status` is non-zero, this explains the error encountered.
    - `status` '0' | '1' | '2' | '3' | '4' | '5' | '6' | '8' | '9' | '19' — Code | Text | Description -- | -- | -- 0 | Success | The request was successfully accepted by Vonage. 1 | Throttled | You are trying to send more than the maximum of 30 requests per second. 2 | Your request is incomplete and missing the mandatory parameter `$parameter` | The stated parameter is missing. 3 | Invalid value for parameter `$parameter` | Invalid value for parameter. If you see Facility not allowed in the error text, check that you are using the correct Base URL in your request. 4 | Invalid credentials were provided | The supplied API key or secret in the request is either invalid or disabled. 5 | Internal Error | An error occurred processing this request in the Cloud Communications Platform. 6 | The Vonage platform was unable to process this message for the following reason: `$reason` | The request could not be routed. 8 | The api_key you supplied is for an account that has been barred from submitting messages. | 9 | Partner quota exceeded | Your account does not have sufficient credit to process this request. 19 | For `cancel`: Either you have not waited at least 30 secs after sending a Verify request before cancelling or Verify has made too many attempts to deliver the verification code for this request and you must now wait for the process to complete. For `trigger_next_event`: All attempts to deliver the verification code for this request have completed and there are no remaining events to advance to.

---

[API](https://skmtc.net/vonage/apis/verify.md) · [All operations](https://skmtc.net/vonage/apis/verify/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vonage/verify/versions/9b6adb3b4f08/schema)