v20180301

package
v3.0.965+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 26, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// CAM signature/authentication error.
	AUTHFAILURE_INVALIDAUTHORIZATION = "AuthFailure.InvalidAuthorization"

	// No motions of eye closing are detected.
	FAILEDOPERATION_ACTIONCLOSEEYE = "FailedOperation.ActionCloseEye"

	// The face is too close to the screen.
	FAILEDOPERATION_ACTIONFACECLOSE = "FailedOperation.ActionFaceClose"

	// The face is too far from the screen.
	FAILEDOPERATION_ACTIONFACEFAR = "FailedOperation.ActionFaceFar"

	// The face is too far left from the screen.
	FAILEDOPERATION_ACTIONFACELEFT = "FailedOperation.ActionFaceLeft"

	// The face is too far right from the screen.
	FAILEDOPERATION_ACTIONFACERIGHT = "FailedOperation.ActionFaceRight"

	// No movement is detected.
	FAILEDOPERATION_ACTIONFIRSTACTION = "FailedOperation.ActionFirstAction"

	// The lighting is too dim.
	FAILEDOPERATION_ACTIONLIGHTDARK = "FailedOperation.ActionLightDark"

	// The lighting is too strong.
	FAILEDOPERATION_ACTIONLIGHTSTRONG = "FailedOperation.ActionLightStrong"

	// Failed to detect a full face.
	FAILEDOPERATION_ACTIONNODETECTFACE = "FailedOperation.ActionNodetectFace"

	// No motions of mouth opening are detected.
	FAILEDOPERATION_ACTIONOPENMOUTH = "FailedOperation.ActionOpenMouth"

	// Comparison failed.
	FAILEDOPERATION_COMPAREFAIL = "FailedOperation.CompareFail"

	// The comparison similarity did not reach the passing standard.
	FAILEDOPERATION_COMPARELOWSIMILARITY = "FailedOperation.CompareLowSimilarity"

	// Error calling the comparison engine API.
	FAILEDOPERATION_COMPARESYSTEMERROR = "FailedOperation.CompareSystemError"

	// File download failed.
	FAILEDOPERATION_DOWNLOADERROR = "FailedOperation.DownLoadError"

	// File download timed out.
	FAILEDOPERATION_DOWNLOADTIMEOUTERROR = "FailedOperation.DownLoadTimeoutError"

	// The image is blurry.
	FAILEDOPERATION_IMAGEBLUR = "FailedOperation.ImageBlur"

	// Image decoding failed.
	FAILEDOPERATION_IMAGEDECODEFAILED = "FailedOperation.ImageDecodeFailed"

	// The image is too large.
	FAILEDOPERATION_IMAGESIZETOOLARGE = "FailedOperation.ImageSizeTooLarge"

	// Multiple faces are detected.
	FAILEDOPERATION_LIFEPHOTODETECTFACES = "FailedOperation.LifePhotoDetectFaces"

	// Real person comparison failed.
	FAILEDOPERATION_LIFEPHOTODETECTFAKE = "FailedOperation.LifePhotoDetectFake"

	// Failed to detect a full face.
	FAILEDOPERATION_LIFEPHOTODETECTNOFACES = "FailedOperation.LifePhotoDetectNoFaces"

	// The resolution of the image passed in is too low. Please upload a new one.
	FAILEDOPERATION_LIFEPHOTOPOORQUALITY = "FailedOperation.LifePhotoPoorQuality"

	// The image passed in is too large or too small.
	FAILEDOPERATION_LIFEPHOTOSIZEERROR = "FailedOperation.LifePhotoSizeError"

	// The face is not fully exposed.
	FAILEDOPERATION_LIPFACEINCOMPLETE = "FailedOperation.LipFaceIncomplete"

	// The lip movement range is too small.
	FAILEDOPERATION_LIPMOVESMALL = "FailedOperation.LipMoveSmall"

	// Failed to pull the video. Please try again.
	FAILEDOPERATION_LIPNETFAILED = "FailedOperation.LipNetFailed"

	// The video is empty or its size is inappropriate. The recording duration should be about 6 seconds.
	FAILEDOPERATION_LIPSIZEERROR = "FailedOperation.LipSizeError"

	// The video format is incorrect.
	FAILEDOPERATION_LIPVIDEOINVALID = "FailedOperation.LipVideoInvalid"

	// The video definition is too low.
	FAILEDOPERATION_LIPVIDEOQUAILITY = "FailedOperation.LipVideoQuaility"

	// No sound is detected.
	FAILEDOPERATION_LIPVOICEDETECT = "FailedOperation.LipVoiceDetect"

	// The volume of the video is too low.
	FAILEDOPERATION_LIPVOICELOW = "FailedOperation.LipVoiceLow"

	// Speech recognition failed.
	FAILEDOPERATION_LIPVOICERECOGNIZE = "FailedOperation.LipVoiceRecognize"

	// Face detection failed. Unable to extract the photo for comparison.
	FAILEDOPERATION_LIVESSBESTFRAMEERROR = "FailedOperation.LivessBestFrameError"

	// Liveness detection failed.
	FAILEDOPERATION_LIVESSDETECTFAIL = "FailedOperation.LivessDetectFail"

	// Suspected spoofed recording.
	FAILEDOPERATION_LIVESSDETECTFAKE = "FailedOperation.LivessDetectFake"

	// Error calling the liveness engine API.
	FAILEDOPERATION_LIVESSSYSTEMERROR = "FailedOperation.LivessSystemError"

	// Video-based real person detection failed.
	FAILEDOPERATION_LIVESSUNKNOWNERROR = "FailedOperation.LivessUnknownError"

	// Real person detection failed.
	FAILEDOPERATION_SILENTDETECTFAIL = "FailedOperation.SilentDetectFail"

	// Eye detection failed.
	FAILEDOPERATION_SILENTEYELIVEFAIL = "FailedOperation.SilentEyeLiveFail"

	// No face is detected in the video.
	FAILEDOPERATION_SILENTFACEDETECTFAIL = "FailedOperation.SilentFaceDetectFail"

	// Low face quality.
	FAILEDOPERATION_SILENTFACEQUALITYFAIL = "FailedOperation.SilentFaceQualityFail"

	// A face mask is detected.
	FAILEDOPERATION_SILENTFACEWITHMASKFAIL = "FailedOperation.SilentFaceWithMaskFail"

	// Mouth detection failed.
	FAILEDOPERATION_SILENTMOUTHLIVEFAIL = "FailedOperation.SilentMouthLiveFail"

	// Multiple faces are detected in the video.
	FAILEDOPERATION_SILENTMULTIFACEFAIL = "FailedOperation.SilentMultiFaceFail"

	// The video might be spoofed.
	FAILEDOPERATION_SILENTPICTURELIVEFAIL = "FailedOperation.SilentPictureLiveFail"

	// Real person detection did not reach the passing standard.
	FAILEDOPERATION_SILENTTHRESHOLD = "FailedOperation.SilentThreshold"

	// The video is too short. Please capture a video longer than 2 seconds.
	FAILEDOPERATION_SILENTTOOSHORT = "FailedOperation.SilentTooShort"

	// Unknown error.
	FAILEDOPERATION_UNKNOWERROR = "FailedOperation.UnKnowError"

	// Unknown internal error.
	FAILEDOPERATION_UNKNOWN = "FailedOperation.UnKnown"

	// The service is not activated.
	FAILEDOPERATION_UNOPENERROR = "FailedOperation.UnOpenError"

	// Internal error.
	INTERNALERROR = "InternalError"

	// The lighting is too dim.
	INTERNALERROR_ACTIONLIGHTDARK = "InternalError.ActionLightDark"

	// The lighting is too strong.
	INTERNALERROR_ACTIONLIGHTSTRONG = "InternalError.ActionLightStrong"

	// Failed to detect a full face.
	INTERNALERROR_ACTIONNODETECTFACE = "InternalError.ActionNodetectFace"

	// The similarity did not reach the passing standard.
	INTERNALERROR_COMPARELOWSIMILARITY = "InternalError.CompareLowSimilarity"

	// The resolution of the image passed in is too low. Please upload a new one.
	INTERNALERROR_LIFEPHOTOPOORQUALITY = "InternalError.LifePhotoPoorQuality"

	// The image passed in is too large or too small.
	INTERNALERROR_LIFEPHOTOSIZEERROR = "InternalError.LifePhotoSizeError"

	// Unknown internal error.
	INTERNALERROR_UNKNOWN = "InternalError.UnKnown"

	// Invalid parameter.
	INVALIDPARAMETER = "InvalidParameter"

	// Image decoding failed.
	INVALIDPARAMETER_ENGINEIMAGEDECODEFAILED = "InvalidParameter.EngineImageDecodeFailed"

	// Incorrect parameter value.
	INVALIDPARAMETERVALUE = "InvalidParameterValue"

	// BizToken expired.
	INVALIDPARAMETERVALUE_BIZTOKENEXPIRED = "InvalidParameterValue.BizTokenExpired"

	// Invalid BizToken.
	INVALIDPARAMETERVALUE_BIZTOKENILLEGAL = "InvalidParameterValue.BizTokenIllegal"

	// The image file content size is abnormal.
	INVALIDPARAMETERVALUE_INVALIDFILECONTENTSIZE = "InvalidParameterValue.InvalidFileContentSize"

	// Parameter value is wrong.
	INVALIDPARAMETERVALUE_INVALIDPARAMETERVALUELIMIT = "InvalidParameterValue.InvalidParameterValueLimit"

	// Operation denied.
	OPERATIONDENIED = "OperationDenied"

	// The resource is unavailable.
	RESOURCEUNAVAILABLE = "ResourceUnavailable"

	// Image file download failed.
	RESOURCEUNAVAILABLE_IMAGEDOWNLOADERROR = "ResourceUnavailable.ImageDownloadError"

	// The account is in arrears.
	RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears"

	// The account has exhausted the resource package for this service.
	RESOURCEUNAVAILABLE_RESOURCEPACKAGERUNOUT = "ResourceUnavailable.ResourcePackageRunOut"

	// Unauthorized operation.
	UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

	// Service activation exception.
	UNAUTHORIZEDOPERATION_ACTIVATEERROR = "UnauthorizedOperation.ActivateError"

	// Activating the service.
	UNAUTHORIZEDOPERATION_ACTIVATING = "UnauthorizedOperation.Activating"

	// The account is in arrears.
	UNAUTHORIZEDOPERATION_ARREARS = "UnauthorizedOperation.Arrears"

	// Identity verification has not been completed for the account.
	UNAUTHORIZEDOPERATION_NONAUTHORIZE = "UnauthorizedOperation.NonAuthorize"

	// The service has not been activated.
	UNAUTHORIZEDOPERATION_NONACTIVATED = "UnauthorizedOperation.Nonactivated"

	// Unsupported operation.
	UNSUPPORTEDOPERATION = "UnsupportedOperation"
)
View Source 
const APIVersion = "2018-03-01"

Variables

This section is empty.

Functions

This section is empty.

Types

type Address 

type Address struct {
	// Nationality.
	Country *string `json:"Country,omitnil,omitempty" name:"Country"`

	// Post code.
	PostalCode *string `json:"PostalCode,omitnil,omitempty" name:"PostalCode"`

	// Subregion.
	Subdivision *string `json:"Subdivision,omitnil,omitempty" name:"Subdivision"`

	// City.
	City *string `json:"City,omitnil,omitempty" name:"City"`

	// Complete address.
	FormattedAddress *string `json:"FormattedAddress,omitnil,omitempty" name:"FormattedAddress"`

	// The first line of address.
	LineOne *string `json:"LineOne,omitnil,omitempty" name:"LineOne"`

	// The second line of address.
	LineTwo *string `json:"LineTwo,omitnil,omitempty" name:"LineTwo"`

	// The third line of address.
	LineThree *string `json:"LineThree,omitnil,omitempty" name:"LineThree"`

	// The fourth line of address.
	LineFour *string `json:"LineFour,omitnil,omitempty" name:"LineFour"`

	// The fifth line of address.
	LineFive *string `json:"LineFive,omitnil,omitempty" name:"LineFive"`
}

type ApplyCardVerificationRequest 

type ApplyCardVerificationRequest struct {
	*tchttp.BaseRequest

	// Please select the country code of ID document.
	// IDN: Indonesia
	// HKG: Hong Kong
	// THA: Thailand
	// MYS: Malaysia
	// SGP: Singapore
	// JPN: Japan
	// AUTO: Automatic Identification
	Nationality *string `json:"Nationality,omitnil,omitempty" name:"Nationality"`

	// Please select the type of ID document. The supported options are:
	// ID_CARD
	// PASSPORT
	// DRIVING_LICENSE
	// AUTO
	CardType *string `json:"CardType,omitnil,omitempty" name:"CardType"`

	// Base64 value for the front of the document. Supported image formats: PNG, JPEG, GIF format is not supported yet. Supported image size: The downloaded image cannot exceed 5M after Base64 encoding.
	// The image download takes no more than 3 seconds. Supported image resolution: 8000*8000. One of ImageUrlFront and ImageBase64 Front of the image must be provided. If both are provided, only ImageUrlFront will be used.
	ImageBase64Front *string `json:"ImageBase64Front,omitnil,omitempty" name:"ImageBase64Front"`

	// Base64 value of the reverse side of the document. Supported image formats: PNG, JPEG, GIF format is not supported yet. Supported image size: The downloaded image cannot exceed 5M after Base64 encoding. The image download takes no more than 3 seconds. Maximum supported image resolution: 8000*8000. For some certificates, one of ImageUrlBack and ImageBase64Back must be provided. If both are provided, only ImageUrlBack will be used.
	ImageBase64Back *string `json:"ImageBase64Back,omitnil,omitempty" name:"ImageBase64Back"`

	// The URL value on the back of the certificate. Supported image formats: PNG, JPEG, GIF format is not supported yet. Supported image size: The downloaded image cannot exceed 5M after Base64 encoding. The image download takes no more than 3 seconds. Maximum supported image resolution: 8000*8000. One of ImageUrlFront and ImageBase64Front of the image must be provided. If both are provided, only ImageUrlFront will be used.
	ImageUrlFront *string `json:"ImageUrlFront,omitnil,omitempty" name:"ImageUrlFront"`

	// The URL value on the back of the certificate. Supported image formats: PNG, JPEG, GIF format is not supported yet. Supported image size: The downloaded image cannot exceed 5M after Base64 encoding. The image download takes no more than 3 seconds. Maximum supported image resolution: 8000*8000. For some certificates, one of ImageUrlBack and ImageBase64Back must be provided. If both are provided, only ImageUrlBack will be used.
	ImageUrlBack *string `json:"ImageUrlBack,omitnil,omitempty" name:"ImageUrlBack"`
}

func NewApplyCardVerificationRequest 

func NewApplyCardVerificationRequest() (request *ApplyCardVerificationRequest)

func (*ApplyCardVerificationRequest) FromJsonString 

func (r *ApplyCardVerificationRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ApplyCardVerificationRequest) ToJsonString 

func (r *ApplyCardVerificationRequest) ToJsonString() string

type ApplyCardVerificationRequestParams 

type ApplyCardVerificationRequestParams struct {
	// Please select the country code of ID document.
	// IDN: Indonesia
	// HKG: Hong Kong
	// THA: Thailand
	// MYS: Malaysia
	// SGP: Singapore
	// JPN: Japan
	// AUTO: Automatic Identification
	Nationality *string `json:"Nationality,omitnil,omitempty" name:"Nationality"`

	// Please select the type of ID document. The supported options are:
	// ID_CARD
	// PASSPORT
	// DRIVING_LICENSE
	// AUTO
	CardType *string `json:"CardType,omitnil,omitempty" name:"CardType"`

	// Base64 value for the front of the document. Supported image formats: PNG, JPEG, GIF format is not supported yet. Supported image size: The downloaded image cannot exceed 5M after Base64 encoding.
	// The image download takes no more than 3 seconds. Supported image resolution: 8000*8000. One of ImageUrlFront and ImageBase64 Front of the image must be provided. If both are provided, only ImageUrlFront will be used.
	ImageBase64Front *string `json:"ImageBase64Front,omitnil,omitempty" name:"ImageBase64Front"`

	// Base64 value of the reverse side of the document. Supported image formats: PNG, JPEG, GIF format is not supported yet. Supported image size: The downloaded image cannot exceed 5M after Base64 encoding. The image download takes no more than 3 seconds. Maximum supported image resolution: 8000*8000. For some certificates, one of ImageUrlBack and ImageBase64Back must be provided. If both are provided, only ImageUrlBack will be used.
	ImageBase64Back *string `json:"ImageBase64Back,omitnil,omitempty" name:"ImageBase64Back"`

	// The URL value on the back of the certificate. Supported image formats: PNG, JPEG, GIF format is not supported yet. Supported image size: The downloaded image cannot exceed 5M after Base64 encoding. The image download takes no more than 3 seconds. Maximum supported image resolution: 8000*8000. One of ImageUrlFront and ImageBase64Front of the image must be provided. If both are provided, only ImageUrlFront will be used.
	ImageUrlFront *string `json:"ImageUrlFront,omitnil,omitempty" name:"ImageUrlFront"`

	// The URL value on the back of the certificate. Supported image formats: PNG, JPEG, GIF format is not supported yet. Supported image size: The downloaded image cannot exceed 5M after Base64 encoding. The image download takes no more than 3 seconds. Maximum supported image resolution: 8000*8000. For some certificates, one of ImageUrlBack and ImageBase64Back must be provided. If both are provided, only ImageUrlBack will be used.
	ImageUrlBack *string `json:"ImageUrlBack,omitnil,omitempty" name:"ImageUrlBack"`
}

Predefined struct for user

type ApplyCardVerificationResponse 

type ApplyCardVerificationResponse struct {
	*tchttp.BaseResponse
	Response *ApplyCardVerificationResponseParams `json:"Response"`
}

func NewApplyCardVerificationResponse 

func NewApplyCardVerificationResponse() (response *ApplyCardVerificationResponse)

func (*ApplyCardVerificationResponse) FromJsonString 

func (r *ApplyCardVerificationResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ApplyCardVerificationResponse) ToJsonString 

func (r *ApplyCardVerificationResponse) ToJsonString() string

type ApplyCardVerificationResponseParams 

