{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-cloudauth/aigcface-verify":{"post":{"operationId":"cloud_aliyun_cloudauth_aigcface_verify","summary":"Detects whether an image is generated by AIGC and returns the detection result","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"SceneId":{"type":"integer","description":"The ID of the verification scenario. This ID is automatically generated after you create a verification scenario in the console. For more…"},"OuterOrderNo":{"type":"string","description":"The custom business unique identifier on the client side, which is used for subsequent troubleshooting. The value can contain up to 32…"},"ProductCode":{"type":"string","description":"The product solution"},"FaceContrastPicture":{"type":"string","description":"The Base64-encoded photo. You can use one of the following methods to pass in the image: FaceContrastPicture, FaceContrastPictureUrl, or OSS"},"FaceContrastPictureUrl":{"type":"string","description":"The URL of the face image. The URL must be a publicly accessible HTTP or HTTPS link. You can use one of the following methods to pass in…"},"OssBucketName":{"type":"string","description":"The name of the authorized OSS bucket. You can use one of the following methods to pass in the image: FaceContrastPicture,…"},"OssObjectName":{"type":"string","description":"The file name in the authorized OSS bucket. You can use one of the following methods to pass in the image: FaceContrastPicture,…"}}}}}},"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/bank-meta-verify":{"post":{"operationId":"cloud_aliyun_cloudauth_bank_meta_verify","summary":"Provides API operations for bank card element verification, including two-element, three-element, and…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ParamType":{"type":"string","description":"The parameter type. Valid values: normal: not encrypted. md5: MD5-encrypted"},"VerifyMode":{"type":"string","description":"VERIFY_BANK_CARD: bank card verification mode. Specifies whether the provided bank card number matches the real name, ID card number, and…"},"ProductType":{"type":"string","description":"The product type. Valid values: BANK_CARD_2_META: bank card number + name verification. BANK_CARD_3_META: bank card number + name + ID…"},"UserName":{"type":"string","description":"The name. If paramType is set to normal, enter the name in plaintext. If paramType is set to md5, enter the MD5 hash (32-bit lowercase) of…"},"IdentifyNum":{"type":"string","description":"The ID card number. This parameter is required if ProductType is set to BANK_CARD_3_META. If paramType is set to normal, enter the ID card…"},"BankCard":{"type":"string","description":"The bank card number. If paramType is set to normal, enter the bank card number in plaintext. If paramType is set to md5, enter the card…"},"Mobile":{"type":"string","description":"The phone number. This parameter is required if ProductType is set to BANK_CARD_4_META. If paramType is set to normal, enter the phone…"},"IdentityType":{"type":"string","description":"The identity document 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/compare-face-verify":{"post":{"operationId":"cloud_aliyun_cloudauth_compare_face_verify","summary":"Provides a financial-grade server-side API for face comparison","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"SceneId":{"type":"integer","description":"The verification scenario ID"},"OuterOrderNo":{"type":"string","description":"The unique identifier of the merchant request. The value is a 32-character alphanumeric string. The first few characters are a custom…"},"ProductCode":{"type":"string","description":"Fixed value: PV_FC"},"SourceFaceContrastPicture":{"type":"string","description":"The Base64-encoded photo. You can use one of the following four methods to submit a face photo: FaceContrastPicture,…"},"SourceFaceContrastPictureUrl":{"type":"string","description":"The OSS photo URL. Only authorized OSS photo URLs are supported. You can use one of the following four methods to submit a face photo:…"},"SourceCertifyId":{"type":"string","description":"The CertifyId from a previous successful ID Verification. The photo captured during that verification is used as the face comparison…"},"SourceOssBucketName":{"type":"string","description":"The bucket name of the authorized OSS space. You can use one of the following four methods to submit a face photo: FaceContrastPicture,…"},"SourceOssObjectName":{"type":"string","description":"The file name in the authorized OSS space. You can use one of the following four methods to submit a face photo: FaceContrastPicture,…"},"TargetFaceContrastPicture":{"type":"string","description":"The Base64-encoded reference photo. You can use one of the following four methods to submit a reference face photo: FaceContrastPicture,…"},"TargetFaceContrastPictureUrl":{"type":"string","description":"The OSS URL of the reference photo. Only authorized OSS photo URLs are supported. You can use one of the following four methods to submit…"},"TargetCertifyId":{"type":"string","description":"The CertifyId from a previous successful ID Verification. The photo captured during that verification is used as the face comparison…"},"TargetOssBucketName":{"type":"string","description":"The bucket name of the authorized OSS space. You can use one of the following four methods to submit a reference face photo:…"},"TargetOssObjectName":{"type":"string","description":"The file name in the authorized OSS space. You can use one of the following four methods to submit a reference face photo:…"},"Crop":{"type":"string","description":"Specifies whether cropping is allowed. Default value: F. T: detection is required. F: detection is required. (Default: F)"}}}}}},"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/compare-faces":{"post":{"operationId":"cloud_aliyun_cloudauth_compare_faces","summary":"Performs face comparison","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"TargetImageType":{"type":"string","description":"The type of image 2. Valid values: FacePic: A face photo of the user. IDPic: A headshot photo from the chip of the user's…"},"SourceImageType":{"type":"string","description":"The type of image 1. Valid values: FacePic: A face photo of the user. IDPic: A headshot photo from the chip of the user's…"},"SourceImageValue":{"type":"string","description":"The URL of image 1. For more information, see the description of image URL upload"},"TargetImageValue":{"type":"string","description":"The URL of image 2. For more information, see the description of image URL upload"}}}}}},"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/contrast-face-verify":{"post":{"operationId":"cloud_aliyun_cloudauth_contrast_face_verify","summary":"Submits verification materials for identity comparison and synchronously returns the verification result","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"SceneId":{"type":"integer","description":"The verification scenario ID"},"OuterOrderNo":{"type":"string","description":"The unique identifier of the merchant request. The value is a 32-character alphanumeric string. The first few characters are a custom…"},"ProductCode":{"type":"string","description":"Fixed value: ID_MIN"},"CertType":{"type":"string","description":"The certificate type. Currently only ID cards are supported. You must set this parameter to IDENTITY_CARD"},"CertName":{"type":"string","description":"The real name"},"CertNo":{"type":"string","description":"The certificate number"},"FaceContrastPicture":{"type":"string","description":"The Base64-encoded photo"},"DeviceToken":{"type":"string","description":"The device token for risk identification"},"Mobile":{"type":"string","description":"The mobile phone number of the user"},"Ip":{"type":"string","description":"The IP address of the user"},"UserId":{"type":"string","description":"The custom user ID defined by the business"},"FaceContrastPictureUrl":{"type":"string","description":"The OSS photo URL. Currently only authorized OSS photo URLs are supported. Among the four methods of passing in images…"},"CertifyId":{"type":"string","description":"The CertifyId from a previous successful ID Verification. The photo from that verification is used as the comparison photo. Among the four…"},"OssBucketName":{"type":"string","description":"The bucket name of the authorized OSS space. Among the four methods of passing in images (FaceContrastPicture, FaceContrastPictureUrl,…"},"OssObjectName":{"type":"string","description":"The file name in the authorized OSS space. Among the four methods of passing in images (FaceContrastPicture, FaceContrastPictureUrl,…"},"Model":{"type":"string","description":"The liveness detection type"},"FaceContrastFile":{"type":"string","description":"The local video file"},"Crop":{"type":"string","description":"Specifies whether to allow cropping of the face image. Valid values: T: Allowed. F (default): Not allowed"},"EncryptType":{"type":"string","description":"The encryption type. An empty value indicates no encryption"}}}}}},"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/create-ant-cloud-auth-scene":{"post":{"operationId":"cloud_aliyun_cloudauth_create_ant_cloud_auth_scene","summary":"Creates a network access credential","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SceneName"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"SceneName":{"type":"string","description":"The scenario name"},"StoreImage":{"type":"string","description":"Specifies whether to deliver files generated during verification to the customer's OSS. Valid values: Y: Yes. N: No"},"BindMiniProgram":{"type":"string","description":"Specifies whether to enable mini program binding. Valid values: Y: Enabled. N (default): Disabled"},"MiniProgramName":{"type":"string","description":"The mini program name"},"Platform":{"type":"string","description":"The mini program platform to bind. Valid values: WECHAT: WeChat. ALIPAY: Alipay. TIKTOK: TikTok"},"CheckFileName":{"type":"string","description":"The name of the uploaded verification file"},"CheckFileBody":{"type":"string","description":"The content of the uploaded verification file"},"ReturnPicCount":{"type":"integer","description":"The number of face photos for evidence storage (1-5)"},"ReturnVideoLength":{"type":"integer","description":"The duration of the evidence storage video, in seconds"},"DeviceRiskPlus":{"type":"string","description":"Specifies whether to enable enhanced device risk detection. Valid values: Y: Enabled. N: Disabled"},"UseDegrade":{"type":"string","description":"Specifies whether to enable degradation"},"DegradeType":{"type":"string","description":"The degradation verification type"},"DegradeSubCodes":{"type":"string","description":"The SubCode that triggers degradation"},"DegradeAppScheme":{"type":"string","description":"The iOS app scheme for degradation redirect"}}}}}},"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/create-auth-key":{"post":{"operationId":"cloud_aliyun_cloudauth_create_auth_key","summary":"Obtains an authorization key for activating the offline facial recognition SDK","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"BizType":{"type":"string","description":"The business type. The value can be up to 64 characters in length. You can use this parameter to add remarks for a specific business, such…"},"UserDeviceId":{"type":"string","description":"The user device ID. The value can be up to 64 characters in length. You can use this parameter to identify a specific device. We recommend…"},"Test":{"type":"string","description":"The test identifier. Valid values: true: Uses test authorization. The authorization duration is 30 days by default. false: The…"},"AuthYears":{"type":"integer","description":"The authorization duration. This parameter is required when the Test parameter is set to false or is left empty. Unit: years. Valid…"}}}}}},"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/create-cloudauthst-scene":{"post":{"operationId":"cloud_aliyun_cloudauth_create_cloudauthst_scene","summary":"Creates an authentication scenario for enhanced ID Verification","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProductCode","SceneName"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ProductCode":{"type":"string","description":"The product code"},"SceneName":{"type":"string","description":"The scenario name"},"StoreImage":{"type":"string","description":"Specifies whether to deliver files generated during authentication to the customer's OSS. Valid values: Y: Enabled. N: 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/create-scene-config":{"post":{"operationId":"cloud_aliyun_cloudauth_create_scene_config","summary":"Creates a willingness authentication configuration","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["type","sceneId","config"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"type":{"type":"string","description":"The configuration type"},"sceneId":{"type":"integer","description":"The scenario ID"},"config":{"type":"string","description":"The willingness authentication configuration, in JSON string 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/create-verify-setting":{"post":{"operationId":"cloud_aliyun_cloudauth_create_verify_setting","summary":"Creates an ID Verification scenario configuration. This is equivalent to creating a verification scenario in…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BizType","BizName","Solution"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"BizType":{"type":"string","description":"The identifier of the verification scenario"},"BizName":{"type":"string","description":"The name of the verification scenario"},"Solution":{"type":"string","description":"The name of the verification solution"},"GuideStep":{"type":"string","description":"Specifies whether to use the default system guide page"},"PrivacyStep":{"type":"string","description":"Specifies whether to use the default system authorization page"},"ResultStep":{"type":"string","description":"Specifies whether to use the default system result page"}}}}}},"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/create-whitelist-setting":{"post":{"operationId":"cloud_aliyun_cloudauth_create_whitelist_setting","summary":"Creates a whitelist for ID Verification","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ServiceCode","ValidDay"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"SourceIp":{"type":"string","description":"The source IP address of the visitor. You do not need to specify this parameter. The system automatically obtains the value"},"Lang":{"type":"string","description":"The user language"},"ServiceCode":{"type":"string","description":"The service type. Valid values: antcloudauth: Financial-grade ID Verification. cloudauthst (discontinued): ID Verification Enhanced Edition"},"SceneId":{"type":"integer","description":"The scene ID"},"CertifyId":{"type":"string","description":"The certificate ID. The user associated with this authentication is added to the whitelist"},"CertNo":{"type":"string","description":"The ID card number to add to the whitelist"},"ValidDay":{"type":"integer","description":"The number of valid days after the whitelist is created"},"Remark":{"type":"string","description":"The remarks for the whitelist"},"WhitelistType":{"type":"string","description":"The whitelist 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/credential-product-verify-v2":{"post":{"operationId":"cloud_aliyun_cloudauth_credential_product_verify_v2","summary":"API operation for the product image tampering detection service. Detects image tampering, quality (clarity),…","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.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"CredType":{"type":"string","enum":["05"],"description":"The credential type. Only the following value is supported: 05 (product image)"},"CredName":{"type":"string","enum":["0501"],"description":"The credential name. Only the following value is supported: 0501 (product image)"},"ImageUrl":{"type":"string","description":"The URL of the image"},"ImageFile":{"type":"string","description":"The InputStream object of the image"},"MerchantId":{"type":"string","description":"The merchant ID"},"ProductCode":{"type":"string","enum":["ANTI_FAKE_CHECK"],"description":"The call mode. Only the following value is supported: ANTI_FAKE_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/credential-verify":{"post":{"operationId":"cloud_aliyun_cloudauth_credential_verify","summary":"Credential verification","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"CredType":{"type":"string","description":"The credential type. Valid values: 01: personal card and certificate 02: business scenario 03: enterprise qualification"},"CredName":{"type":"string","description":"The credential name. Valid values: 01: personal card and certificate 0101: ID card 0102: bank card 0104: teacher qualification certificate…"},"ImageUrl":{"type":"string","description":"The image URL. Specify either imageUrl or imageContext"},"ImageContext":{"type":"string","description":"The Base64-encoded image. Specify either imageUrl or imageContext"},"IsOCR":{"type":"string","description":"Specifies whether to enable optical character recognition (OCR). Valid values: 0: Disabled. 1: Enabled. You can set isOCR to 1 only when…"},"IsCheck":{"type":"string","description":"Specifies whether to enable authoritative verification. Valid values: 0: Disabled. 1: Enabled"},"UserName":{"type":"string","description":"The name"},"IdentifyNum":{"type":"string","description":"The ID card number"},"CertNum":{"type":"string","description":"The certificate number"},"MerchantId":{"type":"string","description":"The merchant ID. This parameter is required when CredName is set to 02"},"ProductCode":{"type":"string","description":"The call mode. Valid values: ANTI_FAKE_CHECK: image anti-forgery detection. ANTI_FAKE_VL: image anti-forgery detection and semantic…"},"PromptModel":{"type":"string","description":"The method to obtain the prompt for image semantic understanding. Valid values: DEFAULT: system default. CUSTOM: custom. Note: This…"},"Prompt":{"type":"string","description":"The custom prompt content for image semantic understanding. This parameter is required when PromptModel is set to CUSTOM"},"MerchantDetail":{"type":"string","description":"This parameter is required when PromptModel is set to DEFAULT (JSON-encoded)"}}}}}},"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/credential-verify-v2":{"post":{"operationId":"cloud_aliyun_cloudauth_credential_verify_v2","summary":"Credential verification","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"CredType":{"type":"string","description":"The credential type. Valid values: 01: personal card or certificate 02: business scenario 03: enterprise qualification"},"CredName":{"type":"string","description":"The credential name. Valid values: 01: personal card or certificate 0101: ID card 0102: bank card 0104: teacher qualification certificate…"},"ImageUrl":{"type":"string","description":"The URL of the image. Specify one of imageUrl, imageFile, or imageContext"},"ImageFile":{"type":"string","description":"The input stream of the image. Specify one of imageUrl, imageFile, or imageContext"},"ImageContext":{"type":"string","description":"The Base64-encoded image. Specify one of imageUrl, imageFile, or imageContext"},"IsOcr":{"type":"string","description":"Specifies whether to enable OCR. Deprecated>"},"IsCheck":{"type":"string","description":"Specifies whether to enable authoritative verification. Valid values: 0: Disabled. 1: Enabled. Deprecated>"},"UserName":{"type":"string","description":"The name"},"IdentifyNum":{"type":"string","description":"The ID card number"},"CertNum":{"type":"string","description":"The certificate number"},"MerchantId":{"type":"string","description":"The merchant ID. This parameter is required when CredName is set to 02"},"ProductCode":{"type":"string","description":"The call mode. Valid values: ANTI_FAKE_CHECK (default): image anti-forgery detection"},"PromptModel":{"type":"string","description":"This feature is offline. This parameter no longer takes effect"},"Prompt":{"type":"string","description":"This feature is offline. This parameter no longer takes effect"},"MerchantDetail":{"type":"string","description":"This feature is offline. This parameter no longer takes effect (JSON-encoded)"}}}}}},"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/deepfake-detect":{"post":{"operationId":"cloud_aliyun_cloudauth_deepfake_detect","summary":"Accepts a face image and uses algorithms to detect deepfake risks. Covers risk scenarios such as…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"OuterOrderNo":{"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…"},"FaceInputType":{"type":"string","description":"The input type of the face material. Valid values: IMAGE (default): face image VIDEO: face video Video processing takes longer. Set the…"},"FaceUrl":{"type":"string","description":"The URL of the face image. Specify either FaceUrl or FaceBase64"},"FaceBase64":{"type":"string","description":"The Base64-encoded face 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/delete-all-customize-flow-strategy":{"post":{"operationId":"cloud_aliyun_cloudauth_delete_all_customize_flow_strategy","summary":"Deletes all custom rate limiting policies","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["UserId"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"UserId":{"type":"integer","description":"The user ID"},"RegionId":{"type":"string","description":"The region 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/delete-ant-cloud-auth-scene":{"post":{"operationId":"cloud_aliyun_cloudauth_delete_ant_cloud_auth_scene","summary":"Deletes a China Finance Verification scene","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SceneId"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"SceneId":{"type":"integer","description":"The ID of the scene 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/delete-black-list-strategy":{"post":{"operationId":"cloud_aliyun_cloudauth_delete_black_list_strategy","summary":"Deletes a blacklist rule","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"RegionId":{"type":"string","description":"The region ID"},"Id":{"type":"integer","description":"The rule ID"},"ProductName":{"type":"string","description":"The product name. Valid values: id2meta: ID card two-element verification. mobile3Meta: Mobile number element verification. bankcardMeta:…"}}}}}},"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/delete-cloudauthst-scene":{"post":{"operationId":"cloud_aliyun_cloudauth_delete_cloudauthst_scene","summary":"Delete a specified authentication scene for Enhanced Real-person Identity Verification","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SceneId"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"SceneId":{"type":"string","description":"The ID of the scene to be deleted"}}}}}},"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/delete-control-strategy":{"post":{"operationId":"cloud_aliyun_cloudauth_delete_control_strategy","summary":"Delete a stability alert rule","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"RegionId":{"type":"string","description":"The region ID"},"Id":{"type":"integer","description":"The security rule ID"},"ApiName":{"type":"string","description":"The API name, same as ProductCode"},"ProductType":{"type":"string","description":"The product type. Currently, only ANT_CLOUD_AUTH (financial-grade real-person authentication) is supported. All other types have been…"}}}}}},"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/delete-customize-flow-strategy":{"post":{"operationId":"cloud_aliyun_cloudauth_delete_customize_flow_strategy","summary":"Deletes a custom rate limiting policy","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"Id":{"type":"integer","description":"The policy ID"},"UserId":{"type":"integer","description":"The user ID"},"ApiName":{"type":"string","description":"The API name, same as ProductCode"},"RegionId":{"type":"string","description":"The region ID"},"ProductType":{"type":"string","description":"The product type. Currently, only ANT_CLOUD_AUTH (financial-grade ID Verification) is supported. All other types have been discontinued"}}}}}},"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/delete-face-verify-result":{"post":{"operationId":"cloud_aliyun_cloudauth_delete_face_verify_result","summary":"API for deleting sensitive data in financial-grade services","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"CertifyId":{"type":"string","description":"The unique identifier for real-person authentication"},"DeleteAfterQuery":{"type":"string","description":"Specifies whether deletion depends on having retrieved the relevant data from the corresponding authentication process. Y: Required. To…"}}}}}},"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/delete-scene-config":{"post":{"operationId":"cloud_aliyun_cloudauth_delete_scene_config","summary":"Deletes a scenario configuration","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sceneConfigId"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"sceneConfigId":{"type":"integer","description":"The ID of the ID Verification scenario configuration"}}}}}},"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/delete-whitelist-setting":{"post":{"operationId":"cloud_aliyun_cloudauth_delete_whitelist_setting","summary":"Deletes the version of a specified cluster","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ServiceCode","Ids"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"SourceIp":{"type":"string","description":"The source IP address of the visitor. CIDR format and IPv4 format are supported. Example: 10.0.3.0/24"},"Lang":{"type":"string","description":"The language of the user information to delete. Valid values: zh: Chinese. en: English"},"ServiceCode":{"type":"string","description":"The service code of the ID Verification product. Set the value to antcloudauth"},"Ids":{"type":"string","description":"The list of rule IDs 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/describe-ant-and-cloud-auth-user-status":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_ant_and_cloud_auth_user_status","summary":"Queries the activation status of different ID Verification product plans","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.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/describe-auth-verify":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_auth_verify","summary":"Retrieves OCR results","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SceneId","CertifyId"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"SceneId":{"type":"integer","description":"The authentication scenario ID"},"CertifyId":{"type":"string","description":"The unique identifier for ID Verification. Obtain this value by calling InitAuthVerify to initiate an OCR 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/describe-card-verify":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_card_verify","summary":"Retrieves the verification result for image element verification","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CertifyId"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"CertifyId":{"type":"string","description":"The verification request ID. You must first call the InitCardVerify operation to submit a verification request before you can obtain 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/describe-cloudauthst-scene-list":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_cloudauthst_scene_list","summary":"Queries the authentication scenarios for enhanced ID Verification","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ProductCode":{"type":"string","description":"The commodity 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/describe-device-info":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_device_info","summary":"Such as authorization validity period, custom business identifiers defined by the integrating party, and…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"PageSize":{"type":"integer","description":"The number of entries per page"},"CurrentPage":{"type":"integer","description":"The current page number"},"DeviceId":{"type":"string","description":"The unique ID generated by the China Real Identity Authentication server for the device of the integrating party. This ID is generated…"},"BizType":{"type":"string","description":"The business type. Maximum of 64 characters"},"UserDeviceId":{"type":"string","description":"Maximum of 64 characters. Custom-defined by the integrating party to identify a specific device"},"ExpiredStartDay":{"type":"string","description":"The start time of the query, which queries the authorizations that expire between ExpiredStartDay and ExpiredEndDay"},"ExpiredEndDay":{"type":"string","description":"The end time of the query, which queries the authorizations that expire between ExpiredStartDay and ExpiredEndDay"}}}}}},"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/describe-face-guard-risk":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_face_guard_risk","summary":"Financial-grade Face Guard service","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"DeviceToken":{"type":"string","description":"The device token for risk identification"},"OuterOrderNo":{"type":"string","description":"The identifier used for subsequent troubleshooting. Ensure that this value is unique within your business. The value can contain letters…"},"ProductCode":{"type":"string","description":"The product code. Set this to FACE_GUARD"},"BizId":{"type":"string","description":"The authentication 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/describe-face-verify":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_face_verify","summary":"Retrieves the verification status and verification materials after the China-based mobile client receives a…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"SceneId":{"type":"integer","description":"The verification scenario ID"},"CertifyId":{"type":"string","description":"The unique identifier of the ID Verification request"},"PictureReturnType":{"type":"string","description":"The image return 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/describe-info-check-export-record":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_info_check_export_record","summary":"Queries export tasks for information verification in a paged manner","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ProductType":{"type":"string","description":"The product type. Valid values: ID_CARD_2_META: ID card two-element verification. ID_PERIOD: ID card validity period verification.…"},"StartDate":{"type":"string","description":"The query start time. Format: YYYY-MM-DD HH:mm:ss, for example, 2025-10-11 21:24:48"},"EndDate":{"type":"string","description":"The query end time. Format: YYYY-MM-DD HH:mm:ss, for example, 2025-10-11 21:24:48"},"CurrentPage":{"type":"integer","description":"The current page number"},"PageSize":{"type":"integer","description":"The number of entries per page"}}}}}},"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/describe-list-ant-cloud-auth-scenes":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_list_ant_cloud_auth_scenes","summary":"Queries the list of financial-grade authentication scenarios","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"SceneId":{"type":"integer","description":"The scenario 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/describe-list-face-verify-data":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_list_face_verify_data","summary":"Queries the list of facial recognition data","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"GmtStart":{"type":"integer","description":"The query start time"},"GmtEnd":{"type":"integer","description":"The query end time"},"SceneId":{"type":"integer","description":"The scene ID"},"Name":{"type":"string","description":"The product code. This parameter is deprecated"}}}}}},"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/describe-list-face-verify-infos":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_list_face_verify_infos","summary":"Retrieves facial recognition authentication records (legacy)","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"GmtStart":{"type":"integer","description":"The start time of the authentication query"},"GmtEnd":{"type":"integer","description":"The end time of the authentication query"},"CertifyId":{"type":"string","description":"The authentication ID"},"PageSize":{"type":"integer","description":"The number of entries per page in a paged query. Maximum value: 100. Default value: 10"},"PageNumber":{"type":"integer","description":"The current page number for pagination"},"Status":{"type":"integer","description":"The authentication status. Valid values: 1: Authentication passed. 2: Authentication failed"},"SceneId":{"type":"integer","description":"The scene 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/describe-meta-search-page-list":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_meta_search_page_list","summary":"Queries information verification details by paging","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Api","StartDate","EndDate","CurrentPage","PageSize"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"Api":{"type":"string","description":"The product API. Valid values: ID_CARD_2_META: ID card two-element verification. ID_PERIOD: ID card validity period verification.…"},"StartDate":{"type":"integer","description":"The start time of the query. The value is a UNIX timestamp in milliseconds"},"EndDate":{"type":"integer","description":"The end time of the query. The value is a UNIX timestamp in milliseconds"},"BizCode":{"type":"string","description":"The authentication status. Valid values: 1: Authentication passed. 2: Authentication failed. 3: No record found"},"SubCode":{"type":"string","description":"The result code. For more information, refer to the official documentation…"},"ReqId":{"type":"string","description":"The request ID"},"IdentifyNum":{"type":"string","description":"The ID card number"},"UserName":{"type":"string","description":"The name"},"CurrentPage":{"type":"integer","description":"The current page number"},"PageSize":{"type":"integer","description":"The number of entries per page"},"VehicleNum":{"type":"string","description":"The license plate number"},"Mobile":{"type":"string","description":"The mobile number"},"BankCard":{"type":"string","description":"The bank card number"},"IspName":{"type":"string","description":"The telecommunications service provider name. Valid values: CMCC: China Mobile. CUCC: China Unicom. CTCC: China Telecom"}}}}}},"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/describe-meta-statistics-list":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_meta_statistics_list","summary":"Queries statistics information for information verification authentication","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Api","StartDate","EndDate"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"Api":{"type":"string","description":"The product code. Valid values: ID_CARD_2_META: ID card two-element verification ID_PERIOD: ID card validity period verification…"},"StartDate":{"type":"integer","description":"The start time of the query. The value is a UNIX timestamp. Unit: milliseconds"},"EndDate":{"type":"integer","description":"The end time of the query. The value is a UNIX timestamp. Unit: milliseconds"}}}}}},"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/describe-meta-statistics-page-list":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_meta_statistics_page_list","summary":"Queries information verification data by paging","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Api","StartDate","EndDate","CurrentPage","PageSize"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"Api":{"type":"string","description":"The product API. Valid values: ID_CARD_2_META: ID card two-element verification ID_PERIOD: ID card validity period verification…"},"StartDate":{"type":"integer","description":"The start time of the query. The timestamp is in milliseconds"},"EndDate":{"type":"integer","description":"The end time of the query. The value is a UNIX timestamp"},"CurrentPage":{"type":"integer","description":"The current page number"},"PageSize":{"type":"integer","description":"The number of entries per page"}}}}}},"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/describe-oss-status":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_oss_status","summary":"Queries the status of OSS","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ServiceCode":{"type":"string","description":"The service code. Valid values: antcloudauth: Chinese financial-grade ID Verification. cloudauthst (discontinued): ID Verification…"}}}}}},"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/describe-oss-status-v2":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_oss_status_v2","summary":"Queries the OSS status of a user (V2)","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ServiceCode":{"type":"string","description":"The ServiceCode of the ID Verification product. Valid values: antcloudauth: financial-grade ID Verification. cloudauthst (discontinued):…"},"SourceIp":{"type":"string","description":"The source IP address of the visitor"}}}}}},"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/describe-oss-upload-token":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_oss_upload_token","summary":"Retrieves the token required for uploading photos to OSS","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.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/describe-page-face-verify-data":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_page_face_verify_data","summary":"Queries the paging statistics of financial-grade ID Verification invocations","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"StartDate":{"type":"string","description":"Required. The start time in the format of yyyy-MM-dd. The default time is yyyy-MM-dd 00:00:00. The maximum query interval is 90 days"},"EndDate":{"type":"string","description":"Required. The end time in the format of yyyy-MM-dd. The default time is yyyy-MM-dd 00:00:00. The maximum query interval is 90 days"},"SceneId":{"type":"integer","description":"The scene ID"},"ProductCode":{"type":"string","description":"The product code"},"CurrentPage":{"type":"integer","description":"The current page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10"}}}}}},"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/describe-page-setting":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_page_setting","summary":"Queries page settings and returns the reasons for authentication failure","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.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/describe-product-code":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_product_code","summary":"Retrieves the product codes for financial-grade ID Verification","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.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/describe-smart-statistics-page-list":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_smart_statistics_page_list","summary":"Queries the invoke statistics of enhanced ID Verification by using a paged query","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["StartDate","EndDate","SceneId","CurrentPage","PageSize"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"StartDate":{"type":"string","description":"The start time in UTC. Format: yyyy-MM-ddTHH:mm:ssZ"},"EndDate":{"type":"string","description":"The end time in UTC. Format: yyyy-MM-ddTHH:mm:ssZ"},"SceneId":{"type":"string","description":"The scene ID"},"CurrentPage":{"type":"string","description":"The current page number"},"PageSize":{"type":"string","description":"The number of entries per page"},"ServiceCode":{"type":"string","description":"The ServiceCode of the ID Verification product. The value can only be cloudauthst"}}}}}},"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/describe-verify-device-risk-statistics":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_verify_device_risk_statistics","summary":"Retrieves statistics of verification devices","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["StartDate","EndDate","ServiceCode"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ProductCode":{"type":"string","description":"The cloud product code"},"StartDate":{"type":"integer","description":"The start time of the query. The value is a UNIX timestamp in milliseconds, such as 1746720000000"},"EndDate":{"type":"integer","description":"The end time. The value is a UNIX timestamp in milliseconds, such as 1748624399999"},"ServiceCode":{"type":"string","description":"The service type. Valid values: antcloudauth: financial-grade ID Verification. cloudauthst (discontinued): ID Verification Enhanced…"},"SceneId":{"type":"string","description":"The scene 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/describe-verify-fail-statistics":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_verify_fail_statistics","summary":"Queries the total number of failed authentication requests","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProductCode","StartDate","EndDate","ServiceCode","Api"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ProductCode":{"type":"string","description":"The product code"},"StartDate":{"type":"integer","description":"The start time of the query. The value is a UNIX timestamp in milliseconds, such as 1760025600000"},"EndDate":{"type":"integer","description":"The end time of the query. The value is a UNIX timestamp in milliseconds, such as 1760630399999"},"ServiceCode":{"type":"string","description":"The service type. Valid values: antcloudauth: Financial-grade ID Verification. cloudauthst (discontinued): ID Verification Enhanced…"},"DeviceType":{"type":"string","description":"The device type. Valid values: ios android websdk"},"Api":{"type":"string","description":"The API code. Valid values: INIT_SERVICE: Server-side initialization failure. INIT_DEVICE: Client-side failure. VERIFY_DEVICE:…"},"AgeGt":{"type":"string","description":"Specifies whether the age is greater than 14. Valid values: T: Greater than 14. F: Less than 14"}}}}}},"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/describe-verify-personas-device-model-statistics":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_verify_personas_device_model_statistics","summary":"Queries the distribution data of phone models used by authenticated users","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TimeRange","ServiceCode"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"SceneId":{"type":"integer","description":"The scene ID"},"ProductCode":{"type":"string","description":"The product code"},"TimeRange":{"type":"string","description":"The time range for the query, indicating the number of preceding days. Format: a numeric string. Unit: days (d). A value of 30 indicates…"},"ServiceCode":{"type":"string","description":"The service type. Valid values: antcloudauth: financial-grade ID Verification. cloudauthst (discontinued): ID Verification enhanced edition"}}}}}},"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/describe-verify-personas-os-statistics":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_verify_personas_os_statistics","summary":"Queries the distribution data of authenticated devices","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TimeRange","ServiceCode"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"SceneId":{"type":"integer","description":"The scene ID"},"ProductCode":{"type":"string","description":"The product code"},"TimeRange":{"type":"string","description":"The time range for the query, indicating the number of preceding days. Format: a numeric string. Unit: days (d). A value of 7 indicates…"},"ServiceCode":{"type":"string","description":"The service type. Valid values: antcloudauth: financial-grade ID Verification. cloudauthst (discontinued): ID Verification Enhanced Edition"}}}}}},"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/describe-verify-personas-province-statistics":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_verify_personas_province_statistics","summary":"Queries authentication statistics by province where individuals are located","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TimeRange","ServiceCode"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"SceneId":{"type":"integer","description":"The scene ID"},"ProductCode":{"type":"string","description":"The cloud product code"},"TimeRange":{"type":"string","description":"The time range. The search range is the previous N days. Format: a numeric string. Unit: days (d). A value of 1 indicates the previous 1 day"},"ServiceCode":{"type":"string","description":"The service type. Valid values: antcloudauth: financial-grade ID Verification. cloudauthst (discontinued): ID Verification enhanced edition"}}}}}},"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/describe-verify-personas-sex-statistics":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_verify_personas_sex_statistics","summary":"Queries ID Verification statistics by gender","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TimeRange","ServiceCode"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"SceneId":{"type":"integer","description":"The scene ID"},"ProductCode":{"type":"string","description":"The product code"},"TimeRange":{"type":"string","description":"The time range. The search range is the previous N days. Format: a numeric string. Unit: days (d). A value of 7 indicates the previous 7…"},"ServiceCode":{"type":"string","description":"The service type. Valid values: antcloudauth: financial-grade ID Verification. cloudauthst (discontinued): ID Verification enhanced edition"}}}}}},"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/describe-verify-result":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_verify_result","summary":"Queries the result of an ID Verification task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BizId","BizType"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"BizId":{"type":"string","description":"The verification ID. A unique ID that identifies a verification task. The value can be up to 64 characters in length. For a single…"},"BizType":{"type":"string","description":"The business scenario identifier of the ID Verification service"}}}}}},"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/describe-verify-sdk":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_verify_sdk","summary":"Retrieves the download URL of an offline SDK","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"TaskId":{"type":"string","description":"The ID of the SDK generation task"}}}}}},"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/describe-verify-search-page-list":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_verify_search_page_list","summary":"Queries the details of authentication records with paging and conditional query","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CurrentPage","PageSize"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"CertifyId":{"type":"string","description":"The authentication ID"},"SceneId":{"type":"string","description":"The scene ID"},"OuterOrderNo":{"type":"string","description":"The unique identifier of the customer request"},"ProductCode":{"type":"string","description":"The product code"},"CertNo":{"type":"string","description":"The ID card number"},"StartDate":{"type":"string","description":"The start time of the query. Format: YYYY-MM-DD HH:mm:ss, such as 2025-10-10 00:00:00"},"EndDate":{"type":"string","description":"The end time of the query. Format: YYYY-MM-DD HH:mm:ss, such as 2025-10-16 23:59:59"},"SubCode":{"type":"string","description":"The result code. For more information about valid values, see SubCode description…"},"SubCodes":{"type":"string","description":"Comma-separated result codes. For more information about valid values, see SubCode description…"},"HasDeviceRisk":{"type":"string","description":"Specifies whether device risk exists. Set this parameter to true to indicate root = 1, simulator = 1, or virtual_video = 1"},"Passed":{"type":"string","description":"Indicates whether the authentication is passed. Valid values: T: Passed. F: Not passed"},"Model":{"type":"string","description":"The liveness detection model"},"CurrentPage":{"type":"string","description":"The current page number"},"PageSize":{"type":"string","description":"The number of entries per page"},"Root":{"type":"integer","description":"Specifies whether the device is rooted. Set this parameter to 1 if selected. Otherwise, do not pass this parameter. This corresponds to…"},"Simulator":{"type":"integer","description":"Specifies whether the device is a simulator. Set this parameter to 1 if selected. Otherwise, do not pass this parameter. This corresponds…"},"VirtualVideo":{"type":"integer","description":"Specifies whether virtual video adaptation is used. Set this parameter to 1 if selected. Otherwise, do not pass this parameter. This…"},"RiskDevice":{"type":"integer","description":"The device risk. Valid values: 0: No risk. 1: Risk exists"},"RiskDeviceToken":{"type":"integer","description":"The DeviceToken risk. Valid values: 0: No risk. 1: Risk exists"},"RiskGeneric":{"type":"integer","description":"The generic risk. Valid values: 0: No risk. 1: Risk exists"},"RiskBizScenario":{"type":"integer","description":"The business scenario risk. Valid values: 0: No risk. 1: Risk exists"},"RiskModelMining":{"type":"integer","description":"The large model mining risk. Valid values: 0: No risk. 1: Risk exists"}}}}}},"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/describe-verify-statistics":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_verify_statistics","summary":"Queries the statistics information of authentication requests","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["StartDate","EndDate","ServiceCode"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ProductCode":{"type":"string","description":"The product code"},"StartDate":{"type":"integer","description":"The start time of the query. Format: UNIX timestamp. Unit: milliseconds. Example: 1760025600000"},"EndDate":{"type":"integer","description":"The end time of the query. Format: UNIX timestamp. Unit: milliseconds. Example: 1760630399999"},"ServiceCode":{"type":"string","description":"The service type. Valid values: antcloudauth: financial-grade ID Verification. cloudauthst (discontinued): ID Verification - Enhanced…"},"AgeGt":{"type":"string","description":"Specifies whether the age is older than 14. Valid values: T: older than 14 F: younger than 14"}}}}}},"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/describe-verify-token":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_verify_token","summary":"Initiates an authentication request and obtains an authentication token. This operation is applicable to…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BizType","BizId"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"IdCardBackImageUrl":{"type":"string","description":"The HTTP or HTTPS URL of the national emblem side of the ID card image"},"BizType":{"type":"string","description":"The business scenario identifier for using the ID Verification service. Create one in the console first. For more information, see…"},"FailedRedirectUrl":{"type":"string","description":"The redirect URL upon verification failure"},"FaceRetainedImageUrl":{"type":"string","description":"The HTTP or HTTPS URL of the retained face photo"},"CallbackSeed":{"type":"string","description":"The callback seed"},"IdCardFrontImageUrl":{"type":"string","description":"The HTTP or HTTPS URL of the portrait side of the ID card image"},"UserId":{"type":"string","description":"The ID of the end user, such as the account ID of the end user"},"BizId":{"type":"string","description":"The authentication ID. A unique ID that identifies an authentication task. The value can be up to 64 characters in length. For a single…"},"Name":{"type":"string","description":"The name"},"IdCardNumber":{"type":"string","description":"The ID card number"},"PassedRedirectUrl":{"type":"string","description":"The redirect URL upon successful verification"},"CallbackUrl":{"type":"string","description":"The callback URL"},"UserIp":{"type":"string","description":"The IP address of the user"},"UserPhoneNumber":{"type":"string","description":"The phone number of the user"},"UserRegistTime":{"type":"integer","description":"The registration time of the user. Specify the value in UNIX timestamp format. Unit: milliseconds"}}}}}},"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/describe-whitelist-setting":{"post":{"operationId":"cloud_aliyun_cloudauth_describe_whitelist_setting","summary":"Queries the whitelist of a specified scenario","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ServiceCode","PageSize","CurrentPage"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"SourceIp":{"type":"string","description":"The source IP address of the visitor"},"Lang":{"type":"string","description":"The language of the query results. Valid values: zh: Chinese. en: English"},"ServiceCode":{"type":"string","description":"The service code. Valid values: cloudauthst: Enhanced Finance Edition. antcloudauth: Finance Edition"},"SceneId":{"type":"integer","description":"The scene ID"},"CertifyId":{"type":"string","description":"The certification ID"},"CertNo":{"type":"string","description":"The ID card number"},"ValidStartDate":{"type":"integer","description":"The start time of the validity period. Format: UNIX timestamp. Unit: milliseconds. Example: 1759939200000"},"ValidEndDate":{"type":"integer","description":"The end time of the validity period. Format: UNIX timestamp. Unit: milliseconds. Example: 1730304000000"},"Status":{"type":"string","description":"The whitelist status. Valid values: VALID: valid. INVALID: invalid. DELETED: deleted"},"PageSize":{"type":"integer","description":"The number of entries per page in a paged query"},"CurrentPage":{"type":"integer","description":"The current page number. Default value: 1"},"WhitelistType":{"type":"string","description":"The whitelist 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/detect-face-attributes":{"post":{"operationId":"cloud_aliyun_cloudauth_detect_face_attributes","summary":"Detects validity attributes of faces in a photo","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["MaterialValue"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"MaterialValue":{"type":"string","description":"The photo to be detected. For format details, see the notes on uploading image addresses. A maximum of 5 faces can be detected in a single…"},"BizType":{"type":"string","description":"The business scenario identifier for the ID Verification service"}}}}}},"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/download-verify-records":{"post":{"operationId":"cloud_aliyun_cloudauth_download_verify_records","summary":"Retrieves statistical call volume data","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ProductType":{"type":"string","description":"The product type. Valid values: FINANCE_VERIFY: financial-grade ID Verification SMART_VERIFY: enhanced ID Verification (discontinued)…"},"BizParam":{"type":"string","description":"The query conditions in JSON string format. The following fields are included: DownloadMode (String): the download mode. Example: sync…"}}}}}},"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/id2-meta-period-verify":{"post":{"operationId":"cloud_aliyun_cloudauth_id2_meta_period_verify","summary":"Verifies the validity period of a two-factor identity document","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ParamType":{"type":"string","description":"The parameter type. Valid values: normal: not encrypted. md5: MD5-encrypted"},"IdentifyNum":{"type":"string","description":"The ID card number. If paramType is set to normal, enter the ID card number in plaintext. If paramType is set to md5, the value is in the…"},"UserName":{"type":"string","description":"The name. paramType = normal: enter the name in plaintext. paramType = md5: the first character of the name is MD5-encrypted (32-bit…"},"ValidityStartDate":{"type":"string","description":"The start date of the ID card validity period. Format: YYYYMMDD"},"ValidityEndDate":{"type":"string","description":"The expiration date of the ID card validity period. Format: YYYYMMDD"}}}}}},"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/id2-meta-standard-verify":{"post":{"operationId":"cloud_aliyun_cloudauth_id2_meta_standard_verify","summary":"Two-factor identity verification Standard Edition","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ParamType":{"type":"string","description":"The parameter type. Valid values: normal: not encrypted. md5: MD5-encrypted"},"IdentifyNum":{"type":"string","description":"The ID card number. If ParamType is set to normal, enter the ID card number in plaintext. If ParamType is set to md5, the format is: first…"},"UserName":{"type":"string","description":"The name. If ParamType is set to normal, enter the name in plaintext. If ParamType is set to md5, the format is: first character of 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/id2-meta-verify":{"post":{"operationId":"cloud_aliyun_cloudauth_id2_meta_verify","summary":"Verifies the authenticity and consistency of a name and ID card number against 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.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ParamType":{"type":"string","description":"The encryption method. Valid values: normal: plaintext without encryption md5: MD5 encryption"},"IdentifyNum":{"type":"string","description":"The ID card number. Note Only second-generation resident ID card numbers and Hong Kong, Macao, and Taiwan residence permit numbers are…"},"UserName":{"type":"string","description":"The name. If ParamType is set to normal, enter the name in plaintext. If ParamType is set to md5, the format is: first character of 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/id2-meta-verify-with-ocr":{"post":{"operationId":"cloud_aliyun_cloudauth_id2_meta_verify_with_ocr","summary":"Verifies the authenticity and consistency of an identity by taking images of both sides of an ID card,…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"CertUrl":{"type":"string","description":"The image of the portrait side of the ID card. A publicly accessible HTTP or HTTPS URL. Specify either CertUrl or CertFile"},"CertFile":{"type":"string","description":"The input stream of the portrait side image of the ID card. Specify either CertUrl or CertFile"},"CertNationalUrl":{"type":"string","description":"The URL of the national emblem side image of the ID card. A publicly accessible HTTP or HTTPS URL. Specify either CertNationalUrl or…"},"CertNationalFile":{"type":"string","description":"The image of the national emblem side of the ID card. Specify either CertNationalUrl or CertNationalFile. You can also leave both empty"}}}}}},"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/id3-meta-verify":{"post":{"operationId":"cloud_aliyun_cloudauth_id3_meta_verify","summary":"Verifies the authenticity and consistency of a name, ID card number, and facial photo against an…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ParamType":{"type":"string","description":"The encryption method. Valid values: normal: plaintext without encryption. md5: MD5 encryption. Important All encrypted parameter values…"},"IdentifyNum":{"type":"string","description":"The ID card number: If paramType is set to normal: enter the ID card number in plaintext. If paramType is set to md5: first 6 digits of…"},"UserName":{"type":"string","description":"The name: If paramType is set to normal: enter the name in plaintext. If paramType is set to md5: ciphertext of the first character of the…"},"FaceUrl":{"type":"string","description":"The URL of the ID card portrait photo. The URL must be a publicly accessible HTTP or HTTPS link. Specify either CertUrl or CertFile"},"FaceFile":{"type":"string","description":"The input stream of the ID card portrait photo. Specify either CertUrl or CertFile"},"Crop":{"type":"string","description":"Specifies whether to allow cropping of the facial photo. By default, cropping is not allowed. Valid values: T: allows cropping. F: does…"},"FacePicture":{"type":"string","description":"The Base64-encoded facial photo"}}}}}},"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/id3-meta-verify-pro":{"post":{"operationId":"cloud_aliyun_cloudauth_id3_meta_verify_pro","summary":"Three-factor verification (premium edition)","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ParamType":{"type":"string","description":"The encryption method. Valid values: normal: Plaintext without encryption. sm2: SM2 encryption"},"IdentifyNum":{"type":"string","description":"The ID card number. If paramType is set to normal: Enter the ID card number in plaintext. If paramType is set to sm2: Enter the encrypted…"},"UserName":{"type":"string","description":"The name. If paramType is set to normal: Enter the name in plaintext. If paramType is set to sm2: Enter the encrypted name"},"FaceUrl":{"type":"string","description":"The URL of the facial photo. The URL must be a publicly accessible HTTP or HTTPS link"},"FaceFile":{"type":"string","description":"The input stream of the facial photo"},"Crop":{"type":"string","description":"Specifies whether to allow cropping of the facial photo. By default, cropping is not allowed. Valid values: T: Cropping is allowed. F:…"},"FacePicture":{"type":"string","description":"The Base64-encoded photo. If you use this method to submit the facial photo, check the photo size and do not submit an excessively large…"},"LivenessCheck":{"type":"string","description":"Specifies whether to enable liveness detection. Valid values: N (default): Liveness detection is disabled. Y: Liveness detection is enabled"},"EnableFallback":{"type":"string","description":"Specifies whether to allow fallback to a non-public security source. Valid values: N (default): Disabled. Y: Enabled"}}}}}},"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/id3-meta-verify-with-ocr":{"post":{"operationId":"cloud_aliyun_cloudauth_id3_meta_verify_with_ocr","summary":"Verifies the authenticity and consistency of facial recognition three-factor elements by accepting front and…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"CertUrl":{"type":"string","description":"The image of the portrait side of the ID card. A publicly accessible HTTP or HTTPS URL. Specify either CertUrl or CertFile"},"CertFile":{"type":"string","description":"The input stream of the portrait side image of the ID card. Specify either CertUrl or CertFile"},"CertNationalUrl":{"type":"string","description":"The URL of the national emblem side image of the ID card. A publicly accessible HTTP or HTTPS URL. Specify either CertNationalUrl or…"},"CertNationalFile":{"type":"string","description":"The image of the national emblem side of the ID card. Specify either CertNationalUrl or CertNationalFile, or leave both empty"}}}}}},"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/init-auth-verify":{"post":{"operationId":"cloud_aliyun_cloudauth_init_auth_verify","summary":"Initiates an OCR request","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SceneId","OuterOrderNo","ProductCode","MetaInfo","CardType","CardPageNumber"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"SceneId":{"type":"integer","description":"The China Chinese authentication scenario ID"},"OuterOrderNo":{"type":"string","description":"A custom business unique identifier that you specify for subsequent troubleshooting. The value can contain letters (both uppercase and…"},"ProductCode":{"type":"string","description":"The product solution to use. Set the value to ID_OCR"},"MetaInfo":{"type":"string","description":"The MetaInfo environment parameter, which must be obtained from the client SDK"},"CardType":{"type":"string","description":"The document type. Set the value to IDENTITY_CARD"},"IdSpoof":{"type":"string","description":"Specifies whether to enable the document anti-forgery detection feature. Valid values: Y: Enabled. N: Disabled. This is the default value"},"CallbackUrl":{"type":"string","description":"The callback URL for OCR results. The callback request method is GET by default. The callback URL must start with https. After OCR is…"},"CallbackToken":{"type":"string","description":"A security token that you generate to prevent replay attacks and data tampering. If this value is set, the CallbackToken field is included…"},"CardPageNumber":{"type":"string","description":"The number of card pages collected by the SDK. Valid values: \"1\": front side only \"2\": both front and back sides"},"DocScanMode":{"type":"string","description":"The OCR document scan pattern. Valid values: shoot (default): photo capture scan: scan auto: automatic switchover between photo capture…"}}}}}},"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/init-card-verify":{"post":{"operationId":"cloud_aliyun_cloudauth_init_card_verify","summary":"Initiates an image verification authentication request","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["MerchantBizId","MetaInfo","CardType","Model","VerifyMeta","CardPageNumber","PictureSave"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"MerchantBizId":{"type":"string","description":"A custom business unique identifier that you define for subsequent troubleshooting. The value is a combination of letters and digits up to…"},"MetaInfo":{"type":"string","description":"The MetaInfo environment parameter. Obtain this value by using the client SDK"},"CardType":{"type":"string","description":"The document type. Valid values: IDENTITY_CARD: resident identity card"},"Model":{"type":"string","description":"The verification mode. Valid values: OCR_VERIFY: OCR recognition and authentication mode"},"VerifyMeta":{"type":"string","description":"The verification type. Valid values: ID_2_META: two-factor identity verification (name + ID card number)"},"CardPageNumber":{"type":"string","description":"The number of card pages to be collected by the SDK. Valid values: 1: collects the front side only. 2: collects both the front and back…"},"PictureSave":{"type":"string","description":"Specifies whether to temporarily store images collected by the app. Valid values: Y: Yes. N: No. If you set this parameter to Y, the query…"},"CallbackUrl":{"type":"string","description":"The callback URL for authentication results. The URL must start with https. After the authentication is complete, the system sends a…"},"CallbackToken":{"type":"string","description":"The security token used for anti-replay and anti-tampering verification. If you specify this parameter, the CallbackToken field is…"},"DocScanMode":{"type":"string","description":"The photo capture mode (manual or automatic). Valid values: shoot: manual capture scan: scan mode auto: automatic switchover"}}}}}},"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/init-face-verify":{"post":{"operationId":"cloud_aliyun_cloudauth_init_face_verify","summary":"Obtains a CertifyId before each authentication session, which is used to correlate the various API…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"SceneId":{"type":"integer","description":"The authentication scene ID"},"OuterOrderNo":{"type":"string","description":"The unique identifier of the merchant request. The value is a 32-character alphanumeric string. The first few characters are a custom…"},"ProductCode":{"type":"string","description":"A fixed value. This parameter varies depending on the product plan: APP authentication plan: The fixed value is ID_PRO. Face liveness…"},"CertType":{"type":"string","description":"The certificate type. Currently, only ID cards are supported. Set this parameter to IDENTITY_CARD"},"CertName":{"type":"string","description":"The real name"},"CertNo":{"type":"string","description":"The certificate number"},"ReturnUrl":{"type":"string","description":"The target URL to which the merchant business page redirects"},"FaceContrastPicture":{"type":"string","description":"The Base64-encoded photo. Among the four image input methods (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, and OSS), select…"},"MetaInfo":{"type":"string","description":"The Metainfo environment parameter, which must be obtained through the client SDK"},"Mobile":{"type":"string","description":"The mobile phone number of the user"},"Ip":{"type":"string","description":"The IP address of the user"},"UserId":{"type":"string","description":"The custom user ID defined by the business. Keep this value unique"},"FaceContrastPictureUrl":{"type":"string","description":"The OSS photo URL. Currently, only authorized OSS photo URLs are supported. Among the four image input methods (FaceContrastPicture,…"},"CertifyId":{"type":"string","description":"This parameter will be deprecated. The CertifyId from a previous successful ID Verification session. The photo from that authentication is…"},"OssBucketName":{"type":"string","description":"The bucket name of the authorized OSS space. Among the four image input methods (FaceContrastPicture, FaceContrastPictureUrl, CertifyId,…"},"OssObjectName":{"type":"string","description":"The file name in the authorized OSS space. Among the four image input methods (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, and…"},"Model":{"type":"string","description":"The liveness detection type. Valid values: The liveness detection type supports only the following values. Custom actions or combinations…"},"CallbackUrl":{"type":"string","description":"The callback notification URL for the authentication result. The default callback request method is GET, and the callback URL must start…"},"CallbackToken":{"type":"string","description":"The security token that you generate to prevent duplication and tampering. If this value is set, the CallbackToken field is displayed in…"},"Crop":{"type":"string","description":"Specifies whether to allow cropping of face images. Cropping is not allowed by default. T: Cropping is allowed. F: Cropping is not…"},"CertifyUrlType":{"type":"string","description":"The Web SDK device type. Valid values: WEB or H5. Only Web SDK device types are supported"},"AuthId":{"type":"string","description":"The user authorization ID. Maximum length: 64 characters"},"EncryptType":{"type":"string","description":"The encryption algorithm. Currently, only the SM2 national cryptographic algorithm is supported. After encrypted transmission is enabled,…"},"VoluntaryCustomizedContent":{"type":"string","description":"The custom voluntary content. This parameter is required when personalized settings are enabled. The format is a JSON string of a String…"},"SuitableType":{"type":"string","description":"The elderly-friendly configuration parameter. This parameter takes effect for each authentication request. You can select different…"},"ProcedurePriority":{"type":"string","description":"The degradation configuration when WebRTC or WebAssembly incompatibility occurs during mobile H5 authentication. keep: Degradation is not…"},"Mode":{"type":"string","description":"The method for obtaining passport NFC verification elements: 1: User input. The end user manually enters certificate element information…"},"ReadImg":{"type":"string","description":"Specifies whether to read the certificate photo: Y: Read. N: Do not read. If the certificate face photo is needed in subsequent…"},"Birthday":{"type":"string","description":"The date of birth on the certificate. This field is required when the certificate type CertType is set to PASSPORT and Mode is set to 3"},"ValidityDate":{"type":"string","description":"The certificate expiration date. This field is required when the certificate type CertType is set to PASSPORT and Mode is set to 3"},"CertifyUrlStyle":{"type":"string","description":"The type of the returned CertifyUrl. Valid values: L: Original long URL. S (default): Short URL"},"FaceGuardOutput":{"type":"string","description":"The device assistant tag type. Valid values: DeviceRisk. Selecting device assistant output incurs additional fees. For more information,…"},"RarelyCharacters":{"type":"string","description":"Specifies whether to enable the rare character mode: Y: Enabled. An information input box pops up before authentication, requiring the…"},"UiCustomUrl":{"type":"string","description":"The UI configuration file URL. You can view the complete configuration in Web SDK UI custom configuration…"},"VideoEvidence":{"type":"string","description":"Specifies whether to enable video evidence: true: Enabled. false: Disabled (default). Because video files are large, the system discards…"},"AppQualityCheck":{"type":"string","description":"Specifies whether the SDK enables strict face quality detection: Y: Enabled. N: Disabled (default). If this parameter is enabled, the SDK…"},"CameraSelection":{"type":"string","description":"Specifies whether to enable the camera selection feature: Y: Enabled. N: Disabled (default). This feature takes effect only for PC…"},"NeedMultiFaceCheck":{"type":"string","description":"Specifies whether to block authentication when multiple faces are detected on the device. Valid values: Y: Block. The client prompts the…"},"H5DegradeConfirmBtn":{"type":"string","description":"Specifies whether to display the \"I have completed authentication\" button on the H5 degradation page after authentication is complete: Y:…"},"EnableBeauty":{"type":"string","description":"Specifies whether to enable beauty mode: Y/N"}}}}}},"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/insert-white-list-setting":{"post":{"operationId":"cloud_aliyun_cloudauth_insert_white_list_setting","summary":"Adds an ID Verification whitelist entry","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ServiceCode":{"type":"string","description":"The ServiceCode of the ID Verification cloud service. Set this parameter to antcloudauth"},"SceneId":{"type":"integer","description":"The verification scenario ID. This ID is automatically generated after you create a verification scenario in the console. For information…"},"CertifyId":{"type":"string","description":"The unique identifier of the ID Verification request"},"CertNo":{"type":"string","description":"The certificate number"},"ValidDay":{"type":"integer","description":"The number of days the whitelist entry is valid. Valid values: 3, 7, and 30"},"Remark":{"type":"string","description":"The remarks. The maximum length is 32 characters"}}}}}},"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/liveness-face-verify":{"post":{"operationId":"cloud_aliyun_cloudauth_liveness_face_verify","summary":"LivenessFaceVerify is a service that performs passive liveness detection on face images submitted through an…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"SceneId":{"type":"integer","description":"The ID of the authentication scenario. This ID is automatically generated after you create an authentication scenario in the console"},"OuterOrderNo":{"type":"string","description":"The custom business unique identity on the client side, which is used for subsequent troubleshooting. The value can contain up to 32…"},"ProductCode":{"type":"string","description":"Fixed value: LR_FR_MIN"},"FaceContrastPicture":{"type":"string","description":"The Base64 encoding of the photo"},"DeviceToken":{"type":"string","description":"The device token, which is used for risk identification"},"Mobile":{"type":"string","description":"The mobile phone number of the user"},"Ip":{"type":"string","description":"The IP address of the user network"},"UserId":{"type":"string","description":"The custom user ID (up to 100 characters). Make sure the value is unique"},"FaceContrastPictureUrl":{"type":"string","description":"The URL of the image"},"CertifyId":{"type":"string","description":"The unique identity of the ID Verification request"},"OssBucketName":{"type":"string","description":"The bucket name of the authorization-granted OSS bucket"},"OssObjectName":{"type":"string","description":"The file name in the authorization-granted OSS bucket"},"Model":{"type":"string","description":"The liveness detection parameter"},"Crop":{"type":"string","description":"Specifies whether to allow trim of the face image. Valid values: T: Trim is allowed. F (default): Trim is not allowed"}}}}}},"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/mobile2-meta-verify":{"post":{"operationId":"cloud_aliyun_cloudauth_mobile2_meta_verify","summary":"Verifies the consistency of a mobile phone number and the owner's name","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ParamType","UserName","Mobile"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ParamType":{"type":"string","description":"The encryption method. Valid values: normal: plaintext without encryption md5: MD5 encryption"},"UserName":{"type":"string","description":"The name. Valid values: If ParamType is set to normal, pass in the name in plaintext. If ParamType is set to md5, pass in the…"},"Mobile":{"type":"string","description":"The mobile phone number. Valid values: If ParamType is set to normal, pass in the mobile phone number in plaintext. If ParamType is set to…"}}}}}},"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/mobile3-meta-detail-standard-verify":{"post":{"operationId":"cloud_aliyun_cloudauth_mobile3_meta_detail_standard_verify","summary":"Verifies the three-element identity of a phone number (detailed version - standard edition)","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ParamType":{"type":"string","description":"The parameter type. Valid values: normal: not encrypted. md5: MD5-encrypted"},"IdentifyNum":{"type":"string","description":"The ID card number. If ParamType is set to normal, pass in the ID card number in plaintext. If ParamType is set to md5, pass in the…"},"UserName":{"type":"string","description":"The name. If ParamType is set to normal, pass in the name in plaintext. If ParamType is set to md5, pass in the MD5-encrypted name"},"Mobile":{"type":"string","description":"The phone number. If ParamType is set to normal, pass in the phone number in plaintext. If ParamType is set to md5, pass in 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/mobile3-meta-detail-verify":{"post":{"operationId":"cloud_aliyun_cloudauth_mobile3_meta_detail_verify","summary":"Verifies the authenticity and consistency of a phone number, name, and ID card number against authoritative…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ParamType":{"type":"string","description":"The encryption method. Valid values: normal: plaintext without encryption md5: MD5 encryption"},"IdentifyNum":{"type":"string","description":"The ID card number. Note: Only second-generation resident ID card numbers and Hong Kong, Macao, or Taiwan residence permit numbers are…"},"UserName":{"type":"string","description":"The name. If ParamType is set to normal, pass in the name in plaintext. If ParamType is set to md5, pass in the name in ciphertext"},"Mobile":{"type":"string","description":"The phone number. If ParamType is set to normal, pass in the phone number in plaintext. If ParamType is set to md5, pass in the phone…"}}}}}},"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/mobile3-meta-simple-standard-verify":{"post":{"operationId":"cloud_aliyun_cloudauth_mobile3_meta_simple_standard_verify","summary":"Verifies the three-element identity of a phone number (Standard Edition)","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ParamType":{"type":"string","description":"The parameter type. Valid values: normal: not encrypted. md5: MD5-encrypted"},"IdentifyNum":{"type":"string","description":"The ID card number. Valid values: If ParamType is set to normal, pass in the ID card number in plaintext. If ParamType is set to md5, pass…"},"UserName":{"type":"string","description":"The name. Valid values: If ParamType is set to normal, pass in the name in plaintext. If ParamType is set to md5, pass in the…"},"Mobile":{"type":"string","description":"The phone number. Valid values: If ParamType is set to normal, pass in the phone number in plaintext. If ParamType is set to md5, pass 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/mobile3-meta-simple-verify":{"post":{"operationId":"cloud_aliyun_cloudauth_mobile3_meta_simple_verify","summary":"Pass in the name and ID card number to verify their authenticity and consistency through authoritative data…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ParamType":{"type":"string","description":"Encryption method: normal: plaintext, no encryption md5: MD5 encryption"},"IdentifyNum":{"type":"string","description":"ID card number: Note Only the ID numbers of the second-generation resident ID card and Hong Kong, Macao, and Taiwan residence permits are…"},"UserName":{"type":"string","description":"Name: When paramType is set to normal: pass in the name in plaintext. When paramType is set to md5: pass in the encrypted name"},"Mobile":{"type":"string","description":"Mobile number: When paramType is set to normal: pass in the mobile number in plaintext. When paramType is set to md5: pass in 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/mobile-detect":{"post":{"operationId":"cloud_aliyun_cloudauth_mobile_detect","summary":"Detects phone numbers","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ParamType":{"type":"string","description":"The encryption method. Valid values: normal: plaintext without encryption md5: MD5 encryption"},"Mobiles":{"type":"string","description":"The list of phone numbers"}}}}}},"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/mobile-online-status":{"post":{"operationId":"cloud_aliyun_cloudauth_mobile_online_status","summary":"Queries the network availability status of a phone number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ParamType":{"type":"string","description":"The parameter type. Valid values: normal: not encrypted. md5: MD5-encrypted"},"Mobile":{"type":"string","description":"The phone number. Valid values: If paramType is set to normal, pass in the phone number in plaintext. If paramType is set to md5, pass 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/mobile-online-time":{"post":{"operationId":"cloud_aliyun_cloudauth_mobile_online_time","summary":"Queries the length of time a phone number has been active on a network","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ParamType":{"type":"string","description":"The parameter type. Valid values: normal: not encrypted. md5: MD5-encrypted"},"Mobile":{"type":"string","description":"The phone number. Valid values: If paramType is set to normal, pass in the phone number in plaintext. If paramType is set to md5, pass 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/mobile-recycled-meta-verify":{"post":{"operationId":"cloud_aliyun_cloudauth_mobile_recycled_meta_verify","summary":"Verifies whether a phone number has been reassigned to a new subscriber","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ParamType","RegisterDate","Mobile"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ParamType":{"type":"string","description":"The encryption method. Valid values: normal: plaintext without encryption md5: MD5 encryption"},"RegisterDate":{"type":"string","description":"The registration date in the format YYYYMMDD. For example, 19800101 indicates January 1, 1980"},"Mobile":{"type":"string","description":"The phone number. Valid values: If ParamType is set to normal, pass in the phone number in plaintext. If ParamType is set to md5, pass 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/modify-black-list-strategy":{"post":{"operationId":"cloud_aliyun_cloudauth_modify_black_list_strategy","summary":"Creates or modifies a blacklist rule","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"RegionId":{"type":"string","description":"The region ID"},"BlackListStrategy":{"type":"string","description":"The blacklist rule (JSON-encoded)"}}}}}},"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/modify-control-strategy":{"post":{"operationId":"cloud_aliyun_cloudauth_modify_control_strategy","summary":"Adjusts stability alert rules","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ControlStrategyList":{"type":"string","description":"The list of security alert rules (JSON-encoded)"},"RegionId":{"type":"string","description":"The region ID of the Smart Access Gateway instance"},"ProductType":{"type":"string","description":"The product type. Currently, only ANT_CLOUD_AUTH (financial-grade ID Verification) is supported. All other types have been discontinued"}}}}}},"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/modify-customize-flow-strategy-list":{"post":{"operationId":"cloud_aliyun_cloudauth_modify_customize_flow_strategy_list","summary":"Adjusts the list of custom rate limiting policies","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"StrategyObject":{"type":"string","description":"The policy list (JSON-encoded)"},"ProductType":{"type":"string","description":"The product type. Currently, only ANT_CLOUD_AUTH (financial-grade ID Verification) is supported. All other types have been discontinued"}}}}}},"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/modify-device-info":{"post":{"operationId":"cloud_aliyun_cloudauth_modify_device_info","summary":"Updates device-related information, such as extending the device authorization validity period, updating…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DeviceId"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"DeviceId":{"type":"string","description":"The unique ID generated by the ID Verification server for the device of the requester. This ID is generated only after the device is…"},"UserDeviceId":{"type":"string","description":"The updated user device ID. The value can be up to 64 characters in length. This parameter is defined by the requester and can be used to…"},"BizType":{"type":"string","description":"The updated business type. The value can be up to 64 characters in length. This parameter is defined by the requester and can be used to…"},"Duration":{"type":"string","description":"The period by which to extend the device expiration time. Unit: years. Valid values: 1 to 100. A value of 100 indicates permanent use. One…"},"ExpiredDay":{"type":"string","description":"The expiration time of the current device. An error is returned if the expiration date is incorrect (differs from the expiration time…"}}}}}},"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/page-query-white-list-setting":{"post":{"operationId":"cloud_aliyun_cloudauth_page_query_white_list_setting","summary":"Queries ID Verification whitelist configurations by paging","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ServiceCode":{"type":"string","description":"The ServiceCode of the ID Verification cloud service. Value: antcloudauth"},"SceneId":{"type":"integer","description":"The verification scenario ID. This ID is automatically generated after you create a verification scenario in the console. For information…"},"CertifyId":{"type":"string","description":"The unique identifier of the ID Verification"},"CertNo":{"type":"string","description":"The certificate number"},"ValidStartDate":{"type":"string","description":"The start date of the validity period (timestamp in milliseconds)"},"ValidEndDate":{"type":"string","description":"The end date of the validity period (timestamp in milliseconds)"},"Status":{"type":"string","description":"The status. Valid values: DELETE: Deleted. VALID: Not deleted and within the validity period (valid). INVALID: Not deleted but not within…"},"CurrentPage":{"type":"integer","description":"The current page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10"}}}}}},"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/query-black-list-strategy":{"post":{"operationId":"cloud_aliyun_cloudauth_query_black_list_strategy","summary":"Queries the blacklist configuration list","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"RegionId":{"type":"string","description":"The region 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/query-control-strategy":{"post":{"operationId":"cloud_aliyun_cloudauth_query_control_strategy","summary":"Queries the list of stability rules. The system monitors the stability of the server-side InitFaceVerify…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"RegionId":{"type":"string","description":"The region ID"},"ProductType":{"type":"string","description":"The product type. Currently, only ANT_CLOUD_AUTH (financial-grade ID Verification) is supported. All other product types have been…"}}}}}},"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/query-customize-flow-strategy":{"post":{"operationId":"cloud_aliyun_cloudauth_query_customize_flow_strategy","summary":"Queries security rules","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["UserId"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"UserId":{"type":"integer","description":"The user ID"},"RegionId":{"type":"string","description":"The region ID"},"ProductType":{"type":"string","description":"The product type. Currently, only ANT_CLOUD_AUTH (financial-grade ID Verification) is supported. All other types have been discontinued"}}}}}},"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/query-scene-configs":{"post":{"operationId":"cloud_aliyun_cloudauth_query_scene_configs","summary":"Queries the list of intent verification settings","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["type"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"type":{"type":"string","description":"The scenario 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/query-verify-download-task":{"post":{"operationId":"cloud_aliyun_cloudauth_query_verify_download_task","summary":"Queries an ID Verification download task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"DownloadTaskId":{"type":"string","description":"The download task 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/query-verify-flow-package":{"post":{"operationId":"cloud_aliyun_cloudauth_query_verify_flow_package","summary":"Queries data transfer plans","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProductType"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ProductType":{"type":"string","description":"The product type. Valid values: FINANCE_VERIFY: Financial-grade ID Verification. SMART_VERIFY: Enhanced ID Verification (discontinued).…"}}}}}},"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/query-verify-invoke-satistic":{"post":{"operationId":"cloud_aliyun_cloudauth_query_verify_invoke_satistic","summary":"Queries the call volume of a product code based on different product plans","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"StatisticsType":{"type":"string","description":"The statistics dimension. Valid values: day: daily. month: monthly"},"StartDate":{"type":"integer","description":"The query start time. Format: UNIX timestamp. Unit: milliseconds. Example: 1743436800000"},"EndDate":{"type":"integer","description":"The query end time. Format: UNIX timestamp. Unit: milliseconds. Example: 1761926399999"},"ProductType":{"type":"string","description":"The product type. Valid values: FINANCE_VERIFY: Finance-grade ID Verification. SMART_VERIFY: Enhanced ID Verification (discontinued).…"},"SceneIdList":{"type":"string","description":"The list of common scenarios"},"ProductProgramList":{"type":"string","description":"The list of product codes to query. For specific values, refer to the productCode under the corresponding ProductType"},"PageSize":{"type":"integer","description":"The number of entries per page"},"CurrentPage":{"type":"integer","description":"The current page number"}}}}}},"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/remove-white-list-setting":{"post":{"operationId":"cloud_aliyun_cloudauth_remove_white_list_setting","summary":"Deletes an ID Verification whitelist","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ServiceCode":{"type":"string","description":"The ServiceCode of the ID Verification service. Set this parameter to antcloudauth"},"Ids":{"type":"string","description":"The IDs of the whitelists to delete in batch (JSON-encoded)"}}}}}},"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/update-ant-cloud-auth-scene":{"post":{"operationId":"cloud_aliyun_cloudauth_update_ant_cloud_auth_scene","summary":"Updates a China Finance Certification scenario","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SceneId"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"SceneId":{"type":"integer","description":"The scenario ID"},"Status":{"type":"integer","description":"This parameter has no effect. You do not need to specify this parameter"},"SceneName":{"type":"string","description":"The scenario name"},"StoreImage":{"type":"string","description":"Specifies whether to deliver authentication files generated during the authentication process to your OSS bucket. Valid values: Y:…"},"BindMiniProgram":{"type":"string","description":"Specifies whether to bind a mini program. Valid values: Y: enabled. N (default): disabled. If you enable mini program binding, make sure…"},"MiniProgramName":{"type":"string","description":"The name of the mini program"},"Platform":{"type":"string","description":"The mini program platform. Valid values: WECHAT: WeChat ALIPAY: Alipay TIKTOK: TikTok"},"CheckFileName":{"type":"string","description":"The name of the uploaded verification file"},"CheckFileBody":{"type":"string","description":"The content of the uploaded verification file"},"ReturnPicCount":{"type":"integer","description":"The number of returned photos (1 to 5). This parameter takes effect after StoreImage is enabled for authentication file retention"},"ReturnVideoLength":{"type":"integer","description":"The duration of the returned video (1 to 2 seconds). This parameter takes effect after StoreImage is enabled"},"DeviceRiskPlus":{"type":"string","description":"Specifies whether to enable enhanced device risk detection. Valid values: Y: enabled. N: disabled"},"UseDegrade":{"type":"string","description":"Specifies whether to enable degraded authentication"},"DegradeType":{"type":"string","description":"Specifies whether to enable degraded authentication"},"DegradeSubCodes":{"type":"string","description":"The SubCode that triggers degradation"},"DegradeAppScheme":{"type":"string","description":"The iOS app scheme for degradation"}}}}}},"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/update-scene-config":{"post":{"operationId":"cloud_aliyun_cloudauth_update_scene_config","summary":"Updates the intent scenario configuration","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","sceneId","config"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"id":{"type":"integer","description":"The ID of the intent configuration"},"sceneId":{"type":"integer","description":"The selected verification scenario"},"config":{"type":"string","description":"The scenario configuration in JSON format. For the specific structure definition, refer to the additional information about configurations"}}}}}},"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/vehicle5-item-query":{"post":{"operationId":"cloud_aliyun_cloudauth_vehicle5_item_query","summary":"Identifies the five key attributes of a vehicle","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"VehicleType":{"type":"string","description":"The vehicle type. 02: standard passenger car 52: new energy passenger car"},"VehicleNum":{"type":"string","description":"The license plate number. If ParamType is set to normal, enter the plaintext value. If ParamType is set to md5, enter the plaintext of the…"},"ParamType":{"type":"string","description":"The parameter type. Valid values: normal: Not encrypted. md5: MD5-encrypted"}}}}}},"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/vehicle-insure-query":{"post":{"operationId":"cloud_aliyun_cloudauth_vehicle_insure_query","summary":"Queries the insurance date of a vehicle","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ParamType":{"type":"string","description":"The parameter type. Valid values: normal: not encrypted. md5: MD5-encrypted"},"VehicleType":{"type":"string","description":"The vehicle type on the driving license"},"VehicleNum":{"type":"string","description":"The license plate number. If ParamType is set to normal, enter the plaintext value. If ParamType is set to md5, enter the plaintext of the…"},"Vin":{"type":"string","description":"The vehicle identification number (VIN). If ParamType is set to normal, enter the plaintext value. 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/vehicle-meta-verify":{"post":{"operationId":"cloud_aliyun_cloudauth_vehicle_meta_verify","summary":"Verifies vehicle element consistency","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ParamType":{"type":"string","description":"The parameter type. Valid values: normal: not encrypted. md5: MD5-encrypted"},"VehicleType":{"type":"string","description":"The vehicle type"},"VerifyMetaType":{"type":"string","description":"The verification type. VEHICLE_2_META: two-element verification. Verifies the name and license plate number. VEHICLE_3_META: three-element…"},"IdentifyNum":{"type":"string","description":"The ID card number. This parameter is required when VerifyMetaType is set to VEHICLE_3_META. When paramType is set to normal, enter the…"},"UserName":{"type":"string","description":"The name. Note When paramType is set to normal, enter the plaintext. When paramType is set to md5, enter the MD5-encrypted first character…"},"VehicleNum":{"type":"string","description":"The license plate number. When paramType is set to normal, enter the plaintext. When paramType is set to md5, enter the characters of 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/vehicle-meta-verify-v2":{"post":{"operationId":"cloud_aliyun_cloudauth_vehicle_meta_verify_v2","summary":"Verifies vehicle element information (enhanced edition)","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ParamType":{"type":"string","description":"The parameter type. Valid values: normal: not encrypted. md5: MD5-encrypted"},"VehicleType":{"type":"string","description":"The vehicle type"},"VerifyMetaType":{"type":"string","description":"The verification type. VEHICLE_2_META: two-element verification. Verifies the name and license plate number. VEHICLE_3_META: three-element…"},"IdentifyNum":{"type":"string","description":"The ID card number. This parameter is required when VerifyMetaType is set to VEHICLE_3_META. If ParamType is set to normal, enter the…"},"UserName":{"type":"string","description":"The name. If ParamType is set to normal, enter the plaintext value. If ParamType is set to md5, enter the MD5-encrypted first character of…"},"VehicleNum":{"type":"string","description":"The license plate number. If ParamType is set to normal, enter the plaintext value. If ParamType is set to md5, enter the license plate…"}}}}}},"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/vehicle-query":{"post":{"operationId":"cloud_aliyun_cloudauth_vehicle_query","summary":"Identifies vehicle information","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"ParamType":{"type":"string","description":"The parameter type. Valid values: normal: not encrypted. md5: MD5-encrypted"},"VehicleType":{"type":"string","description":"The vehicle type"},"VehicleNum":{"type":"string","description":"The license plate number. If ParamType is set to normal, enter the plaintext license plate 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/verify-material":{"post":{"operationId":"cloud_aliyun_cloudauth_verify_material","summary":"Submits a name, ID card number, facial photo, and optional front and back photos of the ID card for ID…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FaceImageUrl","BizType","BizId","Name","IdCardNumber"],"properties":{"endpoint":{"type":"string","enum":["https://cloudauth.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.aliyuncs.com"},"IdCardBackImageUrl":{"type":"string","description":"The HTTP or HTTPS URL of the national emblem side of the ID card"},"FaceImageUrl":{"type":"string","description":"The HTTP or HTTPS URL of the front-facing facial photo"},"BizType":{"type":"string","description":"The business scenario identifier for the ID Verification service. Create one in the console first. For more information, see…"},"BizId":{"type":"string","description":"The unique ID that identifies a verification task. The value can be up to 64 characters in length. For a single verification task, the…"},"Name":{"type":"string","description":"The name"},"IdCardNumber":{"type":"string","description":"The ID card number"},"IdCardFrontImageUrl":{"type":"string","description":"The HTTP or HTTPS URL of the portrait side of the ID card"},"UserId":{"type":"string","description":"The ID of the end user, such as the account ID of the end 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/version":{"post":{"operationId":"cloud_aliyun_cloudauth_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.aliyuncs.com","https://cloudauth.cn-beijing.aliyuncs.com"],"default":"https://cloudauth.aliyuncs.com","description":"Regional endpoint, for example https://cloudauth.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"}}}}}}}