# Alibaba Cloud ID Verification Intl API

> Alibaba Cloud ID Verification Intl API on Apizie: 48 endpoints (Adds a face image to a specified face library, Compares the similarity of two addresses, Verifies an address, Provides the API operation for bank card elements, including two-element, three-element, and four-element…, …) 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-intl/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-cloudauth-intl`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/cloudauth-intl
- Page: https://zieapi.vercel.app/api/cloud/aliyun-cloudauth-intl
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-cloudauth-intl/openapi.json

Alibaba Cloud OpenAPI for ID Verification Intl (cloudauth-intl, version 2022-08-09). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Adds a face image to a specified face library
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/add-face-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| FaceGroupCode | string | yes | The face library code |
| ProductCode | string | yes | The product code |
| MerchantUserId | string | no | The custom unique user ID. The value cannot exceed 32 characters. If this parameter is specified, the system registers the user with the… |
| FacePicture | string | no | The Base64-encoded face image to register |
| FacePictureUrl | string | no | The URL of the face image to register |
| FacePictureFile | string | no | The file stream of the face image to register |
| FaceQualityCheck | string | no | Specifies whether to check the quality of the face image. Valid values: Y: enabled. N: disabled (default) |

### Compares the similarity of two addresses
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/address-compare-intl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| ProductCode | string | yes | ADD_VERIFY |
| Text1 | string | yes | Address 1 |
| Text2 | string | yes | Address 2 |
| DefaultCountry | string | yes | The country name. Valid values: China |

### Verifies an address
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/address-verify-v2-intl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| ProductCode | string | yes | The product code. Set the value to ADD_VERIFY_PRO |
| VerifyType | string | no | The address verification method. Valid values: HOME: Home address verification. WORK: Work address verification |
| Mobile | string | no | The mobile phone number. Only mobile phone numbers in the Chinese mainland are supported |
| RegCountry | string | yes | The list of prohibited countries |
| Text | string | no | The detailed address text |
| DeviceToken | string | yes | The device token used for risk identification |

### Provides the API operation for bank card elements, including two-element, three-element, and four-element…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/bank-meta-verify-intl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| ProductCode | string | yes | The fixed value. Valid value: BANK_CARD_N_META |
| ParamType | string | yes | The encryption method. Valid values: normal: No encryption. md5: MD5 encryption. Important: The ciphertext of all parameters must be a… |
| VerifyMode | string | yes | The verification mode. Valid value: VERIFY_BANK_CARD. This value indicates the bank card authentication mode, which verifies whether the… |
| ProductType | string | yes | The product type. Valid values: BANK_CARD_2_META: Verifies the bank card number and name. BANK_CARD_3_META: Verifies the bank card number,… |
| BankCard | string | yes | The bank card number. If paramType is set to normal, enter the plaintext bank card number. If paramType is set to md5, enter the plaintext… |
| UserName | string | yes | The name. If paramType is set to normal, enter the plaintext name. If paramType is set to md5, enter the 32-character lowercase MD5 hash… |
| IdentityType | string | no | The type of the identification document. If you leave this parameter empty, the default value is ID card. For other types of… |
| IdentifyNum | string | no | The identification document number. If paramType is set to normal, enter the plaintext identification document number. If paramType is set… |
| Mobile | string | no | The mobile phone number. If paramType is set to normal, enter the plaintext mobile phone number. If paramType is set to md5, enter the… |

### Queries the detailed results of an authentication task. This operation is part of the SDK integration…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/check-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| MerchantBizId | string | no | The custom unique business identifier on the merchant side, which is used for subsequent troubleshooting. It supports a combination of… |
| TransactionId | string | no | The authentication ID |
| IsReturnImage | string | no | Specifies whether to return images. Valid values: Y: Returns images. N: Does not return images |
| ExtraImageControlList | string | no | The additional information to return |
| ReturnFiveCategorySpoofResult | string | no | Specifies whether to return the anti-spoofing detection results |

### Authentication log query
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/check-verify-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| MerchantBizId | string | no | The merchant-side custom business unique identifier, used for subsequent troubleshooting. The value supports a combination of letters and… |
| TransactionId | string | no | The unique identifier of the entire authentication process. Obtain this value by calling the Initialize operation |

### Queries the credential recognition results
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/credential-get-result-intl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| TransactionId | string | yes | The unique identifier of the authentication request |

### An API operation that uploads a credential image, such as a utility bill or credit card statement, and uses…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/credential-recognition-intl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| ProductCode | string | yes | The product solution to use. Set the value to CREDENTIAL_RECOGNITION |
| CredentialOcrPictureBase64 | string | no | The Base64-encoded image. If you choose to pass in the image by using IdOcrPictureBase64 (Base64-encoded photo), check the photo size and… |
| CredentialOcrPictureUrl | string | no | The URL of the image. The URL must be a publicly accessible HTTP or HTTPS link |
| DocType | string | yes | The credential type. Valid values: 01: transaction credential (including electronic bill images for water, electricity, gas, credit card,… |
| OcrArea | string | yes | The extraction type. Valid values: 0101: electronic bill address and name module (extracts the address and name module through intelligent… |
| FraudCheck | string | yes | Specifies whether to enable tampering detection. Valid values: true: Enabled. false: Disabled |
| IdQuality | string | no | Specifies whether to enable quality detection. Valid values: Y: Enabled. N: Disabled |
| CheckRuleConfig | string | no | The field check rule configuration, in JSON string format |
| OcrValueStandard | string | no | Specifies whether to enable OCR result normalization. Valid values: 0: Disabled. 1: Enabled |
| OcrTranslation | string | no | Specifies whether to enable translation. Valid values: 0: Disabled. 1: Enabled |
| FileInputType | string | no | The input file type. Valid values: IMAGE (default): image. PDF: PDF format |

### Provides an API operation to upload credential images, such as utility bills and credit card statements, and…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/credential-recognition-intl-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| ProductCode | string | yes | The product solution to be integrated. Valid value: CREDENTIAL_RECOGNITION |
| CredentialOcrPictureBase64 | string | no | The Base64-encoded image. If you choose to pass the photo by using IdOcrPictureBase64, check the photo size and do not pass excessively… |
| CredentialOcrPictureUrl | string | no | The image URL. The URL must be a publicly accessible HTTP or HTTPS link |
| DocType | string | yes | The credential type. Valid values: 01: transaction receipt, including electronic bills for utilities and credit cards 02: vehicle… |
| OcrArea | string | yes | The extraction type. Valid values: 0101: electronic bill address and name module, which extracts the address and name module through… |
| FraudCheck | string | yes | Specifies whether to enable tampering detection. Valid values: true: enables tampering detection. false: disables tampering detection |
| IdQuality | string | no | Specifies whether to enable quality detection. Valid values: Y: enables quality detection. N: disables quality detection |
| CheckRuleConfig | string | no | The field validation rule configuration. The value is a JSON string |
| OcrValueStandard | string | no | Specifies whether to enable OCR result standardization. Valid values: 0: disables OCR result standardization. 1: enables OCR result… |
| OcrTranslation | string | no | Specifies whether to enable translation. Valid values: 0: disables translation. 1: enables translation |
| FileInputType | string | no | The material input type. Valid values: IMAGE: image PDF: PDF format Default value: IMAGE |
| CredentialOcrPictureFile | string | no | The image file stream |

### Submits credential recognition information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/credential-submit-intl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| ProductCode | string | yes | The product solution to use. Set this parameter to CREDENTIAL_RECOGNITION |
| SceneCode | string | yes | The custom authentication scenario ID. You can use this scenario ID to query related records in the console. The value can be a… |
| MerchantBizId | string | yes | The custom business unique identifier on the merchant side, used for subsequent troubleshooting. The value can be a combination of letters… |
| CredentialOcrPictureBase64 | string | no | The Base64-encoded image. If you use this method to submit a photo, check the photo size and do not submit an excessively large photo |
| CredentialOcrPictureUrl | string | no | The URL of the image. The URL must be a publicly accessible HTTP or HTTPS link |
| DocType | string | yes | The credential type. Valid values: 02: vehicle registration certificate |
| OcrArea | string | yes | The extraction type. Valid values: 0201: Thailand vehicle registration certificate |
| FraudCheck | string | yes | Specifies whether to enable tampering detection. Valid values: true: Enabled. false: Disabled |
| IdQuality | string | no | Specifies whether to enable quality detection. Valid values: Y: Enabled. N: Disabled |
| CheckRuleConfig | string | no | The field validation rule configuration in JSON string format |
| OcrValueStandard | string | no | Specifies whether to enable OCR result standardization. Valid values: 0: Disabled. 1: Enabled |
| OcrTranslation | string | no | Specifies whether to enable translation. Valid values: 0: Disabled. 1: Enabled |
| FileInputType | string | no | The input file type. Valid values: IMAGE (default): image. PDF: PDF format |

### Submits credential recognition information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/credential-submit-intl-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| ProductCode | string | yes | The product solution to be integrated. Valid values: CREDENTIAL_RECOGNITION |
| MerchantBizId | string | yes | The unique identifier of the merchant request. The value is a 32-character alphanumeric string. The first few characters consist of a… |
| CredentialOcrPictureBase64 | string | no | The Base64-encoded image. If you choose this method to upload the photo, check the photo size and do not upload excessively large photos |
| CredentialOcrPictureUrl | string | no | The image URL. The URL must be an HTTP or HTTPS link accessible over the Internet |
| DocType | string | yes | The credential type. Valid values: 01: transaction credential, including electronic bill images for water, electricity, gas, and credit… |
| OcrArea | string | yes | The extraction type. Valid values: 0101: electronic bill address and name module, which extracts the address and name module through… |
| FraudCheck | string | yes | Specifies whether to enable tampering detection. Valid values: true: enabled false: disabled |
| IdQuality | string | no | Specifies whether to enable quality detection. Valid values: Y: enabled, N: disabled |
| CheckRuleConfig | string | no | The field validation rule configuration. The value is a JSON string |
| OcrValueStandard | string | no | Specifies whether to enable standardization of key fields in OCR recognition. Valid values: 0: no (default) 1: yes |
| OcrTranslation | string | no | Specifies whether to enable translation. Valid values: 0: disabled, 1: enabled |
| FileInputType | string | no | The material input type. Valid values: IMAGE: image (default) PDF: PDF format |
| CredentialOcrPictureFile | string | no | The image file stream |
| SceneCode | string | yes | The custom authentication scenario ID. This ID is used to query related records in the console. The value can be up to 10 characters in… |

### Provides the API operation for the credential verification service. This operation uses a large language…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/credential-verify-intl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| CredType | string | yes | The credential type. Valid values: 03: enterprise qualification 04: transaction voucher |
| CredName | string | yes | The credential name (specified as a numeric code). Valid values: Codes starting with 03: enterprise qualification 0301: business license… |
| ImageUrl | string | no | The URL of the image. Specify either ImageUrl or ImageFile |
| ImageFile | string | no | The image input stream. Specify either ImageUrl or ImageFile |
| ProductCode | string | yes | The call mode. Valid values: ANTI_FAKE_CHECK: image quality and tampering detection |

### Detects deepfake risks in facial images
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/deepfake-detect-intl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| ProductCode | string | yes | The product solution to use. Set the value to FACE_DEEPFAKE |
| SceneCode | string | no | The custom scene ID for authentication. You can use this scene ID to query related records in the console. The value can be up to 10… |
| MerchantBizId | string | yes | The unique identifier of the merchant request. The value is a 32-character combination of letters and digits. The first few characters are… |
| FaceInputType | string | no | Set the value to IMAGE to specify a facial image |
| FaceUrl | string | no | The URL of the facial image. Specify either FaceUrl or FaceBase64 |
| FaceBase64 | string | no | The Base64-encoded content of the facial image. Specify either FaceUrl or FaceBase64 |

### Provides face deepfake detection capabilities for ID Verification, which can be independently integrated…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/deepfake-detect-intl-stream` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| ProductCode | string | no | The product solution to be integrated. Valid values: FACE_DEEPFAKE |
| SceneCode | string | no | The custom authentication scenario ID, which is used to query related records in the console. The value must be 10 characters in length… |
| MerchantBizId | string | no | The unique identifier of the merchant request. The value must be a 32-character alphanumeric string. The prefix consists of a custom… |
| FaceInputType | string | no | The input type of the face material. Valid values: IMAGE: face image. This is the default value. VIDEO: face video. Note: Video processing… |
| FaceUrl | string | no | The URL of the face image |
| FaceBase64 | string | no | The Base64-encoded string of the face image. For videos, we recommend that you pass the data as a stream |
| FaceFile | string | no | The input stream of the image |

