Verify OTP

Use this resource to check the validity of One-Time Passwords (OTPs) that were generated using the OTP Message resource.

URI

/v1/apps/application-id/verify-otp

Operation ID: VerifyOTPMessage

Verifies a One-Time Password that was generated by the OTP Message resource.

Path parameters
Name	Type	Required	Description
`application-id`	String	True	The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Header parameters
Name	Type	Required	Description
`accept`	String	False	Indicates which content types, expressed as MIME types, the client understands.

Responses
Status code	Response model	Description
`200`	`VerificationResponse`	200 response
`400`	`MessageBody`	The request contains a syntax error (BadRequestException).
`403`	`MessageBody`	The request was denied because access to the specified resource is forbidden (ForbiddenException).
`404`	`MessageBody`	The request failed because the specified resource was not found (NotFoundException).
`405`	`MessageBody`	The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
`413`	`MessageBody`	The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
`429`	`MessageBody`	The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
`500`	`MessageBody`	The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

Path parameters
Name	Type	Required	Description
`application-id`	String	True	The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Responses
Status code	Response model	Description
`200`	None	The request succeeded.


{
  "DestinationIdentity": "string",
  "Otp": "string",
  "ReferenceId": "string"
}


{
  "Valid": boolean
}


{
  "RequestID": "string",
  "Message": "string"
}

Provides information about an API request or response.

Property	Type	Required	Description
`Message`	string	False	The message that's returned from the API.
`RequestID`	string	False	The unique identifier for the request or response.

Provides information about the validity of the OTP code provided in the request.

Property	Type	Required	Description
`Valid`	boolean	False	Specifies whether the OTP is valid or not.

Specifies the details of the OTP that you are validating.

Property	Type	Required	Description
`DestinationIdentity`	string	True	The phone number, in E.164 format, that the OTP code was sent to.
`Otp`	string	True	The OTP code that you are validating.
`ReferenceId`	string	True	The reference ID that you used when you sent the OTP code to the recipient. The reference ID must be an exact match.