Pinpoint / Client / verify_otp_message

verify_otp_message#

Pinpoint.Client.verify_otp_message(**kwargs)#

Verify an OTP

See also: AWS API Documentation

Request Syntax

response = client.verify_otp_message(
    ApplicationId='string',
    VerifyOTPMessageRequestParameters={
        'DestinationIdentity': 'string',
        'Otp': 'string',
        'ReferenceId': 'string'
    }
)
Parameters:

  • ApplicationId (string) –

    [REQUIRED]

    The unique ID of your Amazon Pinpoint application.

  • VerifyOTPMessageRequestParameters (dict) –

    [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.

Return type:

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