When your server makes infrequent calls to the ID Verification API, call the KeepaliveIntl operation to maintain the client connection.
API description
-
API operation: KeepaliveIntl
-
Request methods: POST and GET
-
Transport protocol: HTTPS
-
Description: Maintains the client connection when your server makes infrequent calls to the ID Verification service. This operation requires no input parameters and has no specific business logic.
-
Endpoints:
NoteDifferent ID Verification solutions support different regions, and data is isolated between them. To access your data, you must use the API domain name for the region where your data is stored.
Singapore
Public endpoint:
cloudauth-intl.ap-southeast-1.aliyuncs.comInternal endpoint:
cloudauth-intl-vpc.ap-southeast-1.aliyuncs.com
Indonesia (Jakarta)
Public endpoint:
cloudauth-intl.ap-southeast-5.aliyuncs.comInternal endpoint:
cloudauth-intl-vpc.ap-southeast-5.aliyuncs.com
China (Hong Kong)
Public endpoint:
cloudauth-intl.cn-hongkong.aliyuncs.comInternal endpoint:
cloudauth-intl-vpc.cn-hongkong.aliyuncs.com
Online debugging and integration
Before you debug or integrate, read the Debug and integrate server-side APIs with OpenAPI guide to understand how to call APIs on the OpenAPI platform and how to obtain the SDK.
You can run this operation in OpenAPI Explorer to debug it and generate an SDK code example.
Response parameters
|
Name |
Type |
Description |
Example |
|
RequestId |
String |
The request ID. |
|
|
Code |
String |
The return code. |
|
|
Message |
String |
A detailed description of the Code. |
|
|
Result.Result |
Object |
The result of the call. |
Return codes
HTTP status code | Code | Message description |
200 | Success | Request successful. |
400 | MissingParameter | Parameter cannot be empty. |
InvalidParameter | Invalid parameter. | |
TransactionIdInvalid | Invalid Transaction ID. | |
403 | Forbidden.RAMUserAccessDenied | You need to grant the RAM user the AliyunAntCloudAuthFullAccess permission. For more information, see Authorize RAM users to access the service. |
Forbidden.AccountAccessDenied | Ensure that you have activated ID verification and your account has no overdue payment. | |
Throttling.Api | API request is blocked due to throttling. | |
404 | ProcessNotCompleted | The entire authentication process is not completed. |
500 | InternalError | Internal system error. Provide feedback to engineers for troubleshooting. |
503 | ServiceUnavailable | The service is unavailable. Contact engineers for troubleshooting. |