### Deletes a face library
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/delete-face-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| Id | string | yes | The primary key ID |

### Deletes a face record
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/delete-face-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| Id | string | no | The primary key ID |

### Deletes a face record
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/delete-face-record-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| MerchantUserId | string | yes | The unique user identifier, which must be consistent with the one used when calling AddFaceRecord. If this parameter was not specified… |
| FaceGroupCode | string | no | The face group code. If this parameter is not specified, the face data of the user is deleted from all face groups |

### Deletes data related to a user authentication record
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/delete-verify-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| TransactionId | string | no | The unique identifier of the authentication request |
| DeleteAfterQuery | string | no | Specifies whether the deletion depends on the query operation |
| DeleteType | string | no | The type of data to delete |

### Provides server-side card and certificate OCR capabilities
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/doc-ocr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| MerchantBizId | string | no | The custom business unique identifier on the merchant side, used for subsequent issue tracking and troubleshooting. The value can be a… |
| MerchantUserId | string | no | The custom user ID in the business. Ensure that the value is unique |
| IdOcrPictureBase64 | string | no | The Base64-encoded card or certificate image. If you use IdOcrPictureBase64 (Base64-encoded photo) to submit the certificate photo, check… |
| IdOcrPictureUrl | string | no | The URL of the front side of the certificate image |
| DocType | string | no | The certificate type |
| ProductCode | string | no | The product code |
| Ocr | string | no | Specifies whether to perform certificate OCR. Valid values: T: OCR is required. F: OCR is not required |
| IdFaceQuality | string | no | Specifies whether to perform certificate face quality detection. Valid values: T: Detection is required. F: Detection is not required.… |
| Spoof | string | no | Specifies whether to enable anti-spoofing detection. Valid values: T: Anti-spoofing is enabled. F: Anti-spoofing is disabled |
| IdThreshold | string | no | The custom OCR quality detection threshold mode. Valid values: 0: system default 1: strict mode 2: loose mode 3 (default): quality… |
| CardSide | string | no | Specifies the side of the certificate to distinguish between the national emblem side and the portrait side. If this parameter is not… |

