Bandwidth · JSON Structure

Toll Free Verification Verification Structure

Verification schema from Bandwidth toll-free-verification API

Type: object Properties: 8
CommunicationsCPaaSVoiceMessagingTelephonySMSMFA

Verification is a JSON Structure definition published by Bandwidth, describing 8 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

verificationId telephoneNumbers status businessName useCase submissionDate verificationDate denialReason

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/bandwidth/refs/heads/main/json-structure/toll-free-verification-verification-structure.json",
  "name": "Verification",
  "description": "Verification schema from Bandwidth toll-free-verification API",
  "type": "object",
  "properties": {
    "verificationId": {
      "type": "string",
      "description": "The unique identifier for the verification request"
    },
    "telephoneNumbers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The toll-free numbers associated with this verification"
    },
    "status": {
      "type": "string",
      "enum": [
        "PENDING_VERIFICATION",
        "VERIFIED",
        "RESTRICTED",
        "DENIED",
        "SUBMITTED"
      ],
      "description": "The current verification status"
    },
    "businessName": {
      "type": "string",
      "description": "The business name on the verification"
    },
    "useCase": {
      "type": "string",
      "description": "The messaging use case"
    },
    "submissionDate": {
      "type": "datetime",
      "description": "The date and time the verification was submitted"
    },
    "verificationDate": {
      "type": "datetime",
      "description": "The date and time the verification was approved or denied"
    },
    "denialReason": {
      "type": "string",
      "description": "The reason for denial, if the verification was denied"
    }
  }
}