Authentication Verification
Use this interface to verify the legality of the one-time password (OTP) received by the user.
Request parameters
Collapse All
authenticationTypeEnumRequired
Indicates the authentication type. Possible value is:
OTP: One-time password
authenticationRequestIdString(64)Required
The unique ID of an authentication generated by merchants. The value of this field must be identical to that of authenticationRequestId in the Authentication Initiation interface.
authenticationValueString(256)Required
Authentication value
Response parameters
Collapse All
resultResultRequired
The request result, which contains information related to the request result, such as status and error codes.
resultCodeString(16)Required
Result code
resultStatusEnumRequired
Result status. Possible values are:
- S: Indicates that the result status is successful.
- F: Indicates that the result status is failed.
- U: Indicates that the result status is unknown.
resultMessageString(64)Optional
Result message
isPassedBooleanOptional
Indicates whether the authentication is passed.
Result/Error codes
| Code | Value | Message |
|---|---|---|
| SUCCESS | S | Success |
| PARAM_ILLEGAL | F | Illegal parameters exist. For example, a non-numeric input, or an invalid date. |
| PROCESS_FAIL | F | A general business failure occurred. Do not retry. |
| UNKNOWN_EXCEPTION | U | An API calling is failed, which is caused by unknown reasons. |
| KEY_NOT_FOUND | F | The key is not found. |
| API_INVALID | F | API is invalid or not active. |
| CLIENT_INVALID | F | The client is invalid. |
| SIGNATURE_INVALID | F | The signature is invalid. |
| METHOD_NOT_SUPPORTED | F | The server does not implement the requested HTTP method. |
| REQUEST_TRAFFIC_EXCEED_LIMIT | U | The request traffic exceeds the limit. |
| ACCESS_DENIED | F | Access denied |
| USER_NOT_EXIST | F | The user does not exist. |
| USER_STATUS_ABNORMAL | F | The user status is abnormal. |
| INVALID_ACCESS_TOKEN | F | The access token is invalid. |
| VERIFY_TIMES_EXCEED_LIMIT | F | The verification code was failed too many times. The user must get a new verification. |
| VERIFY_UNMATCHED | F | The verification code is invalid. |
| AUTHENTICATION_REQUEST_ID_INVALID | The value of authenticationRequestId is invalid |
Request/Response Code
Request
Method
POST
Endpoint
v1/users/verifyAuthentication
Header
Accept: application/json
URL
Domain name
Request Body
Request parameters
Response Body
Body content