### Recognizes global identity documents through OCR
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/doc-ocr-max` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| ProductCode | string | no | The product solution to use. Set this parameter to ID_OCR_MAX |
| SceneCode | string | no | The custom authentication scenario ID. You can use this scenario ID to query related records in the console. The value can contain up to… |
| MerchantBizId | string | no | The custom unique business identifier, which is used for subsequent troubleshooting. The value can contain up to 32 characters, including… |
| MerchantUserId | string | no | The custom user ID or another identifier that can identify a specific user, such as a phone number or email address. We strongly recommend… |
| IdOcrPictureBase64 | string | no | The Base64-encoded image of the card or certificate. If you use IdOcrPictureBase64 to pass in the document image, check the image size and… |
| IdOcrPictureUrl | string | no | The URL of the card or certificate image. The URL must be a publicly accessible HTTP or HTTPS link |
| OcrModel | string | no | The OCR recognition mode. Valid values: 0: general document recognition mode (default). 1: automatic document classification mode. 2:… |
| DocType | string | no | The document type. Format: country code + document type abbreviation + page (optional). Note: OcrModel = 0: DocType is required. Specify… |
| Prompt | string | no | This field is deprecated. |
| Spoof | string | no | This field is deprecated. |
| IdThreshold | string | no | The custom OCR quality detection threshold mode. Valid values: 0: system default. 1: strict mode. 2: loose mode. 3 (default): quality… |
| IdSpoof | string | no | Specifies whether to enable the document anti-forgery feature. Valid values: T: enabled. F (default): disabled |
| DocPage | string | no | The expected page to recognize. Valid values: 01 (default): the portrait side of the document. 02: the back side of the document |
| OcrValueStandard | string | no | Specifies whether to enable OCR key field standardization. Valid values: 0: no (default). 1: yes |
| Authorize | string | no | Specifies whether to enable authoritative data source verification to enhance document anti-forgery capabilities. T: enabled. F: disabled… |

### Recognizes global identity documents by using optical character recognition (OCR)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/doc-ocr-max-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| ProductCode | string | no | The product solution to integrate. Valid value: ID_OCR_MAX |
| SceneCode | string | no | The custom authentication scenario ID. You can use this ID to query related records in the console later. The value can be up to 10… |
| MerchantBizId | string | no | The custom unique business identifier on the merchant side. This identifier is used for subsequent troubleshooting. The value can be up to… |
| MerchantUserId | string | no | The custom user ID or another identifier that can identify a specific user, such as a mobile phone number or an email address. Desensitize… |
| IdOcrPictureBase64 | string | no | The Base64-encoded image of the identity document. If you use the IdOcrPictureBase64 parameter to pass the Base64-encoded image, check the… |
| IdOcrPictureUrl | string | no | The URL of the identity document image. The URL must be a publicly accessible HTTP or HTTPS link |
| OcrModel | string | no | The OCR recognition mode. Valid values: 0: general identity document recognition mode (default). 1: automatic identity document… |
| DocType | string | no | The type of the identity document. Format: country code + identity document type abbreviation + page (optional). If OcrModel is set to 0,… |
| IdThreshold | string | no | The custom threshold mode for OCR quality detection. Valid values: 0: system default. 1: strict mode. 2: loose mode. 3: quality detection… |
| IdSpoof | string | no | Specifies whether to enable the identity document anti-spoofing feature. Valid values: T: enabled. F: disabled. This is the default value |
| DocPage | string | no | The page to be recognized. Valid values: 01: the portrait side of the identity document. This is the default value. 02: the back side of… |
| OcrValueStandard | string | no | Specifies whether to enable standardization for key OCR fields. Valid values: 0: disabled. This is the default value. 1: enabled |
| Authorize | string | no | Specifies whether to enable authoritative data source verification to enhance the anti-spoofing capability of identity documents. Valid… |
| IdOcrPictureFile | string | no | The file stream of the identity document image |

### Performs server-side optical character recognition (OCR) on ID cards
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/doc-ocr-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| MerchantBizId | string | no | The custom unique business identifier on the merchant side, which is used for subsequent troubleshooting. The identifier supports a… |
| MerchantUserId | string | no | The custom user ID in your business system. Ensure that the ID is unique |
| IdOcrPictureBase64 | string | no | The Base64-encoded image of the ID card or certificate. If you use the IdOcrPictureBase64 parameter to pass the Base64-encoded image,… |
| IdOcrPictureUrl | string | no | The URL of the front image of the ID card |
| IdOcrPictureFile | string | no | The file stream of the front image of the ID card |
| DocType | string | no | The type of the ID card |
| ProductCode | string | no | The product code |
| Ocr | string | no | Specifies whether to perform OCR on the ID card. Valid values: T: Performs OCR on the ID card. F: Does not perform OCR on the ID card |
| IdFaceQuality | string | no | Specifies whether to perform face quality detection on the ID card. Valid values: T: Performs face quality detection. F: Does not perform… |
| Spoof | string | no | Specifies whether to enable anti-spoofing detection. Valid values: T: Enables anti-spoofing detection. F: Disables anti-spoofing detection |
| IdThreshold | string | no | The custom threshold mode for OCR quality detection. Valid values: 0: System default. 1: Strict mode. 2: Loose mode. 3: Disables quality… |
| CardSide | string | no | The side of the ID card, which distinguishes the side with the national emblem from the side with the portrait. If you do not specify this… |

### Downloads verification task records
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/download-verify-record-intl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| Code | string | no | The query code |
| Param | string | no | The parameters for the export and download query task |
| ProductType | string | no | The product code |
| DownloadMode | string | no | The download mode. Valid values: async: asynchronous sync: synchronous |
| BizType | string | no | The business type. Valid values: INVOKE_STATISTICS INVOKE_RECORD |

### Provides a server-side-only API for the eKYC solution
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/ekyc-verify` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| ProductCode | string | no | The product code |
| MerchantBizId | string | no | A custom business unique identifier defined by the merchant, used for subsequent issue tracking and troubleshooting. Supports a… |
| MerchantUserId | string | no | A custom user ID or other identifier that can identify a specific user, such as a phone number or email address. We strongly recommend… |
| DocType | string | no | The document type |
| DocName | string | no | The real name of the user. When Authorize='T' and the document type is a mainland China ID card, either the key document information… |
| DocNo | string | no | The document number of the user. When Authorize='T' and the document type is a mainland China ID card, either the key document information… |
| IdOcrPictureUrl | string | no | The URL of the front side of the document image |
| IdOcrPictureBase64 | string | no | The Base64-encoded document image. Note: If you choose this method to pass in the document image, check the photo size and do not pass in… |
| FacePictureUrl | string | no | The URL of the face photo |
| FacePictureBase64 | string | no | The Base64-encoded face image. Note: If you choose this method to pass in the face image, check the photo size and do not pass in an… |
| Crop | string | no | Specifies whether cropping is allowed. By default, cropping is not allowed. Valid values: T: Detection is required. F: Detection is… |
| Authorize | string | no | Specifies whether to enable authoritative identity verification. Currently, this applies only to second-generation ID cards in mainland… |
| IdThreshold | string | no | The custom OCR quality detection threshold mode. Valid values: 0: system default 1: strict mode 2: loose mode 3 (default): disable quality… |
| FaceQualityCheck | string | no | Specifies whether to enable face quality detection |
| IdSpoof | string | no | Specifies whether to enable document anti-spoofing |

