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

Nationality Indonesia ID card No Indonesia Drving license No Hongkong ID card Yes Thailand ID card No Thailand Drving license Yes Malaysia ID card Yes Malaysia Drving license Yes Singapore ID card Yes Singapore Drving license Yes Philippine ID card Yes Philippine Drving license No Japan ID card Yes Japan Drving license No

Modifier and Type	Method and Description
ApplyCardVerificationResponse	ApplyCardVerification(ApplyCardVerificationRequest req) The types of national cards supported by the API and whether instructions on the back of the card are required are as follows:
CardType	Back side required
ApplyLivenessTokenResponse	ApplyLivenessToken(ApplyLivenessTokenRequest req) This API is used to apply for a token before calling the liveness detection service each time.
ApplySdkVerificationTokenResponse	ApplySdkVerificationToken(ApplySdkVerificationTokenRequest req) This API is used to apply for a token before calling the Identity Verification SDK service each time.
ApplyWebVerificationBizTokenIntlResponse	ApplyWebVerificationBizTokenIntl(ApplyWebVerificationBizTokenIntlRequest req) This API is used to apply for a BizToken before calling the web-based verification service each time.
ApplyWebVerificationTokenResponse	ApplyWebVerificationToken(ApplyWebVerificationTokenRequest req) This API is used to apply for a token before calling the web-based verification service each time.
CompareFaceLivenessResponse	CompareFaceLiveness(CompareFaceLivenessRequest req) This interface supports judgment of real person and photo comparison to verify the user's identity online.
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.
GetCardVerificationResultResponse	GetCardVerificationResult(GetCardVerificationResultRequest req) The interface supports obtaining the certificate authentication result based on the token.
GetFaceIdResultIntlResponse	GetFaceIdResultIntl(GetFaceIdResultIntlRequest req) This API is used to get the verification result with the corresponding SDK token after the identity verification process is completed.
GetFaceIdTokenIntlResponse	GetFaceIdTokenIntl(GetFaceIdTokenIntlRequest req) This API is used to apply for an SDK token before calling the liveness detection and face comparison SDK each time.
GetLivenessResultResponse	GetLivenessResult(GetLivenessResultRequest req) This API is used to get the verification result with the corresponding token (SdkToken) after the liveness detection is completed.
GetSdkVerificationResultResponse	GetSdkVerificationResult(GetSdkVerificationResultRequest req) This API is used to get the verification result with the corresponding token after the SDK-based verification is completed.
GetWebVerificationResultResponse	GetWebVerificationResult(GetWebVerificationResultRequest req) This API is used to get the verification result with the corresponding token (BizToken) after the web-based verification is completed.
GetWebVerificationResultIntlResponse	GetWebVerificationResultIntl(GetWebVerificationResultIntlRequest req) This API is used to get the verification result with the corresponding BizToken after the u200dweb-based verification is completed.
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, callOctetStream, getClientProfile, getCredential, getRegion, getRegionBreaker, internalRequest, internalRequest, internalRequestRaw, processResponseJson, processResponseSSE, retry, setClientProfile, setCredential, setRegion, setRegionBreaker

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

ApplyCardVerification

public ApplyCardVerificationResponse ApplyCardVerification(ApplyCardVerificationRequest req)
                                                    throws TencentCloudSDKException

The types of national cards supported by the API and whether instructions on the back of the card are required are as follows:

Nationality	CardType	Back side required
Indonesia	ID card	No
Indonesia	Drving license	No
Hongkong	ID card	Yes
Thailand	ID card	No
Thailand	Drving license	Yes
Malaysia	ID card	Yes
Malaysia	Drving license	Yes
Singapore	ID card	Yes
Singapore	Drving license	Yes
Philippine	ID card	Yes
Philippine	Drving license	No
Japan	ID card	Yes
Japan	Drving license	No

Parameters:

req - ApplyCardVerificationRequest

Returns:

ApplyCardVerificationResponse

Throws:

TencentCloudSDKException

ApplyLivenessToken

public ApplyLivenessTokenResponse ApplyLivenessToken(ApplyLivenessTokenRequest req)
                                              throws TencentCloudSDKException

This API is used to apply for a token before calling the liveness detection service each time. This token is required for initiating the verification process and getting the result after the verification is completed.

Parameters:

req - ApplyLivenessTokenRequest

Returns:

ApplyLivenessTokenResponse

Throws:

TencentCloudSDKException

ApplySdkVerificationToken

public ApplySdkVerificationTokenResponse ApplySdkVerificationToken(ApplySdkVerificationTokenRequest req)
                                                            throws TencentCloudSDKException

This API is used to apply for a token before calling the Identity Verification SDK service each time. This token is required for initiating the verification process and getting the result after the verification is completed.

Parameters:

req - ApplySdkVerificationTokenRequest

Returns:

ApplySdkVerificationTokenResponse

Throws:

TencentCloudSDKException

ApplyWebVerificationBizTokenIntl

