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