Bandwidth · Schema
MfaVerifyRequest
MfaVerifyRequest schema from Bandwidth mfa API
CommunicationsCPaaSVoiceMessagingTelephonySMSMFA
Properties
| Name | Type | Description |
|---|---|---|
| to | string | The phone number the MFA code was sent to, in E.164 format |
| scope | string | The scope that was used when the code was generated. Must match for verification to succeed. |
| code | string | The MFA code entered by the user for verification |
| expirationTimeInMinutes | number | The expiration window to check against, in minutes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/bandwidth/refs/heads/main/json-schema/mfa-mfa-verify-request-schema.json",
"title": "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": "number",
"minimum": 1,
"maximum": 15,
"default": 3,
"description": "The expiration window to check against, in minutes"
}
},
"required": [
"to",
"code",
"expirationTimeInMinutes"
]
}