Verify a verification code with CheckVerification - Phone Number Verification Service

Verifies a verification code.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ServiceSid	string	No	The service ID that is displayed in the Phone Number Verification Service console.	FA00000000000001
To	string	No	The mobile phone number of the recipient. You must add the country code to the beginning of the mobile phone number.	6212345****01
Code	string	Yes	The verification code.	1234
VerificationId	string	Yes	The unique authentication ID that is returned by calling the StartVerification operation.	rJXlaR2q5LpKfREtpRPMBfDVQvELZwmBbK5yVR7gr3nLbNAcolLGPYCJaVHt/i+I

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request. An ID is a unique identifier that Alibaba Cloud generates for a request.	HF14955E-EEB5-3CE4-AE50-00F7FC8C1D62
Message	string	The message that was returned.	OK
Model	object	The data that was returned for the successful request.	{ "phoneNumber": "", "channel": "", "verificationId": "", "status": "approved" }
Code	string	The HTTP status code that was returned.	OK
Success	string	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "HF14955E-EEB5-3CE4-AE50-00F7FC8C1D62",
  "Message": "OK",
  "Model": {
    "phoneNumber": "",
    "channel": "",
    "verificationId": "",
    "status": "approved"
  },
  "Code": "OK",
  "Success": "true"
}

Error codes

HTTP status code	Error code	Error message
400	Invalid.Parameters	The parameter is invalid.

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-11-03

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400