Bandwidth · JSON Structure

Mfa Mfa Verify Request Structure

MfaVerifyRequest schema from Bandwidth mfa API

Type: object Properties: 4 Required: 3
CommunicationsCPaaSVoiceMessagingTelephonySMSMFA

MfaVerifyRequest is a JSON Structure definition published by Bandwidth, describing 4 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

to scope code expirationTimeInMinutes

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/mfa-mfa-verify-request-structure.json",
  "name": "MfaVerifyRequest",
  "description": "MfaVerifyRequest schema from Bandwidth mfa API",
  "type": "object",
  "properties": {
    "to": {
      "type": "string",
      "description": "The phone number the MFA code was sent to, in E.164 format",
      "example": "+19195554321"
    },
    "scope": {
      "type": "string",
      "description": "The scope that was used when the code was generated. Must match for verification to succeed."
    },
    "code": {
      "type": "string",
      "description": "The MFA code entered by the user for verification",
      "example": "123456"
    },
    "expirationTimeInMinutes": {
      "type": "double",
      "minimum": 1,
      "maximum": 15,
      "default": 3,
      "description": "The expiration window to check against, in minutes"
    }
  },
  "required": [
    "to",
    "code",
    "expirationTimeInMinutes"
  ]
}