verifyRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/vonage/main/json-schema/vonage-verify-request-schema.json",
  "title": "verifyRequest",
  "x-generated": "2026-10-08",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/vonage-verify-openapi.yml#/components/schemas/verifyRequest",
  "type": "object",
  "required": [
    "number",
    "brand"
  ],
  "properties": {
    "number": {
      "type": "string",
      "description": "The mobile or landline phone number to verify. Unless you are setting `country` explicitly, this number must be in [E.164](https://en.wikipedia.org/wiki/E.164) format."
    },
    "country": {
      "description": "If you do not provide `number` in international format or you are not sure if `number` is correctly formatted, specify the two-character country code in `country`. Verify will then format the number for you.",
      "type": "string"
    },
    "brand": {
      "description": "An 18-character alphanumeric string you can use to personalize the verification request SMS body, to help users identify your company or application name. For example: \"Your `Acme Inc` PIN is ...\"",
      "type": "string",
      "maxLength": 18
    },
    "sender_id": {
      "description": "An 11-character alphanumeric string that represents the [identity of the sender](https://developer.nexmo.com/messaging/sms/guides/custom-sender-id) of the verification request. Depending on the destination of the phone number you are sending the verification SMS to, restrictions might apply.",
      "type": "string",
      "maxLength": 11,
      "default": "VERIFY"
    },
    "code_length": {
      "description": "The length of the verification code.",
      "type": "integer",
      "enum": [
        4,
        6
      ],
      "default": 4
    },
    "lg": {
      "description": "By default, the SMS or text-to-speech (TTS) message is generated in the locale that matches the `number`. For example, the text message or TTS message for a `33*` number is sent in French. Use this parameter to explicitly control the language used for the Verify request. A list of languages is available: <https://developer.nexmo.com/verify/verify-v1/guides/verify-languages>",
      "type": "string",
      "default": "en-us",
      "enum": [
        "ar-xa",
        "cs-cz",
        "cy-cy",
        "cy-gb",
        "da-dk",
        "de-de",
        "el-gr",
        "en-au",
        "en-gb",
        "en-in",
        "en-us",
        "es-es",
        "es-mx",
        "es-us",
        "fi-fi",
        "fil-ph",
        "fr-ca",
        "fr-fr",
        "hi-in",
        "hu-hu",
        "id-id",
        "is-is",
        "it-it",
        "ja-jp",
        "ko-kr",
        "nb-no",
        "nl-nl",
        "pl-pl",
        "pt-br",
        "pt-pt",
        "ro-ro",
        "ru-ru",
        "sv-se",
        "th-th",
        "tr-tr",
        "vi-vn",
        "yue-cn",
        "zh-cn",
        "zh-tw"
      ]
    },
    "pin_expiry": {
      "description": "How long the generated verification code is valid for, in seconds. When you specify both `pin_expiry` and `next_event_wait` then `pin_expiry` must be an integer multiple of `next_event_wait` otherwise `pin_expiry` is defaulted to equal next_event_wait. See [changing the event timings](https://developer.nexmo.com/verify/verify-v1/guides/changing-default-timings).",
      "type": "integer",
      "minimum": 60,
      "maximum": 3600,
      "default": 300
    },
    "next_event_wait": {
      "description": "Specifies the wait time in seconds between attempts to deliver the verification code.",
      "type": "integer",
      "minimum": 60,
      "maximum": 900,
      "default": 300
    },
    "workflow_id": {
      "description": "Selects the predefined sequence of SMS and TTS (Text To Speech) actions to use in order to convey the PIN to your user. For example, an id of 1 identifies the workflow SMS - TTS - TTS. For a list of all workflows and their associated ids, please visit the [developer portal](https://developer.nexmo.com/verify/verify-v1/guides/workflows-and-events).",
      "type": "integer",
      "default": 1,
      "enum": [
        1,
        2,
        3,
        4,
        5,
        6,
        7
      ]
    },
    "pin_code": {
      "type": "string",
      "minimum": 4,
      "maximum": 10,
      "description": "A custom PIN to send to the user. If a PIN is not provided, Verify will generate a random PIN for you. <b>This feature is not enabled by default</b> - please discuss with your Account Manager if you would like it enabled. If this feature is not enabled on your account, error status `20` will be returned."
    }
  }
}