InitiateAVResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/telesign/main/json-schema/telesign-initiate-av-response-schema.json",
  "title": "InitiateAVResponse",
  "x-generated": "2026-10-07",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telesign-app-verify-api-openapi.yml#/components/schemas/initiate-av-response",
  "type": "object",
  "properties": {
    "reference_id": {
      "type": "string",
      "description": "A unique, randomly generated hex value that identifies your web service request.",
      "minLength": 32,
      "maxLength": 32
    },
    "sub_resource": {
      "type": "string",
      "description": "The name of the subresource accessed."
    },
    "errors": {
      "type": "array",
      "description": "Contains an object for each error condition that resulted from the request.",
      "items": {
        "type": "object",
        "description": "Contains properties related to an error that occurred during processing of the request.",
        "properties": {
          "code": {
            "type": "integer",
            "description": "A one to five-digit error code (possibly negative) that indicates the type of error that occurred."
          },
          "description": {
            "type": "string",
            "description": "A description of the type of error that occurred."
          }
        }
      }
    },
    "status": {
      "type": "object",
      "description": "Contains details about the request status.",
      "properties": {
        "code": {
          "type": "integer",
          "description": "A numeric code indicating the processing status of this request.\n \n| Value | Description | \n|-------|-------------| \n| 2400 | Pending | \n| 2401 | Success | \n| 2402 | Failure | \n| 2403 | Not Attempted | \n| 2404 | Invalid Phone Number | \n| 2405 | Not Supported | \n| 2407 | CallerID prefix did not match | \n| 2408 | Unsupported phone type | \n| 2409 | Verification call not received |\n| 2410 | Please retry verification |\n| 2411 | Verification call failed |\n| 2429 | Call blocked by customer request | \n| 2430 | Call blocked by Telesign | \n"
        },
        "description": {
          "type": "string",
          "description": "Text describing the transaction status."
        },
        "updated_on": {
          "type": "string",
          "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp indicating when the transaction status was updated."
        }
      }
    },
    "resource_uri": {
      "type": "string",
      "description": "You should disregard this parameter, as it is not currently needed to use the API."
    },
    "verify_code": {
      "type": "string",
      "description": "The code you sent us for verification. Obtained from the last five digits of the caller ID.\n\n"
    },
    "prefix": {
      "type": "string",
      "description": "The first digits included in the caller ID returned by Telesign. Remove these from the beginning of the caller ID to get the verify code."
    }
  }
}