type ApplyCardVerificationResponseParams struct {
	// The token used to identify an verification process. It can be used to get the verification result after the process is completed.
	CardVerificationToken *string `json:"CardVerificationToken,omitnil,omitempty" name:"CardVerificationToken"`

	// The maximum number of polls for calling the pull result interface polling.
	AsyncCardVerificationMaxPollingTimes *uint64 `json:"AsyncCardVerificationMaxPollingTimes,omitnil,omitempty" name:"AsyncCardVerificationMaxPollingTimes"`

	// The interval for polling when calling the pull result interface (in seconds).
	AsyncCardVerificationPollingWaitTime *uint64 `json:"AsyncCardVerificationPollingWaitTime,omitnil,omitempty" name:"AsyncCardVerificationPollingWaitTime"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ApplyLivenessTokenRequest 

type ApplyLivenessTokenRequest struct {
	*tchttp.BaseRequest

	// Enumerated value. Valid values: `1`, `2`, `3`, and `4`.
	// Their meanings are as follows:
	// 1 - silent
	// 2 - blinking
	// 3 - light
	// 4 - blinking + light (default)
	SecureLevel *string `json:"SecureLevel,omitnil,omitempty" name:"SecureLevel"`
}

func NewApplyLivenessTokenRequest 

func NewApplyLivenessTokenRequest() (request *ApplyLivenessTokenRequest)

func (*ApplyLivenessTokenRequest) FromJsonString 

func (r *ApplyLivenessTokenRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ApplyLivenessTokenRequest) ToJsonString 

func (r *ApplyLivenessTokenRequest) ToJsonString() string

type ApplyLivenessTokenRequestParams 

type ApplyLivenessTokenRequestParams struct {
	// Enumerated value. Valid values: `1`, `2`, `3`, and `4`.
	// Their meanings are as follows:
	// 1 - silent
	// 2 - blinking
	// 3 - light
	// 4 - blinking + light (default)
	SecureLevel *string `json:"SecureLevel,omitnil,omitempty" name:"SecureLevel"`
}

Predefined struct for user

type ApplyLivenessTokenResponse 

type ApplyLivenessTokenResponse struct {
	*tchttp.BaseResponse
	Response *ApplyLivenessTokenResponseParams `json:"Response"`
}

func NewApplyLivenessTokenResponse 

func NewApplyLivenessTokenResponse() (response *ApplyLivenessTokenResponse)

func (*ApplyLivenessTokenResponse) FromJsonString 

func (r *ApplyLivenessTokenResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ApplyLivenessTokenResponse) ToJsonString 

func (r *ApplyLivenessTokenResponse) ToJsonString() string

type ApplyLivenessTokenResponseParams 

type ApplyLivenessTokenResponseParams struct {
	// The token used to identify an SDK-based verification process. It is valid for 10 minutes and can be used to get the verification result after the process is completed.
	SdkToken *string `json:"SdkToken,omitnil,omitempty" name:"SdkToken"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ApplySdkVerificationTokenRequest 

type ApplySdkVerificationTokenRequest struct {
	*tchttp.BaseRequest

	// The verification mode. Valid values:
	// 1: OCR + liveness detection + face comparison
	// 2: Liveness detection + face comparison
	// 3: Liveness detection
	// Default value: 1
	CheckMode *int64 `json:"CheckMode,omitnil,omitempty" name:"CheckMode"`

	// The security level of the verification. Valid values:
	// 1: Video-based liveness detection
	// 2: Motion-based liveness detection
	// 3: Reflection-based liveness detection
	// 4: Motion- and reflection-based liveness detection
	// Default value: 4
	SecurityLevel *int64 `json:"SecurityLevel,omitnil,omitempty" name:"SecurityLevel"`

	// The identity document type. Valid values:
	// 1. `HK` (default): Identity card of Hong Kong (China)
	// 2. `ML`: Malaysian identity card
	// 3. `IndonesiaIDCard`: Indonesian identity card
	// 4. `PhilippinesVoteID`: Philippine voters ID card
	// 5. `PhilippinesDrivingLicense`: Philippine driver's license
	// 6. `PhilippinesTinID`: Philippine TIN ID card
	// 7. `PhilippinesSSSID`: Philippine SSS ID card
	// 8. `PhilippinesUMID`: Philippine UMID card
	// 9. `MLIDPassport`: Passport issued in Hong Kong/Macao/Taiwan (China) or other countries/regions
	// 10..MacaoIDCard: Macao ID Card
	// 11.ThailandIDCard: Thailand ID Card
	// 12.MainlandIDCard: Mainland ID Card
	IdCardType *string `json:"IdCardType,omitnil,omitempty" name:"IdCardType"`

	// The Base64-encoded value of the photo to compare, which is required only when `CheckMode` is set to `2`.
	CompareImage *string `json:"CompareImage,omitnil,omitempty" name:"CompareImage"`

	// Whether ID card authentication is required. If not, only document OCR will be performed. Currently, authentication is available only when the value of `IdCardType` is `HK`.
	NeedVerifyIdCard *bool `json:"NeedVerifyIdCard,omitnil,omitempty" name:"NeedVerifyIdCard"`

	// Whether to forbid the modification of the OCR result by users. Default value: `false` (modification allowed). (Currently, this parameter is not applied.)
	DisableChangeOcrResult *bool `json:"DisableChangeOcrResult,omitnil,omitempty" name:"DisableChangeOcrResult"`

	// Whether to disable the OCR warnings. Default value: `false` (not disable), where OCR warnings are enabled and the OCR result will not be returned if there is a warning.
	// This feature applies only to Hong Kong (China) identity cards, Malaysian identity cards, and passports.
	DisableCheckOcrWarnings *bool `json:"DisableCheckOcrWarnings,omitnil,omitempty" name:"DisableCheckOcrWarnings"`

	// A passthrough field, which is returned together with the verification result and can contain up to 1,024 bits.
	Extra *string `json:"Extra,omitnil,omitempty" name:"Extra"`
}

func NewApplySdkVerificationTokenRequest 

func NewApplySdkVerificationTokenRequest() (request *ApplySdkVerificationTokenRequest)

func (*ApplySdkVerificationTokenRequest) FromJsonString 

func (r *ApplySdkVerificationTokenRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ApplySdkVerificationTokenRequest) ToJsonString 

func (r *ApplySdkVerificationTokenRequest) ToJsonString() string

type ApplySdkVerificationTokenRequestParams 

type ApplySdkVerificationTokenRequestParams struct {
	// The verification mode. Valid values:
	// 1: OCR + liveness detection + face comparison
	// 2: Liveness detection + face comparison
	// 3: Liveness detection
	// Default value: 1
	CheckMode *int64 `json:"CheckMode,omitnil,omitempty" name:"CheckMode"`

	// The security level of the verification. Valid values:
	// 1: Video-based liveness detection
	// 2: Motion-based liveness detection
	// 3: Reflection-based liveness detection
	// 4: Motion- and reflection-based liveness detection
	// Default value: 4
	SecurityLevel *int64 `json:"SecurityLevel,omitnil,omitempty" name:"SecurityLevel"`

	// The identity document type. Valid values:
	// 1. `HK` (default): Identity card of Hong Kong (China)
	// 2. `ML`: Malaysian identity card
	// 3. `IndonesiaIDCard`: Indonesian identity card
	// 4. `PhilippinesVoteID`: Philippine voters ID card
	// 5. `PhilippinesDrivingLicense`: Philippine driver's license
	// 6. `PhilippinesTinID`: Philippine TIN ID card
	// 7. `PhilippinesSSSID`: Philippine SSS ID card
	// 8. `PhilippinesUMID`: Philippine UMID card
	// 9. `MLIDPassport`: Passport issued in Hong Kong/Macao/Taiwan (China) or other countries/regions
	// 10..MacaoIDCard: Macao ID Card
	// 11.ThailandIDCard: Thailand ID Card
	// 12.MainlandIDCard: Mainland ID Card
	IdCardType *string `json:"IdCardType,omitnil,omitempty" name:"IdCardType"`

	// The Base64-encoded value of the photo to compare, which is required only when `CheckMode` is set to `2`.
	CompareImage *string `json:"CompareImage,omitnil,omitempty" name:"CompareImage"`

	// Whether ID card authentication is required. If not, only document OCR will be performed. Currently, authentication is available only when the value of `IdCardType` is `HK`.
	//
	// Deprecated: NeedVerifyIdCard is deprecated.
	NeedVerifyIdCard *bool `json:"NeedVerifyIdCard,omitnil,omitempty" name:"NeedVerifyIdCard"`

	// Whether to forbid the modification of the OCR result by users. Default value: `false` (modification allowed). (Currently, this parameter is not applied.)
	DisableChangeOcrResult *bool `json:"DisableChangeOcrResult,omitnil,omitempty" name:"DisableChangeOcrResult"`

	// Whether to disable the OCR warnings. Default value: `false` (not disable), where OCR warnings are enabled and the OCR result will not be returned if there is a warning.
	// This feature applies only to Hong Kong (China) identity cards, Malaysian identity cards, and passports.
	DisableCheckOcrWarnings *bool `json:"DisableCheckOcrWarnings,omitnil,omitempty" name:"DisableCheckOcrWarnings"`

	// A passthrough field, which is returned together with the verification result and can contain up to 1,024 bits.
	Extra *string `json:"Extra,omitnil,omitempty" name:"Extra"`
}

Predefined struct for user

type ApplySdkVerificationTokenResponse 

type ApplySdkVerificationTokenResponse struct {
	*tchttp.BaseResponse
	Response *ApplySdkVerificationTokenResponseParams `json:"Response"`
}

func NewApplySdkVerificationTokenResponse 

func NewApplySdkVerificationTokenResponse() (response *ApplySdkVerificationTokenResponse)

func (*ApplySdkVerificationTokenResponse) FromJsonString 

func (r *ApplySdkVerificationTokenResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ApplySdkVerificationTokenResponse) ToJsonString 

func (r *ApplySdkVerificationTokenResponse) ToJsonString() string

type ApplySdkVerificationTokenResponseParams 

type ApplySdkVerificationTokenResponseParams struct {
	// The token used to identify an SDK-based verification process. It is valid for 7,200s and can be used to get the verification result after the process is completed.
	SdkToken *string `json:"SdkToken,omitnil,omitempty" name:"SdkToken"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ApplyWebVerificationBizTokenIntlRequest 

type ApplyWebVerificationBizTokenIntlRequest struct {
	*tchttp.BaseRequest

	// The web callback URL to redirect to after the verification is completed, including the protocol, hostname, and path.
	// After the verification process is completed, the BizToken of this process will be spliced to the callback URL in the format of https://www.tencentcloud.com/products/faceid?token={BizToken} before redirect.
	// Example: https://www.tencentcloud.com/products/faceid.
	RedirectURL *string `json:"RedirectURL,omitnil,omitempty" name:"RedirectURL"`

	// The Base64-encoded string (max 8 MB in size) of the photo to be compared.The Data URI scheme header needs to be removed from the encoded string
	// Example: xhBQAAACBjSFJNAAB6****AAAASUVORK5CYII=
	CompareImageBase64 *string `json:"CompareImageBase64,omitnil,omitempty" name:"CompareImageBase64"`

	// The passthrough parameter of the business, max 1,000 characters, which will be returned in GetWebVerificationResultIntl.
	Extra *string `json:"Extra,omitnil,omitempty" name:"Extra"`

	// The parameter control the page configuration.
	// Example: {"AutoSkip": true,"CheckMode": 1,"IdCardType": "HKIDCard"}
	Config *WebVerificationConfigIntl `json:"Config,omitnil,omitempty" name:"Config"`
}

func NewApplyWebVerificationBizTokenIntlRequest 

func NewApplyWebVerificationBizTokenIntlRequest() (request *ApplyWebVerificationBizTokenIntlRequest)

func (*ApplyWebVerificationBizTokenIntlRequest) FromJsonString 

func (r *ApplyWebVerificationBizTokenIntlRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ApplyWebVerificationBizTokenIntlRequest) ToJsonString 

func (r *ApplyWebVerificationBizTokenIntlRequest) ToJsonString() string

type ApplyWebVerificationBizTokenIntlRequestParams 

type ApplyWebVerificationBizTokenIntlRequestParams struct {
	// The web callback URL to redirect to after the verification is completed, including the protocol, hostname, and path.
	// After the verification process is completed, the BizToken of this process will be spliced to the callback URL in the format of https://www.tencentcloud.com/products/faceid?token={BizToken} before redirect.
	// Example: https://www.tencentcloud.com/products/faceid.
	RedirectURL *string `json:"RedirectURL,omitnil,omitempty" name:"RedirectURL"`

	// The Base64-encoded string (max 8 MB in size) of the photo to be compared.The Data URI scheme header needs to be removed from the encoded string
	// Example: xhBQAAACBjSFJNAAB6****AAAASUVORK5CYII=
	CompareImageBase64 *string `json:"CompareImageBase64,omitnil,omitempty" name:"CompareImageBase64"`

	// The passthrough parameter of the business, max 1,000 characters, which will be returned in GetWebVerificationResultIntl.
	Extra *string `json:"Extra,omitnil,omitempty" name:"Extra"`

	// The parameter control the page configuration.
	// Example: {"AutoSkip": true,"CheckMode": 1,"IdCardType": "HKIDCard"}
	Config *WebVerificationConfigIntl `json:"Config,omitnil,omitempty" name:"Config"`
}

Predefined struct for user

type ApplyWebVerificationBizTokenIntlResponse 

type ApplyWebVerificationBizTokenIntlResponse struct {
	*tchttp.BaseResponse
	Response *ApplyWebVerificationBizTokenIntlResponseParams `json:"Response"`
}

func NewApplyWebVerificationBizTokenIntlResponse 

func NewApplyWebVerificationBizTokenIntlResponse() (response *ApplyWebVerificationBizTokenIntlResponse)

func (*ApplyWebVerificationBizTokenIntlResponse) FromJsonString 

func (r *ApplyWebVerificationBizTokenIntlResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ApplyWebVerificationBizTokenIntlResponse) ToJsonString 

func (r *ApplyWebVerificationBizTokenIntlResponse) ToJsonString() string

type ApplyWebVerificationBizTokenIntlResponseParams 

type ApplyWebVerificationBizTokenIntlResponseParams struct {
	// The token identifying this web-based verification process, valid for 7,200s after issuance. It is required for getting the result after the verification process is completed.
	// Example: https://intl.faceid.qq.com/reflect/?token=81EEF678-28EE-4759-A82E-6CBBBE6BC442
	//
	// Deprecated: VerificationUrl is deprecated.
	VerificationUrl *string `json:"VerificationUrl,omitnil,omitempty" name:"VerificationUrl"`

	// The token for the web-based verification, which is generated using the ApplyWebVerificationBizTokenIntl API.
	// Example: 81EEF678-28EE-4759-A82E-6CBBBE6BC442
	BizToken *string `json:"BizToken,omitnil,omitempty" name:"BizToken"`

	// The verification URL to be opened with a browser to start the verification process.
	// Example: https://intl.faceid.qq.com/reflect/?token=81EEF678-28EE-4759-A82E-6CBBBE6BC442
	VerificationURL *string `json:"VerificationURL,omitnil,omitempty" name:"VerificationURL"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ApplyWebVerificationTokenRequest 

type ApplyWebVerificationTokenRequest struct {
	*tchttp.BaseRequest

	// The web redirect URL after the verification is completed.
	RedirectUrl *string `json:"RedirectUrl,omitnil,omitempty" name:"RedirectUrl"`

	// The COS URL of the image for face comparison, which can be obtained with one of the following methods:
	// 1. Call the `CreateUploadUrl` API to generate a URL and call it again after the image is successfully uploaded.
	// 2. Use an existing COS URL. For a private bucket, grant the download permission with a pre-signed URL. The corresponding COS bucket must be in the same region as the input parameter `Region`.
	CompareImageUrl *string `json:"CompareImageUrl,omitnil,omitempty" name:"CompareImageUrl"`

	// The MD5 hash values of the image for face comparison (CompareImageUrl).
	CompareImageMd5 *string `json:"CompareImageMd5,omitnil,omitempty" name:"CompareImageMd5"`
}

func NewApplyWebVerificationTokenRequest 

func NewApplyWebVerificationTokenRequest() (request *ApplyWebVerificationTokenRequest)

func (*ApplyWebVerificationTokenRequest) FromJsonString 

func (r *ApplyWebVerificationTokenRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ApplyWebVerificationTokenRequest) ToJsonString 

func (r *ApplyWebVerificationTokenRequest) ToJsonString() string

type ApplyWebVerificationTokenRequestParams 

type ApplyWebVerificationTokenRequestParams struct {
	// The web redirect URL after the verification is completed.
	RedirectUrl *string `json:"RedirectUrl,omitnil,omitempty" name:"RedirectUrl"`

	// The COS URL of the image for face comparison, which can be obtained with one of the following methods:
	// 1. Call the `CreateUploadUrl` API to generate a URL and call it again after the image is successfully uploaded.
	// 2. Use an existing COS URL. For a private bucket, grant the download permission with a pre-signed URL. The corresponding COS bucket must be in the same region as the input parameter `Region`.
	CompareImageUrl *string `json:"CompareImageUrl,omitnil,omitempty" name:"CompareImageUrl"`

	// The MD5 hash values of the image for face comparison (CompareImageUrl).
	CompareImageMd5 *string `json:"CompareImageMd5,omitnil,omitempty" name:"CompareImageMd5"`
}

Predefined struct for user

type ApplyWebVerificationTokenResponse 

type ApplyWebVerificationTokenResponse struct {
	*tchttp.BaseResponse
	Response *ApplyWebVerificationTokenResponseParams `json:"Response"`
}

func NewApplyWebVerificationTokenResponse 

func NewApplyWebVerificationTokenResponse() (response *ApplyWebVerificationTokenResponse)

func (*ApplyWebVerificationTokenResponse) FromJsonString 

func (r *ApplyWebVerificationTokenResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ApplyWebVerificationTokenResponse) ToJsonString 

func (r *ApplyWebVerificationTokenResponse) ToJsonString() string

type ApplyWebVerificationTokenResponseParams 

type ApplyWebVerificationTokenResponseParams struct {
	// The verification URL to be opened with a browser to start the verification process.
	VerificationUrl *string `json:"VerificationUrl,omitnil,omitempty" name:"VerificationUrl"`

	// The token used to identify a web-based verification process. It is valid for 7,200s and can be used to get the verification result after the process is completed.
	BizToken *string `json:"BizToken,omitnil,omitempty" name:"BizToken"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CardInfo 

type CardInfo struct {
	// Hong Kong ID Card
	// Note: This field may return null, indicating that no valid values can be obtained.
	HKIDCard *HKIDCard `json:"HKIDCard,omitnil,omitempty" name:"HKIDCard"`

	// Malaysia ID Card
	// Note: This field may return null, indicating that no valid values can be obtained.
	MLIDCard *MLIDCard `json:"MLIDCard,omitnil,omitempty" name:"MLIDCard"`

	// Philippines VoteID Card
	// Note: This field may return null, indicating that no valid values can be obtained.
	PhilippinesVoteID *PhilippinesVoteID `json:"PhilippinesVoteID,omitnil,omitempty" name:"PhilippinesVoteID"`

	// Indonesia ID Card
	// Note: This field may return null, indicating that no valid values can be obtained.
	IndonesiaIDCard *IndonesiaIDCard `json:"IndonesiaIDCard,omitnil,omitempty" name:"IndonesiaIDCard"`

	// Philippines Driving License
	// Note: This field may return null, indicating that no valid values can be obtained.
	PhilippinesDrivingLicense *PhilippinesDrivingLicense `json:"PhilippinesDrivingLicense,omitnil,omitempty" name:"PhilippinesDrivingLicense"`

	// Philippines TinID
	// Note: This field may return null, indicating that no valid values can be obtained.
	PhilippinesTinID *PhilippinesTinID `json:"PhilippinesTinID,omitnil,omitempty" name:"PhilippinesTinID"`

	// Philippines SSSID
	// Note: This field may return null, indicating that no valid values can be obtained.
	PhilippinesSSSID *PhilippinesSSSID `json:"PhilippinesSSSID,omitnil,omitempty" name:"PhilippinesSSSID"`

	// Philippines UMID
	// Note: This field may return null, indicating that no valid values can be obtained.
	PhilippinesUMID *PhilippinesUMID `json:"PhilippinesUMID,omitnil,omitempty" name:"PhilippinesUMID"`

	// ID Cards of Hong Kong, Macao and Taiwan (China), and International Passport
	// Note: This field may return null, indicating that no valid values can be obtained.
	InternationalIDPassport *InternationalIDPassport `json:"InternationalIDPassport,omitnil,omitempty" name:"InternationalIDPassport"`

	// General license information
	// Note: This field may return null, indicating that no valid values can be obtained.
	GeneralCard *GeneralCard `json:"GeneralCard,omitnil,omitempty" name:"GeneralCard"`

	// Indonesia Driving License
	// Note: This field may return null, indicating that no valid values can be obtained.
	IndonesiaDrivingLicense *IndonesiaDrivingLicense `json:"IndonesiaDrivingLicense,omitnil,omitempty" name:"IndonesiaDrivingLicense"`

	// Thailand ID Card
	// Note: This field may return null, indicating that no valid values can be obtained.
	ThailandIDCard *ThailandIDCard `json:"ThailandIDCard,omitnil,omitempty" name:"ThailandIDCard"`

	// Singapore ID Card
	// Note: This field may return null, indicating that no valid values can be obtained.
	SingaporeIDCard *SingaporeIDCard `json:"SingaporeIDCard,omitnil,omitempty" name:"SingaporeIDCard"`

	// Macao ID Card
	// Note: This field may return null, indicating that no valid values can be obtained.
	MacaoIDCard *MacaoIDCard `json:"MacaoIDCard,omitnil,omitempty" name:"MacaoIDCard"`
}

type CardVerifyResult 

type CardVerifyResult struct {
	// Whether the authentication or OCR process is successful.
	IsPass *bool `json:"IsPass,omitnil,omitempty" name:"IsPass"`

	// Whether the user modified the card recognition result
	IsEdit *bool `json:"IsEdit,omitnil,omitempty" name:"IsEdit"`

	// The download URL of the video used for identity document verification, which is valid for 10 minutes. This parameter is returned only if video-based identity document verification is enabled.
	// Note: This field may return null, indicating that no valid value can be obtained.
	CardVideo *FileInfo `json:"CardVideo,omitnil,omitempty" name:"CardVideo"`

	// The download URL of the identity document image, which is valid for 10 minutes.
	// Note: This field may return null, indicating that no valid value can be obtained.
	CardImage *FileInfo `json:"CardImage,omitnil,omitempty" name:"CardImage"`

	// The OCR result (in JSON) of the identity document image. If verification or OCR fails, this parameter is left empty. The URL is valid for 10 minutes.
	// (1) Hong Kong (China) identity card
	// When the value of `IdCardType` is `HK`:
	// - CnName (string): Name in Chinese.
	// - EnName (string): Name in English.
	// - TelexCode (string): The code corresponding to the name in Chinese.
	// - Sex (string): Gender. Valid values: `M` (male) and `F` (female).
	// - Birthday (string): Date of birth.
	// - Permanent (int): Whether it is a permanent residence identity card. Valid values: `0` (non-permanent), `1` (permanent), and `-1` (unknown).
	// - IdNum (string): Identity card number.
	// - Symbol (string): The ID symbol below the date of birth, such as "***AZ".
	// - FirstIssueDate (string): Month and year of first registration.
	// - CurrentIssueDate (string): The date of latest issuance.
	//
	// (2) Malaysian identity card
	// When the value of `IdCardType` is `ML`:
	// - Sex (string): Gender. Valid values: `LELAKI` (male) and `PEREMPUAN` (female).
	// - Birthday (string): Date of birth.
	// - ID (string): Identity card number.
	// - Name (string): Name.
	// - Address (string): Address.
	// - Type (string): Identity document type.
	//
	// (3) Philippine identity document
	// When the value of `IdCardType` is `PhilippinesVoteID`:
	// - Birthday (string): Date of birth.
	// - Address (string): Address.
	// - LastName (string): Last name.
	// - FirstName (string): First name.
	// - VIN (string): Voter's identification number (VIN).
	// - CivilStatus (string): Civil status.
	// - Citizenship (string): Citizenship.
	// - PrecinctNo (string): Precinct.
	//
	// When the value of `IdCardType` is `PhilippinesDrivingLicense`:
	// - Sex (string): Gender.
	// - Birthday (string): Date of birth.
	// - Name (string): Name.
	// - Address (string): Address.
	// - LastName (string): Last name.
	// - FirstName (string): First name.
	// - MiddleName (string): Middle name.
	// - Nationality (string): Nationality.
	// - LicenseNo (string): License number.
	// - ExpiresDate (string): Expiration date.
	// - AgencyCode (string): Agency code.
	//
	// When the value of `IdCardType` is `PhilippinesTinID`:
	// - LicenseNumber (string): Tax identification number (TIN).
	// - FullName (string): Full name.
	// - Address (string): Address.
	// - Birthday (string): Date of birth.
	// - IssueDate (string): Issue date.
	//
	// When the value of `IdCardType` is `PhilippinesSSSID`:
	// - LicenseNumber (string): Common reference number (CRN).
	// - FullName (string): Full name.
	// - Birthday (string): Date of birth.
	//
	// When the value of `IdCardType` is `PhilippinesUMID`:
	// - Surname (string): Surname.
	// - MiddleName (string):Middle name.
	// - GivenName (string): Given name.
	// - Sex (string): Gender.
	// - Birthday (string): Date of birth.
	// - Address (string): Address.
	// - CRN (string): Common reference number (CRN).
	//
	// (4) Indonesian identity card
	// When the value of `IdCardType` is `IndonesiaIDCard`:
	// - NIK (string): Single Identity Number.
	// - Nama (string): Full name.
	// - TempatTglLahir (string): Place and date of birth.
	// - JenisKelamin (string): Gender.
	// - GolDarah (string): Blood type.
	// - Alamat (string): Address.
	// - RTRW (string): Street.
	// - KelDesa (string): Village.
	// - Kecamatan (string): Region.
	// - Agama (string): Religion.
	// - StatusPerkawinan (string): Marital status.
	// - Perkerjaan (string): Occupation.
	// - KewargaNegaraan (string): Nationality.
	// - BerlakuHingga (string): Expiry date.
	// - IssuedDate (string): Issue date.
	//
	// (5) A passport issued in Hong Kong/Macao/Taiwan (China) or other countries/regions
	// When the value of `IdCardType` is `MLIDPassport`:
	// - FullName (string): Full name.
	// - Surname (string): Surname.
	// - GivenName (string): Given name.
	// - Birthday (string): Date of birth.
	// - Sex (string): Gender. Valid values: `F` (female) and `M` (male).
	// - DateOfExpiration (string): Expiration date.
	// - IssuingCountry (string): Issuing country.
	// - NationalityCode (string): Country/region code.
	// Note: This field may return null, indicating that no valid values can be obtained.
	CardInfoOcrJson *FileInfo `json:"CardInfoOcrJson,omitnil,omitempty" name:"CardInfoOcrJson"`

	// The request ID of a single process.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`

	// The recognition results of ID card
	//
	// Deprecated: CardInfo is deprecated.
	CardInfo *CardInfo `json:"CardInfo,omitnil,omitempty" name:"CardInfo"`

	// License OCR result
	NormalCardInfo *NormalCardInfo `json:"NormalCardInfo,omitnil,omitempty" name:"NormalCardInfo"`

	// Card warning information
	// -9101 Alarm for covered certificate,
	// -9102 Alarm for photocopied certificate,
	// -9103 Alarm for photographed certificate,
	// -9107 Alarm for reflective certificate,
	// -9108 Alarm for blurry image,
	// -9109 This capability is not enabled.
	WarnCardInfos []*int64 `json:"WarnCardInfos,omitnil,omitempty" name:"WarnCardInfos"`
}

type Client 

type Client struct {
	common.Client
}

func NewClient 

func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)

func NewClientWithSecretId 

func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)

Deprecated

func (*Client) ApplyCardVerification 

func (c *Client) ApplyCardVerification(request *ApplyCardVerificationRequest) (response *ApplyCardVerificationResponse, err error)

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

<table> <thead> <tr> <td>Nationality</td> <td style="width:200px">CardType</td> <td style="width:200px">Back side required</td> </tr> </thead> <tbody> <tr> <td>Indonesia</td> <td>ID card</td> <td>No</td> </tr> <tr> <td>Indonesia</td> <td>Drving license</td> <td>No</td> </tr> <tr> <td>Hongkong</td> <td>ID card</td> <td>Yes</td> </tr> <tr> <td>Thailand</td> <td>ID card</td> <td>No</td> </tr> <tr> <td>Thailand</td> <td>Drving license</td> <td>Yes</td> </tr> <tr> <td>Malaysia</td> <td>ID card</td> <td>Yes</td> </tr> <tr> <td>Malaysia</td> <td>Drving license</td> <td>Yes</td> </tr> <tr> <td>Singapore</td> <td>ID card</td> <td>Yes</td> </tr> <tr> <td>Singapore</td> <td>Drving license</td> <td>Yes</td> </tr> <tr> <td>Philippine</td> <td>ID card</td> <td>Yes</td> </tr> <tr> <td>Philippine</td> <td>Drving license</td> <td>No</td> </tr> <tr> <td>Japan</td> <td>ID card</td> <td>Yes</td> </tr> <tr> <td>Japan</td> <td>Drving license</td> <td>No</td> </tr> </tbody> </table>

