Amazon Pinpoint · JSON Structure

Amazon Pinpoint Verify Otp Message Request Parameters Structure

Verify OTP message request.

Type: object Properties: 3 Required: 3
CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics

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

Properties

DestinationIdentity Otp ReferenceId

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/amazon-pinpoint/refs/heads/main/json-structure/amazon-pinpoint-verify-otp-message-request-parameters-structure.json",
  "name": "VerifyOTPMessageRequestParameters",
  "description": "Verify OTP message request.",
  "type": "object",
  "properties": {
    "DestinationIdentity": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The destination identity to send OTP to."
        }
      ]
    },
    "Otp": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The OTP the end user provided for verification."
        }
      ]
    },
    "ReferenceId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The reference identifier provided when the OTP was previously sent."
        }
      ]
    }
  },
  "required": [
    "ReferenceId",
    "Otp",
    "DestinationIdentity"
  ]
}