### Provides a server-side API for the eKYC solution
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/ekyc-verify-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| ProductCode | string | no | The product code |
| MerchantBizId | string | no | The custom unique business identifier on the merchant side, used for subsequent troubleshooting. The value must be a unique combination of… |
| MerchantUserId | string | no | The custom user ID or another identifier that identifies a specific user, such as a phone number or email address. We strongly recommend… |
| DocType | string | no | The ID document type |
| DocName | string | no | The real name of the user. If Authorize is set to T and the document type is a mainland China ID card, you must provide at least one of… |
| DocNo | string | no | The ID document number of the user. If Authorize is set to T and the document type is a mainland China ID card, you must provide at least… |
| IdOcrPictureUrl | string | no | The URL of the front image of the ID document |
| IdOcrPictureBase64 | string | no | The Base64-encoded image of the ID document. Note: If you choose this method to pass the document image, check the image size and do not… |
| IdOcrPictureFile | string | no | The file stream of the front image of the ID document |
| FacePictureUrl | string | no | The URL of the face image |
| FacePictureBase64 | string | no | The Base64-encoded face image. Note: If you choose this method to pass the face image, check the image size and do not pass an excessively… |
| FacePictureFile | string | no | The file stream of the face image |
| Crop | string | no | Specifies whether cropping is allowed. Default value: F. Valid values: T: Allowed. F: Not allowed (default) |
| Authorize | string | no | Specifies whether to enable authoritative identity verification. This parameter is currently applicable only to second-generation ID cards… |
| IdThreshold | string | no | The custom OCR quality check threshold mode. Valid values: 0: System default. 1: Strict mode. 2: Loose mode. 3: Quality check disabled… |
| FaceQualityCheck | string | no | Specifies whether to enable face quality check |
| IdSpoof | string | no | Specifies whether to enable ID document anti-spoofing |

### Compares and verifies two input face images by using face recognition technology, and returns the face…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/face-compare` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| MerchantBizId | string | no | The custom unique business identifier on the merchant side, which is used for subsequent troubleshooting. It supports a combination of… |
| SourceFacePicture | string | no | The Base64-encoded portrait photo. Note If you choose this method to pass the ID photo, check the photo size and do not pass oversized… |
| SourceFacePictureUrl | string | no | The HTTPS or HTTP URL of the face image |
| TargetFacePicture | string | no | The Base64-encoded reference photo. Note If you choose this method to pass the ID photo, check the photo size and do not pass oversized… |
| TargetFacePictureUrl | string | no | The HTTPS or HTTP URL of the reference face image |
| FacePictureQualityCheck | string | no | [Deprecated] Specifies whether to enable the quality check for the input face image |
| FaceQualityCheck | string | no | The face quality check |

### Compares and verifies two input face images by using face recognition technology, and returns the face…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/face-compare-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| MerchantBizId | string | no | The custom unique business identifier on the merchant side, used for subsequent troubleshooting. It supports a combination of letters and… |
| SourceFacePicture | string | no | The Base64-encoded portrait photo. Note If you use this method to pass the ID photo, check the photo size and do not pass oversized… |
| SourceFacePictureUrl | string | no | The HTTPS or HTTP URL of the face image |
| SourceFacePictureFile | string | no | The file stream of the face image |
| TargetFacePicture | string | no | The Base64-encoded reference photo. Note If you use this method to pass the ID photo, check the photo size and do not pass oversized… |
| TargetFacePictureUrl | string | no | The HTTPS or HTTP URL of the reference face image |
| TargetFacePictureFile | string | no | The file stream of the reference face image |
| FacePictureQualityCheck | string | no | Specifies whether to enable quality check for the input face image. [Deprecated] |
| FaceQualityCheck | string | no | The face quality check |

### Performs cross-comparison of faces
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/face-cross-compare-intl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| ProductCode | string | yes | The product solution to use. Valid values: FACE_CROSS_COMPARE |
| SceneCode | string | no | The custom business scenario ID |
| MerchantBizId | string | yes | The custom unique business identifier, used for subsequent troubleshooting. The value is a combination of letters and digits with a length… |
| CompareModel | string | no | The comparison mode. Valid values: 0: chain comparison (default). A:B and B:C. 1: circular comparison. A:B, B:C, and C:A |
| SourceAFacePicture | string | no | The Base64-encoded face photo |
| SourceAFacePictureUrl | string | no | The URL of the face photo. The URL must be a publicly accessible HTTP or HTTPS link |
| SourceBFacePicture | string | no | The Base64-encoded face photo |
| SourceBFacePictureUrl | string | no | The URL of the face photo. The URL must be a publicly accessible HTTP or HTTPS link |
| SourceCFacePicture | string | no | The Base64-encoded face photo |
| SourceCFacePictureUrl | string | no | The URL of the face photo. The URL must be a publicly accessible HTTP or HTTPS link |
| FaceVerifyThreshold | string | no | The face matching threshold. This parameter is reserved by the system and does not support custom values |

