putCompletionResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/telesign/main/json-schema/telesign-put-completion-response-schema.json",
  "title": "putCompletionResponse",
  "x-generated": "2026-10-07",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telesign-engage-api-openapi.yml#/components/schemas/putCompletionResponse",
  "type": "object",
  "properties": {
    "reference_id": {
      "type": "string",
      "description": "A 32-digit hex value used to identify the web service request. The value is unique to each web service request, is randomly generated by Telesign, and is returned in the response message immediately following the web service request.\n"
    },
    "subresource": {
      "type": "string",
      "description": "The subresource in the URI path from your original request to initiate this transaction. Indicates which form of verification you used."
    },
    "errors": {
      "type": "array",
      "description": "Contains an object for each error that resulted from the request.",
      "items": {
        "$ref": "#/$defs/errorObject"
      }
    },
    "status": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "A numeric code describing the processing status of your transaction. See [All status and error codes](/enterprise/docs/all-status-and-error-codes)\n"
        },
        "description": {
          "type": "string",
          "description": "A text description of the status code."
        },
        "updated_on": {
          "type": "string",
          "description": "This is a timestamp showing when your transaction status was updated last."
        }
      },
      "required": [
        "code",
        "description",
        "updated_on"
      ]
    }
  },
  "$defs": {
    "errorObject": {
      "type": "object",
      "title": "errorObject",
      "description": "Contains properties related to an error that occurred during processing of the request.",
      "properties": {
        "code": {
          "type": "integer",
          "description": "A numeric code specifying which error occurred."
        },
        "description": {
          "type": "string",
          "description": "Text describing the error that occurred."
        }
      }
    }
  }
}