com.tencentcloudapi.faceid.v20180301

Class FaceidClient

java.lang.Object

com.tencentcloudapi.common.AbstractClient

com.tencentcloudapi.faceid.v20180301.FaceidClient

public class FaceidClient
extends AbstractClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors

Constructor and Description
FaceidClient(Credential credential, String region)
FaceidClient(Credential credential, String region, ClientProfile profile)

Method Summary

Modifier and Type	Method and Description
CreateUploadUrlResponse	CreateUploadUrl(CreateUploadUrlRequest req) This API is used to generate a temporary `UploadUrl` for uploading resource files (with the `HTTP PUT` method).
DetectReflectLivenessAndCompareResponse	DetectReflectLivenessAndCompare(DetectReflectLivenessAndCompareRequest req) This API is used to detect liveness with the package generated by the liveness comparison (reflection-based) SDK, and to compare the person detected with that in the image passed in.
GenerateReflectSequenceResponse	GenerateReflectSequence(GenerateReflectSequenceRequest req) This API is used to generate an appropriate light sequence based on the information collected by the liveness comparison (reflection-based) SDK and pass the light sequence into the SDK to start the identity verification process.
LivenessCompareResponse	LivenessCompare(LivenessCompareRequest req) This API is used to pass in a video and a photo, determine whether the person in the video is real, and if yes, then determine whether the person in the video is the same as that in the photo.
VideoLivenessCompareResponse	VideoLivenessCompare(VideoLivenessCompareRequest req) This API is used to pass in URLs of a video and a photo, determine whether the person in the video is real, and if yes, then determine whether the person in the video is the same as that in the photo.

Methods inherited from class com.tencentcloudapi.common.AbstractClient

call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FaceidClient

public FaceidClient(Credential credential,
                    String region)

FaceidClient

public FaceidClient(Credential credential,
                    String region,
                    ClientProfile profile)

Method Detail

CreateUploadUrl

public CreateUploadUrlResponse CreateUploadUrl(CreateUploadUrlRequest req)
                                        throws TencentCloudSDKException

This API is used to generate a temporary `UploadUrl` for uploading resource files (with the `HTTP PUT` method). After resource upload, `ResourceUrl` will be passed to the `TargetAction` API to complete the resource passing (specific fields vary by case). The data will be stored in a COS bucket in the region specified by the parameter `Region` for two hours.

Parameters:

req - CreateUploadUrlRequest

Returns:

CreateUploadUrlResponse

Throws:

TencentCloudSDKException

DetectReflectLivenessAndCompare

public DetectReflectLivenessAndCompareResponse DetectReflectLivenessAndCompare(DetectReflectLivenessAndCompareRequest req)
                                                                        throws TencentCloudSDKException

This API is used to detect liveness with the package generated by the liveness comparison (reflection-based) SDK, and to compare the person detected with that in the image passed in. The image and the data generated with the SDK must be stored in COS, and the region of the COS bucket must be same as that of requests made with this API. We recommend that you pass resources with upload link APIs.

Parameters:

req - DetectReflectLivenessAndCompareRequest

Returns:

DetectReflectLivenessAndCompareResponse

Throws:

TencentCloudSDKException

GenerateReflectSequence

public GenerateReflectSequenceResponse GenerateReflectSequence(GenerateReflectSequenceRequest req)
                                                        throws TencentCloudSDKException

This API is used to generate an appropriate light sequence based on the information collected by the liveness comparison (reflection-based) SDK and pass the light sequence into the SDK to start the identity verification process. The data generated with the SDK must be stored in COS, and the region of the COS bucket must be same as that of requests made with this API. We recommend that you pass resources with upload link APIs.

Parameters:

req - GenerateReflectSequenceRequest

Returns:

GenerateReflectSequenceResponse

Throws:

TencentCloudSDKException

LivenessCompare

public LivenessCompareResponse LivenessCompare(LivenessCompareRequest req)
                                        throws TencentCloudSDKException

This API is used to pass in a video and a photo, determine whether the person in the video is real, and if yes, then determine whether the person in the video is the same as that in the photo.

Parameters:

req - LivenessCompareRequest

Returns:

LivenessCompareResponse

Throws:

TencentCloudSDKException

VideoLivenessCompare

public VideoLivenessCompareResponse VideoLivenessCompare(VideoLivenessCompareRequest req)
                                                  throws TencentCloudSDKException

This API is used to pass in URLs of a video and a photo, determine whether the person in the video is real, and if yes, then determine whether the person in the video is the same as that in the photo.

Parameters:

req - VideoLivenessCompareRequest

Returns:

VideoLivenessCompareResponse

Throws:

TencentCloudSDKException