---
title: "Verify Check"
method: POST
path: "/check/{format}"
---

# Verify Check

`POST /check/{format}`

Use Verify check to confirm that the PIN you received from your user matches the one sent by Vonage in your Verify request.

1. Send the verification `code` that your user supplied, with the corresponding `request_id` from the Verify request.
2. Check the `status` of the response to determine if the code the user supplied matches the one sent by Vonage.

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

## Path parameters

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

## Response `200`

OK

- union
  - CheckResponse — Success
    - `currency` string — The currency code.
    - `estimated_price_messages_sent` string — This field may not be present, depending on your pricing model. The value indicates the cost (in EUR) of the calls made and messages sent for the verification process. This value may be updated during and shortly after the request completes because user input events can overlap with message/call events. When this field is present, the total cost of the verification is the sum of this field and the `price` field.
    - `event_id` string — The ID of the verification event, such as an SMS or TTS call.
    - `price` string — The cost incurred for this request.
    - `request_id` string — The `request_id` that you received in the response to the Verify request and used in the Verify check request.
    - `status` string — A value of `0` indicates that your user entered the correct code. If it is non-zero, check the `error_text`.
  - CheckErrorResponse — Error
    - `error_text` string — If the `status` is non-zero, this explains the error encountered.
    - `request_id` string — The `request_id` that you received in the response to the Verify request and used in the Verify check request.
    - `status` '0' | '1' | '2' | '3' | '4' | '5' | '6' | '16' | '17' — 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. 16 | The code inserted does not match the expected value | 17 | The wrong code was provided too many times | You can run Verify check on a specific `request_id` up to three times unless a new verification code is generated. If you check a request more than three times, it is set to FAILED and you cannot check it again.

---

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