Call the DeleteVerifyResult operation to delete sensitive authentication data for specific ID Verification solutions.
Limitations
DeleteVerifyResult supports only the following solutions:
API description
Call this operation after an authentication flow completes to delete its data.
Console data is deleted asynchronously. Changes take up to 3 minutes to take effect.
Before you delete the data, ensure that you save it. Deleted data cannot be recovered or viewed in the console.
-
API operation name: DeleteVerifyResult
-
Request method: POST
-
Transport protocol: HTTPS
-
Endpoint:
NoteAn internal network is a private communication network connecting Alibaba Cloud products within the same region. If your application server is deployed in the same region, use the internal endpoint to access the ID Verification service for enhanced security and stability.
Different ID Verification product plans support different regions, and data is isolated between them. You must use the endpoint for your data's region to access it.
Asia Pacific SE 1 (Singapore)
Public endpoint:
cloudauth-intl.ap-southeast-1.aliyuncs.comInternal endpoint:
cloudauth-intl-vpc.ap-southeast-1.aliyuncs.com
Asia Pacific SE 5 (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 debugging and integration, read the Use OpenAPI document to learn how to call APIs on the OpenAPI platform and obtain the SDK.
You can debug this API operation in OpenAPI Explorer and generate an SDK code sample for it.
Request parameters
|
Name |
Type |
Required |
Description |
Example |
|
TransactionId |
String |
Yes |
Unique ID of the authentication flow, returned by the Initialize operation. Used to initiate CheckResult requests. |
e0c34a77f5ac40a5aa5e6ed20c35**** |
|
DeleteAfterQuery |
String |
Yes |
Whether deletion requires that you have already retrieved the authentication data.
|
Y |
|
DeleteType |
String |
Yes |
The scope of data to delete.
|
Img |
Response parameters
|
Name |
Type |
Description |
Example |
|
HTTP Status Code |
Integer |
The HTTP status code. |
200 |
|
HTTP Body |
Object |
None. |
None. |
|
└RequestId |
String |
The request ID. |
|
|
└Code |
String |
The response code. |
Success |
|
└Message |
String |
A detailed description of the response code. |
success |
|
└Result.TransactionId |
String |
The unique ID for the entire authentication flow. |
e0c34a77f5ac40a5aa5e6ed20c35**** |
|
└Result.DeleteResult |
String |
Deletion result:
|
Y |
Response codes
|
Code |
Message |
Description |
|
200 |
Success |
The request was successful. |
|
400 |
MissingParameter |
A parameter cannot be empty. |
|
400 |
InvalidParameter |
The parameter is invalid. |
|
400 |
TransactionIdInvalid |
The transaction ID is invalid. |
|
403 |
Forbidden.RAMUserAccessDenied |
The RAM user requires the AliyunAntCloudAuthFullAccess permission. Grant a RAM user access to the service. |
|
403 |
Forbidden.AccountAccessDenied |
Activate ID Verification and ensure your account has no overdue payments. |
|
403 |
Throttling.Api |
The request was throttled. |
|
500 |
InternalError |
An internal error occurred. Contact technical support. |