public ApplyWebVerificationBizTokenIntlResponse ApplyWebVerificationBizTokenIntl(ApplyWebVerificationBizTokenIntlRequest req)
                                                                          throws TencentCloudSDKException

This API is used to apply for a BizToken before calling the web-based verification service each time. This token is required for initiating a verification process and getting the result after the verification is completed.

Parameters:

req - ApplyWebVerificationBizTokenIntlRequest

Returns:

ApplyWebVerificationBizTokenIntlResponse

Throws:

TencentCloudSDKException

ApplyWebVerificationToken

public ApplyWebVerificationTokenResponse ApplyWebVerificationToken(ApplyWebVerificationTokenRequest req)
                                                            throws TencentCloudSDKException

This API is used to apply for a token before calling the web-based verification service each time. This token is required for initiating the verification process and getting the result after the verification is completed.

Parameters:

req - ApplyWebVerificationTokenRequest

Returns:

ApplyWebVerificationTokenResponse

Throws:

TencentCloudSDKException

CompareFaceLiveness

public CompareFaceLivenessResponse CompareFaceLiveness(CompareFaceLivenessRequest req)
                                                throws TencentCloudSDKException

This interface supports judgment of real person and photo comparison to verify the user's identity online. By passing the video and photo into the interface, it will first judge whether the person in the video is real. If yes, it judges whether the person in the video is the same one as the uploaded photo and returns authentication result.

Parameters:

req - CompareFaceLivenessRequest

Returns:

CompareFaceLivenessResponse

Throws:

TencentCloudSDKException

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

GetCardVerificationResult

public GetCardVerificationResultResponse GetCardVerificationResult(GetCardVerificationResultRequest req)
                                                            throws TencentCloudSDKException

The interface supports obtaining the certificate authentication result based on the token.

Parameters:

req - GetCardVerificationResultRequest

Returns:

GetCardVerificationResultResponse

Throws:

TencentCloudSDKException

GetFaceIdResultIntl

public GetFaceIdResultIntlResponse GetFaceIdResultIntl(GetFaceIdResultIntlRequest req)
                                                throws TencentCloudSDKException

This API is used to get the verification result with the corresponding SDK token after the identity verification process is completed. The SDK token is valid for two hours (2*3,600s) after generation and can be called multiple times.

Parameters:

req - GetFaceIdResultIntlRequest

Returns:

GetFaceIdResultIntlResponse

Throws:

TencentCloudSDKException

GetFaceIdTokenIntl

public GetFaceIdTokenIntlResponse GetFaceIdTokenIntl(GetFaceIdTokenIntlRequest req)
                                              throws TencentCloudSDKException

This API is used to apply for an SDK token before calling the liveness detection and face comparison SDK each time. The SDK token is used throughout the identity verification process and to get the verification result after the verification is completed. A token is valid for one identity verification process only.

Parameters:

req - GetFaceIdTokenIntlRequest

Returns:

GetFaceIdTokenIntlResponse

Throws:

TencentCloudSDKException

GetLivenessResult

public GetLivenessResultResponse GetLivenessResult(GetLivenessResultRequest req)
                                            throws TencentCloudSDKException

This API is used to get the verification result with the corresponding token (SdkToken) after the liveness detection is completed. The token is valid for two hours after issuance and can be called multiple times.

Parameters:

req - GetLivenessResultRequest

Returns:

GetLivenessResultResponse

Throws:

TencentCloudSDKException

GetSdkVerificationResult

public GetSdkVerificationResultResponse GetSdkVerificationResult(GetSdkVerificationResultRequest req)
                                                          throws TencentCloudSDKException

This API is used to get the verification result with the corresponding token after the SDK-based verification is completed. The token is valid for three days after issuance and can be called multiple times.

Parameters:

req - GetSdkVerificationResultRequest

Returns:

GetSdkVerificationResultResponse

Throws:

TencentCloudSDKException

GetWebVerificationResult

public GetWebVerificationResultResponse GetWebVerificationResult(GetWebVerificationResultRequest req)
                                                          throws TencentCloudSDKException

This API is used to get the verification result with the corresponding token (BizToken) after the web-based verification is completed. The BizToken is valid for three days (3*24*3,600s) after issuance and can be called multiple times.

Parameters:

req - GetWebVerificationResultRequest

Returns:

GetWebVerificationResultResponse

Throws:

TencentCloudSDKException

GetWebVerificationResultIntl

public GetWebVerificationResultIntlResponse GetWebVerificationResultIntl(GetWebVerificationResultIntlRequest req)
                                                                  throws TencentCloudSDKException

This API is used to get the verification result with the corresponding BizToken after the u200dweb-based verification is completed. The token is valid for three days (259,200s) after issuance and can be called multiple times.

Parameters:

req - GetWebVerificationResultIntlRequest

Returns:

GetWebVerificationResultIntlResponse

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. This API on the legacy version will continue to serve existing users but will be unavailable to new users. We recommend you use `VideoLivenessCompare` for better service quality.

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