{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-cloudauth-intl/add-face-record":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_add_face_record","summary":"Adds a face image to a specified face library","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FaceGroupCode","ProductCode"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"FaceGroupCode":{"type":"string","description":"The face library code"},"ProductCode":{"type":"string","description":"The product code"},"MerchantUserId":{"type":"string","description":"The custom unique user ID. The value cannot exceed 32 characters. If this parameter is specified, the system registers the user with the…"},"FacePicture":{"type":"string","description":"The Base64-encoded face image to register"},"FacePictureUrl":{"type":"string","description":"The URL of the face image to register"},"FacePictureFile":{"type":"string","description":"The file stream of the face image to register"},"FaceQualityCheck":{"type":"string","description":"Specifies whether to check the quality of the face image. Valid values: Y: enabled. N: disabled (default)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/address-compare-intl":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_address_compare_intl","summary":"Compares the similarity of two addresses","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProductCode","Text1","Text2","DefaultCountry"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"ProductCode":{"type":"string","description":"ADD_VERIFY"},"Text1":{"type":"string","description":"Address 1"},"Text2":{"type":"string","description":"Address 2"},"DefaultCountry":{"type":"string","description":"The country name. Valid values: China"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/address-verify-v2-intl":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_address_verify_v2_intl","summary":"Verifies an address","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProductCode","RegCountry","DeviceToken"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"ProductCode":{"type":"string","description":"The product code. Set the value to ADD_VERIFY_PRO"},"VerifyType":{"type":"string","description":"The address verification method. Valid values: HOME: Home address verification. WORK: Work address verification"},"Mobile":{"type":"string","description":"The mobile phone number. Only mobile phone numbers in the Chinese mainland are supported"},"RegCountry":{"type":"string","description":"The list of prohibited countries"},"Text":{"type":"string","description":"The detailed address text"},"DeviceToken":{"type":"string","description":"The device token used for risk identification"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/bank-meta-verify-intl":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_bank_meta_verify_intl","summary":"Provides the API operation for bank card elements, including two-element, three-element, and four-element…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProductCode","ParamType","VerifyMode","ProductType","BankCard","UserName"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"ProductCode":{"type":"string","description":"The fixed value. Valid value: BANK_CARD_N_META"},"ParamType":{"type":"string","description":"The encryption method. Valid values: normal: No encryption. md5: MD5 encryption. Important: The ciphertext of all parameters must be a…"},"VerifyMode":{"type":"string","description":"The verification mode. Valid value: VERIFY_BANK_CARD. This value indicates the bank card authentication mode, which verifies whether the…"},"ProductType":{"type":"string","description":"The product type. Valid values: BANK_CARD_2_META: Verifies the bank card number and name. BANK_CARD_3_META: Verifies the bank card number,…"},"BankCard":{"type":"string","description":"The bank card number. If paramType is set to normal, enter the plaintext bank card number. If paramType is set to md5, enter the plaintext…"},"UserName":{"type":"string","description":"The name. If paramType is set to normal, enter the plaintext name. If paramType is set to md5, enter the 32-character lowercase MD5 hash…"},"IdentityType":{"type":"string","description":"The type of the identification document. If you leave this parameter empty, the default value is ID card. For other types of…"},"IdentifyNum":{"type":"string","description":"The identification document number. If paramType is set to normal, enter the plaintext identification document number. If paramType is set…"},"Mobile":{"type":"string","description":"The mobile phone number. If paramType is set to normal, enter the plaintext mobile phone number. If paramType is set to md5, enter the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/check-result":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_check_result","summary":"Queries the detailed results of an authentication task. This operation is part of the SDK integration…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"MerchantBizId":{"type":"string","description":"The custom unique business identifier on the merchant side, which is used for subsequent troubleshooting. It supports a combination of…"},"TransactionId":{"type":"string","description":"The authentication ID"},"IsReturnImage":{"type":"string","description":"Specifies whether to return images. Valid values: Y: Returns images. N: Does not return images"},"ExtraImageControlList":{"type":"string","description":"The additional information to return"},"ReturnFiveCategorySpoofResult":{"type":"string","description":"Specifies whether to return the anti-spoofing detection results"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/check-verify-log":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_check_verify_log","summary":"Authentication log query","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"MerchantBizId":{"type":"string","description":"The merchant-side custom business unique identifier, used for subsequent troubleshooting. The value supports a combination of letters and…"},"TransactionId":{"type":"string","description":"The unique identifier of the entire authentication process. Obtain this value by calling the Initialize operation"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/credential-get-result-intl":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_credential_get_result_intl","summary":"Queries the credential recognition results","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TransactionId"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"TransactionId":{"type":"string","description":"The unique identifier of the authentication request"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/credential-recognition-intl":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_credential_recognition_intl","summary":"An API operation that uploads a credential image, such as a utility bill or credit card statement, and uses…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProductCode","DocType","OcrArea","FraudCheck"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"ProductCode":{"type":"string","description":"The product solution to use. Set the value to CREDENTIAL_RECOGNITION"},"CredentialOcrPictureBase64":{"type":"string","description":"The Base64-encoded image. If you choose to pass in the image by using IdOcrPictureBase64 (Base64-encoded photo), check the photo size and…"},"CredentialOcrPictureUrl":{"type":"string","description":"The URL of the image. The URL must be a publicly accessible HTTP or HTTPS link"},"DocType":{"type":"string","description":"The credential type. Valid values: 01: transaction credential (including electronic bill images for water, electricity, gas, credit card,…"},"OcrArea":{"type":"string","description":"The extraction type. Valid values: 0101: electronic bill address and name module (extracts the address and name module through intelligent…"},"FraudCheck":{"type":"string","description":"Specifies whether to enable tampering detection. Valid values: true: Enabled. false: Disabled"},"IdQuality":{"type":"string","description":"Specifies whether to enable quality detection. Valid values: Y: Enabled. N: Disabled"},"CheckRuleConfig":{"type":"string","description":"The field check rule configuration, in JSON string format"},"OcrValueStandard":{"type":"string","description":"Specifies whether to enable OCR result normalization. Valid values: 0: Disabled. 1: Enabled"},"OcrTranslation":{"type":"string","description":"Specifies whether to enable translation. Valid values: 0: Disabled. 1: Enabled"},"FileInputType":{"type":"string","description":"The input file type. Valid values: IMAGE (default): image. PDF: PDF format"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/credential-recognition-intl-v2":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_credential_recognition_intl_v2","summary":"Provides an API operation to upload credential images, such as utility bills and credit card statements, and…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProductCode","DocType","OcrArea","FraudCheck"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"ProductCode":{"type":"string","description":"The product solution to be integrated. Valid value: CREDENTIAL_RECOGNITION"},"CredentialOcrPictureBase64":{"type":"string","description":"The Base64-encoded image. If you choose to pass the photo by using IdOcrPictureBase64, check the photo size and do not pass excessively…"},"CredentialOcrPictureUrl":{"type":"string","description":"The image URL. The URL must be a publicly accessible HTTP or HTTPS link"},"DocType":{"type":"string","description":"The credential type. Valid values: 01: transaction receipt, including electronic bills for utilities and credit cards 02: vehicle…"},"OcrArea":{"type":"string","description":"The extraction type. Valid values: 0101: electronic bill address and name module, which extracts the address and name module through…"},"FraudCheck":{"type":"string","description":"Specifies whether to enable tampering detection. Valid values: true: enables tampering detection. false: disables tampering detection"},"IdQuality":{"type":"string","description":"Specifies whether to enable quality detection. Valid values: Y: enables quality detection. N: disables quality detection"},"CheckRuleConfig":{"type":"string","description":"The field validation rule configuration. The value is a JSON string"},"OcrValueStandard":{"type":"string","description":"Specifies whether to enable OCR result standardization. Valid values: 0: disables OCR result standardization. 1: enables OCR result…"},"OcrTranslation":{"type":"string","description":"Specifies whether to enable translation. Valid values: 0: disables translation. 1: enables translation"},"FileInputType":{"type":"string","description":"The material input type. Valid values: IMAGE: image PDF: PDF format Default value: IMAGE"},"CredentialOcrPictureFile":{"type":"string","description":"The image file stream"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/credential-submit-intl":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_credential_submit_intl","summary":"Submits credential recognition information","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProductCode","SceneCode","MerchantBizId","DocType","OcrArea","FraudCheck"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"ProductCode":{"type":"string","description":"The product solution to use. Set this parameter to CREDENTIAL_RECOGNITION"},"SceneCode":{"type":"string","description":"The custom authentication scenario ID. You can use this scenario ID to query related records in the console. The value can be a…"},"MerchantBizId":{"type":"string","description":"The custom business unique identifier on the merchant side, used for subsequent troubleshooting. The value can be a combination of letters…"},"CredentialOcrPictureBase64":{"type":"string","description":"The Base64-encoded image. If you use this method to submit a photo, check the photo size and do not submit an excessively large photo"},"CredentialOcrPictureUrl":{"type":"string","description":"The URL of the image. The URL must be a publicly accessible HTTP or HTTPS link"},"DocType":{"type":"string","description":"The credential type. Valid values: 02: vehicle registration certificate"},"OcrArea":{"type":"string","description":"The extraction type. Valid values: 0201: Thailand vehicle registration certificate"},"FraudCheck":{"type":"string","description":"Specifies whether to enable tampering detection. Valid values: true: Enabled. false: Disabled"},"IdQuality":{"type":"string","description":"Specifies whether to enable quality detection. Valid values: Y: Enabled. N: Disabled"},"CheckRuleConfig":{"type":"string","description":"The field validation rule configuration in JSON string format"},"OcrValueStandard":{"type":"string","description":"Specifies whether to enable OCR result standardization. Valid values: 0: Disabled. 1: Enabled"},"OcrTranslation":{"type":"string","description":"Specifies whether to enable translation. Valid values: 0: Disabled. 1: Enabled"},"FileInputType":{"type":"string","description":"The input file type. Valid values: IMAGE (default): image. PDF: PDF format"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/credential-submit-intl-v2":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_credential_submit_intl_v2","summary":"Submits credential recognition information","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProductCode","MerchantBizId","DocType","OcrArea","FraudCheck","SceneCode"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"ProductCode":{"type":"string","description":"The product solution to be integrated. Valid values: CREDENTIAL_RECOGNITION"},"MerchantBizId":{"type":"string","description":"The unique identifier of the merchant request. The value is a 32-character alphanumeric string. The first few characters consist of a…"},"CredentialOcrPictureBase64":{"type":"string","description":"The Base64-encoded image. If you choose this method to upload the photo, check the photo size and do not upload excessively large photos"},"CredentialOcrPictureUrl":{"type":"string","description":"The image URL. The URL must be an HTTP or HTTPS link accessible over the Internet"},"DocType":{"type":"string","description":"The credential type. Valid values: 01: transaction credential, including electronic bill images for water, electricity, gas, and credit…"},"OcrArea":{"type":"string","description":"The extraction type. Valid values: 0101: electronic bill address and name module, which extracts the address and name module through…"},"FraudCheck":{"type":"string","description":"Specifies whether to enable tampering detection. Valid values: true: enabled false: disabled"},"IdQuality":{"type":"string","description":"Specifies whether to enable quality detection. Valid values: Y: enabled, N: disabled"},"CheckRuleConfig":{"type":"string","description":"The field validation rule configuration. The value is a JSON string"},"OcrValueStandard":{"type":"string","description":"Specifies whether to enable standardization of key fields in OCR recognition. Valid values: 0: no (default) 1: yes"},"OcrTranslation":{"type":"string","description":"Specifies whether to enable translation. Valid values: 0: disabled, 1: enabled"},"FileInputType":{"type":"string","description":"The material input type. Valid values: IMAGE: image (default) PDF: PDF format"},"CredentialOcrPictureFile":{"type":"string","description":"The image file stream"},"SceneCode":{"type":"string","description":"The custom authentication scenario ID. This ID is used to query related records in the console. The value can be up to 10 characters in…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/credential-verify-intl":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_credential_verify_intl","summary":"Provides the API operation for the credential verification service. This operation uses a large language…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CredType","CredName","ProductCode"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"CredType":{"type":"string","description":"The credential type. Valid values: 03: enterprise qualification 04: transaction voucher"},"CredName":{"type":"string","description":"The credential name (specified as a numeric code). Valid values: Codes starting with 03: enterprise qualification 0301: business license…"},"ImageUrl":{"type":"string","description":"The URL of the image. Specify either ImageUrl or ImageFile"},"ImageFile":{"type":"string","description":"The image input stream. Specify either ImageUrl or ImageFile"},"ProductCode":{"type":"string","description":"The call mode. Valid values: ANTI_FAKE_CHECK: image quality and tampering detection"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/deepfake-detect-intl":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_deepfake_detect_intl","summary":"Detects deepfake risks in facial images","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProductCode","MerchantBizId"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"ProductCode":{"type":"string","description":"The product solution to use. Set the value to FACE_DEEPFAKE"},"SceneCode":{"type":"string","description":"The custom scene ID for authentication. You can use this scene ID to query related records in the console. The value can be up to 10…"},"MerchantBizId":{"type":"string","description":"The unique identifier of the merchant request. The value is a 32-character combination of letters and digits. The first few characters are…"},"FaceInputType":{"type":"string","description":"Set the value to IMAGE to specify a facial image"},"FaceUrl":{"type":"string","description":"The URL of the facial image. Specify either FaceUrl or FaceBase64"},"FaceBase64":{"type":"string","description":"The Base64-encoded content of the facial image. Specify either FaceUrl or FaceBase64"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/deepfake-detect-intl-stream":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_deepfake_detect_intl_stream","summary":"Provides face deepfake detection capabilities for ID Verification, which can be independently integrated…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"ProductCode":{"type":"string","description":"The product solution to be integrated. Valid values: FACE_DEEPFAKE"},"SceneCode":{"type":"string","description":"The custom authentication scenario ID, which is used to query related records in the console. The value must be 10 characters in length…"},"MerchantBizId":{"type":"string","description":"The unique identifier of the merchant request. The value must be a 32-character alphanumeric string. The prefix consists of a custom…"},"FaceInputType":{"type":"string","description":"The input type of the face material. Valid values: IMAGE: face image. This is the default value. VIDEO: face video. Note: Video processing…"},"FaceUrl":{"type":"string","description":"The URL of the face image"},"FaceBase64":{"type":"string","description":"The Base64-encoded string of the face image. For videos, we recommend that you pass the data as a stream"},"FaceFile":{"type":"string","description":"The input stream of the image"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/delete-face-group":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_delete_face_group","summary":"Deletes a face library","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"Id":{"type":"string","description":"The primary key ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/delete-face-record":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_delete_face_record","summary":"Deletes a face record","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"Id":{"type":"string","description":"The primary key ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/delete-face-record-v2":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_delete_face_record_v2","summary":"Deletes a face record","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["MerchantUserId"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"MerchantUserId":{"type":"string","description":"The unique user identifier, which must be consistent with the one used when calling AddFaceRecord. If this parameter was not specified…"},"FaceGroupCode":{"type":"string","description":"The face group code. If this parameter is not specified, the face data of the user is deleted from all face groups"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/delete-verify-result":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_delete_verify_result","summary":"Deletes data related to a user authentication record","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"TransactionId":{"type":"string","description":"The unique identifier of the authentication request"},"DeleteAfterQuery":{"type":"string","description":"Specifies whether the deletion depends on the query operation"},"DeleteType":{"type":"string","description":"The type of data to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/doc-ocr":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_doc_ocr","summary":"Provides server-side card and certificate OCR capabilities","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"MerchantBizId":{"type":"string","description":"The custom business unique identifier on the merchant side, used for subsequent issue tracking and troubleshooting. The value can be a…"},"MerchantUserId":{"type":"string","description":"The custom user ID in the business. Ensure that the value is unique"},"IdOcrPictureBase64":{"type":"string","description":"The Base64-encoded card or certificate image. If you use IdOcrPictureBase64 (Base64-encoded photo) to submit the certificate photo, check…"},"IdOcrPictureUrl":{"type":"string","description":"The URL of the front side of the certificate image"},"DocType":{"type":"string","description":"The certificate type"},"ProductCode":{"type":"string","description":"The product code"},"Ocr":{"type":"string","description":"Specifies whether to perform certificate OCR. Valid values: T: OCR is required. F: OCR is not required"},"IdFaceQuality":{"type":"string","description":"Specifies whether to perform certificate face quality detection. Valid values: T: Detection is required. F: Detection is not required.…"},"Spoof":{"type":"string","description":"Specifies whether to enable anti-spoofing detection. Valid values: T: Anti-spoofing is enabled. F: Anti-spoofing is disabled"},"IdThreshold":{"type":"string","description":"The custom OCR quality detection threshold mode. Valid values: 0: system default 1: strict mode 2: loose mode 3 (default): quality…"},"CardSide":{"type":"string","description":"Specifies the side of the certificate to distinguish between the national emblem side and the portrait side. If this parameter is not…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/doc-ocr-max":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_doc_ocr_max","summary":"Recognizes global identity documents through OCR","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"ProductCode":{"type":"string","description":"The product solution to use. Set this parameter to ID_OCR_MAX"},"SceneCode":{"type":"string","description":"The custom authentication scenario ID. You can use this scenario ID to query related records in the console. The value can contain up to…"},"MerchantBizId":{"type":"string","description":"The custom unique business identifier, which is used for subsequent troubleshooting. The value can contain up to 32 characters, including…"},"MerchantUserId":{"type":"string","description":"The custom user ID or another identifier that can identify a specific user, such as a phone number or email address. We strongly recommend…"},"IdOcrPictureBase64":{"type":"string","description":"The Base64-encoded image of the card or certificate. If you use IdOcrPictureBase64 to pass in the document image, check the image size and…"},"IdOcrPictureUrl":{"type":"string","description":"The URL of the card or certificate image. The URL must be a publicly accessible HTTP or HTTPS link"},"OcrModel":{"type":"string","description":"The OCR recognition mode. Valid values: 0: general document recognition mode (default). 1: automatic document classification mode. 2:…"},"DocType":{"type":"string","description":"The document type. Format: country code + document type abbreviation + page (optional). Note: OcrModel = 0: DocType is required. Specify…"},"Prompt":{"type":"string","description":"This field is deprecated."},"Spoof":{"type":"string","description":"This field is deprecated."},"IdThreshold":{"type":"string","description":"The custom OCR quality detection threshold mode. Valid values: 0: system default. 1: strict mode. 2: loose mode. 3 (default): quality…"},"IdSpoof":{"type":"string","description":"Specifies whether to enable the document anti-forgery feature. Valid values: T: enabled. F (default): disabled"},"DocPage":{"type":"string","description":"The expected page to recognize. Valid values: 01 (default): the portrait side of the document. 02: the back side of the document"},"OcrValueStandard":{"type":"string","description":"Specifies whether to enable OCR key field standardization. Valid values: 0: no (default). 1: yes"},"Authorize":{"type":"string","description":"Specifies whether to enable authoritative data source verification to enhance document anti-forgery capabilities. T: enabled. F: disabled…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/doc-ocr-max-v2":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_doc_ocr_max_v2","summary":"Recognizes global identity documents by using optical character recognition (OCR)","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"ProductCode":{"type":"string","description":"The product solution to integrate. Valid value: ID_OCR_MAX"},"SceneCode":{"type":"string","description":"The custom authentication scenario ID. You can use this ID to query related records in the console later. The value can be up to 10…"},"MerchantBizId":{"type":"string","description":"The custom unique business identifier on the merchant side. This identifier is used for subsequent troubleshooting. The value can be up to…"},"MerchantUserId":{"type":"string","description":"The custom user ID or another identifier that can identify a specific user, such as a mobile phone number or an email address. Desensitize…"},"IdOcrPictureBase64":{"type":"string","description":"The Base64-encoded image of the identity document. If you use the IdOcrPictureBase64 parameter to pass the Base64-encoded image, check the…"},"IdOcrPictureUrl":{"type":"string","description":"The URL of the identity document image. The URL must be a publicly accessible HTTP or HTTPS link"},"OcrModel":{"type":"string","description":"The OCR recognition mode. Valid values: 0: general identity document recognition mode (default). 1: automatic identity document…"},"DocType":{"type":"string","description":"The type of the identity document. Format: country code + identity document type abbreviation + page (optional). If OcrModel is set to 0,…"},"IdThreshold":{"type":"string","description":"The custom threshold mode for OCR quality detection. Valid values: 0: system default. 1: strict mode. 2: loose mode. 3: quality detection…"},"IdSpoof":{"type":"string","description":"Specifies whether to enable the identity document anti-spoofing feature. Valid values: T: enabled. F: disabled. This is the default value"},"DocPage":{"type":"string","description":"The page to be recognized. Valid values: 01: the portrait side of the identity document. This is the default value. 02: the back side of…"},"OcrValueStandard":{"type":"string","description":"Specifies whether to enable standardization for key OCR fields. Valid values: 0: disabled. This is the default value. 1: enabled"},"Authorize":{"type":"string","description":"Specifies whether to enable authoritative data source verification to enhance the anti-spoofing capability of identity documents. Valid…"},"IdOcrPictureFile":{"type":"string","description":"The file stream of the identity document image"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/doc-ocr-v2":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_doc_ocr_v2","summary":"Performs server-side optical character recognition (OCR) on ID cards","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"MerchantBizId":{"type":"string","description":"The custom unique business identifier on the merchant side, which is used for subsequent troubleshooting. The identifier supports a…"},"MerchantUserId":{"type":"string","description":"The custom user ID in your business system. Ensure that the ID is unique"},"IdOcrPictureBase64":{"type":"string","description":"The Base64-encoded image of the ID card or certificate. If you use the IdOcrPictureBase64 parameter to pass the Base64-encoded image,…"},"IdOcrPictureUrl":{"type":"string","description":"The URL of the front image of the ID card"},"IdOcrPictureFile":{"type":"string","description":"The file stream of the front image of the ID card"},"DocType":{"type":"string","description":"The type of the ID card"},"ProductCode":{"type":"string","description":"The product code"},"Ocr":{"type":"string","description":"Specifies whether to perform OCR on the ID card. Valid values: T: Performs OCR on the ID card. F: Does not perform OCR on the ID card"},"IdFaceQuality":{"type":"string","description":"Specifies whether to perform face quality detection on the ID card. Valid values: T: Performs face quality detection. F: Does not perform…"},"Spoof":{"type":"string","description":"Specifies whether to enable anti-spoofing detection. Valid values: T: Enables anti-spoofing detection. F: Disables anti-spoofing detection"},"IdThreshold":{"type":"string","description":"The custom threshold mode for OCR quality detection. Valid values: 0: System default. 1: Strict mode. 2: Loose mode. 3: Disables quality…"},"CardSide":{"type":"string","description":"The side of the ID card, which distinguishes the side with the national emblem from the side with the portrait. If you do not specify this…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/download-verify-record-intl":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_download_verify_record_intl","summary":"Downloads verification task records","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"Code":{"type":"string","description":"The query code"},"Param":{"type":"string","description":"The parameters for the export and download query task"},"ProductType":{"type":"string","description":"The product code"},"DownloadMode":{"type":"string","description":"The download mode. Valid values: async: asynchronous sync: synchronous"},"BizType":{"type":"string","description":"The business type. Valid values: INVOKE_STATISTICS INVOKE_RECORD"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/ekyc-verify":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_ekyc_verify","summary":"Provides a server-side-only API for the eKYC solution","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"ProductCode":{"type":"string","description":"The product code"},"MerchantBizId":{"type":"string","description":"A custom business unique identifier defined by the merchant, used for subsequent issue tracking and troubleshooting. Supports a…"},"MerchantUserId":{"type":"string","description":"A custom user ID or other identifier that can identify a specific user, such as a phone number or email address. We strongly recommend…"},"DocType":{"type":"string","description":"The document type"},"DocName":{"type":"string","description":"The real name of the user. When Authorize='T' and the document type is a mainland China ID card, either the key document information…"},"DocNo":{"type":"string","description":"The document number of the user. When Authorize='T' and the document type is a mainland China ID card, either the key document information…"},"IdOcrPictureUrl":{"type":"string","description":"The URL of the front side of the document image"},"IdOcrPictureBase64":{"type":"string","description":"The Base64-encoded document image. Note: If you choose this method to pass in the document image, check the photo size and do not pass in…"},"FacePictureUrl":{"type":"string","description":"The URL of the face photo"},"FacePictureBase64":{"type":"string","description":"The Base64-encoded face image. Note: If you choose this method to pass in the face image, check the photo size and do not pass in an…"},"Crop":{"type":"string","description":"Specifies whether cropping is allowed. By default, cropping is not allowed. Valid values: T: Detection is required. F: Detection is…"},"Authorize":{"type":"string","description":"Specifies whether to enable authoritative identity verification. Currently, this applies only to second-generation ID cards in mainland…"},"IdThreshold":{"type":"string","description":"The custom OCR quality detection threshold mode. Valid values: 0: system default 1: strict mode 2: loose mode 3 (default): disable quality…"},"FaceQualityCheck":{"type":"string","description":"Specifies whether to enable face quality detection"},"IdSpoof":{"type":"string","description":"Specifies whether to enable document anti-spoofing"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/ekyc-verify-v2":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_ekyc_verify_v2","summary":"Provides a server-side API for the eKYC solution","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"ProductCode":{"type":"string","description":"The product code"},"MerchantBizId":{"type":"string","description":"The custom unique business identifier on the merchant side, used for subsequent troubleshooting. The value must be a unique combination of…"},"MerchantUserId":{"type":"string","description":"The custom user ID or another identifier that identifies a specific user, such as a phone number or email address. We strongly recommend…"},"DocType":{"type":"string","description":"The ID document type"},"DocName":{"type":"string","description":"The real name of the user. If Authorize is set to T and the document type is a mainland China ID card, you must provide at least one of…"},"DocNo":{"type":"string","description":"The ID document number of the user. If Authorize is set to T and the document type is a mainland China ID card, you must provide at least…"},"IdOcrPictureUrl":{"type":"string","description":"The URL of the front image of the ID document"},"IdOcrPictureBase64":{"type":"string","description":"The Base64-encoded image of the ID document. Note: If you choose this method to pass the document image, check the image size and do not…"},"IdOcrPictureFile":{"type":"string","description":"The file stream of the front image of the ID document"},"FacePictureUrl":{"type":"string","description":"The URL of the face image"},"FacePictureBase64":{"type":"string","description":"The Base64-encoded face image. Note: If you choose this method to pass the face image, check the image size and do not pass an excessively…"},"FacePictureFile":{"type":"string","description":"The file stream of the face image"},"Crop":{"type":"string","description":"Specifies whether cropping is allowed. Default value: F. Valid values: T: Allowed. F: Not allowed (default)"},"Authorize":{"type":"string","description":"Specifies whether to enable authoritative identity verification. This parameter is currently applicable only to second-generation ID cards…"},"IdThreshold":{"type":"string","description":"The custom OCR quality check threshold mode. Valid values: 0: System default. 1: Strict mode. 2: Loose mode. 3: Quality check disabled…"},"FaceQualityCheck":{"type":"string","description":"Specifies whether to enable face quality check"},"IdSpoof":{"type":"string","description":"Specifies whether to enable ID document anti-spoofing"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/face-compare":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_face_compare","summary":"Compares and verifies two input face images by using face recognition technology, and returns the face…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"MerchantBizId":{"type":"string","description":"The custom unique business identifier on the merchant side, which is used for subsequent troubleshooting. It supports a combination of…"},"SourceFacePicture":{"type":"string","description":"The Base64-encoded portrait photo. Note If you choose this method to pass the ID photo, check the photo size and do not pass oversized…"},"SourceFacePictureUrl":{"type":"string","description":"The HTTPS or HTTP URL of the face image"},"TargetFacePicture":{"type":"string","description":"The Base64-encoded reference photo. Note If you choose this method to pass the ID photo, check the photo size and do not pass oversized…"},"TargetFacePictureUrl":{"type":"string","description":"The HTTPS or HTTP URL of the reference face image"},"FacePictureQualityCheck":{"type":"string","description":"[Deprecated] Specifies whether to enable the quality check for the input face image"},"FaceQualityCheck":{"type":"string","description":"The face quality check"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/face-compare-v2":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_face_compare_v2","summary":"Compares and verifies two input face images by using face recognition technology, and returns the face…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"MerchantBizId":{"type":"string","description":"The custom unique business identifier on the merchant side, used for subsequent troubleshooting. It supports a combination of letters and…"},"SourceFacePicture":{"type":"string","description":"The Base64-encoded portrait photo. Note If you use this method to pass the ID photo, check the photo size and do not pass oversized…"},"SourceFacePictureUrl":{"type":"string","description":"The HTTPS or HTTP URL of the face image"},"SourceFacePictureFile":{"type":"string","description":"The file stream of the face image"},"TargetFacePicture":{"type":"string","description":"The Base64-encoded reference photo. Note If you use this method to pass the ID photo, check the photo size and do not pass oversized…"},"TargetFacePictureUrl":{"type":"string","description":"The HTTPS or HTTP URL of the reference face image"},"TargetFacePictureFile":{"type":"string","description":"The file stream of the reference face image"},"FacePictureQualityCheck":{"type":"string","description":"Specifies whether to enable quality check for the input face image. [Deprecated]"},"FaceQualityCheck":{"type":"string","description":"The face quality check"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/face-cross-compare-intl":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_face_cross_compare_intl","summary":"Performs cross-comparison of faces","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProductCode","MerchantBizId"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"ProductCode":{"type":"string","description":"The product solution to use. Valid values: FACE_CROSS_COMPARE"},"SceneCode":{"type":"string","description":"The custom business scenario ID"},"MerchantBizId":{"type":"string","description":"The custom unique business identifier, used for subsequent troubleshooting. The value is a combination of letters and digits with a length…"},"CompareModel":{"type":"string","description":"The comparison mode. Valid values: 0: chain comparison (default). A:B and B:C. 1: circular comparison. A:B, B:C, and C:A"},"SourceAFacePicture":{"type":"string","description":"The Base64-encoded face photo"},"SourceAFacePictureUrl":{"type":"string","description":"The URL of the face photo. The URL must be a publicly accessible HTTP or HTTPS link"},"SourceBFacePicture":{"type":"string","description":"The Base64-encoded face photo"},"SourceBFacePictureUrl":{"type":"string","description":"The URL of the face photo. The URL must be a publicly accessible HTTP or HTTPS link"},"SourceCFacePicture":{"type":"string","description":"The Base64-encoded face photo"},"SourceCFacePictureUrl":{"type":"string","description":"The URL of the face photo. The URL must be a publicly accessible HTTP or HTTPS link"},"FaceVerifyThreshold":{"type":"string","description":"The face matching threshold. This parameter is reserved by the system and does not support custom values"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/face-duplication-check-intl":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_face_duplication_check_intl","summary":"Checks for duplicate faces. FaceDuplicationCheckIntl is suitable for scenarios where SDK integration is…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProductCode","MerchantBizId","MerchantUserId","VerifyModel"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"ProductCode":{"type":"string","description":"The product code"},"SceneCode":{"type":"string","description":"The custom authentication scenario ID"},"MerchantBizId":{"type":"string","description":"The custom unique business identifier, which is used for subsequent troubleshooting. The value can be a combination of up to 32 letters…"},"MerchantUserId":{"type":"string","description":"The custom user ID or another identifier that identifies a specific user, such as a mobile phone number or an email address. We strongly…"},"VerifyModel":{"type":"string","description":"The authentication type. Valid values: 0: retrieve pattern. Feature: Pass the face library and the user face image (sourceFacePicture).…"},"Liveness":{"type":"string","description":"Specifies whether to enable passive liveness detection. Valid values: 0: disabled. 1: enabled"},"FaceGroupCodes":{"type":"string","description":"The codes of the face libraries created by the customer in the console. You can query up to 10 face libraries at a time. Separate multiple…"},"SourceFacePicture":{"type":"string","description":"The Base64-encoded portrait photo"},"SourceFacePictureUrl":{"type":"string","description":"The URL of the portrait image. The URL must be an HTTP or HTTPS link accessible over the Internet"},"TargetFacePicture":{"type":"string","description":"The Base64-encoded portrait photo"},"TargetFacePictureUrl":{"type":"string","description":"The URL of the portrait image. The URL must be an HTTP or HTTPS link accessible over the Internet"},"AutoRegistration":{"type":"string","description":"Specifies whether to automatically register the face to the specified face library if no duplicate face is found during the search. Valid…"},"FaceRegisterGroupCode":{"type":"string","description":"The face library to which the face is registered"},"SaveFacePicture":{"type":"string","description":"Specifies the type of the saved face image. Valid values: 0: face. This is the default value. 1: feature. Reserved field. Not enabled yet.>"},"FaceVerifyThreshold":{"type":"string","description":"The face matching threshold.> Reserved field. Not enabled yet.>"},"ReturnFaces":{"type":"string","description":"The number of faces to return when multiple faces exceed the matching threshold. Valid values: Default value: 1. Maximum value: 5"},"FaceQualityCheck":{"type":"string","description":"The face quality check"},"FaceAttributeCheck":{"type":"string","description":"Specifies whether to return additional face attribute information. Valid values: N: do not return. This is the default value. Y: return.…"},"UpdateFaceIfUserExists":{"type":"string","description":"Specifies whether to use the current face to overwrite the existing face if MerchantUserId already exists during automatic registration.…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/face-guard-risk":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_face_guard_risk","summary":"Calls the server-side API of Face Guard International","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"DeviceToken":{"type":"string","description":"The device token obtained through the Face Guard SDK"},"MerchantBizId":{"type":"string","description":"The custom unique business identifier on the merchant side, used for subsequent troubleshooting. It supports a combination of letters and…"},"ProductCode":{"type":"string","description":"The product code. Valid values: FACE_GUARD and FACE_GUARD_PRO"},"BizId":{"type":"string","description":"The customer business ID"},"Type":{"type":"string","description":"The type of the risk scenario detected by Device Assistant"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/face-liveness":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_face_liveness","summary":"Performs server-side passive liveness detection","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"ProductCode":{"type":"string","description":"The product code"},"MerchantBizId":{"type":"string","description":"The custom unique business identifier on the merchant side, used for subsequent troubleshooting. It supports a combination of letters and…"},"MerchantUserId":{"type":"string","description":"The merchant user ID or another identifier used to identify a specific user, such as a phone number or email address. Desensitize the…"},"FacePictureUrl":{"type":"string","description":"The URL of the face photo"},"FacePictureBase64":{"type":"string","description":"The Base64-encoded string of the photo. Note: If you use the FacePictureBase64 parameter to pass the face photo, check the photo size and…"},"FaceQuality":{"type":"string","description":"Specifies whether to output the face quality score. Valid values: T: The detection is required. F: The detection is not required. Default…"},"Crop":{"type":"string","description":"Specifies whether to allow cropping. Valid values: T: Cropping is allowed. F: Cropping is not allowed. Default value: F"},"Occlusion":{"type":"string","description":"Specifies whether to perform occlusion detection. Valid values: T: Occlusion detection is required. F: Occlusion detection is not…"},"FaceQualityCheck":{"type":"string","description":"The face quality check"},"FaceAttributeCheck":{"type":"string","description":"The face attribute check"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/face-liveness-v2":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_face_liveness_v2","summary":"Detects real faces by using pre-obtained face images through API operations, and combines the Qwen-VL large…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProductCode"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"ProductCode":{"type":"string","description":"The product solution to integrate. Valid values: FACE_LIVENESS_MIN_PRO and FACE_LIVENESS_MIN"},"MerchantBizId":{"type":"string","description":"The custom unique business identifier on the merchant side for subsequent troubleshooting. It supports a combination of letters and…"},"MerchantUserId":{"type":"string","description":"The custom user ID or other identifier that can identify a specific user, such as a mobile phone number or email address. Desensitize the…"},"FacePictureBase64":{"type":"string","description":"The Base64-encoded face image. Note If you use this method to pass the face image, check the image size and do not pass oversized images.…"},"FacePictureUrl":{"type":"string","description":"The URL of the face photo. The URL must be a publicly accessible HTTPS link"},"FacePictureFile":{"type":"string","description":"The file stream of the face photo"},"FaceQualityCheck":{"type":"string","description":"Specifies whether to check the quality of the face image. Valid values: Y: Enabled. N: Disabled. Default value: N"},"FaceAttributeCheck":{"type":"string","description":"The face attribute detection"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/face-verify-intl":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_face_verify_intl","summary":"Detects real faces by using pre-acquired face images passed through the API operation. The algorithm…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProductCode"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"ProductCode":{"type":"string","description":"The product code. Valid values: FACE_VERIFY_MIN and FACE_IDU_MIN"},"MerchantUserId":{"type":"string","description":"The custom user ID or another identifier that can identify a specific user, such as a phone number or email address. It is highly…"},"MerchantBizId":{"type":"string","description":"The custom unique business identifier used for subsequent troubleshooting. It supports a combination of up to 32 letters and digits. Make…"},"FaceQualityCheck":{"type":"string","description":"Specifies whether to check the quality of the face image. Valid values: Y: Enabled. N: Disabled. Default value: N"},"TargetFacePicture":{"type":"string","description":"The Base64-encoded reference photo. Note If you use this method to pass the reference photo, check the photo size and do not pass…"},"TargetFacePictureUrl":{"type":"string","description":"The HTTPS URL of the reference face image"},"TargetFacePictureFile":{"type":"string","description":"The file stream of the reference face image"},"SourceFacePicture":{"type":"string","description":"The Base64-encoded portrait photo. Note If you use this method to pass the portrait photo, check the photo size and do not pass oversized…"},"SourceFacePictureUrl":{"type":"string","description":"The URL of the portrait image. It must be a publicly accessible HTTPS link"},"SourceFacePictureFile":{"type":"string","description":"The file stream of the face image"},"VerifyModel":{"type":"string","description":"Required when ProductCode is set to FACE_IDU_MIN. The authentication type. Valid values: 0: Retrieval pattern. Feature: Passes the face…"},"FaceGroupCodes":{"type":"string","description":"Required when ProductCode is set to FACE_IDU_MIN. The codes of the face libraries created by the customer in the console. You can query up…"},"AutoRegistration":{"type":"string","description":"Required when ProductCode is set to FACE_IDU_MIN. Specifies whether to automatically register the face to the specified face library when…"},"FaceRegisterGroupCode":{"type":"string","description":"Required when ProductCode is set to FACE_IDU_MIN. The code of the face library for registration"},"ReturnFaces":{"type":"string","description":"Required when ProductCode is set to FACE_IDU_MIN. Specifies the number of faces to return when multiple faces exceed the matching…"},"FaceAttributeCheck":{"type":"string","description":"Specifies whether to return additional face attribute information. Valid values: N: Do not return. Default value. Y: Return. The result is…"},"UpdateFaceIfUserExists":{"type":"string","description":"Specifies whether to overwrite the original face with the current face if MerchantUserId already exists during automatic registration.…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/id2-meta-period-verify-intl":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_id2_meta_period_verify_intl","summary":"Verifies the validity period of an identity document as a two-factor authentication element","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProductCode","MerchantBizId","DocType","DocName","DocNo","ValidityStartDate","ValidityEndDate"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"ProductCode":{"type":"string","description":"The product solution to use. Set the value to eKYC_Date_MIN"},"SceneCode":{"type":"string","description":"The custom authentication scenario ID. You can use this scenario ID to query related records in the console. The value can be up to 10…"},"MerchantBizId":{"type":"string","description":"The custom unique business identifier, which is used for subsequent troubleshooting. The value can be up to 32 characters in length and…"},"MerchantUserId":{"type":"string","description":"The custom user ID or another identifier that can identify a specific user, such as a phone number or email address. We strongly recommend…"},"DocType":{"type":"string","description":"The document type, which is uniquely identified by an 8-digit number. For more information, see the document type list. Currently, only…"},"DocName":{"type":"string","description":"The name of the user"},"DocNo":{"type":"string","description":"The document number of the user"},"ValidityStartDate":{"type":"string","description":"The start date of the validity period, in the format YYYYMMDD. Example: 20201001"},"ValidityEndDate":{"type":"string","description":"The expiration date of the ID card validity period, in the format YYYYMMDD. Example: 20301001"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/id2-meta-verify-intl":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_id2_meta_verify_intl","summary":"Verifies the authenticity and consistency of a name and an ID card number through an authoritative data source","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"ProductCode":{"type":"string","description":"The product solution. Fixed value: ID_2META"},"ParamType":{"type":"string","description":"The parameter type. Valid values: normal: The original value in plaintext. Note: Due to the limitations of the authoritative data source,…"},"IdentifyNum":{"type":"string","description":"The ID card number in plaintext"},"UserName":{"type":"string","description":"The name in plaintext"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/idn-authority-verify-intl":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_idn_authority_verify_intl","summary":"Verifies the identity of an Indonesian user by calling the authoritative source API in a standalone business…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProductCode","MerchantBizId","MerchantUserId","IdNumber","BirthDate","FullName","Timestamp","Mobile","Email"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"ProductCode":{"type":"string","description":"The product solution to use. Set the value to IDN_META"},"SceneCode":{"type":"string","description":"The custom authentication scenario ID. You can use this scenario ID to query related records in the console. The value can be a…"},"MerchantBizId":{"type":"string","description":"The merchant-side custom business unique identifier, which is used for subsequent troubleshooting. The value can be a combination of…"},"MerchantUserId":{"type":"string","description":"The custom user ID, or another identifier that can identify a specific user, such as a phone number or email address. We strongly…"},"IdNumber":{"type":"string","description":"The ID card number"},"BirthDate":{"type":"string","description":"The date of birth"},"FullName":{"type":"string","description":"The full name"},"Timestamp":{"type":"string","description":"The Timestamp"},"SourceFacePicture":{"type":"string","description":"The Base64-encoded facial photo. Note If you use this method to pass the ID photo, check the photo size and do not pass an excessively…"},"SourceFacePictureUrl":{"type":"string","description":"The URL of the facial photo. The URL must be a publicly accessible HTTP or HTTPS link"},"SourceFacePictureFile":{"type":"string","description":"The file stream of the facial photo"},"Mobile":{"type":"string","description":"The Indonesian mobile phone number. The number must start with +62, followed by 9 to 11 digits"},"Email":{"type":"string","description":"The email address of the user"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/initialize":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_initialize","summary":"Initializes the authentication process","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"ProductCode":{"type":"string","description":"The product solution to be integrated. For more information, see the official documentation:…"},"MerchantBizId":{"type":"string","description":"The custom unique business identifier on the merchant side, used for subsequent troubleshooting. It supports a combination of letters and…"},"MetaInfo":{"type":"string","description":"The MetaInfo environment parameter, which must be obtained through the client SDK"},"DocType":{"type":"string","description":"The type of the identity document. For the eKYC_PRO and ID_OCR_MAX solutions, see the official documentation:…"},"MerchantUserId":{"type":"string","description":"The custom user ID or other identifier that can identify a specific user, such as a mobile phone number or email address. Desensitize the…"},"SceneCode":{"type":"string","description":"The scene code. This parameter is applicable to IDV products"},"Pages":{"type":"string","description":"The configuration of the pages to be captured. Separate multiple pages with commas (,). Valid values: 01: The portrait side of the…"},"FacePictureBase64":{"type":"string","description":"The Base64-encoded string of the photo. If you choose to pass the face photo by using FacePictureBase64, check the photo size and do not…"},"FacePictureUrl":{"type":"string","description":"The URL of the face photo. It must be a publicly accessible HTTP or HTTPS link"},"Crop":{"type":"string","description":"Specifies whether to crop the image. This parameter is applicable to IDV products"},"Ocr":{"type":"string","description":"Specifies whether to enable OCR. This parameter is applicable to IDV products"},"IdFaceQuality":{"type":"string","description":"The quality of the face image. This parameter is applicable to IDV products"},"IdSpoof":{"type":"string","description":"Specifies whether to enable document anti-spoofing detection. This parameter is applicable to IDV products"},"ReturnUrl":{"type":"string","description":"The client-side callback URL"},"Authorize":{"type":"string","description":"Specifies whether to enable authoritative identity verification. This parameter is currently applicable only to second-generation ID cards…"},"DocScanMode":{"type":"string","description":"The photo capture mode for document collection. Valid values: manual: Manual capture. auto: Automatic capture. This is the default value"},"ProductFlow":{"type":"string","description":"The sequence of document and face verification. Valid values: DOC_FACE: Document first, then face. This is the default value. FACE_DOC:…"},"CallbackUrl":{"type":"string","description":"The callback URL for authentication result notifications. The default callback request method is GET, and the callback URL must start with…"},"CallbackToken":{"type":"string","description":"The security token used for anti-replay and anti-tampering verification. If this parameter is passed, the CallbackToken field is displayed…"},"LanguageConfig":{"type":"string","description":"The language configuration. This parameter is applicable to IDV products"},"SecurityLevel":{"type":"string","description":"The pattern that represents different security levels of the authentication flow. Valid values: 01: Normal pattern. This is the default…"},"StyleConfig":{"type":"string","description":"The custom UI configuration. Convert your custom UI configuration into a JSON string based on the configuration template and pass it…"},"ExperienceCode":{"type":"string","description":"The experience code"},"DocVideo":{"type":"string","description":"Specifies whether to store a video for evidence. Valid values: N: No. This is the default value. Y: Yes. During the authentication…"},"Model":{"type":"string","description":"The type of liveness detection to be performed. Valid values: LIVENESS: Blink liveness detection. This is the default value.…"},"IdThreshold":{"type":"string","description":"The custom threshold mode for OCR quality detection. Valid values: 0: Standard mode. 1: Strict mode. 2: Loose mode. 3: Disable quality…"},"ShowAlbumIcon":{"type":"string","description":"Specifies whether to display the album upload entry during the document OCR recognition phase. Valid values: 1: Display. This is the…"},"ShowOcrResult":{"type":"string","description":"Specifies whether to display the recognition result page during the document OCR recognition phase. Valid values: 1: Display. This is the…"},"ShowGuidePage":{"type":"string","description":"Specifies whether to display the guide page. Valid values: 1: Display. This is the default value. 0: Do not display"},"ProcedurePriority":{"type":"string","description":"Specifies whether to allow fallback processing when compatibility issues occur during mobile H5 authentication. Valid values: url:…"},"AppQualityCheck":{"type":"string","description":"This feature is not supported by the Web SDK. To use this feature, refer to the App SDK integration guide. Specifies whether to enable…"},"DocPageConfig":{"type":"string","description":"The custom configuration passed by the customer to specify whether to capture more pages (JSON-encoded)"},"MRTDInput":{"type":"string","description":"The input source of the MRTD verification parameter. This parameter is required to decrypt information when NFC reads the document chip…"},"DocumentNumber":{"type":"string","description":"The document number. This parameter is required when MRTDInput is set to 2"},"DateOfBirth":{"type":"string","description":"The date of birth on the document, in the format of YYMMDD (6 digits). This parameter is required when MRTDInput is set to 2"},"DateOfExpiry":{"type":"string","description":"The expiration date on the document, in the format of YYMMDD (6 digits). This parameter is required when MRTDInput is set to 2"},"UseNFC":{"type":"string","description":"Specifies whether to enable NFC verification when DocType is set to 01000000 (global passport). Valid values: Y: Enable. N: Disable"},"ChameleonFrameEnable":{"type":"string","description":"Specifies whether to enable the adaptive color-changing window border. Valid values: Y: Enable. N: Disable"},"DocNo":{"type":"string","description":"The document number of the user"},"DocName":{"type":"string","description":"The real name of the user"},"EditOcrResult":{"type":"string","description":"Specifies whether the recognition result page is editable during the document OCR recognition phase. Valid values: 0: Not editable. 1:…"},"VerifyModel":{"type":"string","description":"The type of verification"},"FaceGroupCodes":{"type":"string","description":"The face databases to be compared"},"TargetFacePicture":{"type":"string","description":"The Base64-encoded string of the portrait photo"},"TargetFacePictureUrl":{"type":"string","description":"The URL of the portrait photo. It must be a publicly accessible HTTP or HTTPS link"},"AutoRegistration":{"type":"string","description":"Specifies whether to enable automatic registration"},"FaceRegisterGroupCode":{"type":"string","description":"The face database for registration"},"SaveFacePicture":{"type":"string","description":"Specifies whether to save the face picture"},"FaceVerifyThreshold":{"type":"string","description":"The threshold for face verification"},"ReturnFaces":{"type":"string","description":"The number of duplicate faces to be returned"},"Mobile":{"type":"string","description":"The Indonesian phone number. The format must be verified, starting with +62 followed by 9 to 11 digits. This field takes effect only when…"},"Email":{"type":"string","description":"The Indonesian email address. This field takes effect only when Authorize is set to T. This field is required only when the Indonesian…"},"TemplateType":{"type":"string","description":"The execution sequence of liveness detection actions in TemplateConfig. This parameter is required when Model is set to TEMPLATE. Valid…"},"TemplateConfig":{"type":"string","description":"The custom action pool configuration for liveness detection. This parameter is required when Model is set to TEMPLATE. Configuration…"},"TemplateRanCount":{"type":"string","description":"The number of actions randomly selected from TemplateConfig. This parameter takes effect only when TemplateType is set to Ran. Validation…"},"OcrValueStandard":{"type":"string","description":"Specifies whether to return additional standardized format fields for OCR recognition. Valid values: 0: No. This is the default value. 1:…"},"FaceAttributeCheck":{"type":"string","description":"Specifies whether to return additional face attribute information. Valid values: N: Do not return. This is the default value. Y: Return.…"},"AutoDocPageConfig":{"type":"string","description":"The automatic document page classification configuration. This parameter takes effect only when DocType is set to a country or region…"},"UpdateFaceIfUserExists":{"type":"string","description":"Specifies whether to overwrite the original face with the current face if MerchantUserId already exists during automatic registration.…"},"NeedMultiFaceCheck":{"type":"string","description":"Specifies whether to intercept the request when multiple faces are detected on the terminal. Valid values: Y: Intercept. The client…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/initialize-v2":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_initialize_v2","summary":"Creates an authentication session for SDK integration. This operation must be used in conjunction with a…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"ProductCode":{"type":"string","description":"The product solution to integrate. Note: For more information, see the official documentation:…"},"MerchantBizId":{"type":"string","description":"The custom unique business identifier on the merchant side, which is used for subsequent troubleshooting. It supports a combination of…"},"MetaInfo":{"type":"string","description":"The Metainfo environment parameter, which must be obtained through the client SDK"},"DocType":{"type":"string","description":"The document type. For the eKYC_PRO and ID_OCR_MAX solutions, see the official documentation:…"},"MerchantUserId":{"type":"string","description":"Your custom user ID or another identifier that can identify a specific user, such as a mobile phone number or an email address.…"},"SceneCode":{"type":"string","description":"The scene code. This parameter is applicable to IDV products"},"Pages":{"type":"string","description":"The collection page configuration. Separate multiple pages with commas (,). Valid values: 01: The portrait side of the document. 01,02:…"},"FacePictureBase64":{"type":"string","description":"The Base64-encoded photo. If you use the FacePictureBase64 method to pass the face photo, check the photo size and do not pass an…"},"FacePictureUrl":{"type":"string","description":"The URL of the face photo. The URL must be a publicly accessible HTTP or HTTPS link"},"Crop":{"type":"string","description":"Specifies whether to crop the image. This parameter is applicable to IDV products"},"Ocr":{"type":"string","description":"Specifies whether to enable OCR. This parameter is applicable to IDV products"},"IdFaceQuality":{"type":"string","description":"The quality of the face image. This parameter is applicable to IDV products"},"IdSpoof":{"type":"string","description":"Specifies whether to enable document anti-spoofing detection. This parameter is applicable to IDV products"},"ReturnUrl":{"type":"string","description":"The client-side callback URL"},"Authorize":{"type":"string","description":"Specifies whether to enable authoritative identity verification. This feature currently applies only to second-generation ID cards in the…"},"DocScanMode":{"type":"string","description":"The photo capture mode for document collection. Valid values: manual: Manual capture. auto: Automatic capture. This is the default value"},"ProductFlow":{"type":"string","description":"The sequence orchestration for document and face verification. Valid values: DOC_FACE: Document first, then face. This is the default…"},"CallbackUrl":{"type":"string","description":"The callback notification URL for authentication results. The default callback request method is GET, and the callback URL must start with…"},"CallbackToken":{"type":"string","description":"The security token used for anti-replay and anti-tampering verification. If this parameter is passed, the CallbackToken field is displayed…"},"LanguageConfig":{"type":"string","description":"The language configuration. This parameter is applicable to IDV products"},"SecurityLevel":{"type":"string","description":"The pattern that represents different security levels of the authentication flow. Valid values: 01: Normal pattern. This is the default…"},"StyleConfig":{"type":"string","description":"The custom UI configuration. Convert your custom UI configuration into a JSON string based on the configuration template and pass it…"},"ExperienceCode":{"type":"string","description":"The experience code"},"DocVideo":{"type":"string","description":"Specifies whether to store a video for evidence. Valid values: N: No. This is the default value. Y: Yes. During the authentication…"},"Model":{"type":"string","description":"The type of liveness detection to perform. Valid values: LIVENESS: Blink liveness detection. This is the default value. PHOTINUS_LIVENESS:…"},"IdThreshold":{"type":"string","description":"The custom threshold mode for OCR quality detection. Valid values: 0: System default. 1: Strict mode. 2: Loose mode. 3: Disable quality…"},"ShowAlbumIcon":{"type":"string","description":"Specifies whether to display the album upload entry during the document OCR recognition phase. Valid values: 1: Display. This is the…"},"ShowOcrResult":{"type":"string","description":"Specifies whether to display the recognition result page during the document OCR recognition phase. Valid values: 1: Display. This is the…"},"ShowGuidePage":{"type":"string","description":"Specifies whether to display the guide page. Valid values: 1: Display. This is the default value. 0: Do not display"},"ProcedurePriority":{"type":"string","description":"Specifies whether to allow degraded processing when compatibility issues occur during mobile H5 authentication. Valid values: url:…"},"AppQualityCheck":{"type":"string","description":"This feature is not supported by the Web SDK. To use this feature, refer to the App SDK integration guide. Specifies whether to enable…"},"DocPageConfig":{"type":"string","description":"The custom configuration passed by the customer to specify whether to collect more pages (JSON-encoded)"},"MRTDInput":{"type":"string","description":"The input source for MRTD verification parameters. This parameter is required to decrypt information when NFC reads the document chip…"},"DocumentNumber":{"type":"string","description":"The document number. This parameter is required when MRTDInput is set to 2"},"DateOfBirth":{"type":"string","description":"The date of birth on the document, in the format of YYMMDD (6 digits). This parameter is required when MRTDInput is set to 2"},"DateOfExpiry":{"type":"string","description":"The expiration date on the document, in the format of YYMMDD (6 digits). This parameter is required when MRTDInput is set to 2"},"UseNFC":{"type":"string","description":"Specifies whether to enable NFC verification when DocType is set to 01000000 (global passport). Valid values: Y: Enable. N: Disable"},"ChameleonFrameEnable":{"type":"string","description":"Specifies whether to enable the adaptive color-changing window border. Valid values: Y: Enable. N: Disable"},"DocNo":{"type":"string","description":"The document number of the user"},"DocName":{"type":"string","description":"The real name of the user"},"EditOcrResult":{"type":"string","description":"Specifies whether the recognition result page is editable during the document OCR recognition phase. Valid values: 0: Not editable. 1:…"},"VerifyModel":{"type":"string","description":"The type of verification"},"FaceGroupCodes":{"type":"string","description":"The face databases for comparison"},"TargetFacePicture":{"type":"string","description":"The Base64-encoded portrait photo"},"TargetFacePictureUrl":{"type":"string","description":"The URL of the portrait photo. The URL must be a publicly accessible HTTP or HTTPS link"},"AutoRegistration":{"type":"string","description":"Specifies whether to enable automatic registration"},"FaceRegisterGroupCode":{"type":"string","description":"The face registration database"},"SaveFacePicture":{"type":"string","description":"Specifies whether to save the face photo"},"FaceVerifyThreshold":{"type":"string","description":"The face verification threshold"},"ReturnFaces":{"type":"string","description":"The number of duplicate faces returned"},"Mobile":{"type":"string","description":"The Indonesian phone number. The format must be verified, starting with +62 followed by 9 to 11 digits. This field takes effect only when…"},"Email":{"type":"string","description":"The Indonesian email address. This field takes effect only when Authorize is set to T. Note This field is required only when the…"},"TemplateType":{"type":"string","description":"The execution sequence of liveness detection actions in TemplateConfig. This parameter is required when Model is set to TEMPLATE. Valid…"},"TemplateConfig":{"type":"string","description":"The custom action pool configuration for liveness detection. This parameter is required when Model is set to TEMPLATE. Configuration…"},"TemplateRanCount":{"type":"string","description":"[Deprecated] The random mode is no longer recommended. This field is deprecated"},"OcrValueStandard":{"type":"string","description":"Specifies whether to return additional standardized format fields for OCR recognition. Valid values: 0: No. This is the default value. 1:…"},"TargetFacePictureFile":{"type":"string","description":"The file stream of the base library face photo"},"FacePictureFile":{"type":"string","description":"The file stream of the face photo"},"FaceAttributeCheck":{"type":"string","description":"Specifies whether to return additional face attribute information. Valid values: N: Do not return. This is the default value. Y: Return.…"},"AutoDocPageConfig":{"type":"string","description":"The automatic document page classification configuration. This parameter takes effect only when DocType is set to a country or region…"},"UpdateFaceIfUserExists":{"type":"string","description":"Specifies whether to use the current face to overwrite the existing face when MerchantUserId already exists during automatic registration.…"},"NeedMultiFaceCheck":{"type":"string","description":"Specifies whether to intercept the request when the terminal detects multiple faces. Valid values: Y: Intercept. The client prompts the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/keepalive-intl":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_keepalive_intl","summary":"Configures client connection keep-alive settings","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/mobile2-meta-verify-intl":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_mobile2_meta_verify_intl","summary":"Verifies the mobile phone number and name","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProductCode","ParamType","UserName","Mobile"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"ProductCode":{"type":"string","description":"The product code. Set the value to MOBILE_2META"},"ParamType":{"type":"string","description":"The parameter type. Valid values: normal: No encryption. md5: MD5 encryption"},"UserName":{"type":"string","description":"The name. If paramType is set to normal, enter the plaintext name. If paramType is set to md5, enter the ciphertext name, which is a…"},"Mobile":{"type":"string","description":"The mobile phone number. If paramType is set to normal, enter the plaintext mobile phone number. If paramType is set to md5, enter the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/mobile3-meta-verify-intl":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_mobile3_meta_verify_intl","summary":"Verifies the authenticity and consistency of a mobile phone number, name, and ID card number through…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"ProductCode":{"type":"string","description":"The product solution to be accessed. Set the value to MOBILE_3META"},"ParamType":{"type":"string","description":"The parameter type. Valid values: normal: Unencrypted. md5: MD5-encrypted"},"IdentifyNum":{"type":"string","description":"The ID card number. If paramType is set to normal, enter the plaintext. If paramType is set to md5, enter a 32-character lowercase MD5…"},"UserName":{"type":"string","description":"The name. If paramType is set to normal, enter the plaintext. If paramType is set to md5, enter a 32-character lowercase MD5 string"},"Mobile":{"type":"string","description":"The mobile phone number. If paramType is set to normal, enter the plaintext. If paramType is set to md5, enter a 32-character lowercase…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/modify-face-group":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_modify_face_group","summary":"Modifies a face library","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"Id":{"type":"string","description":"The primary key ID"},"Name":{"type":"string","description":"The name of the face library"},"Description":{"type":"string","description":"The description"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/modify-face-record":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_modify_face_record","summary":"Edits a face record","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ImgOssInfos","FaceGroupCode"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"ImgOssInfos":{"type":"string","description":"The OSS information of the image"},"FaceGroupCode":{"type":"string","description":"The face library code"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/query-face-group":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_query_face_group","summary":"Queries face libraries","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CurrentPage","PageSize"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"Name":{"type":"string","description":"The name of the face library"},"GroupCode":{"type":"string","description":"The code of the face library"},"CurrentPage":{"type":"integer","description":"The current page number"},"PageSize":{"type":"integer","description":"The number of entries per page"},"MaxResults":{"type":"integer","description":"The maximum number of entries per page"},"NextToken":{"type":"string","description":"The token for the next query"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/query-face-record":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_query_face_record","summary":"Queries face records","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FaceGroupCode","CurrentPage","PageSize"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"FaceId":{"type":"string","description":"The face ID"},"MerchantUserId":{"type":"string","description":"The merchant user ID"},"RegistrationType":{"type":"string","description":"The registration type"},"FaceGroupCode":{"type":"string","description":"The face library code"},"CurrentPage":{"type":"integer","description":"The current page number"},"PageSize":{"type":"integer","description":"The number of entries per page"},"MaxResults":{"type":"integer","description":"The maximum number of entries per page for a paginated query"},"NextToken":{"type":"string","description":"The token used to retrieve the next page of results"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/temp-access-token-intl":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_temp_access_token_intl","summary":"Retrieves a temporary token","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"Type":{"type":"string","description":"The type"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/temp-oss-url-intl":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_temp_oss_url_intl","summary":"Retrieves a temporary URL for a file","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ObjectName"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"},"ObjectName":{"type":"string","description":"The object name"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cloudauth-intl/version":{"post":{"operationId":"cloud_aliyun_cloudauth_intl_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth-intl.ap-southeast-1.aliyuncs.com","https://cloudauth-intl.ap-southeast-3.aliyuncs.com","https://cloudauth-intl.ap-southeast-5.aliyuncs.com","https://cloudauth-intl.cn-hongkong.aliyuncs.com"],"default":"https://cloudauth-intl.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}