:doc:`Pinpoint <../../pinpoint>` / Client / verify_otp_message

******************
verify_otp_message
******************



.. py:method:: Pinpoint.Client.verify_otp_message(**kwargs)

  

  Verify an OTP

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/VerifyOTPMessage>`_  


  **Request Syntax**
  ::

    response = client.verify_otp_message(
        ApplicationId='string',
        VerifyOTPMessageRequestParameters={
            'DestinationIdentity': 'string',
            'Otp': 'string',
            'ReferenceId': 'string'
        }
    )
    
  :type ApplicationId: string
  :param ApplicationId: **[REQUIRED]** 

    The unique ID of your Amazon Pinpoint application.

    

  
  :type VerifyOTPMessageRequestParameters: dict
  :param VerifyOTPMessageRequestParameters: **[REQUIRED]** 

    Verify OTP message request.

    

  
    - **DestinationIdentity** *(string) --* **[REQUIRED]** 

      The destination identity to send OTP to.

      

    
    - **Otp** *(string) --* **[REQUIRED]** 

      The OTP the end user provided for verification.

      

    
    - **ReferenceId** *(string) --* **[REQUIRED]** 

      The reference identifier provided when the OTP was previously sent.

      

    
  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'VerificationResponse': {
              'Valid': True|False
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 

      200 response

      
      

      - **VerificationResponse** *(dict) --* 

        Verify OTP Message Response.

        
        

        - **Valid** *(boolean) --* 

          Specifies whether the OTP is valid or not.

          
    
  
  **Exceptions**
  
  *   :py:class:`Pinpoint.Client.exceptions.BadRequestException`

  
  *   :py:class:`Pinpoint.Client.exceptions.InternalServerErrorException`

  
  *   :py:class:`Pinpoint.Client.exceptions.PayloadTooLargeException`

  
  *   :py:class:`Pinpoint.Client.exceptions.ForbiddenException`

  
  *   :py:class:`Pinpoint.Client.exceptions.NotFoundException`

  
  *   :py:class:`Pinpoint.Client.exceptions.MethodNotAllowedException`

  
  *   :py:class:`Pinpoint.Client.exceptions.TooManyRequestsException`

  