---
title: "Request a Verification"
method: POST
path: "/{format}"
tags: ["Requests"]
---

# Request a Verification

`POST /{format}`

Use Verify request to generate and send a PIN to your user:

1. Create a request to send a verification code to your user.

2. Check the `status` field in the response to ensure that your request was successful (zero is success).

3. Use the `request_id` field in the response for the Verify check.

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

## Path parameters

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

## Response `200`

OK

- union
  - RequestResponse — Success
    - `request_id` string — The unique ID of the Verify request. You need this `request_id` for the Verify check.
    - `status` string — Indicates the outcome of the request; zero is success
  - RequestErrorResponse — Error
    - `error_text` string — If `status` is non-zero, this explains the error encountered.
    - `network` string — The Network ID of the blocking network, if relevant to the error.
    - `request_id` string — The unique ID of the Verify request. This may be blank in an error situation.
    - `status` '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '15' | '20' | '29' — 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. 7 | The number you are trying to verify is blacklisted for verification. | Returns a `network` property but no `request_id` will be present in the response. 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. 10 | Concurrent verifications to the same number are not allowed. | This will return a `request_id`. 15 | The destination number is not in a supported network | The request has been rejected. Find out more about this error in the [Knowledge Base](https://help.nexmo.com/hc/en-us/articles/360018406532-Verify-On-demand-Service-to-High-Risk-Countries) 20 | This account does not support the parameter: pin_code. | Only certain accounts have the ability to set the `pin_code`. Please contact your account manager for more information. 29 | Non-Permitted Destination | Your Vonage account is still in demo mode. While in demo mode you must add target numbers to the approved list for your account. Add funds to your account to remove this limitation.

---

[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)