error code that may be returned: 

FAILEDOPERATION_IMAGESIZETOOLARGE = "FailedOperation.ImageSizeTooLarge"
FAILEDOPERATION_UNKNOWERROR = "FailedOperation.UnKnowError"
FAILEDOPERATION_UNOPENERROR = "FailedOperation.UnOpenError"
INVALIDPARAMETER_ENGINEIMAGEDECODEFAILED = "InvalidParameter.EngineImageDecodeFailed"
INVALIDPARAMETERVALUE_INVALIDFILECONTENTSIZE = "InvalidParameterValue.InvalidFileContentSize"
INVALIDPARAMETERVALUE_INVALIDPARAMETERVALUELIMIT = "InvalidParameterValue.InvalidParameterValueLimit"
RESOURCEUNAVAILABLE_IMAGEDOWNLOADERROR = "ResourceUnavailable.ImageDownloadError"
RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears"
RESOURCEUNAVAILABLE_RESOURCEPACKAGERUNOUT = "ResourceUnavailable.ResourcePackageRunOut"

func (*Client) ApplyCardVerificationWithContext 

func (c *Client) ApplyCardVerificationWithContext(ctx context.Context, request *ApplyCardVerificationRequest) (response *ApplyCardVerificationResponse, err error)

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

<table> <thead> <tr> <td>Nationality</td> <td style="width:200px">CardType</td> <td style="width:200px">Back side required</td> </tr> </thead> <tbody> <tr> <td>Indonesia</td> <td>ID card</td> <td>No</td> </tr> <tr> <td>Indonesia</td> <td>Drving license</td> <td>No</td> </tr> <tr> <td>Hongkong</td> <td>ID card</td> <td>Yes</td> </tr> <tr> <td>Thailand</td> <td>ID card</td> <td>No</td> </tr> <tr> <td>Thailand</td> <td>Drving license</td> <td>Yes</td> </tr> <tr> <td>Malaysia</td> <td>ID card</td> <td>Yes</td> </tr> <tr> <td>Malaysia</td> <td>Drving license</td> <td>Yes</td> </tr> <tr> <td>Singapore</td> <td>ID card</td> <td>Yes</td> </tr> <tr> <td>Singapore</td> <td>Drving license</td> <td>Yes</td> </tr> <tr> <td>Philippine</td> <td>ID card</td> <td>Yes</td> </tr> <tr> <td>Philippine</td> <td>Drving license</td> <td>No</td> </tr> <tr> <td>Japan</td> <td>ID card</td> <td>Yes</td> </tr> <tr> <td>Japan</td> <td>Drving license</td> <td>No</td> </tr> </tbody> </table>

error code that may be returned: 

FAILEDOPERATION_IMAGESIZETOOLARGE = "FailedOperation.ImageSizeTooLarge"
FAILEDOPERATION_UNKNOWERROR = "FailedOperation.UnKnowError"
FAILEDOPERATION_UNOPENERROR = "FailedOperation.UnOpenError"
INVALIDPARAMETER_ENGINEIMAGEDECODEFAILED = "InvalidParameter.EngineImageDecodeFailed"
INVALIDPARAMETERVALUE_INVALIDFILECONTENTSIZE = "InvalidParameterValue.InvalidFileContentSize"
INVALIDPARAMETERVALUE_INVALIDPARAMETERVALUELIMIT = "InvalidParameterValue.InvalidParameterValueLimit"
RESOURCEUNAVAILABLE_IMAGEDOWNLOADERROR = "ResourceUnavailable.ImageDownloadError"
RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears"
RESOURCEUNAVAILABLE_RESOURCEPACKAGERUNOUT = "ResourceUnavailable.ResourcePackageRunOut"

func (*Client) ApplyLivenessToken 

func (c *Client) ApplyLivenessToken(request *ApplyLivenessTokenRequest) (response *ApplyLivenessTokenResponse, err error)

ApplyLivenessToken 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.

error code that may be returned: 

INTERNALERROR = "InternalError"
INTERNALERROR_UNKNOWN = "InternalError.UnKnown"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"

func (*Client) ApplyLivenessTokenWithContext 

func (c *Client) ApplyLivenessTokenWithContext(ctx context.Context, request *ApplyLivenessTokenRequest) (response *ApplyLivenessTokenResponse, err error)

ApplyLivenessToken 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.

error code that may be returned: 

INTERNALERROR = "InternalError"
INTERNALERROR_UNKNOWN = "InternalError.UnKnown"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"

func (*Client) ApplySdkVerificationToken 

func (c *Client) ApplySdkVerificationToken(request *ApplySdkVerificationTokenRequest) (response *ApplySdkVerificationTokenResponse, err error)

ApplySdkVerificationToken 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.

error code that may be returned: 

INTERNALERROR = "InternalError"
INTERNALERROR_UNKNOWN = "InternalError.UnKnown"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"

func (*Client) ApplySdkVerificationTokenWithContext 

func (c *Client) ApplySdkVerificationTokenWithContext(ctx context.Context, request *ApplySdkVerificationTokenRequest) (response *ApplySdkVerificationTokenResponse, err error)

ApplySdkVerificationToken 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.

error code that may be returned: 

INTERNALERROR = "InternalError"
INTERNALERROR_UNKNOWN = "InternalError.UnKnown"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"

func (*Client) ApplyWebVerificationBizTokenIntl 

func (c *Client) ApplyWebVerificationBizTokenIntl(request *ApplyWebVerificationBizTokenIntlRequest) (response *ApplyWebVerificationBizTokenIntlResponse, err error)

ApplyWebVerificationBizTokenIntl 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.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
UNAUTHORIZEDOPERATION_ACTIVATEERROR = "UnauthorizedOperation.ActivateError"
UNAUTHORIZEDOPERATION_ACTIVATING = "UnauthorizedOperation.Activating"
UNAUTHORIZEDOPERATION_ARREARS = "UnauthorizedOperation.Arrears"
UNAUTHORIZEDOPERATION_NONACTIVATED = "UnauthorizedOperation.Nonactivated"

func (*Client) ApplyWebVerificationBizTokenIntlWithContext 

func (c *Client) ApplyWebVerificationBizTokenIntlWithContext(ctx context.Context, request *ApplyWebVerificationBizTokenIntlRequest) (response *ApplyWebVerificationBizTokenIntlResponse, err error)

ApplyWebVerificationBizTokenIntl 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.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
UNAUTHORIZEDOPERATION_ACTIVATEERROR = "UnauthorizedOperation.ActivateError"
UNAUTHORIZEDOPERATION_ACTIVATING = "UnauthorizedOperation.Activating"
UNAUTHORIZEDOPERATION_ARREARS = "UnauthorizedOperation.Arrears"
UNAUTHORIZEDOPERATION_NONACTIVATED = "UnauthorizedOperation.Nonactivated"

func (*Client) ApplyWebVerificationToken 

func (c *Client) ApplyWebVerificationToken(request *ApplyWebVerificationTokenRequest) (response *ApplyWebVerificationTokenResponse, err error)

ApplyWebVerificationToken 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.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
UNAUTHORIZEDOPERATION_ACTIVATEERROR = "UnauthorizedOperation.ActivateError"
UNAUTHORIZEDOPERATION_ACTIVATING = "UnauthorizedOperation.Activating"
UNAUTHORIZEDOPERATION_ARREARS = "UnauthorizedOperation.Arrears"
UNAUTHORIZEDOPERATION_NONACTIVATED = "UnauthorizedOperation.Nonactivated"

func (*Client) ApplyWebVerificationTokenWithContext 

func (c *Client) ApplyWebVerificationTokenWithContext(ctx context.Context, request *ApplyWebVerificationTokenRequest) (response *ApplyWebVerificationTokenResponse, err error)

ApplyWebVerificationToken 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.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
UNAUTHORIZEDOPERATION_ACTIVATEERROR = "UnauthorizedOperation.ActivateError"
UNAUTHORIZEDOPERATION_ACTIVATING = "UnauthorizedOperation.Activating"
UNAUTHORIZEDOPERATION_ARREARS = "UnauthorizedOperation.Arrears"
UNAUTHORIZEDOPERATION_NONACTIVATED = "UnauthorizedOperation.Nonactivated"

func (*Client) CompareFaceLiveness 

func (c *Client) CompareFaceLiveness(request *CompareFaceLivenessRequest) (response *CompareFaceLivenessResponse, err error)

CompareFaceLiveness 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.

error code that may be returned: 

FAILEDOPERATION_UNKNOWN = "FailedOperation.UnKnown"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
UNAUTHORIZEDOPERATION_ACTIVATING = "UnauthorizedOperation.Activating"
UNAUTHORIZEDOPERATION_ARREARS = "UnauthorizedOperation.Arrears"
UNAUTHORIZEDOPERATION_NONAUTHORIZE = "UnauthorizedOperation.NonAuthorize"
UNAUTHORIZEDOPERATION_NONACTIVATED = "UnauthorizedOperation.Nonactivated"

func (*Client) CompareFaceLivenessWithContext 

func (c *Client) CompareFaceLivenessWithContext(ctx context.Context, request *CompareFaceLivenessRequest) (response *CompareFaceLivenessResponse, err error)

CompareFaceLiveness 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.

error code that may be returned: 

FAILEDOPERATION_UNKNOWN = "FailedOperation.UnKnown"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
UNAUTHORIZEDOPERATION_ACTIVATING = "UnauthorizedOperation.Activating"
UNAUTHORIZEDOPERATION_ARREARS = "UnauthorizedOperation.Arrears"
UNAUTHORIZEDOPERATION_NONAUTHORIZE = "UnauthorizedOperation.NonAuthorize"
UNAUTHORIZEDOPERATION_NONACTIVATED = "UnauthorizedOperation.Nonactivated"

func (*Client) CreateUploadUrl 

func (c *Client) CreateUploadUrl(request *CreateUploadUrlRequest) (response *CreateUploadUrlResponse, err error)

CreateUploadUrl 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.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"

func (*Client) CreateUploadUrlWithContext 

func (c *Client) CreateUploadUrlWithContext(ctx context.Context, request *CreateUploadUrlRequest) (response *CreateUploadUrlResponse, err error)

CreateUploadUrl 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.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"

func (*Client) DetectReflectLivenessAndCompare 

func (c *Client) DetectReflectLivenessAndCompare(request *DetectReflectLivenessAndCompareRequest) (response *DetectReflectLivenessAndCompareResponse, err error)

DetectReflectLivenessAndCompare 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.

error code that may be returned: 

FAILEDOPERATION_ACTIONLIGHTDARK = "FailedOperation.ActionLightDark"
FAILEDOPERATION_ACTIONLIGHTSTRONG = "FailedOperation.ActionLightStrong"
FAILEDOPERATION_DOWNLOADERROR = "FailedOperation.DownLoadError"
FAILEDOPERATION_DOWNLOADTIMEOUTERROR = "FailedOperation.DownLoadTimeoutError"
FAILEDOPERATION_IMAGEBLUR = "FailedOperation.ImageBlur"
FAILEDOPERATION_IMAGEDECODEFAILED = "FailedOperation.ImageDecodeFailed"
FAILEDOPERATION_IMAGESIZETOOLARGE = "FailedOperation.ImageSizeTooLarge"
FAILEDOPERATION_LIFEPHOTODETECTFAKE = "FailedOperation.LifePhotoDetectFake"
FAILEDOPERATION_LIFEPHOTOSIZEERROR = "FailedOperation.LifePhotoSizeError"
FAILEDOPERATION_LIVESSDETECTFAIL = "FailedOperation.LivessDetectFail"
FAILEDOPERATION_LIVESSDETECTFAKE = "FailedOperation.LivessDetectFake"
FAILEDOPERATION_LIVESSSYSTEMERROR = "FailedOperation.LivessSystemError"
FAILEDOPERATION_LIVESSUNKNOWNERROR = "FailedOperation.LivessUnknownError"
FAILEDOPERATION_SILENTDETECTFAIL = "FailedOperation.SilentDetectFail"
FAILEDOPERATION_SILENTFACEDETECTFAIL = "FailedOperation.SilentFaceDetectFail"
FAILEDOPERATION_SILENTFACEQUALITYFAIL = "FailedOperation.SilentFaceQualityFail"
FAILEDOPERATION_SILENTMULTIFACEFAIL = "FailedOperation.SilentMultiFaceFail"
FAILEDOPERATION_SILENTPICTURELIVEFAIL = "FailedOperation.SilentPictureLiveFail"
FAILEDOPERATION_SILENTTHRESHOLD = "FailedOperation.SilentThreshold"
INTERNALERROR_ACTIONLIGHTDARK = "InternalError.ActionLightDark"
INTERNALERROR_ACTIONLIGHTSTRONG = "InternalError.ActionLightStrong"
INTERNALERROR_ACTIONNODETECTFACE = "InternalError.ActionNodetectFace"
INTERNALERROR_COMPARELOWSIMILARITY = "InternalError.CompareLowSimilarity"
INTERNALERROR_LIFEPHOTOPOORQUALITY = "InternalError.LifePhotoPoorQuality"
INTERNALERROR_LIFEPHOTOSIZEERROR = "InternalError.LifePhotoSizeError"

func (*Client) DetectReflectLivenessAndCompareWithContext 

func (c *Client) DetectReflectLivenessAndCompareWithContext(ctx context.Context, request *DetectReflectLivenessAndCompareRequest) (response *DetectReflectLivenessAndCompareResponse, err error)

DetectReflectLivenessAndCompare 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.

error code that may be returned: 

FAILEDOPERATION_ACTIONLIGHTDARK = "FailedOperation.ActionLightDark"
FAILEDOPERATION_ACTIONLIGHTSTRONG = "FailedOperation.ActionLightStrong"
FAILEDOPERATION_DOWNLOADERROR = "FailedOperation.DownLoadError"
FAILEDOPERATION_DOWNLOADTIMEOUTERROR = "FailedOperation.DownLoadTimeoutError"
FAILEDOPERATION_IMAGEBLUR = "FailedOperation.ImageBlur"
FAILEDOPERATION_IMAGEDECODEFAILED = "FailedOperation.ImageDecodeFailed"
FAILEDOPERATION_IMAGESIZETOOLARGE = "FailedOperation.ImageSizeTooLarge"
FAILEDOPERATION_LIFEPHOTODETECTFAKE = "FailedOperation.LifePhotoDetectFake"
FAILEDOPERATION_LIFEPHOTOSIZEERROR = "FailedOperation.LifePhotoSizeError"
FAILEDOPERATION_LIVESSDETECTFAIL = "FailedOperation.LivessDetectFail"
FAILEDOPERATION_LIVESSDETECTFAKE = "FailedOperation.LivessDetectFake"
FAILEDOPERATION_LIVESSSYSTEMERROR = "FailedOperation.LivessSystemError"
FAILEDOPERATION_LIVESSUNKNOWNERROR = "FailedOperation.LivessUnknownError"
FAILEDOPERATION_SILENTDETECTFAIL = "FailedOperation.SilentDetectFail"
FAILEDOPERATION_SILENTFACEDETECTFAIL = "FailedOperation.SilentFaceDetectFail"
FAILEDOPERATION_SILENTFACEQUALITYFAIL = "FailedOperation.SilentFaceQualityFail"
FAILEDOPERATION_SILENTMULTIFACEFAIL = "FailedOperation.SilentMultiFaceFail"
FAILEDOPERATION_SILENTPICTURELIVEFAIL = "FailedOperation.SilentPictureLiveFail"
FAILEDOPERATION_SILENTTHRESHOLD = "FailedOperation.SilentThreshold"
INTERNALERROR_ACTIONLIGHTDARK = "InternalError.ActionLightDark"
INTERNALERROR_ACTIONLIGHTSTRONG = "InternalError.ActionLightStrong"
INTERNALERROR_ACTIONNODETECTFACE = "InternalError.ActionNodetectFace"
INTERNALERROR_COMPARELOWSIMILARITY = "InternalError.CompareLowSimilarity"
INTERNALERROR_LIFEPHOTOPOORQUALITY = "InternalError.LifePhotoPoorQuality"
INTERNALERROR_LIFEPHOTOSIZEERROR = "InternalError.LifePhotoSizeError"

func (*Client) GenerateReflectSequence 

func (c *Client) GenerateReflectSequence(request *GenerateReflectSequenceRequest) (response *GenerateReflectSequenceResponse, err error)

GenerateReflectSequence 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.

error code that may be returned: 

FAILEDOPERATION_DOWNLOADERROR = "FailedOperation.DownLoadError"
FAILEDOPERATION_DOWNLOADTIMEOUTERROR = "FailedOperation.DownLoadTimeoutError"

func (*Client) GenerateReflectSequenceWithContext 

func (c *Client) GenerateReflectSequenceWithContext(ctx context.Context, request *GenerateReflectSequenceRequest) (response *GenerateReflectSequenceResponse, err error)

GenerateReflectSequence 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.

error code that may be returned: 

FAILEDOPERATION_DOWNLOADERROR = "FailedOperation.DownLoadError"
FAILEDOPERATION_DOWNLOADTIMEOUTERROR = "FailedOperation.DownLoadTimeoutError"

func (*Client) GetCardVerificationResult 

func (c *Client) GetCardVerificationResult(request *GetCardVerificationResultRequest) (response *GetCardVerificationResultResponse, err error)

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

error code that may be returned: 

FAILEDOPERATION_UNKNOWERROR = "FailedOperation.UnKnowError"
FAILEDOPERATION_UNOPENERROR = "FailedOperation.UnOpenError"
INVALIDPARAMETERVALUE_INVALIDPARAMETERVALUELIMIT = "InvalidParameterValue.InvalidParameterValueLimit"
RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears"
RESOURCEUNAVAILABLE_RESOURCEPACKAGERUNOUT = "ResourceUnavailable.ResourcePackageRunOut"

func (*Client) GetCardVerificationResultWithContext 

func (c *Client) GetCardVerificationResultWithContext(ctx context.Context, request *GetCardVerificationResultRequest) (response *GetCardVerificationResultResponse, err error)

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

error code that may be returned: 

FAILEDOPERATION_UNKNOWERROR = "FailedOperation.UnKnowError"
FAILEDOPERATION_UNOPENERROR = "FailedOperation.UnOpenError"
INVALIDPARAMETERVALUE_INVALIDPARAMETERVALUELIMIT = "InvalidParameterValue.InvalidParameterValueLimit"
RESOURCEUNAVAILABLE_INARREARS = "ResourceUnavailable.InArrears"
RESOURCEUNAVAILABLE_RESOURCEPACKAGERUNOUT = "ResourceUnavailable.ResourcePackageRunOut"

func (*Client) GetFaceIdResultIntl 

func (c *Client) GetFaceIdResultIntl(request *GetFaceIdResultIntlRequest) (response *GetFaceIdResultIntlResponse, err error)

GetFaceIdResultIntl 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.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_BIZTOKENEXPIRED = "InvalidParameterValue.BizTokenExpired"
INVALIDPARAMETERVALUE_BIZTOKENILLEGAL = "InvalidParameterValue.BizTokenIllegal"
OPERATIONDENIED = "OperationDenied"

func (*Client) GetFaceIdResultIntlWithContext 

func (c *Client) GetFaceIdResultIntlWithContext(ctx context.Context, request *GetFaceIdResultIntlRequest) (response *GetFaceIdResultIntlResponse, err error)

GetFaceIdResultIntl 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.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_BIZTOKENEXPIRED = "InvalidParameterValue.BizTokenExpired"
INVALIDPARAMETERVALUE_BIZTOKENILLEGAL = "InvalidParameterValue.BizTokenIllegal"
OPERATIONDENIED = "OperationDenied"

func (*Client) GetFaceIdTokenIntl 

func (c *Client) GetFaceIdTokenIntl(request *GetFaceIdTokenIntlRequest) (response *GetFaceIdTokenIntlResponse, err error)

GetFaceIdTokenIntl 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.

error code that may be returned: 

FAILEDOPERATION_IMAGESIZETOOLARGE = "FailedOperation.ImageSizeTooLarge"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"

func (*Client) GetFaceIdTokenIntlWithContext 

func (c *Client) GetFaceIdTokenIntlWithContext(ctx context.Context, request *GetFaceIdTokenIntlRequest) (response *GetFaceIdTokenIntlResponse, err error)

GetFaceIdTokenIntl 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.

error code that may be returned: 

FAILEDOPERATION_IMAGESIZETOOLARGE = "FailedOperation.ImageSizeTooLarge"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"

func (*Client) GetLivenessResult 

func (c *Client) GetLivenessResult(request *GetLivenessResultRequest) (response *GetLivenessResultResponse, err error)

GetLivenessResult 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.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_BIZTOKENEXPIRED = "InvalidParameterValue.BizTokenExpired"
INVALIDPARAMETERVALUE_BIZTOKENILLEGAL = "InvalidParameterValue.BizTokenIllegal"
OPERATIONDENIED = "OperationDenied"

func (*Client) GetLivenessResultWithContext 

func (c *Client) GetLivenessResultWithContext(ctx context.Context, request *GetLivenessResultRequest) (response *GetLivenessResultResponse, err error)

GetLivenessResult 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.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_BIZTOKENEXPIRED = "InvalidParameterValue.BizTokenExpired"
INVALIDPARAMETERVALUE_BIZTOKENILLEGAL = "InvalidParameterValue.BizTokenIllegal"
OPERATIONDENIED = "OperationDenied"

func (*Client) GetSdkVerificationResult 

func (c *Client) GetSdkVerificationResult(request *GetSdkVerificationResultRequest) (response *GetSdkVerificationResultResponse, err error)

GetSdkVerificationResult 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.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_BIZTOKENEXPIRED = "InvalidParameterValue.BizTokenExpired"
INVALIDPARAMETERVALUE_BIZTOKENILLEGAL = "InvalidParameterValue.BizTokenIllegal"
OPERATIONDENIED = "OperationDenied"

func (*Client) GetSdkVerificationResultWithContext 

func (c *Client) GetSdkVerificationResultWithContext(ctx context.Context, request *GetSdkVerificationResultRequest) (response *GetSdkVerificationResultResponse, err error)

GetSdkVerificationResult 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.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_BIZTOKENEXPIRED = "InvalidParameterValue.BizTokenExpired"
INVALIDPARAMETERVALUE_BIZTOKENILLEGAL = "InvalidParameterValue.BizTokenIllegal"
OPERATIONDENIED = "OperationDenied"

func (*Client) GetWebVerificationResult 

func (c *Client) GetWebVerificationResult(request *GetWebVerificationResultRequest) (response *GetWebVerificationResultResponse, err error)

GetWebVerificationResult 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.

error code that may be returned: 

INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_BIZTOKENEXPIRED = "InvalidParameterValue.BizTokenExpired"
INVALIDPARAMETERVALUE_BIZTOKENILLEGAL = "InvalidParameterValue.BizTokenIllegal"
OPERATIONDENIED = "OperationDenied"
RESOURCEUNAVAILABLE = "ResourceUnavailable"

func (*Client) GetWebVerificationResultIntl 

func (c *Client) GetWebVerificationResultIntl(request *GetWebVerificationResultIntlRequest) (response *GetWebVerificationResultIntlResponse, err error)

GetWebVerificationResultIntl 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.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_BIZTOKENEXPIRED = "InvalidParameterValue.BizTokenExpired"
INVALIDPARAMETERVALUE_BIZTOKENILLEGAL = "InvalidParameterValue.BizTokenIllegal"
OPERATIONDENIED = "OperationDenied"

func (*Client) GetWebVerificationResultIntlWithContext 

func (c *Client) GetWebVerificationResultIntlWithContext(ctx context.Context, request *GetWebVerificationResultIntlRequest) (response *GetWebVerificationResultIntlResponse, err error)

GetWebVerificationResultIntl 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.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_BIZTOKENEXPIRED = "InvalidParameterValue.BizTokenExpired"
INVALIDPARAMETERVALUE_BIZTOKENILLEGAL = "InvalidParameterValue.BizTokenIllegal"
OPERATIONDENIED = "OperationDenied"