### Checks for duplicate faces. FaceDuplicationCheckIntl is suitable for scenarios where SDK integration is…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/face-duplication-check-intl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| ProductCode | string | yes | The product code |
| SceneCode | string | no | The custom authentication scenario ID |
| MerchantBizId | string | yes | The custom unique business identifier, which is used for subsequent troubleshooting. The value can be a combination of up to 32 letters… |
| MerchantUserId | string | yes | The custom user ID or another identifier that identifies a specific user, such as a mobile phone number or an email address. We strongly… |
| VerifyModel | string | yes | The authentication type. Valid values: 0: retrieve pattern. Feature: Pass the face library and the user face image (sourceFacePicture).… |
| Liveness | string | no | Specifies whether to enable passive liveness detection. Valid values: 0: disabled. 1: enabled |
| FaceGroupCodes | string | no | The codes of the face libraries created by the customer in the console. You can query up to 10 face libraries at a time. Separate multiple… |
| SourceFacePicture | string | no | The Base64-encoded portrait photo |
| SourceFacePictureUrl | string | no | The URL of the portrait image. The URL must be an HTTP or HTTPS link accessible over the Internet |
| TargetFacePicture | string | no | The Base64-encoded portrait photo |
| TargetFacePictureUrl | string | no | The URL of the portrait image. The URL must be an HTTP or HTTPS link accessible over the Internet |
| AutoRegistration | string | no | Specifies whether to automatically register the face to the specified face library if no duplicate face is found during the search. Valid… |
| FaceRegisterGroupCode | string | no | The face library to which the face is registered |
| SaveFacePicture | string | no | Specifies the type of the saved face image. Valid values: 0: face. This is the default value. 1: feature. Reserved field. Not enabled yet.> |
| FaceVerifyThreshold | string | no | The face matching threshold.> Reserved field. Not enabled yet.> |
| ReturnFaces | string | no | The number of faces to return when multiple faces exceed the matching threshold. Valid values: Default value: 1. Maximum value: 5 |
| FaceQualityCheck | string | no | The face quality check |
| FaceAttributeCheck | string | no | Specifies whether to return additional face attribute information. Valid values: N: do not return. This is the default value. Y: return.… |
| UpdateFaceIfUserExists | string | no | Specifies whether to use the current face to overwrite the existing face if MerchantUserId already exists during automatic registration.… |

### Calls the server-side API of Face Guard International
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/face-guard-risk` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| DeviceToken | string | no | The device token obtained through the Face Guard SDK |
| MerchantBizId | string | no | The custom unique business identifier on the merchant side, used for subsequent troubleshooting. It supports a combination of letters and… |
| ProductCode | string | no | The product code. Valid values: FACE_GUARD and FACE_GUARD_PRO |
| BizId | string | no | The customer business ID |
| Type | string | no | The type of the risk scenario detected by Device Assistant |

### Performs server-side passive liveness detection
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/face-liveness` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| ProductCode | string | no | The product code |
| MerchantBizId | string | no | The custom unique business identifier on the merchant side, used for subsequent troubleshooting. It supports a combination of letters and… |
| MerchantUserId | string | no | The merchant user ID or another identifier used to identify a specific user, such as a phone number or email address. Desensitize the… |
| FacePictureUrl | string | no | The URL of the face photo |
| FacePictureBase64 | string | no | The Base64-encoded string of the photo. Note: If you use the FacePictureBase64 parameter to pass the face photo, check the photo size and… |
| FaceQuality | string | no | Specifies whether to output the face quality score. Valid values: T: The detection is required. F: The detection is not required. Default… |
| Crop | string | no | Specifies whether to allow cropping. Valid values: T: Cropping is allowed. F: Cropping is not allowed. Default value: F |
| Occlusion | string | no | Specifies whether to perform occlusion detection. Valid values: T: Occlusion detection is required. F: Occlusion detection is not… |
| FaceQualityCheck | string | no | The face quality check |
| FaceAttributeCheck | string | no | The face attribute check |

### Detects real faces by using pre-obtained face images through API operations, and combines the Qwen-VL large…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/face-liveness-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| ProductCode | string | yes | The product solution to integrate. Valid values: FACE_LIVENESS_MIN_PRO and FACE_LIVENESS_MIN |
| MerchantBizId | string | no | The custom unique business identifier on the merchant side for subsequent troubleshooting. It supports a combination of letters and… |
| MerchantUserId | string | no | The custom user ID or other identifier that can identify a specific user, such as a mobile phone number or email address. Desensitize the… |
| FacePictureBase64 | string | no | The Base64-encoded face image. Note If you use this method to pass the face image, check the image size and do not pass oversized images.… |
| FacePictureUrl | string | no | The URL of the face photo. The URL must be a publicly accessible HTTPS link |
| FacePictureFile | string | no | The file stream of the face photo |
| FaceQualityCheck | string | no | Specifies whether to check the quality of the face image. Valid values: Y: Enabled. N: Disabled. Default value: N |
| FaceAttributeCheck | string | no | The face attribute detection |

### Detects real faces by using pre-acquired face images passed through the API operation. The algorithm…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/face-verify-intl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| ProductCode | string | yes | The product code. Valid values: FACE_VERIFY_MIN and FACE_IDU_MIN |
| MerchantUserId | string | no | The custom user ID or another identifier that can identify a specific user, such as a phone number or email address. It is highly… |
| MerchantBizId | string | no | The custom unique business identifier used for subsequent troubleshooting. It supports a combination of up to 32 letters and digits. Make… |
| FaceQualityCheck | string | no | Specifies whether to check the quality of the face image. Valid values: Y: Enabled. N: Disabled. Default value: N |
| TargetFacePicture | string | no | The Base64-encoded reference photo. Note If you use this method to pass the reference photo, check the photo size and do not pass… |
| TargetFacePictureUrl | string | no | The HTTPS URL of the reference face image |
| TargetFacePictureFile | string | no | The file stream of the reference face image |
| SourceFacePicture | string | no | The Base64-encoded portrait photo. Note If you use this method to pass the portrait photo, check the photo size and do not pass oversized… |
| SourceFacePictureUrl | string | no | The URL of the portrait image. It must be a publicly accessible HTTPS link |
| SourceFacePictureFile | string | no | The file stream of the face image |
| VerifyModel | string | no | Required when ProductCode is set to FACE_IDU_MIN. The authentication type. Valid values: 0: Retrieval pattern. Feature: Passes the face… |
| FaceGroupCodes | string | no | Required when ProductCode is set to FACE_IDU_MIN. The codes of the face libraries created by the customer in the console. You can query up… |
| AutoRegistration | string | no | Required when ProductCode is set to FACE_IDU_MIN. Specifies whether to automatically register the face to the specified face library when… |
| FaceRegisterGroupCode | string | no | Required when ProductCode is set to FACE_IDU_MIN. The code of the face library for registration |
| ReturnFaces | string | no | Required when ProductCode is set to FACE_IDU_MIN. Specifies the number of faces to return when multiple faces exceed the matching… |
| FaceAttributeCheck | string | no | Specifies whether to return additional face attribute information. Valid values: N: Do not return. Default value. Y: Return. The result is… |
| UpdateFaceIfUserExists | string | no | Specifies whether to overwrite the original face with the current face if MerchantUserId already exists during automatic registration.… |