func (*Client) GetWebVerificationResultWithContext 

func (c *Client) GetWebVerificationResultWithContext(ctx context.Context, request *GetWebVerificationResultRequest) (response *GetWebVerificationResultResponse, err error)

GetWebVerificationResult 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.

error code that may be returned: 

INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_BIZTOKENEXPIRED = "InvalidParameterValue.BizTokenExpired"
INVALIDPARAMETERVALUE_BIZTOKENILLEGAL = "InvalidParameterValue.BizTokenIllegal"
OPERATIONDENIED = "OperationDenied"
RESOURCEUNAVAILABLE = "ResourceUnavailable"

func (*Client) LivenessCompare 

func (c *Client) LivenessCompare(request *LivenessCompareRequest) (response *LivenessCompareResponse, err error)

LivenessCompare 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.

error code that may be returned: 

AUTHFAILURE_INVALIDAUTHORIZATION = "AuthFailure.InvalidAuthorization"
FAILEDOPERATION_ACTIONCLOSEEYE = "FailedOperation.ActionCloseEye"
FAILEDOPERATION_ACTIONFACECLOSE = "FailedOperation.ActionFaceClose"
FAILEDOPERATION_ACTIONFACEFAR = "FailedOperation.ActionFaceFar"
FAILEDOPERATION_ACTIONFACELEFT = "FailedOperation.ActionFaceLeft"
FAILEDOPERATION_ACTIONFACERIGHT = "FailedOperation.ActionFaceRight"
FAILEDOPERATION_ACTIONFIRSTACTION = "FailedOperation.ActionFirstAction"
FAILEDOPERATION_ACTIONLIGHTDARK = "FailedOperation.ActionLightDark"
FAILEDOPERATION_ACTIONLIGHTSTRONG = "FailedOperation.ActionLightStrong"
FAILEDOPERATION_ACTIONNODETECTFACE = "FailedOperation.ActionNodetectFace"
FAILEDOPERATION_ACTIONOPENMOUTH = "FailedOperation.ActionOpenMouth"
FAILEDOPERATION_COMPAREFAIL = "FailedOperation.CompareFail"
FAILEDOPERATION_COMPARELOWSIMILARITY = "FailedOperation.CompareLowSimilarity"
FAILEDOPERATION_COMPARESYSTEMERROR = "FailedOperation.CompareSystemError"
FAILEDOPERATION_DOWNLOADERROR = "FailedOperation.DownLoadError"
FAILEDOPERATION_DOWNLOADTIMEOUTERROR = "FailedOperation.DownLoadTimeoutError"
FAILEDOPERATION_LIFEPHOTODETECTFACES = "FailedOperation.LifePhotoDetectFaces"
FAILEDOPERATION_LIFEPHOTODETECTFAKE = "FailedOperation.LifePhotoDetectFake"
FAILEDOPERATION_LIFEPHOTODETECTNOFACES = "FailedOperation.LifePhotoDetectNoFaces"
FAILEDOPERATION_LIFEPHOTOPOORQUALITY = "FailedOperation.LifePhotoPoorQuality"
FAILEDOPERATION_LIFEPHOTOSIZEERROR = "FailedOperation.LifePhotoSizeError"
FAILEDOPERATION_LIPFACEINCOMPLETE = "FailedOperation.LipFaceIncomplete"
FAILEDOPERATION_LIPMOVESMALL = "FailedOperation.LipMoveSmall"
FAILEDOPERATION_LIPNETFAILED = "FailedOperation.LipNetFailed"
FAILEDOPERATION_LIPSIZEERROR = "FailedOperation.LipSizeError"
FAILEDOPERATION_LIPVIDEOINVALID = "FailedOperation.LipVideoInvalid"
FAILEDOPERATION_LIPVIDEOQUAILITY = "FailedOperation.LipVideoQuaility"
FAILEDOPERATION_LIPVOICEDETECT = "FailedOperation.LipVoiceDetect"
FAILEDOPERATION_LIPVOICELOW = "FailedOperation.LipVoiceLow"
FAILEDOPERATION_LIPVOICERECOGNIZE = "FailedOperation.LipVoiceRecognize"
FAILEDOPERATION_LIVESSBESTFRAMEERROR = "FailedOperation.LivessBestFrameError"
FAILEDOPERATION_LIVESSDETECTFAIL = "FailedOperation.LivessDetectFail"
FAILEDOPERATION_LIVESSDETECTFAKE = "FailedOperation.LivessDetectFake"
FAILEDOPERATION_LIVESSSYSTEMERROR = "FailedOperation.LivessSystemError"
FAILEDOPERATION_LIVESSUNKNOWNERROR = "FailedOperation.LivessUnknownError"
FAILEDOPERATION_SILENTDETECTFAIL = "FailedOperation.SilentDetectFail"
FAILEDOPERATION_SILENTEYELIVEFAIL = "FailedOperation.SilentEyeLiveFail"
FAILEDOPERATION_SILENTFACEDETECTFAIL = "FailedOperation.SilentFaceDetectFail"
FAILEDOPERATION_SILENTFACEQUALITYFAIL = "FailedOperation.SilentFaceQualityFail"
FAILEDOPERATION_SILENTFACEWITHMASKFAIL = "FailedOperation.SilentFaceWithMaskFail"
FAILEDOPERATION_SILENTMOUTHLIVEFAIL = "FailedOperation.SilentMouthLiveFail"
FAILEDOPERATION_SILENTMULTIFACEFAIL = "FailedOperation.SilentMultiFaceFail"
FAILEDOPERATION_SILENTPICTURELIVEFAIL = "FailedOperation.SilentPictureLiveFail"
FAILEDOPERATION_SILENTTHRESHOLD = "FailedOperation.SilentThreshold"
FAILEDOPERATION_SILENTTOOSHORT = "FailedOperation.SilentTooShort"
FAILEDOPERATION_UNKNOWN = "FailedOperation.UnKnown"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_ARREARS = "UnauthorizedOperation.Arrears"
UNAUTHORIZEDOPERATION_NONAUTHORIZE = "UnauthorizedOperation.NonAuthorize"
UNAUTHORIZEDOPERATION_NONACTIVATED = "UnauthorizedOperation.Nonactivated"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) LivenessCompareWithContext 

func (c *Client) LivenessCompareWithContext(ctx context.Context, request *LivenessCompareRequest) (response *LivenessCompareResponse, err error)

LivenessCompare 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.

error code that may be returned: 

AUTHFAILURE_INVALIDAUTHORIZATION = "AuthFailure.InvalidAuthorization"
FAILEDOPERATION_ACTIONCLOSEEYE = "FailedOperation.ActionCloseEye"
FAILEDOPERATION_ACTIONFACECLOSE = "FailedOperation.ActionFaceClose"
FAILEDOPERATION_ACTIONFACEFAR = "FailedOperation.ActionFaceFar"
FAILEDOPERATION_ACTIONFACELEFT = "FailedOperation.ActionFaceLeft"
FAILEDOPERATION_ACTIONFACERIGHT = "FailedOperation.ActionFaceRight"
FAILEDOPERATION_ACTIONFIRSTACTION = "FailedOperation.ActionFirstAction"
FAILEDOPERATION_ACTIONLIGHTDARK = "FailedOperation.ActionLightDark"
FAILEDOPERATION_ACTIONLIGHTSTRONG = "FailedOperation.ActionLightStrong"
FAILEDOPERATION_ACTIONNODETECTFACE = "FailedOperation.ActionNodetectFace"
FAILEDOPERATION_ACTIONOPENMOUTH = "FailedOperation.ActionOpenMouth"
FAILEDOPERATION_COMPAREFAIL = "FailedOperation.CompareFail"
FAILEDOPERATION_COMPARELOWSIMILARITY = "FailedOperation.CompareLowSimilarity"
FAILEDOPERATION_COMPARESYSTEMERROR = "FailedOperation.CompareSystemError"
FAILEDOPERATION_DOWNLOADERROR = "FailedOperation.DownLoadError"
FAILEDOPERATION_DOWNLOADTIMEOUTERROR = "FailedOperation.DownLoadTimeoutError"
FAILEDOPERATION_LIFEPHOTODETECTFACES = "FailedOperation.LifePhotoDetectFaces"
FAILEDOPERATION_LIFEPHOTODETECTFAKE = "FailedOperation.LifePhotoDetectFake"
FAILEDOPERATION_LIFEPHOTODETECTNOFACES = "FailedOperation.LifePhotoDetectNoFaces"
FAILEDOPERATION_LIFEPHOTOPOORQUALITY = "FailedOperation.LifePhotoPoorQuality"
FAILEDOPERATION_LIFEPHOTOSIZEERROR = "FailedOperation.LifePhotoSizeError"
FAILEDOPERATION_LIPFACEINCOMPLETE = "FailedOperation.LipFaceIncomplete"
FAILEDOPERATION_LIPMOVESMALL = "FailedOperation.LipMoveSmall"
FAILEDOPERATION_LIPNETFAILED = "FailedOperation.LipNetFailed"
FAILEDOPERATION_LIPSIZEERROR = "FailedOperation.LipSizeError"
FAILEDOPERATION_LIPVIDEOINVALID = "FailedOperation.LipVideoInvalid"
FAILEDOPERATION_LIPVIDEOQUAILITY = "FailedOperation.LipVideoQuaility"
FAILEDOPERATION_LIPVOICEDETECT = "FailedOperation.LipVoiceDetect"
FAILEDOPERATION_LIPVOICELOW = "FailedOperation.LipVoiceLow"
FAILEDOPERATION_LIPVOICERECOGNIZE = "FailedOperation.LipVoiceRecognize"
FAILEDOPERATION_LIVESSBESTFRAMEERROR = "FailedOperation.LivessBestFrameError"
FAILEDOPERATION_LIVESSDETECTFAIL = "FailedOperation.LivessDetectFail"
FAILEDOPERATION_LIVESSDETECTFAKE = "FailedOperation.LivessDetectFake"
FAILEDOPERATION_LIVESSSYSTEMERROR = "FailedOperation.LivessSystemError"
FAILEDOPERATION_LIVESSUNKNOWNERROR = "FailedOperation.LivessUnknownError"
FAILEDOPERATION_SILENTDETECTFAIL = "FailedOperation.SilentDetectFail"
FAILEDOPERATION_SILENTEYELIVEFAIL = "FailedOperation.SilentEyeLiveFail"
FAILEDOPERATION_SILENTFACEDETECTFAIL = "FailedOperation.SilentFaceDetectFail"
FAILEDOPERATION_SILENTFACEQUALITYFAIL = "FailedOperation.SilentFaceQualityFail"
FAILEDOPERATION_SILENTFACEWITHMASKFAIL = "FailedOperation.SilentFaceWithMaskFail"
FAILEDOPERATION_SILENTMOUTHLIVEFAIL = "FailedOperation.SilentMouthLiveFail"
FAILEDOPERATION_SILENTMULTIFACEFAIL = "FailedOperation.SilentMultiFaceFail"
FAILEDOPERATION_SILENTPICTURELIVEFAIL = "FailedOperation.SilentPictureLiveFail"
FAILEDOPERATION_SILENTTHRESHOLD = "FailedOperation.SilentThreshold"
FAILEDOPERATION_SILENTTOOSHORT = "FailedOperation.SilentTooShort"
FAILEDOPERATION_UNKNOWN = "FailedOperation.UnKnown"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_ARREARS = "UnauthorizedOperation.Arrears"
UNAUTHORIZEDOPERATION_NONAUTHORIZE = "UnauthorizedOperation.NonAuthorize"
UNAUTHORIZEDOPERATION_NONACTIVATED = "UnauthorizedOperation.Nonactivated"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) VideoLivenessCompare 

func (c *Client) VideoLivenessCompare(request *VideoLivenessCompareRequest) (response *VideoLivenessCompareResponse, err error)

VideoLivenessCompare 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.

error code that may be returned: 

FAILEDOPERATION_ACTIONCLOSEEYE = "FailedOperation.ActionCloseEye"
FAILEDOPERATION_ACTIONFACECLOSE = "FailedOperation.ActionFaceClose"
FAILEDOPERATION_ACTIONFACEFAR = "FailedOperation.ActionFaceFar"
FAILEDOPERATION_ACTIONFACELEFT = "FailedOperation.ActionFaceLeft"
FAILEDOPERATION_ACTIONFACERIGHT = "FailedOperation.ActionFaceRight"
FAILEDOPERATION_ACTIONFIRSTACTION = "FailedOperation.ActionFirstAction"
FAILEDOPERATION_ACTIONLIGHTDARK = "FailedOperation.ActionLightDark"
FAILEDOPERATION_ACTIONLIGHTSTRONG = "FailedOperation.ActionLightStrong"
FAILEDOPERATION_ACTIONNODETECTFACE = "FailedOperation.ActionNodetectFace"
FAILEDOPERATION_ACTIONOPENMOUTH = "FailedOperation.ActionOpenMouth"
FAILEDOPERATION_COMPAREFAIL = "FailedOperation.CompareFail"
FAILEDOPERATION_COMPARELOWSIMILARITY = "FailedOperation.CompareLowSimilarity"
FAILEDOPERATION_COMPARESYSTEMERROR = "FailedOperation.CompareSystemError"
FAILEDOPERATION_DOWNLOADERROR = "FailedOperation.DownLoadError"
FAILEDOPERATION_DOWNLOADTIMEOUTERROR = "FailedOperation.DownLoadTimeoutError"
FAILEDOPERATION_LIFEPHOTODETECTFACES = "FailedOperation.LifePhotoDetectFaces"
FAILEDOPERATION_LIFEPHOTODETECTFAKE = "FailedOperation.LifePhotoDetectFake"
FAILEDOPERATION_LIFEPHOTODETECTNOFACES = "FailedOperation.LifePhotoDetectNoFaces"
FAILEDOPERATION_LIFEPHOTOPOORQUALITY = "FailedOperation.LifePhotoPoorQuality"
FAILEDOPERATION_LIFEPHOTOSIZEERROR = "FailedOperation.LifePhotoSizeError"
FAILEDOPERATION_LIPFACEINCOMPLETE = "FailedOperation.LipFaceIncomplete"
FAILEDOPERATION_LIPMOVESMALL = "FailedOperation.LipMoveSmall"
FAILEDOPERATION_LIPNETFAILED = "FailedOperation.LipNetFailed"
FAILEDOPERATION_LIPSIZEERROR = "FailedOperation.LipSizeError"
FAILEDOPERATION_LIPVIDEOINVALID = "FailedOperation.LipVideoInvalid"
FAILEDOPERATION_LIPVIDEOQUAILITY = "FailedOperation.LipVideoQuaility"
FAILEDOPERATION_LIPVOICEDETECT = "FailedOperation.LipVoiceDetect"
FAILEDOPERATION_LIPVOICELOW = "FailedOperation.LipVoiceLow"
FAILEDOPERATION_LIPVOICERECOGNIZE = "FailedOperation.LipVoiceRecognize"
FAILEDOPERATION_LIVESSBESTFRAMEERROR = "FailedOperation.LivessBestFrameError"
FAILEDOPERATION_LIVESSDETECTFAIL = "FailedOperation.LivessDetectFail"
FAILEDOPERATION_LIVESSDETECTFAKE = "FailedOperation.LivessDetectFake"
FAILEDOPERATION_LIVESSSYSTEMERROR = "FailedOperation.LivessSystemError"
FAILEDOPERATION_LIVESSUNKNOWNERROR = "FailedOperation.LivessUnknownError"
FAILEDOPERATION_SILENTDETECTFAIL = "FailedOperation.SilentDetectFail"
FAILEDOPERATION_SILENTEYELIVEFAIL = "FailedOperation.SilentEyeLiveFail"
FAILEDOPERATION_SILENTFACEDETECTFAIL = "FailedOperation.SilentFaceDetectFail"
FAILEDOPERATION_SILENTFACEQUALITYFAIL = "FailedOperation.SilentFaceQualityFail"
FAILEDOPERATION_SILENTFACEWITHMASKFAIL = "FailedOperation.SilentFaceWithMaskFail"
FAILEDOPERATION_SILENTMOUTHLIVEFAIL = "FailedOperation.SilentMouthLiveFail"
FAILEDOPERATION_SILENTMULTIFACEFAIL = "FailedOperation.SilentMultiFaceFail"
FAILEDOPERATION_SILENTPICTURELIVEFAIL = "FailedOperation.SilentPictureLiveFail"
FAILEDOPERATION_SILENTTHRESHOLD = "FailedOperation.SilentThreshold"
FAILEDOPERATION_SILENTTOOSHORT = "FailedOperation.SilentTooShort"
FAILEDOPERATION_UNKNOWN = "FailedOperation.UnKnown"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_ARREARS = "UnauthorizedOperation.Arrears"
UNAUTHORIZEDOPERATION_NONAUTHORIZE = "UnauthorizedOperation.NonAuthorize"
UNAUTHORIZEDOPERATION_NONACTIVATED = "UnauthorizedOperation.Nonactivated"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) VideoLivenessCompareWithContext 

func (c *Client) VideoLivenessCompareWithContext(ctx context.Context, request *VideoLivenessCompareRequest) (response *VideoLivenessCompareResponse, err error)

VideoLivenessCompare 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.

error code that may be returned: 

FAILEDOPERATION_ACTIONCLOSEEYE = "FailedOperation.ActionCloseEye"
FAILEDOPERATION_ACTIONFACECLOSE = "FailedOperation.ActionFaceClose"
FAILEDOPERATION_ACTIONFACEFAR = "FailedOperation.ActionFaceFar"
FAILEDOPERATION_ACTIONFACELEFT = "FailedOperation.ActionFaceLeft"
FAILEDOPERATION_ACTIONFACERIGHT = "FailedOperation.ActionFaceRight"
FAILEDOPERATION_ACTIONFIRSTACTION = "FailedOperation.ActionFirstAction"
FAILEDOPERATION_ACTIONLIGHTDARK = "FailedOperation.ActionLightDark"
FAILEDOPERATION_ACTIONLIGHTSTRONG = "FailedOperation.ActionLightStrong"
FAILEDOPERATION_ACTIONNODETECTFACE = "FailedOperation.ActionNodetectFace"
FAILEDOPERATION_ACTIONOPENMOUTH = "FailedOperation.ActionOpenMouth"
FAILEDOPERATION_COMPAREFAIL = "FailedOperation.CompareFail"
FAILEDOPERATION_COMPARELOWSIMILARITY = "FailedOperation.CompareLowSimilarity"
FAILEDOPERATION_COMPARESYSTEMERROR = "FailedOperation.CompareSystemError"
FAILEDOPERATION_DOWNLOADERROR = "FailedOperation.DownLoadError"
FAILEDOPERATION_DOWNLOADTIMEOUTERROR = "FailedOperation.DownLoadTimeoutError"
FAILEDOPERATION_LIFEPHOTODETECTFACES = "FailedOperation.LifePhotoDetectFaces"
FAILEDOPERATION_LIFEPHOTODETECTFAKE = "FailedOperation.LifePhotoDetectFake"
FAILEDOPERATION_LIFEPHOTODETECTNOFACES = "FailedOperation.LifePhotoDetectNoFaces"
FAILEDOPERATION_LIFEPHOTOPOORQUALITY = "FailedOperation.LifePhotoPoorQuality"
FAILEDOPERATION_LIFEPHOTOSIZEERROR = "FailedOperation.LifePhotoSizeError"
FAILEDOPERATION_LIPFACEINCOMPLETE = "FailedOperation.LipFaceIncomplete"
FAILEDOPERATION_LIPMOVESMALL = "FailedOperation.LipMoveSmall"
FAILEDOPERATION_LIPNETFAILED = "FailedOperation.LipNetFailed"
FAILEDOPERATION_LIPSIZEERROR = "FailedOperation.LipSizeError"
FAILEDOPERATION_LIPVIDEOINVALID = "FailedOperation.LipVideoInvalid"
FAILEDOPERATION_LIPVIDEOQUAILITY = "FailedOperation.LipVideoQuaility"
FAILEDOPERATION_LIPVOICEDETECT = "FailedOperation.LipVoiceDetect"
FAILEDOPERATION_LIPVOICELOW = "FailedOperation.LipVoiceLow"
FAILEDOPERATION_LIPVOICERECOGNIZE = "FailedOperation.LipVoiceRecognize"
FAILEDOPERATION_LIVESSBESTFRAMEERROR = "FailedOperation.LivessBestFrameError"
FAILEDOPERATION_LIVESSDETECTFAIL = "FailedOperation.LivessDetectFail"
FAILEDOPERATION_LIVESSDETECTFAKE = "FailedOperation.LivessDetectFake"
FAILEDOPERATION_LIVESSSYSTEMERROR = "FailedOperation.LivessSystemError"
FAILEDOPERATION_LIVESSUNKNOWNERROR = "FailedOperation.LivessUnknownError"
FAILEDOPERATION_SILENTDETECTFAIL = "FailedOperation.SilentDetectFail"
FAILEDOPERATION_SILENTEYELIVEFAIL = "FailedOperation.SilentEyeLiveFail"
FAILEDOPERATION_SILENTFACEDETECTFAIL = "FailedOperation.SilentFaceDetectFail"
FAILEDOPERATION_SILENTFACEQUALITYFAIL = "FailedOperation.SilentFaceQualityFail"
FAILEDOPERATION_SILENTFACEWITHMASKFAIL = "FailedOperation.SilentFaceWithMaskFail"
FAILEDOPERATION_SILENTMOUTHLIVEFAIL = "FailedOperation.SilentMouthLiveFail"
FAILEDOPERATION_SILENTMULTIFACEFAIL = "FailedOperation.SilentMultiFaceFail"
FAILEDOPERATION_SILENTPICTURELIVEFAIL = "FailedOperation.SilentPictureLiveFail"
FAILEDOPERATION_SILENTTHRESHOLD = "FailedOperation.SilentThreshold"
FAILEDOPERATION_SILENTTOOSHORT = "FailedOperation.SilentTooShort"
FAILEDOPERATION_UNKNOWN = "FailedOperation.UnKnown"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_ARREARS = "UnauthorizedOperation.Arrears"
UNAUTHORIZEDOPERATION_NONAUTHORIZE = "UnauthorizedOperation.NonAuthorize"
UNAUTHORIZEDOPERATION_NONACTIVATED = "UnauthorizedOperation.Nonactivated"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

type CompareFaceLivenessRequest 

type CompareFaceLivenessRequest struct {
	*tchttp.BaseRequest

	// Base64 value of photos used for face comparison.
	// The size of image data encoded by Base64 shall not exceed 3M, only jpg and png are supported.
	// Please use standard Base64 encoding (use = for padding). Refer to RFC4648 for encoding specifications.
	// Example values: "/9j/4AAQSk... (total length:61944)KiiK//2Q=="
	ImageBase64 *string `json:"ImageBase64,omitnil,omitempty" name:"ImageBase64"`

	// Base64 value of photos used for face comparison.
	// The size of image data encoded by Base64 shall not exceed 3M, only jpg and png are supported.
	// Please use standard Base64 encoding (use = for padding). Refer to RFC4648 for encoding specifications.
	// Example values: "/9j/4AAQSk... (total length:61944)KiiK//2Q=="
	VideoBase64 *string `json:"VideoBase64,omitnil,omitempty" name:"VideoBase64"`

	// The liveness detection type. Valid values: `LIP`, `ACTION`, and `SILENT`.
	// `LIP`: Numeric mode; `ACTION`: Motion mode; `SILENT`: silent mode. Select one of them.
	// Example value: "SILENT"
	LivenessType *string `json:"LivenessType,omitnil,omitempty" name:"LivenessType"`

	// When the “LivenessType” parameter is “ACTION”, it must be specified.
	// It is used to control the action sequence. Action types:
	// 1 (open mouth)
	// 2 (blink)
	// 3 (nod)
	// 4 (shake head).
	// Select one or two from the four actions.
	// Example of passing single action parameter: "1".
	// Example of passing multiple action parameters: "4,2".
	// When the “LivenessType” parameter value is “SILENT”, it shall be unspecified.
	// Example value: ""
	ValidateData *string `json:"ValidateData,omitnil,omitempty" name:"ValidateData"`
}

func NewCompareFaceLivenessRequest 

func NewCompareFaceLivenessRequest() (request *CompareFaceLivenessRequest)

func (*CompareFaceLivenessRequest) FromJsonString 

func (r *CompareFaceLivenessRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CompareFaceLivenessRequest) ToJsonString 

func (r *CompareFaceLivenessRequest) ToJsonString() string

type CompareFaceLivenessRequestParams 

type CompareFaceLivenessRequestParams struct {
	// Base64 value of photos used for face comparison.
	// The size of image data encoded by Base64 shall not exceed 3M, only jpg and png are supported.
	// Please use standard Base64 encoding (use = for padding). Refer to RFC4648 for encoding specifications.
	// Example values: "/9j/4AAQSk... (total length:61944)KiiK//2Q=="
	ImageBase64 *string `json:"ImageBase64,omitnil,omitempty" name:"ImageBase64"`

	// Base64 value of photos used for face comparison.
	// The size of image data encoded by Base64 shall not exceed 3M, only jpg and png are supported.
	// Please use standard Base64 encoding (use = for padding). Refer to RFC4648 for encoding specifications.
	// Example values: "/9j/4AAQSk... (total length:61944)KiiK//2Q=="
	VideoBase64 *string `json:"VideoBase64,omitnil,omitempty" name:"VideoBase64"`

	// The liveness detection type. Valid values: `LIP`, `ACTION`, and `SILENT`.
	// `LIP`: Numeric mode; `ACTION`: Motion mode; `SILENT`: silent mode. Select one of them.
	// Example value: "SILENT"
	LivenessType *string `json:"LivenessType,omitnil,omitempty" name:"LivenessType"`

	// When the “LivenessType” parameter is “ACTION”, it must be specified.
	// It is used to control the action sequence. Action types:
	// 1 (open mouth)
	// 2 (blink)
	// 3 (nod)
	// 4 (shake head).
	// Select one or two from the four actions.
	// Example of passing single action parameter: "1".
	// Example of passing multiple action parameters: "4,2".
	// When the “LivenessType” parameter value is “SILENT”, it shall be unspecified.
	// Example value: ""
	ValidateData *string `json:"ValidateData,omitnil,omitempty" name:"ValidateData"`
}

Predefined struct for user

type CompareFaceLivenessResponse 

type CompareFaceLivenessResponse struct {
	*tchttp.BaseResponse
	Response *CompareFaceLivenessResponseParams `json:"Response"`
}

func NewCompareFaceLivenessResponse 

func NewCompareFaceLivenessResponse() (response *CompareFaceLivenessResponse)

func (*CompareFaceLivenessResponse) FromJsonString 

func (r *CompareFaceLivenessResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CompareFaceLivenessResponse) ToJsonString 

func (r *CompareFaceLivenessResponse) ToJsonString() string

type CompareFaceLivenessResponseParams 