### Verifies the validity period of an identity document as a two-factor authentication element
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/id2-meta-period-verify-intl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| ProductCode | string | yes | The product solution to use. Set the value to eKYC_Date_MIN |
| SceneCode | string | no | The custom authentication scenario ID. You can use this scenario ID to query related records in the console. The value can be up to 10… |
| MerchantBizId | string | yes | The custom unique business identifier, which is used for subsequent troubleshooting. The value can be up to 32 characters in length and… |
| MerchantUserId | string | no | The custom user ID or another identifier that can identify a specific user, such as a phone number or email address. We strongly recommend… |
| DocType | string | yes | The document type, which is uniquely identified by an 8-digit number. For more information, see the document type list. Currently, only… |
| DocName | string | yes | The name of the user |
| DocNo | string | yes | The document number of the user |
| ValidityStartDate | string | yes | The start date of the validity period, in the format YYYYMMDD. Example: 20201001 |
| ValidityEndDate | string | yes | The expiration date of the ID card validity period, in the format YYYYMMDD. Example: 20301001 |

### Verifies the authenticity and consistency of a name and an ID card number through an authoritative data source
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/id2-meta-verify-intl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| ProductCode | string | no | The product solution. Fixed value: ID_2META |
| ParamType | string | no | The parameter type. Valid values: normal: The original value in plaintext. Note: Due to the limitations of the authoritative data source,… |
| IdentifyNum | string | no | The ID card number in plaintext |
| UserName | string | no | The name in plaintext |

### Verifies the identity of an Indonesian user by calling the authoritative source API in a standalone business…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/idn-authority-verify-intl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| ProductCode | string | yes | The product solution to use. Set the value to IDN_META |
| SceneCode | string | no | The custom authentication scenario ID. You can use this scenario ID to query related records in the console. The value can be a… |
| MerchantBizId | string | yes | The merchant-side custom business unique identifier, which is used for subsequent troubleshooting. The value can be a combination of… |
| MerchantUserId | string | yes | The custom user ID, or another identifier that can identify a specific user, such as a phone number or email address. We strongly… |
| IdNumber | string | yes | The ID card number |
| BirthDate | string | yes | The date of birth |
| FullName | string | yes | The full name |
| Timestamp | string | yes | The Timestamp |
| SourceFacePicture | string | no | The Base64-encoded facial photo. Note If you use this method to pass the ID photo, check the photo size and do not pass an excessively… |
| SourceFacePictureUrl | string | no | The URL of the facial photo. The URL must be a publicly accessible HTTP or HTTPS link |
| SourceFacePictureFile | string | no | The file stream of the facial photo |
| Mobile | string | yes | The Indonesian mobile phone number. The number must start with +62, followed by 9 to 11 digits |
| Email | string | yes | The email address of the user |