type CompareFaceLivenessResponseParams struct {
	// Service error code. When the return value is "Success", it indicates that the liveness detection and face comparison succeeded. It is determined that they are the same person. When the return value is "FailedOperation.CompareLowSimilarity", it indicates that the liveness detection succeeded, and the face comparison similarity is lower than 70 points. It is determined that they are not the same person. For other error cases, please refer to Liveness Face Comparison (Pure API) Error Code (https://www.tencentcloud.com/document/product/1061/55390).
	// Example Value: "Success".
	Result *string `json:"Result,omitnil,omitempty" name:"Result"`

	// Description of business results.
	// Example value: "Success"
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// This value is valid when the “Result” parameter is "Success" or "FailedOperation.CompareLowSimilarity."
	// This value indicates the similarity of face comparison. Value range: [0.00, 100.00]. The false pass rate for threshold 70 is 1 in 1,000, and the false pass rate for threshold 80 is 1 in 1,000.
	// Example value: 80.00
	Sim *float64 `json:"Sim,omitnil,omitempty" name:"Sim"`

	// The optimal screenshot of the video after verification is the value encoded by BASE64, jpg format.
	// Note: This field may return “null”, indicating that no valid value can be obtained.
	// Example values: "/9j/4AAQSk... (total length:142036)s97n//2Q=="
	BestFrameBase64 *string `json:"BestFrameBase64,omitnil,omitempty" name:"BestFrameBase64"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CompareResult 

type CompareResult struct {
	// The final verification result code.
	// 0: Success.
	// 1001: Failed to call the liveness detection engine.
	// 1004: Face detection failed.
	// 2004: The uploaded face image is too large or too small.
	// 2012: The face is not fully exposed.
	// 2013: No face is detected.
	// 2014: The resolution of the uploaded image is too low . Please upload a new one.
	// 2015: Face comparison failed.
	// 2016: The similarity did not reach the passing standard.
	ErrorCode *string `json:"ErrorCode,omitnil,omitempty" name:"ErrorCode"`

	// The description of the final verification result.
	ErrorMsg *string `json:"ErrorMsg,omitnil,omitempty" name:"ErrorMsg"`

	// The liveness algorithm package generated during this SDK-based liveness detection.
	LiveData *FileInfo `json:"LiveData,omitnil,omitempty" name:"LiveData"`

	// The download URL of the video used for verification, which is valid for 10 minutes.
	LiveVideo *FileInfo `json:"LiveVideo,omitnil,omitempty" name:"LiveVideo"`

	// The liveness detection result code.
	// 0: Success.
	// 1001: Failed to call the liveness detection engine.
	// 1004: Face detection failed.
	LiveErrorCode *string `json:"LiveErrorCode,omitnil,omitempty" name:"LiveErrorCode"`

	// The description of the liveness detection result.
	LiveErrorMsg *string `json:"LiveErrorMsg,omitnil,omitempty" name:"LiveErrorMsg"`

	// The download URL of the face screenshot during verification, which is valid for 10 minutes.
	// Note: This field may return null, indicating that no valid value can be obtained.
	BestFrame *FileInfo `json:"BestFrame,omitnil,omitempty" name:"BestFrame"`

	// The download URL of the profile photo screenshot from the identity document, which is valid for 10 minutes.
	ProfileImage *FileInfo `json:"ProfileImage,omitnil,omitempty" name:"ProfileImage"`

	// The face comparison result code.
	// 0: Success.
	// 2004: The uploaded face image is too large or too small.
	// 2012: The face is not fully exposed.
	// 2013: No face is detected.
	// 2014: The resolution of the uploaded image is too low . Please upload a new one.
	// 2015: Face comparison failed.
	// 2016: The similarity did not reach the passing standard.
	// Note: This field may return null, indicating that no valid value can be obtained.
	CompareErrorCode *string `json:"CompareErrorCode,omitnil,omitempty" name:"CompareErrorCode"`

	// The description of the face comparison result.
	// Note: This field may return null, indicating that no valid values can be obtained.
	CompareErrorMsg *string `json:"CompareErrorMsg,omitnil,omitempty" name:"CompareErrorMsg"`

	// The similarity score of face comparison.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Sim *float64 `json:"Sim,omitnil,omitempty" name:"Sim"`

	// This parameter is disused.
	IsNeedCharge *bool `json:"IsNeedCharge,omitnil,omitempty" name:"IsNeedCharge"`

	// The identity document photo info edited by the user. Currently, this parameter is not applied.
	// Note: This field may return null, indicating that no valid values can be obtained.
	CardInfoInputJson *FileInfo `json:"CardInfoInputJson,omitnil,omitempty" name:"CardInfoInputJson"`

	// The request ID of this verification process.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

type CreateUploadUrlRequest 

type CreateUploadUrlRequest struct {
	*tchttp.BaseRequest

	// Target API
	TargetAction *string `json:"TargetAction,omitnil,omitempty" name:"TargetAction"`
}

func NewCreateUploadUrlRequest 

func NewCreateUploadUrlRequest() (request *CreateUploadUrlRequest)

func (*CreateUploadUrlRequest) FromJsonString 

func (r *CreateUploadUrlRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateUploadUrlRequest) ToJsonString 

func (r *CreateUploadUrlRequest) ToJsonString() string

type CreateUploadUrlRequestParams 

type CreateUploadUrlRequestParams struct {
	// Target API
	TargetAction *string `json:"TargetAction,omitnil,omitempty" name:"TargetAction"`
}

Predefined struct for user

type CreateUploadUrlResponse 

type CreateUploadUrlResponse struct {
	*tchttp.BaseResponse
	Response *CreateUploadUrlResponseParams `json:"Response"`
}

func NewCreateUploadUrlResponse 

func NewCreateUploadUrlResponse() (response *CreateUploadUrlResponse)

func (*CreateUploadUrlResponse) FromJsonString 

func (r *CreateUploadUrlResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateUploadUrlResponse) ToJsonString 

func (r *CreateUploadUrlResponse) ToJsonString() string

type CreateUploadUrlResponseParams 

type CreateUploadUrlResponseParams struct {
	// The URL for uploading contents with the `HTTP PUT` method.
	UploadUrl *string `json:"UploadUrl,omitnil,omitempty" name:"UploadUrl"`

	// The resource URL obtained after this upload is completed and to be passed in where it is required later.
	ResourceUrl *string `json:"ResourceUrl,omitnil,omitempty" name:"ResourceUrl"`

	// The point in time when the upload/download link expires, which is a 10-bit Unix timestamp.
	ExpiredTimestamp *int64 `json:"ExpiredTimestamp,omitnil,omitempty" name:"ExpiredTimestamp"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DetectReflectLivenessAndCompareRequest 

type DetectReflectLivenessAndCompareRequest struct {
	*tchttp.BaseRequest

	// URL of the liveness detection data package generated by the SDK
	LiveDataUrl *string `json:"LiveDataUrl,omitnil,omitempty" name:"LiveDataUrl"`

	// MD5 hash value (32-bit) of the liveness detection data package generated by the SDK, which is used to verify the LiveData consistency.
	LiveDataMd5 *string `json:"LiveDataMd5,omitnil,omitempty" name:"LiveDataMd5"`

	// URL of the target image for comparison
	ImageUrl *string `json:"ImageUrl,omitnil,omitempty" name:"ImageUrl"`

	// MD5 hash value (32-bit) of the target image for comparison, which is used to verify the `Image` consistency.
	ImageMd5 *string `json:"ImageMd5,omitnil,omitempty" name:"ImageMd5"`
}

func NewDetectReflectLivenessAndCompareRequest 

func NewDetectReflectLivenessAndCompareRequest() (request *DetectReflectLivenessAndCompareRequest)

func (*DetectReflectLivenessAndCompareRequest) FromJsonString 

func (r *DetectReflectLivenessAndCompareRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DetectReflectLivenessAndCompareRequest) ToJsonString 

func (r *DetectReflectLivenessAndCompareRequest) ToJsonString() string

type DetectReflectLivenessAndCompareRequestParams 

type DetectReflectLivenessAndCompareRequestParams struct {
	// URL of the liveness detection data package generated by the SDK
	LiveDataUrl *string `json:"LiveDataUrl,omitnil,omitempty" name:"LiveDataUrl"`

	// MD5 hash value (32-bit) of the liveness detection data package generated by the SDK, which is used to verify the LiveData consistency.
	LiveDataMd5 *string `json:"LiveDataMd5,omitnil,omitempty" name:"LiveDataMd5"`

	// URL of the target image for comparison
	ImageUrl *string `json:"ImageUrl,omitnil,omitempty" name:"ImageUrl"`

	// MD5 hash value (32-bit) of the target image for comparison, which is used to verify the `Image` consistency.
	ImageMd5 *string `json:"ImageMd5,omitnil,omitempty" name:"ImageMd5"`
}

Predefined struct for user

type DetectReflectLivenessAndCompareResponse 

type DetectReflectLivenessAndCompareResponse struct {
	*tchttp.BaseResponse
	Response *DetectReflectLivenessAndCompareResponseParams `json:"Response"`
}

func NewDetectReflectLivenessAndCompareResponse 

func NewDetectReflectLivenessAndCompareResponse() (response *DetectReflectLivenessAndCompareResponse)

func (*DetectReflectLivenessAndCompareResponse) FromJsonString 

func (r *DetectReflectLivenessAndCompareResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DetectReflectLivenessAndCompareResponse) ToJsonString 

func (r *DetectReflectLivenessAndCompareResponse) ToJsonString() string

type DetectReflectLivenessAndCompareResponseParams 

type DetectReflectLivenessAndCompareResponseParams struct {
	// Temporary URL of the best screenshot (.jpg) of the video after successful verification. Both the screenshot and the URL are valid for two hours only, so you need to download the screenshot within this period.
	BestFrameUrl *string `json:"BestFrameUrl,omitnil,omitempty" name:"BestFrameUrl"`

	// MD5 hash value (32-bit) of the best screenshot of the video after successful verification, which is used to verify the `BestFrame` consistency.
	BestFrameMd5 *string `json:"BestFrameMd5,omitnil,omitempty" name:"BestFrameMd5"`

	// Service error code. `Success` will be returned for success. For error information, see the `FailedOperation` section in the error code list below.
	Result *string `json:"Result,omitnil,omitempty" name:"Result"`

	// Service result description
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// Similarity. Value range: [0.00, 100.00]. As a recommendation, when the similarity is greater than or equal to 70, it can be determined that the two faces are of the same person. You can adjust the threshold according to your specific scenario (the FAR at the threshold of 70 is 0.1%, and FAR at the threshold of 80 is 0.01%).
	Sim *float64 `json:"Sim,omitnil,omitempty" name:"Sim"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type FileInfo 

type FileInfo struct {
	// The URL for downloading the file
	Url *string `json:"Url,omitnil,omitempty" name:"Url"`

	// The 32-bit MD5 checksum of the file
	MD5 *string `json:"MD5,omitnil,omitempty" name:"MD5"`

	// The file size
	Size *int64 `json:"Size,omitnil,omitempty" name:"Size"`
}

type GeneralCard 

type GeneralCard struct {
	// License number
	// Note: This field may return null, indicating that no valid values can be obtained.
	LicenseNumber *string `json:"LicenseNumber,omitnil,omitempty" name:"LicenseNumber"`

	// Personal number, which is returned when it is a passport
	// Note: This field may return null, indicating that no valid values can be obtained.
	PersonalNumber *string `json:"PersonalNumber,omitnil,omitempty" name:"PersonalNumber"`

	// The first line of passport machine reading code
	// Note: This field may return null, indicating that no valid values can be obtained.
	PassportCodeFirst *string `json:"PassportCodeFirst,omitnil,omitempty" name:"PassportCodeFirst"`

	// The first line of passport machine reading code
	// Note: This field may return null, indicating that no valid values can be obtained.
	PassportCodeSecond *string `json:"PassportCodeSecond,omitnil,omitempty" name:"PassportCodeSecond"`

	// Date of expiry in the format of YYYY-MM-DD
	// Note: This field may return null, indicating that no valid values can be obtained.
	ExpirationDate *string `json:"ExpirationDate,omitnil,omitempty" name:"ExpirationDate"`

	// Valid date in the format of YYYY-MM-DD
	// Note: This field may return null, indicating that no valid values can be obtained.
	DueDate *string `json:"DueDate,omitnil,omitempty" name:"DueDate"`

	// Date of issue in the format of YYYY-MM-DD
	// Note: This field may return null, indicating that no valid values can be obtained.
	IssuedDate *string `json:"IssuedDate,omitnil,omitempty" name:"IssuedDate"`

	// Issuing authority
	// Note: This field may return null, indicating that no valid values can be obtained.
	IssuedAuthority *string `json:"IssuedAuthority,omitnil,omitempty" name:"IssuedAuthority"`

	// Issuing country, which is returned following the ISO 3166 country coding specification
	// Note: This field may return null, indicating that no valid values can be obtained.
	// Example: MYS
	IssuedCountry *string `json:"IssuedCountry,omitnil,omitempty" name:"IssuedCountry"`

	// Full Name
	// Note: This field may return null, indicating that no valid values can be obtained.
	FullName *string `json:"FullName,omitnil,omitempty" name:"FullName"`

	// First name
	// Note: This field may return null, indicating that no valid values can be obtained.
	FirstName *string `json:"FirstName,omitnil,omitempty" name:"FirstName"`

	// Last name
	// Note: This field may return null, indicating that no valid values can be obtained.
	LastName *string `json:"LastName,omitnil,omitempty" name:"LastName"`

	// Gender on the license
	// - M: male
	// - F: female
	// - X: other gender
	// Note: This field may return null, indicating that no valid values can be obtained.
	// Example: M
	Sex *string `json:"Sex,omitnil,omitempty" name:"Sex"`

	// Age. 0 indicates that no valid information is obtained.
	// Example: 0
	Age *string `json:"Age,omitnil,omitempty" name:"Age"`

	// Birthday
	// Note: This field may return null, indicating that no valid values can be obtained.
	Birthday *string `json:"Birthday,omitnil,omitempty" name:"Birthday"`

	// Birth place
	// Note: This field may return null, indicating that no valid values can be obtained.
	BirthPlace *string `json:"BirthPlace,omitnil,omitempty" name:"BirthPlace"`

	// Nationality, which is returned following the ISO 3166 country coding specification
	// Note: This field may return null, indicating that no valid values can be obtained.
	// Example: IND
	Nationality *string `json:"Nationality,omitnil,omitempty" name:"Nationality"`

	// Registration number
	// Note: This field may return null, indicating that no valid values can be obtained.
	RegistrationNumber *string `json:"RegistrationNumber,omitnil,omitempty" name:"RegistrationNumber"`

	// Address
	// Note: This field may return null, indicating that no valid values can be obtained.
	Address *Address `json:"Address,omitnil,omitempty" name:"Address"`
}

type GenerateReflectSequenceRequest 

type GenerateReflectSequenceRequest struct {
	*tchttp.BaseRequest

	// The resource URL of the data package generated by the SDK.
	DeviceDataUrl *string `json:"DeviceDataUrl,omitnil,omitempty" name:"DeviceDataUrl"`

	// The MD5 hash value of the data package generated by the SDK.
	DeviceDataMd5 *string `json:"DeviceDataMd5,omitnil,omitempty" name:"DeviceDataMd5"`

	// 1 - silent
	// 2 - blinking
	// 3 - light
	// 4 - blinking + light (default)
	SecurityLevel *string `json:"SecurityLevel,omitnil,omitempty" name:"SecurityLevel"`
}

func NewGenerateReflectSequenceRequest 

func NewGenerateReflectSequenceRequest() (request *GenerateReflectSequenceRequest)

func (*GenerateReflectSequenceRequest) FromJsonString 

func (r *GenerateReflectSequenceRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GenerateReflectSequenceRequest) ToJsonString 

func (r *GenerateReflectSequenceRequest) ToJsonString() string

type GenerateReflectSequenceRequestParams 

type GenerateReflectSequenceRequestParams struct {
	// The resource URL of the data package generated by the SDK.
	DeviceDataUrl *string `json:"DeviceDataUrl,omitnil,omitempty" name:"DeviceDataUrl"`

	// The MD5 hash value of the data package generated by the SDK.
	DeviceDataMd5 *string `json:"DeviceDataMd5,omitnil,omitempty" name:"DeviceDataMd5"`

	// 1 - silent
	// 2 - blinking
	// 3 - light
	// 4 - blinking + light (default)
	SecurityLevel *string `json:"SecurityLevel,omitnil,omitempty" name:"SecurityLevel"`
}

Predefined struct for user

type GenerateReflectSequenceResponse 

type GenerateReflectSequenceResponse struct {
	*tchttp.BaseResponse
	Response *GenerateReflectSequenceResponseParams `json:"Response"`
}

func NewGenerateReflectSequenceResponse 

func NewGenerateReflectSequenceResponse() (response *GenerateReflectSequenceResponse)

func (*GenerateReflectSequenceResponse) FromJsonString 

func (r *GenerateReflectSequenceResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GenerateReflectSequenceResponse) ToJsonString 

func (r *GenerateReflectSequenceResponse) ToJsonString() string

type GenerateReflectSequenceResponseParams 

type GenerateReflectSequenceResponseParams struct {
	// The resource URL of the light sequence, which needs to be downloaded and passed through to the SDK to start the identity verification process.
	ReflectSequenceUrl *string `json:"ReflectSequenceUrl,omitnil,omitempty" name:"ReflectSequenceUrl"`

	// The MD5 hash value of the light sequence, which is used to check whether the light sequence is altered.
	ReflectSequenceMd5 *string `json:"ReflectSequenceMd5,omitnil,omitempty" name:"ReflectSequenceMd5"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GetCardVerificationResultRequest 

type GetCardVerificationResultRequest struct {
	*tchttp.BaseRequest

	// The token used to identify an verification process. It can be used to get the verification result after the process is completed.
	CardVerificationToken *string `json:"CardVerificationToken,omitnil,omitempty" name:"CardVerificationToken"`
}

func NewGetCardVerificationResultRequest 

func NewGetCardVerificationResultRequest() (request *GetCardVerificationResultRequest)

func (*GetCardVerificationResultRequest) FromJsonString 

func (r *GetCardVerificationResultRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetCardVerificationResultRequest) ToJsonString 

func (r *GetCardVerificationResultRequest) ToJsonString() string

type GetCardVerificationResultRequestParams 

type GetCardVerificationResultRequestParams struct {
	// The token used to identify an verification process. It can be used to get the verification result after the process is completed.
	CardVerificationToken *string `json:"CardVerificationToken,omitnil,omitempty" name:"CardVerificationToken"`
}

Predefined struct for user

type GetCardVerificationResultResponse 

type GetCardVerificationResultResponse struct {
	*tchttp.BaseResponse
	Response *GetCardVerificationResultResponseParams `json:"Response"`
}

func NewGetCardVerificationResultResponse 

func NewGetCardVerificationResultResponse() (response *GetCardVerificationResultResponse)

func (*GetCardVerificationResultResponse) FromJsonString 

func (r *GetCardVerificationResultResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetCardVerificationResultResponse) ToJsonString 

func (r *GetCardVerificationResultResponse) ToJsonString() string

type GetCardVerificationResultResponseParams 

type GetCardVerificationResultResponseParams struct {
	// Pass status. When Warning and Rejected are returned, please check the specific reasons in the WarnInfo structure return. Example values are as follows:
	// Passed
	// Warning
	// Rejected
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

	// Warning information returned by document verification.
	WarnInfo []*string `json:"WarnInfo,omitnil,omitempty" name:"WarnInfo"`

	// Nationality code. Complies with standard ISO 3166-1 alpha-3.
	//
	// Example value: IDN
	Nationality *string `json:"Nationality,omitnil,omitempty" name:"Nationality"`

	// Card Type. The supported options are:
	// ID_CARD
	// PASSPORT
	// DRIVING_LICENSE
	// AUTO
	//
	// Example value: ID_CARD
	CardType *string `json:"CardType,omitnil,omitempty" name:"CardType"`

	// Subtype of the ID document.
	CardSubType *string `json:"CardSubType,omitnil,omitempty" name:"CardSubType"`

	// Recognition results of the ID document.
	CardInfo *CardInfo `json:"CardInfo,omitnil,omitempty" name:"CardInfo"`

	// The token used to identify an verification process. It can be used to get the verification result after the process is completed.
	IDVerificationToken *string `json:"IDVerificationToken,omitnil,omitempty" name:"IDVerificationToken"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GetFaceIdResultIntlRequest 

type GetFaceIdResultIntlRequest struct {
	*tchttp.BaseRequest

	// The ID of the SDK-based liveness detection and face comparison process, which is generated when the `GetFaceIdTokenIntl` API is called.
	SdkToken *string `json:"SdkToken,omitnil,omitempty" name:"SdkToken"`
}

func NewGetFaceIdResultIntlRequest 

func NewGetFaceIdResultIntlRequest() (request *GetFaceIdResultIntlRequest)

func (*GetFaceIdResultIntlRequest) FromJsonString 

func (r *GetFaceIdResultIntlRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetFaceIdResultIntlRequest) ToJsonString 

func (r *GetFaceIdResultIntlRequest) ToJsonString() string

type GetFaceIdResultIntlRequestParams 

type GetFaceIdResultIntlRequestParams struct {
	// The ID of the SDK-based liveness detection and face comparison process, which is generated when the `GetFaceIdTokenIntl` API is called.
	SdkToken *string `json:"SdkToken,omitnil,omitempty" name:"SdkToken"`
}

Predefined struct for user

type GetFaceIdResultIntlResponse 

type GetFaceIdResultIntlResponse struct {
	*tchttp.BaseResponse
	Response *GetFaceIdResultIntlResponseParams `json:"Response"`
}

func NewGetFaceIdResultIntlResponse 

func NewGetFaceIdResultIntlResponse() (response *GetFaceIdResultIntlResponse)

func (*GetFaceIdResultIntlResponse) FromJsonString 

func (r *GetFaceIdResultIntlResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetFaceIdResultIntlResponse) ToJsonString 

func (r *GetFaceIdResultIntlResponse) ToJsonString() string

type GetFaceIdResultIntlResponseParams 

type GetFaceIdResultIntlResponseParams struct {
	// The return code of the verification result.
	// 0: Succeeded.
	// 1001: System error.
	// 1004: Liveness detection and face comparison failed.
	// 2004: The image passed in is too large or too small.
	// 2012: Several faces were detected.
	// 2013: No face was detected, or the face detected was incomplete.
	// 2014: The image resolution is too low or the quality does not meet the requirements.
	// 2015: Face comparison failed.
	// 2016: The similarity did not reach the standard passing threshold.
	// -999: The verification process wasn't finished.
	Result *string `json:"Result,omitnil,omitempty" name:"Result"`

	// The description of the verification result.
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// The best frame screenshot (in Base64) obtained during the verification.
	BestFrame *string `json:"BestFrame,omitnil,omitempty" name:"BestFrame"`

	// The video file (Base64) for verification.
	Video *string `json:"Video,omitnil,omitempty" name:"Video"`

	// The similarity, with a value range of 0-100. A greater value indicates higher similarity. This parameter is returned only in the `compare` (liveness detection and face comparison) mode.
	// Note: This field may return `null`, indicating that no valid values can be obtained.
	Similarity *float64 `json:"Similarity,omitnil,omitempty" name:"Similarity"`

	// The pass-through parameter.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Extra *string `json:"Extra,omitnil,omitempty" name:"Extra"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GetFaceIdTokenIntlRequest 

type GetFaceIdTokenIntlRequest struct {
	*tchttp.BaseRequest

	// The detection mode. Valid values:
	// `liveness`: Liveness detection only.
	// `compare`: Liveness detection and face comparison.
	// Default value: `liveness`.
	CheckMode *string `json:"CheckMode,omitnil,omitempty" name:"CheckMode"`

	// The verification security level. Valid values:
	// `1`: Video-based liveness detection.
	// `2`: Motion-based liveness detection.
	// `3`: Reflection-based liveness detection.
	// `4`: Motion- and reflection-based liveness detection.
	// Default value: `4`.
	SecureLevel *string `json:"SecureLevel,omitnil,omitempty" name:"SecureLevel"`

	// The photo (in Base64) to compare. This parameter is required when the value of `CheckMode` is `compare`.
	Image *string `json:"Image,omitnil,omitempty" name:"Image"`

	// The pass-through parameter, which can be omitted if there are no special requirements.
	Extra *string `json:"Extra,omitnil,omitempty" name:"Extra"`
}

func NewGetFaceIdTokenIntlRequest 

func NewGetFaceIdTokenIntlRequest() (request *GetFaceIdTokenIntlRequest)

func (*GetFaceIdTokenIntlRequest) FromJsonString 

func (r *GetFaceIdTokenIntlRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetFaceIdTokenIntlRequest) ToJsonString 

func (r *GetFaceIdTokenIntlRequest) ToJsonString() string

type GetFaceIdTokenIntlRequestParams 

type GetFaceIdTokenIntlRequestParams struct {
	// The detection mode. Valid values:
	// `liveness`: Liveness detection only.
	// `compare`: Liveness detection and face comparison.
	// Default value: `liveness`.
	CheckMode *string `json:"CheckMode,omitnil,omitempty" name:"CheckMode"`

	// The verification security level. Valid values:
	// `1`: Video-based liveness detection.
	// `2`: Motion-based liveness detection.
	// `3`: Reflection-based liveness detection.
	// `4`: Motion- and reflection-based liveness detection.
	// Default value: `4`.
	SecureLevel *string `json:"SecureLevel,omitnil,omitempty" name:"SecureLevel"`

	// The photo (in Base64) to compare. This parameter is required when the value of `CheckMode` is `compare`.
	Image *string `json:"Image,omitnil,omitempty" name:"Image"`

	// The pass-through parameter, which can be omitted if there are no special requirements.
	Extra *string `json:"Extra,omitnil,omitempty" name:"Extra"`
}

Predefined struct for user

type GetFaceIdTokenIntlResponse 

type GetFaceIdTokenIntlResponse struct {
	*tchttp.BaseResponse
	Response *GetFaceIdTokenIntlResponseParams `json:"Response"`
}

func NewGetFaceIdTokenIntlResponse 

func NewGetFaceIdTokenIntlResponse() (response *GetFaceIdTokenIntlResponse)

func (*GetFaceIdTokenIntlResponse) FromJsonString 

func (r *GetFaceIdTokenIntlResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetFaceIdTokenIntlResponse) ToJsonString 

func (r *GetFaceIdTokenIntlResponse) ToJsonString() string

type GetFaceIdTokenIntlResponseParams 

type GetFaceIdTokenIntlResponseParams struct {
	// The SDK token, which is used throughout the verification process and to get the verification result.
	SdkToken *string `json:"SdkToken,omitnil,omitempty" name:"SdkToken"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GetLivenessResultRequest 

type GetLivenessResultRequest struct {
	*tchttp.BaseRequest

	// The token used to identify an SDK-based verification process.
	SdkToken *string `json:"SdkToken,omitnil,omitempty" name:"SdkToken"`
}

func NewGetLivenessResultRequest 

func NewGetLivenessResultRequest() (request *GetLivenessResultRequest)

func (*GetLivenessResultRequest) FromJsonString 

func (r *GetLivenessResultRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetLivenessResultRequest) ToJsonString 

func (r *GetLivenessResultRequest) ToJsonString() string

type GetLivenessResultRequestParams 

type GetLivenessResultRequestParams struct {
	// The token used to identify an SDK-based verification process.
	SdkToken *string `json:"SdkToken,omitnil,omitempty" name:"SdkToken"`
}

Predefined struct for user

type GetLivenessResultResponse 

type GetLivenessResultResponse struct {
	*tchttp.BaseResponse
	Response *GetLivenessResultResponseParams `json:"Response"`
}

func NewGetLivenessResultResponse 

func NewGetLivenessResultResponse() (response *GetLivenessResultResponse)

func (*GetLivenessResultResponse) FromJsonString 

func (r *GetLivenessResultResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetLivenessResultResponse) ToJsonString 

func (r *GetLivenessResultResponse) ToJsonString() string

type GetLivenessResultResponseParams 

type GetLivenessResultResponseParams struct {
	// The final verification result.
	Result *string `json:"Result,omitnil,omitempty" name:"Result"`

	// The description of the final verification result.
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// The face screenshot.
	BestFrame *FileInfo `json:"BestFrame,omitnil,omitempty" name:"BestFrame"`

	// The video for the detection.
	Video *FileInfo `json:"Video,omitnil,omitempty" name:"Video"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GetSdkVerificationResultRequest 

type GetSdkVerificationResultRequest struct {
	*tchttp.BaseRequest

	// The token used to identify an SDK-based verification process.
	SdkToken *string `json:"SdkToken,omitnil,omitempty" name:"SdkToken"`
}

func NewGetSdkVerificationResultRequest 

func NewGetSdkVerificationResultRequest() (request *GetSdkVerificationResultRequest)

func (*GetSdkVerificationResultRequest) FromJsonString 

func (r *GetSdkVerificationResultRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetSdkVerificationResultRequest) ToJsonString 

func (r *GetSdkVerificationResultRequest) ToJsonString() string

type GetSdkVerificationResultRequestParams 

type GetSdkVerificationResultRequestParams struct {
	// The token used to identify an SDK-based verification process.
	SdkToken *string `json:"SdkToken,omitnil,omitempty" name:"SdkToken"`
}

Predefined struct for user

type GetSdkVerificationResultResponse 

type GetSdkVerificationResultResponse struct {
	*tchttp.BaseResponse
	Response *GetSdkVerificationResultResponseParams `json:"Response"`
}

func NewGetSdkVerificationResultResponse 

func NewGetSdkVerificationResultResponse() (response *GetSdkVerificationResultResponse)

func (*GetSdkVerificationResultResponse) FromJsonString 

func (r *GetSdkVerificationResultResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetSdkVerificationResultResponse) ToJsonString 

func (r *GetSdkVerificationResultResponse) ToJsonString() string

type GetSdkVerificationResultResponseParams 

type GetSdkVerificationResultResponseParams struct {
	// The result code of the verification result.
	Result *string `json:"Result,omitnil,omitempty" name:"Result"`

	// The verification result description.
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// The charge count.
	ChargeCount *int64 `json:"ChargeCount,omitnil,omitempty" name:"ChargeCount"`

	// The results of multiple OCR processes (in order). The result of the final process is used as the valid result.
	CardVerifyResults []*CardVerifyResult `json:"CardVerifyResults,omitnil,omitempty" name:"CardVerifyResults"`

	// The results of multiple liveness detection processes (in order). The result of the final process is used as the valid result.
	CompareResults []*CompareResult `json:"CompareResults,omitnil,omitempty" name:"CompareResults"`

	// Data passed through in the process of getting the token.
	Extra *string `json:"Extra,omitnil,omitempty" name:"Extra"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GetWebVerificationResultIntlRequest 

type GetWebVerificationResultIntlRequest struct {
	*tchttp.BaseRequest

	// The token for the web-based verification, which is generated using the `ApplyWebVerificationBizTokenIntl` API.
	BizToken *string `json:"BizToken,omitnil,omitempty" name:"BizToken"`
}

func NewGetWebVerificationResultIntlRequest 

func NewGetWebVerificationResultIntlRequest() (request *GetWebVerificationResultIntlRequest)

func (*GetWebVerificationResultIntlRequest) FromJsonString 

func (r *GetWebVerificationResultIntlRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetWebVerificationResultIntlRequest) ToJsonString 

func (r *GetWebVerificationResultIntlRequest) ToJsonString() string

type GetWebVerificationResultIntlRequestParams 

type GetWebVerificationResultIntlRequestParams struct {
	// The token for the web-based verification, which is generated using the `ApplyWebVerificationBizTokenIntl` API.
	BizToken *string `json:"BizToken,omitnil,omitempty" name:"BizToken"`
}

Predefined struct for user

type GetWebVerificationResultIntlResponse 

type GetWebVerificationResultIntlResponse struct {
	*tchttp.BaseResponse
	Response *GetWebVerificationResultIntlResponseParams `json:"Response"`
}

func NewGetWebVerificationResultIntlResponse 

func NewGetWebVerificationResultIntlResponse() (response *GetWebVerificationResultIntlResponse)

func (*GetWebVerificationResultIntlResponse) FromJsonString 

func (r *GetWebVerificationResultIntlResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetWebVerificationResultIntlResponse) ToJsonString 

func (r *GetWebVerificationResultIntlResponse) ToJsonString() string

type GetWebVerificationResultIntlResponseParams 

type GetWebVerificationResultIntlResponseParams struct {
	// The final result of this verification. `0` indicates that the person is the same as that in the photo.
	// For other error codes, see <a href="https://www.tencentcloud.com/document/product/1061/55390?lang=en&pg=#8a960e1e-39c0-42cb-b181-b3164d77f81e">Liveness Detection and Face Comparison (Mobile HTML5) Error Codes</a>
	// Note: u200dThis field may return null, indicating that no valid values can be obtained.
	ErrorCode *int64 `json:"ErrorCode,omitnil,omitempty" name:"ErrorCode"`

	// The description of the final verification result.
	// Note: u200dThis field may return null, indicating that no valid values can be obtained.
	ErrorMsg *string `json:"ErrorMsg,omitnil,omitempty" name:"ErrorMsg"`

	// The detailed verification result list of this process. Retries are allowed, so a verification process may have several entries of results.
	// Note: u200dThis field may return null, indicating that no valid values can be obtained.
	VerificationDetailList []*VerificationDetail `json:"VerificationDetailList,omitnil,omitempty" name:"VerificationDetailList"`

	// The Base64-encoded string of the video collected from the video stream. Retries are allowed, and this field returns only the data collected in the last verification. If no video is collected, null is returned.
	// Note: u200dThis field may return null, indicating that no valid values can be obtained.
	VideoBase64 *string `json:"VideoBase64,omitnil,omitempty" name:"VideoBase64"`

	// The Base64-encoded string of the best face screenshot u200dcollected from the video stream. Retries are allowed, and this field returns only the data collected in the last verification. If no best face screenshot is collected, null is returned.
	// Note: u200dThis field may return null, indicating that no valid values can be obtained.
	BestFrameBase64 *string `json:"BestFrameBase64,omitnil,omitempty" name:"BestFrameBase64"`

	// Card recognize result.
	// Note: This field may return null, indicating that no valid values can be obtained.
	OCRResult []*OCRResult `json:"OCRResult,omitnil,omitempty" name:"OCRResult"`

	// The passthrough parameter of the business, max 1,000 characters, which will be returned in GetWebVerificationResultIntl.
	Extra *string `json:"Extra,omitnil,omitempty" name:"Extra"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GetWebVerificationResultRequest 

type GetWebVerificationResultRequest struct {
	*tchttp.BaseRequest

	// The token for the web-based verification, which is generated with the `ApplyWebVerificationToken` API.
	BizToken *string `json:"BizToken,omitnil,omitempty" name:"BizToken"`
}

func NewGetWebVerificationResultRequest 

func NewGetWebVerificationResultRequest() (request *GetWebVerificationResultRequest)

func (*GetWebVerificationResultRequest) FromJsonString 

func (r *GetWebVerificationResultRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetWebVerificationResultRequest) ToJsonString 

func (r *GetWebVerificationResultRequest) ToJsonString() string

type GetWebVerificationResultRequestParams 

type GetWebVerificationResultRequestParams struct {
	// The token for the web-based verification, which is generated with the `ApplyWebVerificationToken` API.
	BizToken *string `json:"BizToken,omitnil,omitempty" name:"BizToken"`
}

Predefined struct for user

type GetWebVerificationResultResponse 

type GetWebVerificationResultResponse struct {
	*tchttp.BaseResponse
	Response *GetWebVerificationResultResponseParams `json:"Response"`
}

func NewGetWebVerificationResultResponse 

func NewGetWebVerificationResultResponse() (response *GetWebVerificationResultResponse)

func (*GetWebVerificationResultResponse) FromJsonString 

func (r *GetWebVerificationResultResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetWebVerificationResultResponse) ToJsonString 

func (r *GetWebVerificationResultResponse) ToJsonString() string

type GetWebVerificationResultResponseParams 

type GetWebVerificationResultResponseParams struct {
	// The final result of this verification. `0` indicates that the person is the same as that in the photo.
	// Note: This field may return null, indicating that no valid values can be obtained.
	ErrorCode *int64 `json:"ErrorCode,omitnil,omitempty" name:"ErrorCode"`

	// The description of the final verification result.
	// Note: This field may return null, indicating that no valid values can be obtained.
	ErrorMsg *string `json:"ErrorMsg,omitnil,omitempty" name:"ErrorMsg"`

	// The temporary URL of the best face screenshot collected from the video stream. It is valid for 10 minutes. Download the image if needed.
	// Note: This field may return null, indicating that no valid values can be obtained.
	VideoBestFrameUrl *string `json:"VideoBestFrameUrl,omitnil,omitempty" name:"VideoBestFrameUrl"`

	// The MD5 hash value of the best face screenshot collected from the video stream. It can be used to check whether the image content is consistent with the file content.
	// Note: This field may return null, indicating that no valid values can be obtained.
	VideoBestFrameMd5 *string `json:"VideoBestFrameMd5,omitnil,omitempty" name:"VideoBestFrameMd5"`

	// The details list of this verification process.
	// Note: This field may return null, indicating that no valid values can be obtained.
	VerificationDetailList []*VerificationDetail `json:"VerificationDetailList,omitnil,omitempty" name:"VerificationDetailList"`

	// The temporary URL of the video collected from the video stream. It is valid for 10 minutes. Download the video if needed.
	// Note: This field may return null, indicating that no valid values can be obtained.
	VideoUrl *string `json:"VideoUrl,omitnil,omitempty" name:"VideoUrl"`

	// The MD5 hash value of the video collected from the video stream. It can be used to check whether the video content is consistent with the file content.
	// Note: This field may return null, indicating that no valid values can be obtained.
	VideoMd5 *string `json:"VideoMd5,omitnil,omitempty" name:"VideoMd5"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type HKIDCard 

type HKIDCard struct {
	CnName *string `json:"CnName,omitnil,omitempty" name:"CnName"`

	// English name
	// Note: This field may return null, indicating that no valid values can be obtained.
	// Example: SAN, Nan
	EnName *string `json:"EnName,omitnil,omitempty" name:"EnName"`

	// Telex code correspondint to the Chinese name
	// Note: This field may return null, indicating that no valid values can be obtained.
	TelexCode *string `json:"TelexCode,omitnil,omitempty" name:"TelexCode"`

	// Gender: "Male-M" or "Female-F"
	// Note: This field may return null, indicating that no valid values can be obtained.
	Sex *string `json:"Sex,omitnil,omitempty" name:"Sex"`

	// Birthday
	// Note: This field may return null, indicating that no valid values can be obtained.
	// Example: 01-01-2001
	Birthday *string `json:"Birthday,omitnil,omitempty" name:"Birthday"`

	// Permanent resident ID card: 0-non-permanent; 1-permanent; -1-unknown
	// Note: This field may return null, indicating that no valid values can be obtained.
	Permanent *string `json:"Permanent,omitnil,omitempty" name:"Permanent"`

	// ID card number
	// Note: This field may return null, indicating that no valid values can be obtained.
	// Example: C000000(E)
	IdNum *string `json:"IdNum,omitnil,omitempty" name:"IdNum"`

	// Lisence symbol, which is the symbol below Birthday. Example: "***AZ"
	// Note: This field may return null, indicating that no valid values can be obtained.
	Symbol *string `json:"Symbol,omitnil,omitempty" name:"Symbol"`

	// The first date of issue
	// Note: This field may return null, indicating that no valid values can be obtained.
	FirstIssueDate *string `json:"FirstIssueDate,omitnil,omitempty" name:"FirstIssueDate"`

	// The current date of issue
	// Note: This field may return null, indicating that no valid values can be obtained.
	CurrentIssueDate *string `json:"CurrentIssueDate,omitnil,omitempty" name:"CurrentIssueDate"`
}

type IndonesiaDrivingLicense 

type IndonesiaDrivingLicense struct {
	// Last name
	// Note: This field may return null, indicating that no valid values can be obtained.
	LastName *string `json:"LastName,omitnil,omitempty" name:"LastName"`

	// First name
	// Note: This field may return null, indicating that no valid values can be obtained.
	FirstName *string `json:"FirstName,omitnil,omitempty" name:"FirstName"`

	// License number
	// Note: This field may return null, indicating that no valid values can be obtained.
	LicenseNumber *string `json:"LicenseNumber,omitnil,omitempty" name:"LicenseNumber"`

	// Birthday
	// Note: This field may return null, indicating that no valid values can be obtained.
	Birthday *string `json:"Birthday,omitnil,omitempty" name:"Birthday"`

	// Address
	// Note: This field may return null, indicating that no valid values can be obtained.
	Address *string `json:"Address,omitnil,omitempty" name:"Address"`

	// Expiration date
	// Note: This field may return null, indicating that no valid values can be obtained.
	ExpirationDate *string `json:"ExpirationDate,omitnil,omitempty" name:"ExpirationDate"`

	// Date of issue
	// Note: This field may return null, indicating that no valid values can be obtained.
	IssuedDate *string `json:"IssuedDate,omitnil,omitempty" name:"IssuedDate"`

	// Issuing country
	// Note: This field may return null, indicating that no valid values can be obtained.
	IssuedCountry *string `json:"IssuedCountry,omitnil,omitempty" name:"IssuedCountry"`
}

type IndonesiaIDCard 

type IndonesiaIDCard struct {
	// License number
	// Note: This field may return null, indicating that no valid values can be obtained.
	NIK *string `json:"NIK,omitnil,omitempty" name:"NIK"`

	// Name
	// Note: This field may return null, indicating that no valid values can be obtained.
	Nama *string `json:"Nama,omitnil,omitempty" name:"Nama"`

	// Birth place/Birthday
	// Note: This field may return null, indicating that no valid values can be obtained.
	TempatTglLahir *string `json:"TempatTglLahir,omitnil,omitempty" name:"TempatTglLahir"`

	// Gender
	// Note: This field may return null, indicating that no valid values can be obtained.
	JenisKelamin *string `json:"JenisKelamin,omitnil,omitempty" name:"JenisKelamin"`

	// Blood type
	// Note: This field may return null, indicating that no valid values can be obtained.
	GolDarah *string `json:"GolDarah,omitnil,omitempty" name:"GolDarah"`

	// Address
	// Note: This field may return null, indicating that no valid values can be obtained.
	Alamat *string `json:"Alamat,omitnil,omitempty" name:"Alamat"`

	// Street
	// Note: This field may return null, indicating that no valid values can be obtained.
	RTRW *string `json:"RTRW,omitnil,omitempty" name:"RTRW"`

	// Village
	// Note: This field may return null, indicating that no valid values can be obtained.
	KelDesa *string `json:"KelDesa,omitnil,omitempty" name:"KelDesa"`

	// Region
	// Note: This field may return null, indicating that no valid values can be obtained.
	Kecamatan *string `json:"Kecamatan,omitnil,omitempty" name:"Kecamatan"`

	// Religious beliefs
	// Note: This field may return null, indicating that no valid values can be obtained.
	Agama *string `json:"Agama,omitnil,omitempty" name:"Agama"`

	// Marital status
	// Note: This field may return null, indicating that no valid values can be obtained.
	StatusPerkawinan *string `json:"StatusPerkawinan,omitnil,omitempty" name:"StatusPerkawinan"`

	// Job
	// Note: This field may return null, indicating that no valid values can be obtained.
	Perkerjaan *string `json:"Perkerjaan,omitnil,omitempty" name:"Perkerjaan"`

	// Nationality
	// Note: This field may return null, indicating that no valid values can be obtained.
	KewargaNegaraan *string `json:"KewargaNegaraan,omitnil,omitempty" name:"KewargaNegaraan"`

	// ID card validity period
	// Note: This field may return null, indicating that no valid values can be obtained.
	BerlakuHingga *string `json:"BerlakuHingga,omitnil,omitempty" name:"BerlakuHingga"`

	// Date of issue
	// Note: This field may return null, indicating that no valid values can be obtained.
	IssuedDate *string `json:"IssuedDate,omitnil,omitempty" name:"IssuedDate"`

	// Province
	// Note: This field may return null, indicating that no valid values can be obtained.
	Provinsi *string `json:"Provinsi,omitnil,omitempty" name:"Provinsi"`

	// City
	// Note: This field may return null, indicating that no valid values can be obtained.
	Kota *string `json:"Kota,omitnil,omitempty" name:"Kota"`
}

type InternationalIDPassport 

type InternationalIDPassport struct {
	// Passport ID
	// Note: This field may return null, indicating that no valid values can be obtained.
	LicenseNumber *string `json:"LicenseNumber,omitnil,omitempty" name:"LicenseNumber"`

	// Full name
	// Note: This field may return null, indicating that no valid values can be obtained.
	FullName *string `json:"FullName,omitnil,omitempty" name:"FullName"`

	// Last name
	// Note: This field may return null, indicating that no valid values can be obtained.
	Surname *string `json:"Surname,omitnil,omitempty" name:"Surname"`

	// First name
	// Note: This field may return null, indicating that no valid values can be obtained.
	GivenName *string `json:"GivenName,omitnil,omitempty" name:"GivenName"`

	// Birthday
	// Note: This field may return null, indicating that no valid values can be obtained.
	Birthday *string `json:"Birthday,omitnil,omitempty" name:"Birthday"`

	// Gender (F-Female, M-Male)
	// Note: This field may return null, indicating that no valid values can be obtained.
	Sex *string `json:"Sex,omitnil,omitempty" name:"Sex"`

	// Expiration date
	// Note: This field may return null, indicating that no valid values can be obtained.
	DateOfExpiration *string `json:"DateOfExpiration,omitnil,omitempty" name:"DateOfExpiration"`

	// Issuing country
	// Note: This field may return null, indicating that no valid values can be obtained.
	IssuingCountry *string `json:"IssuingCountry,omitnil,omitempty" name:"IssuingCountry"`

	// Nationality code
	// Note: This field may return null, indicating that no valid values can be obtained.
	NationalityCode *string `json:"NationalityCode,omitnil,omitempty" name:"NationalityCode"`

	// The first line at the bottom, the MRZ Code sequence
	// Note: This field may return null, indicating that no valid values can be obtained.
	PassportCodeFirst *string `json:"PassportCodeFirst,omitnil,omitempty" name:"PassportCodeFirst"`

	// The second line at the bottom, the MRZ Code sequence
	// Note: This field may return null, indicating that no valid values can be obtained.
	PassportCodeSecond *string `json:"PassportCodeSecond,omitnil,omitempty" name:"PassportCodeSecond"`
}

type LivenessCompareRequest 

type LivenessCompareRequest struct {
	*tchttp.BaseRequest

	// Liveness detection type. Valid values: LIP/ACTION/SILENT.
	// LIP: numeric mode; ACTION: motion mode; SILENT: silent mode. You need to select a mode to input.
	LivenessType *string `json:"LivenessType,omitnil,omitempty" name:"LivenessType"`

	// Base64 string of the image for face comparison.
	// The size of the Base64-encoded image data can be up to 3 MB. JPG and PNG formats are supported.
	// Please use the standard Base64 encoding scheme (with the "=" padding). For the encoding conventions, please see RFC 4648.
	//
	// Either the `ImageUrl` or `ImageBase64` of the image must be provided. If both are provided, only `ImageBase64` will be used.
	ImageBase64 *string `json:"ImageBase64,omitnil,omitempty" name:"ImageBase64"`

	// URL of the image for face comparison. The size of the downloaded image after Base64 encoding can be up to 3 MB. JPG and PNG formats are supported.
	//
	// Either the `ImageUrl` or `ImageBase64` of the image must be provided. If both are provided, only `ImageBase64` will be used.
	//
	// We recommend you store the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low.
	ImageUrl *string `json:"ImageUrl,omitnil,omitempty" name:"ImageUrl"`

	// Lip mode: set this parameter to a custom 4-digit verification code.
	// Action mode: set this parameter to a custom action sequence (e.g., `2,1` or `1,2`).
	// Silent mode: do not pass in this parameter.
	ValidateData *string `json:"ValidateData,omitnil,omitempty" name:"ValidateData"`

	// Optional configuration (a JSON string)
	// {
	// "BestFrameNum": 2  // Return multiple best screenshots. Value range: 2−10
	// }
	Optional *string `json:"Optional,omitnil,omitempty" name:"Optional"`

	// Base64 string of the video for liveness detection.
	// The size of the Base64-encoded video data can be up to 8 MB. MP4, AVI, and FLV formats are supported.
	// Please use the standard Base64 encoding scheme (with the "=" padding). For the encoding conventions, please see RFC 4648.
	//
	// Either the `VideoUrl` or `VideoBase64` of the video must be provided. If both are provided, only `VideoBase64` will be used.
	VideoBase64 *string `json:"VideoBase64,omitnil,omitempty" name:"VideoBase64"`

	// URL of the video for liveness detection. The size of the downloaded video after Base64 encoding can be up to 8 MB. It takes no more than 4 seconds to download. MP4, AVI, and FLV formats are supported.
	//
	// Either the `VideoUrl` or `VideoBase64` of the video must be provided. If both are provided, only `VideoBase64` will be used.
	//
	// We recommend you store the video in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low.
	VideoUrl *string `json:"VideoUrl,omitnil,omitempty" name:"VideoUrl"`
}

func NewLivenessCompareRequest 

func NewLivenessCompareRequest() (request *LivenessCompareRequest)

func (*LivenessCompareRequest) FromJsonString 

func (r *LivenessCompareRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*LivenessCompareRequest) ToJsonString 

func (r *LivenessCompareRequest) ToJsonString() string

type LivenessCompareRequestParams 

type LivenessCompareRequestParams struct {
	// Liveness detection type. Valid values: LIP/ACTION/SILENT.
	// LIP: numeric mode; ACTION: motion mode; SILENT: silent mode. You need to select a mode to input.
	LivenessType *string `json:"LivenessType,omitnil,omitempty" name:"LivenessType"`

	// Base64 string of the image for face comparison.
	// The size of the Base64-encoded image data can be up to 3 MB. JPG and PNG formats are supported.
	// Please use the standard Base64 encoding scheme (with the "=" padding). For the encoding conventions, please see RFC 4648.
	//
	// Either the `ImageUrl` or `ImageBase64` of the image must be provided. If both are provided, only `ImageBase64` will be used.
	ImageBase64 *string `json:"ImageBase64,omitnil,omitempty" name:"ImageBase64"`

	// URL of the image for face comparison. The size of the downloaded image after Base64 encoding can be up to 3 MB. JPG and PNG formats are supported.
	//
	// Either the `ImageUrl` or `ImageBase64` of the image must be provided. If both are provided, only `ImageBase64` will be used.
	//
	// We recommend you store the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low.
	ImageUrl *string `json:"ImageUrl,omitnil,omitempty" name:"ImageUrl"`

	// Lip mode: set this parameter to a custom 4-digit verification code.
	// Action mode: set this parameter to a custom action sequence (e.g., `2,1` or `1,2`).
	// Silent mode: do not pass in this parameter.
	ValidateData *string `json:"ValidateData,omitnil,omitempty" name:"ValidateData"`

	// Optional configuration (a JSON string)
	// {
	// "BestFrameNum": 2  // Return multiple best screenshots. Value range: 2−10
	// }
	Optional *string `json:"Optional,omitnil,omitempty" name:"Optional"`

	// Base64 string of the video for liveness detection.
	// The size of the Base64-encoded video data can be up to 8 MB. MP4, AVI, and FLV formats are supported.
	// Please use the standard Base64 encoding scheme (with the "=" padding). For the encoding conventions, please see RFC 4648.
	//
	// Either the `VideoUrl` or `VideoBase64` of the video must be provided. If both are provided, only `VideoBase64` will be used.
	VideoBase64 *string `json:"VideoBase64,omitnil,omitempty" name:"VideoBase64"`

	// URL of the video for liveness detection. The size of the downloaded video after Base64 encoding can be up to 8 MB. It takes no more than 4 seconds to download. MP4, AVI, and FLV formats are supported.
	//
	// Either the `VideoUrl` or `VideoBase64` of the video must be provided. If both are provided, only `VideoBase64` will be used.
	//
	// We recommend you store the video in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low.
	VideoUrl *string `json:"VideoUrl,omitnil,omitempty" name:"VideoUrl"`
}

Predefined struct for user

type LivenessCompareResponse 

type LivenessCompareResponse struct {
	*tchttp.BaseResponse
	Response *LivenessCompareResponseParams `json:"Response"`
}

func NewLivenessCompareResponse 

func NewLivenessCompareResponse() (response *LivenessCompareResponse)

func (*LivenessCompareResponse) FromJsonString 

func (r *LivenessCompareResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*LivenessCompareResponse) ToJsonString 

func (r *LivenessCompareResponse) ToJsonString() string

type LivenessCompareResponseParams 

type LivenessCompareResponseParams struct {
	// The best screenshot of the video after successful verification. The photo is Base64-encoded and in JPG format.
	BestFrameBase64 *string `json:"BestFrameBase64,omitnil,omitempty" name:"BestFrameBase64"`

	// Similarity. Value range: [0.00, 100.00]. As a recommendation, when the similarity is greater than or equal to 70, it can be determined that the two faces are of the same person. You can adjust the threshold according to your specific scenario (the FAR at the threshold of 70 is 0.1%, and FAR at the threshold of 80 is 0.01%).
	Sim *float64 `json:"Sim,omitnil,omitempty" name:"Sim"`

	// Service error code. `Success` will be returned for success. For error information, please see the `FailedOperation` section in the error code list below.
	Result *string `json:"Result,omitnil,omitempty" name:"Result"`

	// Service result description.
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	BestFrameList []*string `json:"BestFrameList,omitnil,omitempty" name:"BestFrameList"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type MLIDCard 

type MLIDCard struct {
	// Full Name
	// Note: This field may return null, indicating that no valid values can be obtained.
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// License number
	// Note: This field may return null, indicating that no valid values can be obtained.
	ID *string `json:"ID,omitnil,omitempty" name:"ID"`

	// Gender
	// Note: This field may return null, indicating that no valid values can be obtained.
	Sex *string `json:"Sex,omitnil,omitempty" name:"Sex"`

	// Address
	// Note: This field may return null, indicating that no valid values can be obtained.
	Address *string `json:"Address,omitnil,omitempty" name:"Address"`

	// Lisence type
	// MyKad ID card
	// MyPR Permanent resident ID card
	// MyTentera Military ID card
	// MyKAS Temporary ID card
	// POLIS Police ID card
	// IKAD Labor ID card
	// MyKid Juvenile ID card
	// Example: MyKad
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`

	// Birthday (Currently, this filed only supports IKAD labor ID card and MyKad ID card)
	// Note: This field may return null, indicating that no valid values can be obtained.
	Birthday *string `json:"Birthday,omitnil,omitempty" name:"Birthday"`
}

type MacaoIDCard 

type MacaoIDCard struct {
	// First name
	// Note: This field may return null, indicating that no valid values can be obtained.
	FirstName *string `json:"FirstName,omitnil,omitempty" name:"FirstName"`

	// Last name
	// Note: This field may return null, indicating that no valid values can be obtained.
	LastName *string `json:"LastName,omitnil,omitempty" name:"LastName"`

	// Birthday
	// Note: This field may return null, indicating that no valid values can be obtained.
	Birthday *string `json:"Birthday,omitnil,omitempty" name:"Birthday"`

	// Expiration date
	// Note: This field may return null, indicating that no valid values can be obtained.
	ExpirationDate *string `json:"ExpirationDate,omitnil,omitempty" name:"ExpirationDate"`

	// License number
	// Note: This field may return null, indicating that no valid values can be obtained.
	LicenseNumber *string `json:"LicenseNumber,omitnil,omitempty" name:"LicenseNumber"`

	// Sex
	// Note: This field may return null, indicating that no valid values can be obtained.
	Sex *string `json:"Sex,omitnil,omitempty" name:"Sex"`

	// Age
	// Note: This field may return null, indicating that no valid values can be obtained.
	Age *string `json:"Age,omitnil,omitempty" name:"Age"`

	// Issued country
	// Note: This field may return null, indicating that no valid values can be obtained.
	IssuedCountry *string `json:"IssuedCountry,omitnil,omitempty" name:"IssuedCountry"`

	// MRZ1 on card
	// Note: This field may return null, indicating that no valid values can be obtained.
	Field1 *string `json:"Field1,omitnil,omitempty" name:"Field1"`

	// MRZ2 on card
	// Note: This field may return null, indicating that no valid values can be obtained.
	Field2 *string `json:"Field2,omitnil,omitempty" name:"Field2"`
}

type MainlandIDCard 

type MainlandIDCard struct {
	// Chinese name
	// Note: This field may return null, indicating that no valid values can be obtained.
	FullName *string `json:"FullName,omitnil,omitempty" name:"FullName"`

	// Sex
	// Note: This field may return null, indicating that no valid values can be obtained.
	Sex *string `json:"Sex,omitnil,omitempty" name:"Sex"`

	// Nation
	// Note: This field may return null, indicating that no valid values can be obtained.
	Nation *string `json:"Nation,omitnil,omitempty" name:"Nation"`

	// Birthday
	// Note: This field may return null, indicating that no valid values can be obtained.
	Birthday *string `json:"Birthday,omitnil,omitempty" name:"Birthday"`

	// Address
	// Note: This field may return null, indicating that no valid values can be obtained.
	//
	// Deprecated: Address is deprecated.
	Address *string `json:"Address,omitnil,omitempty" name:"Address"`

	// License number
	// Note: This field may return null, indicating that no valid values can be obtained.
	LicenseNumber *string `json:"LicenseNumber,omitnil,omitempty" name:"LicenseNumber"`

	// Address
	// Note: This field may return null, indicating that no valid values can be obtained.
	FormattedAddress *string `json:"FormattedAddress,omitnil,omitempty" name:"FormattedAddress"`
}

type NormalCardInfo 

type NormalCardInfo struct {
	// Hong Kong ID Card
	// Note: This field may return null, indicating that no valid values can be obtained.
	HKIDCard *NormalHKIDCard `json:"HKIDCard,omitnil,omitempty" name:"HKIDCard"`

	// Malaysia ID Card
	// Note: This field may return null, indicating that no valid values can be obtained.
	MLIDCard *NormalMLIDCard `json:"MLIDCard,omitnil,omitempty" name:"MLIDCard"`

	// Philippines VoteID Card
	// Note: This field may return null, indicating that no valid values can be obtained.
	PhilippinesVoteID *PhilippinesVoteID `json:"PhilippinesVoteID,omitnil,omitempty" name:"PhilippinesVoteID"`

	// Indonesia ID Card
	// Note: This field may return null, indicating that no valid values can be obtained.
	IndonesiaIDCard *NormalIndonesiaIDCard `json:"IndonesiaIDCard,omitnil,omitempty" name:"IndonesiaIDCard"`

	// Philippines Driving License
	// Note: This field may return null, indicating that no valid values can be obtained.
	PhilippinesDrivingLicense *PhilippinesDrivingLicense `json:"PhilippinesDrivingLicense,omitnil,omitempty" name:"PhilippinesDrivingLicense"`

	// Philippines TinID
	// Note: This field may return null, indicating that no valid values can be obtained.
	PhilippinesTinID *PhilippinesTinID `json:"PhilippinesTinID,omitnil,omitempty" name:"PhilippinesTinID"`

	// Philippines SSSID
	// Note: This field may return null, indicating that no valid values can be obtained.
	PhilippinesSSSID *PhilippinesSSSID `json:"PhilippinesSSSID,omitnil,omitempty" name:"PhilippinesSSSID"`

	// Philippines UMID
	// Note: This field may return null, indicating that no valid values can be obtained.
	PhilippinesUMID *PhilippinesUMID `json:"PhilippinesUMID,omitnil,omitempty" name:"PhilippinesUMID"`

	// ID Cards of Hong Kong, Macao and Taiwan (China), and International Passport
	// Note: This field may return null, indicating that no valid values can be obtained.
	InternationalIDPassport *InternationalIDPassport `json:"InternationalIDPassport,omitnil,omitempty" name:"InternationalIDPassport"`

	// General license information
	// Note: This field may return null, indicating that no valid values can be obtained.
	GeneralCard *GeneralCard `json:"GeneralCard,omitnil,omitempty" name:"GeneralCard"`

	// Indonesia Driving License
	// Note: This field may return null, indicating that no valid values can be obtained.
	IndonesiaDrivingLicense *IndonesiaDrivingLicense `json:"IndonesiaDrivingLicense,omitnil,omitempty" name:"IndonesiaDrivingLicense"`

	// Thailand ID Card
	// Note: This field may return null, indicating that no valid values can be obtained.
	ThailandIDCard *NormalThailandIDCard `json:"ThailandIDCard,omitnil,omitempty" name:"ThailandIDCard"`

	// Singapore ID Card
	// Note: This field may return null, indicating that no valid values can be obtained.
	SingaporeIDCard *SingaporeIDCard `json:"SingaporeIDCard,omitnil,omitempty" name:"SingaporeIDCard"`

	// Macao ID Card
	// Note: This field may return null, indicating that no valid values can be obtained.
	MacaoIDCard *MacaoIDCard `json:"MacaoIDCard,omitnil,omitempty" name:"MacaoIDCard"`

	// Mainland ID Card
	// Note: This field may return null, indicating that no valid values can be obtained.
	MainlandIDCard *MainlandIDCard `json:"MainlandIDCard,omitnil,omitempty" name:"MainlandIDCard"`
}

type NormalHKIDCard 

type NormalHKIDCard struct {
	// Chinese name
	// Note: This field may return null, indicating that no valid values can be obtained.
	ChineseName *string `json:"ChineseName,omitnil,omitempty" name:"ChineseName"`

	// English name
	// Note: This field may return null, indicating that no valid values can be obtained.
	// Example: SAN, Nan
	FullName *string `json:"FullName,omitnil,omitempty" name:"FullName"`

	// Telex code correspondint to the Chinese name
	// Note: This field may return null, indicating that no valid values can be obtained.
	RegistrationNumber *string `json:"RegistrationNumber,omitnil,omitempty" name:"RegistrationNumber"`

	// Gender: "Male-M" or "Female-F"
	// Note: This field may return null, indicating that no valid values can be obtained.
	Sex *string `json:"Sex,omitnil,omitempty" name:"Sex"`

	// Birthday
	// Note: This field may return null, indicating that no valid values can be obtained.
	// Example: 01-01-2001
	Birthday *string `json:"Birthday,omitnil,omitempty" name:"Birthday"`

	// Permanent resident ID card: 0-non-permanent; 1-permanent; -1-unknown
	// Note: This field may return null, indicating that no valid values can be obtained.
	Permanent *string `json:"Permanent,omitnil,omitempty" name:"Permanent"`

	// ID card number
	// Note: This field may return null, indicating that no valid values can be obtained.
	// Example: C000000(E)
	LicenseNumber *string `json:"LicenseNumber,omitnil,omitempty" name:"LicenseNumber"`

	// Lisence symbol, which is the symbol below Birthday. Example: "***AZ"
	// Note: This field may return null, indicating that no valid values can be obtained.
	Symbol *string `json:"Symbol,omitnil,omitempty" name:"Symbol"`

	// The first date of issue
	// Note: This field may return null, indicating that no valid values can be obtained.
	IssuedDate *string `json:"IssuedDate,omitnil,omitempty" name:"IssuedDate"`

	// The current date of issue
	// Note: This field may return null, indicating that no valid values can be obtained.
	CurrentIssueDate *string `json:"CurrentIssueDate,omitnil,omitempty" name:"CurrentIssueDate"`
}

type NormalIndonesiaIDCard 

type NormalIndonesiaIDCard struct {
	// License number
	// Note: This field may return null, indicating that no valid values can be obtained.
	LicenseNumber *string `json:"LicenseNumber,omitnil,omitempty" name:"LicenseNumber"`

	// Name
	// Note: This field may return null, indicating that no valid values can be obtained.
	FullName *string `json:"FullName,omitnil,omitempty" name:"FullName"`

	// Birth place/Birthday
	// Note: This field may return null, indicating that no valid values can be obtained.
	Birthday *string `json:"Birthday,omitnil,omitempty" name:"Birthday"`

	// Gender
	// Note: This field may return null, indicating that no valid values can be obtained.
	Sex *string `json:"Sex,omitnil,omitempty" name:"Sex"`

	// Blood type
	// Note: This field may return null, indicating that no valid values can be obtained.
	BloodType *string `json:"BloodType,omitnil,omitempty" name:"BloodType"`

	// Address
	// Note: This field may return null, indicating that no valid values can be obtained.
	FormattedAddress *string `json:"FormattedAddress,omitnil,omitempty" name:"FormattedAddress"`

	// Street
	// Note: This field may return null, indicating that no valid values can be obtained.
	Street *string `json:"Street,omitnil,omitempty" name:"Street"`

	// Village
	// Note: This field may return null, indicating that no valid values can be obtained.
	Village *string `json:"Village,omitnil,omitempty" name:"Village"`

	// Region
	// Note: This field may return null, indicating that no valid values can be obtained.
	Area *string `json:"Area,omitnil,omitempty" name:"Area"`

	// Religious beliefs
	// Note: This field may return null, indicating that no valid values can be obtained.
	Religion *string `json:"Religion,omitnil,omitempty" name:"Religion"`

	// Marital status
	// Note: This field may return null, indicating that no valid values can be obtained.
	MaritalStatus *string `json:"MaritalStatus,omitnil,omitempty" name:"MaritalStatus"`

	// Job
	// Note: This field may return null, indicating that no valid values can be obtained.
	Occupation *string `json:"Occupation,omitnil,omitempty" name:"Occupation"`

	// Nationality
	// Note: This field may return null, indicating that no valid values can be obtained.
	Nationality *string `json:"Nationality,omitnil,omitempty" name:"Nationality"`

	// ID card validity period
	// Note: This field may return null, indicating that no valid values can be obtained.
	DueDate *string `json:"DueDate,omitnil,omitempty" name:"DueDate"`

	// Date of issue
	// Note: This field may return null, indicating that no valid values can be obtained.
	IssuedDate *string `json:"IssuedDate,omitnil,omitempty" name:"IssuedDate"`

	// Province
	// Note: This field may return null, indicating that no valid values can be obtained.
	Province *string `json:"Province,omitnil,omitempty" name:"Province"`

	// City
	// Note: This field may return null, indicating that no valid values can be obtained.
	City *string `json:"City,omitnil,omitempty" name:"City"`
}

type NormalMLIDCard 

type NormalMLIDCard struct {
	// Full Name
	// Note: This field may return null, indicating that no valid values can be obtained.
	FullName *string `json:"FullName,omitnil,omitempty" name:"FullName"`

	// License number
	// Note: This field may return null, indicating that no valid values can be obtained.
	LicenseNumber *string `json:"LicenseNumber,omitnil,omitempty" name:"LicenseNumber"`

	// Gender
	// Note: This field may return null, indicating that no valid values can be obtained.
	Sex *string `json:"Sex,omitnil,omitempty" name:"Sex"`

	// Address
	// Note: This field may return null, indicating that no valid values can be obtained.
	FormattedAddress *string `json:"FormattedAddress,omitnil,omitempty" name:"FormattedAddress"`

	// Lisence type
	// MyKad ID card
	// MyPR Permanent resident ID card
	// MyTentera Military ID card
	// MyKAS Temporary ID card
	// POLIS Police ID card
	// IKAD Labor ID card
	// MyKid Juvenile ID card
	// Example: MyKad
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`

	// Birthday (Currently, this filed only supports IKAD labor ID card and MyKad ID card)
	// Note: This field may return null, indicating that no valid values can be obtained.
	Birthday *string `json:"Birthday,omitnil,omitempty" name:"Birthday"`
}

type NormalThailandIDCard 

type NormalThailandIDCard struct {
	// LicenseNumber
	// Note: This field may return null, indicating that no valid values can be obtained.
	LicenseNumber *string `json:"LicenseNumber,omitnil,omitempty" name:"LicenseNumber"`

	// Thailand name
	// Note: This field may return null, indicating that no valid values can be obtained.
	FullName *string `json:"FullName,omitnil,omitempty" name:"FullName"`

	// Last name
	// Note: This field may return null, indicating that no valid values can be obtained.
	LastName *string `json:"LastName,omitnil,omitempty" name:"LastName"`

	// First name
	// Note: This field may return null, indicating that no valid values can be obtained.
	FirstName *string `json:"FirstName,omitnil,omitempty" name:"FirstName"`

	// Birthday
	// Note: This field may return null, indicating that no valid values can be obtained.
	Birthday *string `json:"Birthday,omitnil,omitempty" name:"Birthday"`

	// Address
	// Note: This field may return null, indicating that no valid values can be obtained.
	FormattedAddress *string `json:"FormattedAddress,omitnil,omitempty" name:"FormattedAddress"`

	// Expiration date
	// Note: This field may return null, indicating that no valid values can be obtained.
	ExpirationDate *string `json:"ExpirationDate,omitnil,omitempty" name:"ExpirationDate"`

	// Issued date
	// Note: This field may return null, indicating that no valid values can be obtained.
	IssuedDate *string `json:"IssuedDate,omitnil,omitempty" name:"IssuedDate"`

	// Registration number
	// Note: This field may return null, indicating that no valid values can be obtained.
	RegistrationNumber *string `json:"RegistrationNumber,omitnil,omitempty" name:"RegistrationNumber"`

	// Religion
	// Note: This field may return null, indicating that no valid values can be obtained.
	Religion *string `json:"Religion,omitnil,omitempty" name:"Religion"`

	// Birthday in Thai
	// Note: This field may return null, indicating that no valid values can be obtained.
	ThaiBirthday *string `json:"ThaiBirthday,omitnil,omitempty" name:"ThaiBirthday"`

	// Expiration date in Thai
	// Note: This field may return null, indicating that no valid values can be obtained.
	ThaiExpirationDate *string `json:"ThaiExpirationDate,omitnil,omitempty" name:"ThaiExpirationDate"`

	// Issued date in Thai
	// Note: This field may return null, indicating that no valid values can be obtained.
	ThaiIssueDate *string `json:"ThaiIssueDate,omitnil,omitempty" name:"ThaiIssueDate"`
}

type OCRResult 

type OCRResult struct {
	// Is the indentity verification or OCR process passed
	IsPass *bool `json:"IsPass,omitnil,omitempty" name:"IsPass"`

	// The Base64 of ID card image
	// Note: This field may return null, indicating that no valid values can be obtained.
	CardImageBase64 *string `json:"CardImageBase64,omitnil,omitempty" name:"CardImageBase64"`

	// OCR result of the ID card.
	CardInfo *CardInfo `json:"CardInfo,omitnil,omitempty" name:"CardInfo"`

	// The request id
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`

	// Base64 of cropped image of ID card
	CardCutImageBase64 *string `json:"CardCutImageBase64,omitnil,omitempty" name:"CardCutImageBase64"`

	// Base64 of the cropped image on the reverse side of the ID card
	CardBackCutImageBase64 *string `json:"CardBackCutImageBase64,omitnil,omitempty" name:"CardBackCutImageBase64"`
}

type PhilippinesDrivingLicense 

type PhilippinesDrivingLicense struct {
	// Full Name
	// Note: This field may return null, indicating that no valid values can be obtained.
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// Last name
	//
	// Note: This field may return null, indicating that no valid values can be obtained.
	LastName *string `json:"LastName,omitnil,omitempty" name:"LastName"`

	// First name
	// Note: This field may return null, indicating that no valid values can be obtained.
	FirstName *string `json:"FirstName,omitnil,omitempty" name:"FirstName"`

	// Middle name
	// Note: This field may return null, indicating that no valid values can be obtained.
	MiddleName *string `json:"MiddleName,omitnil,omitempty" name:"MiddleName"`

	// Nationality
	// Note: This field may return null, indicating that no valid values can be obtained.
	Nationality *string `json:"Nationality,omitnil,omitempty" name:"Nationality"`

	// Gender
	// Note: This field may return null, indicating that no valid values can be obtained.
	Sex *string `json:"Sex,omitnil,omitempty" name:"Sex"`

	// Address
	// Note: This field may return null, indicating that no valid values can be obtained.
	Address *string `json:"Address,omitnil,omitempty" name:"Address"`

	// License number
	// Note: This field may return null, indicating that no valid values can be obtained.
	LicenseNo *string `json:"LicenseNo,omitnil,omitempty" name:"LicenseNo"`

	// Date of expiry
	// Note: This field may return null, indicating that no valid values can be obtained.
	ExpiresDate *string `json:"ExpiresDate,omitnil,omitempty" name:"ExpiresDate"`

	// Agency code
	// Note: This field may return null, indicating that no valid values can be obtained.
	AgencyCode *string `json:"AgencyCode,omitnil,omitempty" name:"AgencyCode"`

	// Birthday
	// Note: This field may return null, indicating that no valid values can be obtained.
	Birthday *string `json:"Birthday,omitnil,omitempty" name:"Birthday"`
}

type PhilippinesSSSID 

type PhilippinesSSSID struct {
	// License number
	// Note: This field may return null, indicating that no valid values can be obtained.
	LicenseNumber *string `json:"LicenseNumber,omitnil,omitempty" name:"LicenseNumber"`

	// Full name
	// Note: This field may return null, indicating that no valid values can be obtained.
	FullName *string `json:"FullName,omitnil,omitempty" name:"FullName"`

	// Birthday
	// Note: This field may return null, indicating that no valid values can be obtained.
	Birthday *string `json:"Birthday,omitnil,omitempty" name:"Birthday"`
}

type PhilippinesTinID 

type PhilippinesTinID struct {
	// License number
	// Note: This field may return null, indicating that no valid values can be obtained.
	LicenseNumber *string `json:"LicenseNumber,omitnil,omitempty" name:"LicenseNumber"`

	// Full name
	// Note: This field may return null, indicating that no valid values can be obtained.
	FullName *string `json:"FullName,omitnil,omitempty" name:"FullName"`

	// Address
	// Note: This field may return null, indicating that no valid values can be obtained.
	Address *string `json:"Address,omitnil,omitempty" name:"Address"`

	// Birthday
	// Note: This field may return null, indicating that no valid values can be obtained.
	Birthday *string `json:"Birthday,omitnil,omitempty" name:"Birthday"`

	// Date of issue
	// Note: This field may return null, indicating that no valid values can be obtained.
	IssueDate *string `json:"IssueDate,omitnil,omitempty" name:"IssueDate"`
}

type PhilippinesUMID 

type PhilippinesUMID struct {
	// Surname
	// Note: This field may return null, indicating that no valid values can be obtained.
	Surname *string `json:"Surname,omitnil,omitempty" name:"Surname"`

	// Middle Name
	// Note: This field may return null, indicating that no valid values can be obtained.
	MiddleName *string `json:"MiddleName,omitnil,omitempty" name:"MiddleName"`

	// First name
	// Note: This field may return null, indicating that no valid values can be obtained.
	GivenName *string `json:"GivenName,omitnil,omitempty" name:"GivenName"`

	// Gender
	// Note: This field may return null, indicating that no valid values can be obtained.
	Sex *string `json:"Sex,omitnil,omitempty" name:"Sex"`

	// Birthday
	// Note: This field may return null, indicating that no valid values can be obtained.
	Birthday *string `json:"Birthday,omitnil,omitempty" name:"Birthday"`

	// Address
	// Note: This field may return null, indicating that no valid values can be obtained.
	Address *string `json:"Address,omitnil,omitempty" name:"Address"`

	// CRN code
	// Note: This field may return null, indicating that no valid values can be obtained.
	CRN *string `json:"CRN,omitnil,omitempty" name:"CRN"`
}

type PhilippinesVoteID 

type PhilippinesVoteID struct {
	// VIN of Philippines VoteID
	// Note: This field may return null, indicating that no valid values can be obtained.
	VIN *string `json:"VIN,omitnil,omitempty" name:"VIN"`

	// First name
	// Note: This field may return null, indicating that no valid values can be obtained.
	FirstName *string `json:"FirstName,omitnil,omitempty" name:"FirstName"`

	// Last name
	// Note: This field may return null, indicating that no valid values can be obtained.
	LastName *string `json:"LastName,omitnil,omitempty" name:"LastName"`

	// Birthday
	// Note: This field may return null, indicating that no valid values can be obtained.
	Birthday *string `json:"Birthday,omitnil,omitempty" name:"Birthday"`

	// Civil status
	// Note: This field may return null, indicating that no valid values can be obtained.
	CivilStatus *string `json:"CivilStatus,omitnil,omitempty" name:"CivilStatus"`

	// Nationality
	// Note: This field may return null, indicating that no valid values can be obtained.
	Citizenship *string `json:"Citizenship,omitnil,omitempty" name:"Citizenship"`

	// Address
	// Note: This field may return null, indicating that no valid values can be obtained.
	Address *string `json:"Address,omitnil,omitempty" name:"Address"`

	// Region
	// Note: This field may return null, indicating that no valid values can be obtained.
	PrecinctNo *string `json:"PrecinctNo,omitnil,omitempty" name:"PrecinctNo"`
}

type SingaporeIDCard 

type SingaporeIDCard struct {
	// Chinese name
	// Note: This field may return null, indicating that no valid values can be obtained.
	ChName *string `json:"ChName,omitnil,omitempty" name:"ChName"`

	// English name
	// Note: This field may return null, indicating that no valid values can be obtained.
	EnName *string `json:"EnName,omitnil,omitempty" name:"EnName"`

	// License number
	// Note: This field may return null, indicating that no valid values can be obtained.
	ID *string `json:"ID,omitnil,omitempty" name:"ID"`

	// Gender
	// Note: This field may return null, indicating that no valid values can be obtained.
	Sex *string `json:"Sex,omitnil,omitempty" name:"Sex"`

	// Country of birth
	// Note: This field may return null, indicating that no valid values can be obtained.
	CountryOfBirth *string `json:"CountryOfBirth,omitnil,omitempty" name:"CountryOfBirth"`

	// Birthday
	// Note: This field may return null, indicating that no valid values can be obtained.
	Birthday *string `json:"Birthday,omitnil,omitempty" name:"Birthday"`

	// Address (on the back)
	// Note: This field may return null, indicating that no valid values can be obtained.
	Address *string `json:"Address,omitnil,omitempty" name:"Address"`

	// Nationality (on the back)
	// Note: This field may return null, indicating that no valid values can be obtained.
	Race *string `json:"Race,omitnil,omitempty" name:"Race"`

	//  NRIC number (on the back)
	// Note: This field may return null, indicating that no valid values can be obtained.
	NRICCode *string `json:"NRICCode,omitnil,omitempty" name:"NRICCode"`

	// Post number (on the front)
	// Note: This field may return null, indicating that no valid values can be obtained.
	PostCode *string `json:"PostCode,omitnil,omitempty" name:"PostCode"`

	// Date of expiry (on the back)
	// Note: This field may return null, indicating that no valid values can be obtained.
	DateOfExpiration *string `json:"DateOfExpiration,omitnil,omitempty" name:"DateOfExpiration"`

	// Date of issue (on the back)
	// Note: This field may return null, indicating that no valid values can be obtained.
	DateOfIssue *string `json:"DateOfIssue,omitnil,omitempty" name:"DateOfIssue"`
}

type ThailandIDCard 

type ThailandIDCard struct {
	// Last name
	// Note: This field may return null, indicating that no valid values can be obtained.
	LastName *string `json:"LastName,omitnil,omitempty" name:"LastName"`

	// First name
	// Note: This field may return null, indicating that no valid values can be obtained.
	FirstName *string `json:"FirstName,omitnil,omitempty" name:"FirstName"`

	// License number
	// Note: This field may return null, indicating that no valid values can be obtained.
	LicenseNumber *string `json:"LicenseNumber,omitnil,omitempty" name:"LicenseNumber"`

	// Birthday
	// Note: This field may return null, indicating that no valid values can be obtained.
	DateOfBirth *string `json:"DateOfBirth,omitnil,omitempty" name:"DateOfBirth"`

	// Date of expiry
	// Note: This field may return null, indicating that no valid values can be obtained.
	DateOfExpiry *string `json:"DateOfExpiry,omitnil,omitempty" name:"DateOfExpiry"`

	// Date of issue
	// Note: This field may return null, indicating that no valid values can be obtained.
	DateOfIssue *string `json:"DateOfIssue,omitnil,omitempty" name:"DateOfIssue"`

	// Issuing country
	// Note: This field may return null, indicating that no valid values can be obtained.
	IssuedCountry *string `json:"IssuedCountry,omitnil,omitempty" name:"IssuedCountry"`
}

type VerificationDetail 

type VerificationDetail struct {
	// The final result of this verification. `0` indicates that the person is the same as that in the photo.
	// Note: u200dThis field may return null, indicating that no valid values can be obtained.
	ErrorCode *int64 `json:"ErrorCode,omitnil,omitempty" name:"ErrorCode"`

	// The description of the final verification result.
	// Note: u200dThis field may return null, indicating that no valid values can be obtained.
	ErrorMsg *string `json:"ErrorMsg,omitnil,omitempty" name:"ErrorMsg"`

	// The result of this liveness detection process. `0` indicates success.
	// Note: u200dThis field may return null, indicating that no valid values can be obtained.
	LivenessErrorCode *int64 `json:"LivenessErrorCode,omitnil,omitempty" name:"LivenessErrorCode"`

	// The result description of this liveness detection process.
	// Note: This field may return null, indicating that no valid values can be obtained.
	LivenessErrorMsg *string `json:"LivenessErrorMsg,omitnil,omitempty" name:"LivenessErrorMsg"`

	// The result of this comparison process. `0` indicates that the person in the best face screenshot collected from the video stream is the same as that in the uploaded image for comparison.
	// Note: u200dThis field may return null, indicating that no valid values can be obtained.
	CompareErrorCode *int64 `json:"CompareErrorCode,omitnil,omitempty" name:"CompareErrorCode"`

	// The result description of this comparison process.
	// Note: u200dThis field may return null, indicating that no valid values can be obtained.
	CompareErrorMsg *string `json:"CompareErrorMsg,omitnil,omitempty" name:"CompareErrorMsg"`

	// The timestamp (ms) of this verification process.
	// Note: This field may return null, indicating that no valid values can be obtained.
	ReqTimestamp *uint64 `json:"ReqTimestamp,omitnil,omitempty" name:"ReqTimestamp"`

	// The similarity of the best face screenshot collected from the video stream and the uploaded image for comparison in this verification process. Value range: [0.00, 100.00]. By default, the person in the screenshot is determined to be the same person in the image if the similarity is greater than or equal to 70.
	// Note: u200dThis field may return null, indicating that no valid values can be obtained.
	Similarity *float64 `json:"Similarity,omitnil,omitempty" name:"Similarity"`

	// Unique ID of this verification process.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Seq *string `json:"Seq,omitnil,omitempty" name:"Seq"`
}

type VideoLivenessCompareRequest 

type VideoLivenessCompareRequest struct {
	*tchttp.BaseRequest

	// The URL of the photo for face comparison. The downloaded image after Base64 encoding can be up to 3 MB and must be in JPG or PNG.
	//
	// The image must be stored in a COS bucket in the region where the FaceID service resides to ensure a higher download speed and better stability. You can generate an image URL by using `CreateUploadUrl` or purchase the COS service.
	ImageUrl *string `json:"ImageUrl,omitnil,omitempty" name:"ImageUrl"`

	// The 32-bit MD5 checksum of the image for comparison
	ImageMd5 *string `json:"ImageMd5,omitnil,omitempty" name:"ImageMd5"`

	// The URL of the video for liveness detection. The downloaded video after Base64 encoding can be up to 8 MB and must be in MP4, AVI, or FLV. It takes no more than 4s to download the video.
	//
	// The video must be stored in a COS bucket in the region where the FaceID service resides to ensure a higher download speed and better stability. You can generate a video URL by using `CreateUploadUrl` or purchase the COS service.
	VideoUrl *string `json:"VideoUrl,omitnil,omitempty" name:"VideoUrl"`

	// The 32-bit MD5 checksum of the video
	VideoMd5 *string `json:"VideoMd5,omitnil,omitempty" name:"VideoMd5"`

	// The liveness detection type. Valid values: `LIP`, `ACTION`, and `SILENT`.
	// `LIP`: Numeric mode; `ACTION`: Motion mode; `SILENT`: silent mode. Select one of them.
	LivenessType *string `json:"LivenessType,omitnil,omitempty" name:"LivenessType"`

	// LIP parameter: Pass in a custom 4-digit verification code.
	// ACTION parameter: Pass in a custom action sequence (`2,1` or `1,2`).
	// SILENT parameter: Null.
	ValidateData *string `json:"ValidateData,omitnil,omitempty" name:"ValidateData"`
}

func NewVideoLivenessCompareRequest 

func NewVideoLivenessCompareRequest() (request *VideoLivenessCompareRequest)

func (*VideoLivenessCompareRequest) FromJsonString 

func (r *VideoLivenessCompareRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*VideoLivenessCompareRequest) ToJsonString 

func (r *VideoLivenessCompareRequest) ToJsonString() string

type VideoLivenessCompareRequestParams 

type VideoLivenessCompareRequestParams struct {
	// The URL of the photo for face comparison. The downloaded image after Base64 encoding can be up to 3 MB and must be in JPG or PNG.
	//
	// The image must be stored in a COS bucket in the region where the FaceID service resides to ensure a higher download speed and better stability. You can generate an image URL by using `CreateUploadUrl` or purchase the COS service.
	ImageUrl *string `json:"ImageUrl,omitnil,omitempty" name:"ImageUrl"`

	// The 32-bit MD5 checksum of the image for comparison
	ImageMd5 *string `json:"ImageMd5,omitnil,omitempty" name:"ImageMd5"`

	// The URL of the video for liveness detection. The downloaded video after Base64 encoding can be up to 8 MB and must be in MP4, AVI, or FLV. It takes no more than 4s to download the video.
	//
	// The video must be stored in a COS bucket in the region where the FaceID service resides to ensure a higher download speed and better stability. You can generate a video URL by using `CreateUploadUrl` or purchase the COS service.
	VideoUrl *string `json:"VideoUrl,omitnil,omitempty" name:"VideoUrl"`

	// The 32-bit MD5 checksum of the video
	VideoMd5 *string `json:"VideoMd5,omitnil,omitempty" name:"VideoMd5"`

	// The liveness detection type. Valid values: `LIP`, `ACTION`, and `SILENT`.
	// `LIP`: Numeric mode; `ACTION`: Motion mode; `SILENT`: silent mode. Select one of them.
	LivenessType *string `json:"LivenessType,omitnil,omitempty" name:"LivenessType"`

	// LIP parameter: Pass in a custom 4-digit verification code.
	// ACTION parameter: Pass in a custom action sequence (`2,1` or `1,2`).
	// SILENT parameter: Null.
	ValidateData *string `json:"ValidateData,omitnil,omitempty" name:"ValidateData"`
}

Predefined struct for user

type VideoLivenessCompareResponse 

type VideoLivenessCompareResponse struct {
	*tchttp.BaseResponse
	Response *VideoLivenessCompareResponseParams `json:"Response"`
}

func NewVideoLivenessCompareResponse 

func NewVideoLivenessCompareResponse() (response *VideoLivenessCompareResponse)

func (*VideoLivenessCompareResponse) FromJsonString 

func (r *VideoLivenessCompareResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*VideoLivenessCompareResponse) ToJsonString 

func (r *VideoLivenessCompareResponse) ToJsonString() string

type VideoLivenessCompareResponseParams 

type VideoLivenessCompareResponseParams struct {
	// The similarity. Value range: [0.00, 100.00]. As a recommendation, when the similarity is greater than or equal to 70, it can be determined that the two persons are of the same person. You can adjust the threshold according to your specific scenario (the FARs at the thresholds of 70 and 80 are 0.1% and 0.01%, respectively).
	Sim *float64 `json:"Sim,omitnil,omitempty" name:"Sim"`

	// The service error code. `Success` will be returned for success. For error information, see the `FailedOperation` section in the error code list below.
	Result *string `json:"Result,omitnil,omitempty" name:"Result"`

	// The service result description
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// The best video screenshot after successful verification
	// Note: This field may return null, indicating that no valid values can be obtained.
	BestFrame *FileInfo `json:"BestFrame,omitnil,omitempty" name:"BestFrame"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type WebVerificationConfigIntl 

type WebVerificationConfigIntl struct {
	// When starting verification, whether to skip the starting verification page. If true, enter the verification process directly. The default is false. This configuration will not take effect if the downgrade policy is triggered.
	AutoSkipStartPage *bool `json:"AutoSkipStartPage,omitnil,omitempty" name:"AutoSkipStartPage"`

	// When the verification passed, whether to skip the result page and automatically jump to RedirectURL. The default value is false.
	// Example value: false
	AutoSkip *bool `json:"AutoSkip,omitnil,omitempty" name:"AutoSkip"`

	// Detection mode, parameter values are as follows:
	// 1: OCR+living detection & face comparison;
	// 2: Living detection & face comparison;
	// 3: Living detection;
	// The default value is 2.
	// Example value: 3
	CheckMode *int64 `json:"CheckMode,omitnil,omitempty" name:"CheckMode"`

	// The type of lisence used for verification. The following types are supported.
	// 1.HKIDCard: Hong Kong (China) ID card
	// 2.MLIDCard: Malaysia ID card
	// 3.IndonesiaIDCard: Indonesia ID card
	// 4.PhilippinesVoteID: Philippines VoteID card
	// 5.PhilippinesDrivingLicense: Philippines driving license
	// 6.PhilippinesTinID: Philippines TinID card
	// 7.PhilippinesSSSID: Philippines SSSID card
	// 8.PhilippinesUMID: Philippines UMID card
	// 9.InternationalIDPassport: ID cards of Hong Kong, Macao and Taiwan (China), and international passport.
	// Example: HKIDCard
	IDCardType *string `json:"IDCardType,omitnil,omitempty" name:"IDCardType"`

	// Whether to turn off document alarms, the default is false (the alarm detection function is turned on). When enabled, the identity authentication process will be intercepted based on the alarm status of the certificate. If you need to use the document authentication function, please contact us.
	DisableCheckOcrWarnings *bool `json:"DisableCheckOcrWarnings,omitnil,omitempty" name:"DisableCheckOcrWarnings"`

	// Liveness security level: 1:Silent mode;2:Action mode;3:Lighting mode;4:Action+Lighting mode;default value is 3
	SecurityLevel *int64 `json:"SecurityLevel,omitnil,omitempty" name:"SecurityLevel"`

	// Whether to skip the agreement page, the default is false. When SkipPrivacyPolicy is false, the agreement page will be displayed and the privacy agreement needs to be checked; when SkipPrivacyPolicy is true, the agreement page will be skipped and the liveness process will be entered directly without checking the privacy agreement page.
	SkipPrivacyPolicy *bool `json:"SkipPrivacyPolicy,omitnil,omitempty" name:"SkipPrivacyPolicy"`

	// The default value is false. If it is false, the original ID image will be displayed. If it is true, the cut ID image will be displayed.
	IdCardCutReturn *bool `json:"IdCardCutReturn,omitnil,omitempty" name:"IdCardCutReturn"`

	// Front-end theme color, in the format of RGB hexadecimal color code. The default value is "#2d72+1". If the format is incorrect, the default value color will be used.
	ThemeColor *string `json:"ThemeColor,omitnil,omitempty" name:"ThemeColor"`

	// International language, the default value is en (English). Currently supported: th: Thai; en: English;
	Language *string `json:"Language,omitnil,omitempty" name:"Language"`

	// Automatic downgrade mode, with the following parameter values: 1: Downgrade to silent live mode; 2: Disable downgrade mode. The default value is 1.
	AutoDowngrade *int64 `json:"AutoDowngrade,omitnil,omitempty" name:"AutoDowngrade"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.