### Initializes the authentication process
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/initialize` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| ProductCode | string | no | The product solution to be integrated. For more information, see the official documentation:… |
| MerchantBizId | string | no | The custom unique business identifier on the merchant side, used for subsequent troubleshooting. It supports a combination of letters and… |
| MetaInfo | string | no | The MetaInfo environment parameter, which must be obtained through the client SDK |
| DocType | string | no | The type of the identity document. For the eKYC_PRO and ID_OCR_MAX solutions, see the official documentation:… |
| MerchantUserId | string | no | The custom user ID or other identifier that can identify a specific user, such as a mobile phone number or email address. Desensitize the… |
| SceneCode | string | no | The scene code. This parameter is applicable to IDV products |
| Pages | string | no | The configuration of the pages to be captured. Separate multiple pages with commas (,). Valid values: 01: The portrait side of the… |
| FacePictureBase64 | string | no | The Base64-encoded string of the photo. If you choose to pass the face photo by using FacePictureBase64, check the photo size and do not… |
| FacePictureUrl | string | no | The URL of the face photo. It must be a publicly accessible HTTP or HTTPS link |
| Crop | string | no | Specifies whether to crop the image. This parameter is applicable to IDV products |
| Ocr | string | no | Specifies whether to enable OCR. This parameter is applicable to IDV products |
| IdFaceQuality | string | no | The quality of the face image. This parameter is applicable to IDV products |
| IdSpoof | string | no | Specifies whether to enable document anti-spoofing detection. This parameter is applicable to IDV products |
| ReturnUrl | string | no | The client-side callback URL |
| Authorize | string | no | Specifies whether to enable authoritative identity verification. This parameter is currently applicable only to second-generation ID cards… |
| DocScanMode | string | no | The photo capture mode for document collection. Valid values: manual: Manual capture. auto: Automatic capture. This is the default value |
| ProductFlow | string | no | The sequence of document and face verification. Valid values: DOC_FACE: Document first, then face. This is the default value. FACE_DOC:… |
| CallbackUrl | string | no | The callback URL for authentication result notifications. The default callback request method is GET, and the callback URL must start with… |
| CallbackToken | string | no | The security token used for anti-replay and anti-tampering verification. If this parameter is passed, the CallbackToken field is displayed… |
| LanguageConfig | string | no | The language configuration. This parameter is applicable to IDV products |
| SecurityLevel | string | no | The pattern that represents different security levels of the authentication flow. Valid values: 01: Normal pattern. This is the default… |
| StyleConfig | string | no | The custom UI configuration. Convert your custom UI configuration into a JSON string based on the configuration template and pass it… |
| ExperienceCode | string | no | The experience code |
| DocVideo | string | no | Specifies whether to store a video for evidence. Valid values: N: No. This is the default value. Y: Yes. During the authentication… |
| Model | string | no | The type of liveness detection to be performed. Valid values: LIVENESS: Blink liveness detection. This is the default value.… |
| IdThreshold | string | no | The custom threshold mode for OCR quality detection. Valid values: 0: Standard mode. 1: Strict mode. 2: Loose mode. 3: Disable quality… |
| ShowAlbumIcon | string | no | Specifies whether to display the album upload entry during the document OCR recognition phase. Valid values: 1: Display. This is the… |
| ShowOcrResult | string | no | Specifies whether to display the recognition result page during the document OCR recognition phase. Valid values: 1: Display. This is the… |
| ShowGuidePage | string | no | Specifies whether to display the guide page. Valid values: 1: Display. This is the default value. 0: Do not display |
| ProcedurePriority | string | no | Specifies whether to allow fallback processing when compatibility issues occur during mobile H5 authentication. Valid values: url:… |
| AppQualityCheck | string | no | This feature is not supported by the Web SDK. To use this feature, refer to the App SDK integration guide. Specifies whether to enable… |
| DocPageConfig | string | no | The custom configuration passed by the customer to specify whether to capture more pages (JSON-encoded) |
| MRTDInput | string | no | The input source of the MRTD verification parameter. This parameter is required to decrypt information when NFC reads the document chip… |
| DocumentNumber | string | no | The document number. This parameter is required when MRTDInput is set to 2 |
| DateOfBirth | string | no | The date of birth on the document, in the format of YYMMDD (6 digits). This parameter is required when MRTDInput is set to 2 |
| DateOfExpiry | string | no | The expiration date on the document, in the format of YYMMDD (6 digits). This parameter is required when MRTDInput is set to 2 |
| UseNFC | string | no | Specifies whether to enable NFC verification when DocType is set to 01000000 (global passport). Valid values: Y: Enable. N: Disable |
| ChameleonFrameEnable | string | no | Specifies whether to enable the adaptive color-changing window border. Valid values: Y: Enable. N: Disable |
| DocNo | string | no | The document number of the user |
| DocName | string | no | The real name of the user |
| EditOcrResult | string | no | Specifies whether the recognition result page is editable during the document OCR recognition phase. Valid values: 0: Not editable. 1:… |
| VerifyModel | string | no | The type of verification |
| FaceGroupCodes | string | no | The face databases to be compared |
| TargetFacePicture | string | no | The Base64-encoded string of the portrait photo |
| TargetFacePictureUrl | string | no | The URL of the portrait photo. It must be a publicly accessible HTTP or HTTPS link |
| AutoRegistration | string | no | Specifies whether to enable automatic registration |
| FaceRegisterGroupCode | string | no | The face database for registration |
| SaveFacePicture | string | no | Specifies whether to save the face picture |
| FaceVerifyThreshold | string | no | The threshold for face verification |
| ReturnFaces | string | no | The number of duplicate faces to be returned |
| Mobile | string | no | The Indonesian phone number. The format must be verified, starting with +62 followed by 9 to 11 digits. This field takes effect only when… |
| Email | string | no | The Indonesian email address. This field takes effect only when Authorize is set to T. This field is required only when the Indonesian… |
| TemplateType | string | no | The execution sequence of liveness detection actions in TemplateConfig. This parameter is required when Model is set to TEMPLATE. Valid… |
| TemplateConfig | string | no | The custom action pool configuration for liveness detection. This parameter is required when Model is set to TEMPLATE. Configuration… |
| TemplateRanCount | string | no | The number of actions randomly selected from TemplateConfig. This parameter takes effect only when TemplateType is set to Ran. Validation… |
| OcrValueStandard | string | no | Specifies whether to return additional standardized format fields for OCR recognition. Valid values: 0: No. This is the default value. 1:… |
| FaceAttributeCheck | string | no | Specifies whether to return additional face attribute information. Valid values: N: Do not return. This is the default value. Y: Return.… |
| AutoDocPageConfig | string | no | The automatic document page classification configuration. This parameter takes effect only when DocType is set to a country or region… |
| UpdateFaceIfUserExists | string | no | Specifies whether to overwrite the original face with the current face if MerchantUserId already exists during automatic registration.… |
| NeedMultiFaceCheck | string | no | Specifies whether to intercept the request when multiple faces are detected on the terminal. Valid values: Y: Intercept. The client… |

### Creates an authentication session for SDK integration. This operation must be used in conjunction with a…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/initialize-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| ProductCode | string | no | The product solution to integrate. Note: For more information, see the official documentation:… |
| MerchantBizId | string | no | The custom unique business identifier on the merchant side, which is used for subsequent troubleshooting. It supports a combination of… |
| MetaInfo | string | no | The Metainfo environment parameter, which must be obtained through the client SDK |
| DocType | string | no | The document type. For the eKYC_PRO and ID_OCR_MAX solutions, see the official documentation:… |
| MerchantUserId | string | no | Your custom user ID or another identifier that can identify a specific user, such as a mobile phone number or an email address.… |
| SceneCode | string | no | The scene code. This parameter is applicable to IDV products |
| Pages | string | no | The collection page configuration. Separate multiple pages with commas (,). Valid values: 01: The portrait side of the document. 01,02:… |
| FacePictureBase64 | string | no | The Base64-encoded photo. If you use the FacePictureBase64 method to pass the face photo, check the photo size and do not pass an… |
| FacePictureUrl | string | no | The URL of the face photo. The URL must be a publicly accessible HTTP or HTTPS link |
| Crop | string | no | Specifies whether to crop the image. This parameter is applicable to IDV products |
| Ocr | string | no | Specifies whether to enable OCR. This parameter is applicable to IDV products |
| IdFaceQuality | string | no | The quality of the face image. This parameter is applicable to IDV products |
| IdSpoof | string | no | Specifies whether to enable document anti-spoofing detection. This parameter is applicable to IDV products |
| ReturnUrl | string | no | The client-side callback URL |
| Authorize | string | no | Specifies whether to enable authoritative identity verification. This feature currently applies only to second-generation ID cards in the… |
| DocScanMode | string | no | The photo capture mode for document collection. Valid values: manual: Manual capture. auto: Automatic capture. This is the default value |
| ProductFlow | string | no | The sequence orchestration for document and face verification. Valid values: DOC_FACE: Document first, then face. This is the default… |
| CallbackUrl | string | no | The callback notification URL for authentication results. The default callback request method is GET, and the callback URL must start with… |
| CallbackToken | string | no | The security token used for anti-replay and anti-tampering verification. If this parameter is passed, the CallbackToken field is displayed… |
| LanguageConfig | string | no | The language configuration. This parameter is applicable to IDV products |
| SecurityLevel | string | no | The pattern that represents different security levels of the authentication flow. Valid values: 01: Normal pattern. This is the default… |
| StyleConfig | string | no | The custom UI configuration. Convert your custom UI configuration into a JSON string based on the configuration template and pass it… |
| ExperienceCode | string | no | The experience code |
| DocVideo | string | no | Specifies whether to store a video for evidence. Valid values: N: No. This is the default value. Y: Yes. During the authentication… |
| Model | string | no | The type of liveness detection to perform. Valid values: LIVENESS: Blink liveness detection. This is the default value. PHOTINUS_LIVENESS:… |
| IdThreshold | string | no | The custom threshold mode for OCR quality detection. Valid values: 0: System default. 1: Strict mode. 2: Loose mode. 3: Disable quality… |
| ShowAlbumIcon | string | no | Specifies whether to display the album upload entry during the document OCR recognition phase. Valid values: 1: Display. This is the… |
| ShowOcrResult | string | no | Specifies whether to display the recognition result page during the document OCR recognition phase. Valid values: 1: Display. This is the… |
| ShowGuidePage | string | no | Specifies whether to display the guide page. Valid values: 1: Display. This is the default value. 0: Do not display |
| ProcedurePriority | string | no | Specifies whether to allow degraded processing when compatibility issues occur during mobile H5 authentication. Valid values: url:… |
| AppQualityCheck | string | no | This feature is not supported by the Web SDK. To use this feature, refer to the App SDK integration guide. Specifies whether to enable… |
| DocPageConfig | string | no | The custom configuration passed by the customer to specify whether to collect more pages (JSON-encoded) |
| MRTDInput | string | no | The input source for MRTD verification parameters. This parameter is required to decrypt information when NFC reads the document chip… |
| DocumentNumber | string | no | The document number. This parameter is required when MRTDInput is set to 2 |
| DateOfBirth | string | no | The date of birth on the document, in the format of YYMMDD (6 digits). This parameter is required when MRTDInput is set to 2 |
| DateOfExpiry | string | no | The expiration date on the document, in the format of YYMMDD (6 digits). This parameter is required when MRTDInput is set to 2 |
| UseNFC | string | no | Specifies whether to enable NFC verification when DocType is set to 01000000 (global passport). Valid values: Y: Enable. N: Disable |
| ChameleonFrameEnable | string | no | Specifies whether to enable the adaptive color-changing window border. Valid values: Y: Enable. N: Disable |
| DocNo | string | no | The document number of the user |
| DocName | string | no | The real name of the user |
| EditOcrResult | string | no | Specifies whether the recognition result page is editable during the document OCR recognition phase. Valid values: 0: Not editable. 1:… |
| VerifyModel | string | no | The type of verification |
| FaceGroupCodes | string | no | The face databases for comparison |
| TargetFacePicture | string | no | The Base64-encoded portrait photo |
| TargetFacePictureUrl | string | no | The URL of the portrait photo. The URL must be a publicly accessible HTTP or HTTPS link |
| AutoRegistration | string | no | Specifies whether to enable automatic registration |
| FaceRegisterGroupCode | string | no | The face registration database |
| SaveFacePicture | string | no | Specifies whether to save the face photo |
| FaceVerifyThreshold | string | no | The face verification threshold |
| ReturnFaces | string | no | The number of duplicate faces returned |
| Mobile | string | no | The Indonesian phone number. The format must be verified, starting with +62 followed by 9 to 11 digits. This field takes effect only when… |
| Email | string | no | The Indonesian email address. This field takes effect only when Authorize is set to T. Note This field is required only when the… |
| TemplateType | string | no | The execution sequence of liveness detection actions in TemplateConfig. This parameter is required when Model is set to TEMPLATE. Valid… |
| TemplateConfig | string | no | The custom action pool configuration for liveness detection. This parameter is required when Model is set to TEMPLATE. Configuration… |
| TemplateRanCount | string | no | [Deprecated] The random mode is no longer recommended. This field is deprecated |
| OcrValueStandard | string | no | Specifies whether to return additional standardized format fields for OCR recognition. Valid values: 0: No. This is the default value. 1:… |
| TargetFacePictureFile | string | no | The file stream of the base library face photo |
| FacePictureFile | string | no | The file stream of the face photo |
| FaceAttributeCheck | string | no | Specifies whether to return additional face attribute information. Valid values: N: Do not return. This is the default value. Y: Return.… |
| AutoDocPageConfig | string | no | The automatic document page classification configuration. This parameter takes effect only when DocType is set to a country or region… |
| UpdateFaceIfUserExists | string | no | Specifies whether to use the current face to overwrite the existing face when MerchantUserId already exists during automatic registration.… |
| NeedMultiFaceCheck | string | no | Specifies whether to intercept the request when the terminal detects multiple faces. Valid values: Y: Intercept. The client prompts the… |

### Configures client connection keep-alive settings
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/keepalive-intl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |

### Verifies the mobile phone number and name
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/mobile2-meta-verify-intl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| ProductCode | string | yes | The product code. Set the value to MOBILE_2META |
| ParamType | string | yes | The parameter type. Valid values: normal: No encryption. md5: MD5 encryption |
| UserName | string | yes | The name. If paramType is set to normal, enter the plaintext name. If paramType is set to md5, enter the ciphertext name, which is a… |
| Mobile | string | yes | The mobile phone number. If paramType is set to normal, enter the plaintext mobile phone number. If paramType is set to md5, enter the… |

### Verifies the authenticity and consistency of a mobile phone number, name, and ID card number through…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/mobile3-meta-verify-intl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| ProductCode | string | no | The product solution to be accessed. Set the value to MOBILE_3META |
| ParamType | string | no | The parameter type. Valid values: normal: Unencrypted. md5: MD5-encrypted |
| IdentifyNum | string | no | The ID card number. If paramType is set to normal, enter the plaintext. If paramType is set to md5, enter a 32-character lowercase MD5… |
| UserName | string | no | The name. If paramType is set to normal, enter the plaintext. If paramType is set to md5, enter a 32-character lowercase MD5 string |
| Mobile | string | no | The mobile phone number. If paramType is set to normal, enter the plaintext. If paramType is set to md5, enter a 32-character lowercase… |

### Modifies a face library
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/modify-face-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| Id | string | no | The primary key ID |
| Name | string | yes | The name of the face library |
| Description | string | no | The description |

### Edits a face record
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/modify-face-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| ImgOssInfos | string | yes | The OSS information of the image |
| FaceGroupCode | string | yes | The face library code |

### Queries face libraries
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/query-face-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| Name | string | no | The name of the face library |
| GroupCode | string | no | The code of the face library |
| CurrentPage | integer | yes | The current page number |
| PageSize | integer | yes | The number of entries per page |
| MaxResults | integer | no | The maximum number of entries per page |
| NextToken | string | no | The token for the next query |

### Queries face records
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/query-face-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| FaceId | string | no | The face ID |
| MerchantUserId | string | no | The merchant user ID |
| RegistrationType | string | no | The registration type |
| FaceGroupCode | string | yes | The face library code |
| CurrentPage | integer | yes | The current page number |
| PageSize | integer | yes | The number of entries per page |
| MaxResults | integer | no | The maximum number of entries per page for a paginated query |
| NextToken | string | no | The token used to retrieve the next page of results |

### Retrieves a temporary token
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/temp-access-token-intl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| Type | string | no | The type |

### Retrieves a temporary URL for a file
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/temp-oss-url-intl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |
| ObjectName | string | yes | The object name |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudauth-intl.ap-southeast-1.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/add-face-record" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud ID Verification Intl API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-cloudauth-intl/add-face-record with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud ID Verification Intl 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 Intl itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud ID Verification Intl 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-intl.

### What is the status of the Alibaba Cloud ID Verification Intl API?
Needs your own provider key (bring your own key)