diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/cloudauth-intl/2022-08-09 | |
| download | acs-metadata-full-main.tar.gz acs-metadata-full-main.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/cloudauth-intl/2022-08-09')
| -rw-r--r-- | data/en_us/cloudauth-intl/2022-08-09/api-docs.php | 7071 |
1 files changed, 7071 insertions, 0 deletions
diff --git a/data/en_us/cloudauth-intl/2022-08-09/api-docs.php b/data/en_us/cloudauth-intl/2022-08-09/api-docs.php new file mode 100644 index 0000000..6571167 --- /dev/null +++ b/data/en_us/cloudauth-intl/2022-08-09/api-docs.php @@ -0,0 +1,7071 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Cloudauth-intl', + 'version' => '2022-08-09', + ], + 'directories' => [ + [ + 'id' => 349786, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'Initialize', + 'CheckResult', + ], + ], + [ + 'id' => 182315, + 'title' => 'Real Person Certification', + 'type' => 'directory', + 'children' => [ + 'EkycVerify', + ], + ], + [ + 'id' => 349787, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'FaceLiveness', + 'FaceDuplicationCheckIntl', + 'DeepfakeDetectIntlStream', + 'DeepfakeDetectIntl', + 'FaceGuardRisk', + 'FaceCompare', + 'FaceCrossCompareIntl', + ], + ], + [ + 'id' => 207369, + 'title' => 'Identification', + 'type' => 'directory', + 'children' => [ + 'DocOcrMax', + 'DocOcr', + ], + ], + [ + 'id' => 207370, + 'title' => 'information verification', + 'type' => 'directory', + 'children' => [ + 'Id2MetaVerifyIntl', + 'Id2MetaPeriodVerifyIntl', + 'BankMetaVerifyIntl', + 'Mobile2MetaVerifyIntl', + 'Mobile3MetaVerifyIntl', + ], + ], + [ + 'id' => 207371, + 'title' => 'credential detection', + 'type' => 'directory', + 'children' => [ + 'CredentialRecognitionIntl', + 'CredentialSubmitIntl', + 'CredentialGetResultIntl', + 'CredentialVerifyIntl', + ], + ], + [ + 'id' => 236783, + 'title' => 'Address Verification', + 'type' => 'directory', + 'children' => [ + 'AddressVerifyV2Intl', + 'AddressCompareIntl', + ], + ], + [ + 'id' => 187491, + 'title' => 'Auxiliary Interface', + 'type' => 'directory', + 'children' => [ + 'KeepaliveIntl', + 'DeleteVerifyResult', + 'CheckVerifyLog', + ], + ], + [ + 'id' => 280922, + 'title' => 'Other', + 'type' => 'directory', + 'children' => [ + 'AddFaceRecord', + 'DownloadVerifyRecordIntl', + 'QueryFaceGroup', + 'ModifyFaceGroup', + 'DeleteFaceGroup', + 'QueryFaceRecord', + 'ModifyFaceRecord', + 'DeleteFaceRecord', + 'TempOssUrlIntl', + 'TempAccessTokenIntl', + ], + ], + [ + 'id' => 349794, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CardOcr', + 'FraudResultCallBack', + 'AddressVerifyIntl', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'Initialize' => [ + 'summary' => 'Authentication Initialization', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '149600', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthCW0JNH', + 'FEATUREcloudauth6RJHVQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The product solution to be integrated. The values are as follows:'."\n" + ."\n" + .'- KYC_GLOBAL (eKYC product solution)'."\n" + .'- FV_GLOBAL (Live Face Verification)'."\n" + .'- FL_GLOBAL (Liveness Detection)'."\n" + .'- IDR_GLOBAL (Single Document Verification)'."\n" + .'- OCR_GLOBAL (Single Document OCR)', + 'type' => 'string', + 'required' => false, + 'example' => 'KYC_GLOBAL', + ], + ], + [ + 'name' => 'MerchantBizId', + 'in' => 'query', + 'schema' => [ + 'description' => 'A unique business identifier defined by the merchant, used for subsequent troubleshooting. It supports a combination of letters and numbers, with a maximum length of 32 characters. Please ensure its uniqueness.', + 'type' => 'string', + 'required' => false, + 'example' => 'e0c34a***353888', + ], + ], + [ + 'name' => 'MetaInfo', + 'in' => 'query', + 'schema' => [ + 'description' => 'Metainfo environment parameter, which needs to be obtained through the client SDK.', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"bioMetaInfo\\":\\"4.1.0:2916352,0\\",\\"deviceType\\":\\"web\\",\\"ua\\":\\"Mozilla/5.0 (Macintosh', + ], + ], + [ + 'name' => 'DocType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Document type, uniquely identified by an 8-digit combination.'."\n" + .'Note: This parameter is required only when ProductCode is KYC_GLOBAL, OCR_GLOBAL, or IDR_GLOBAL.', + 'type' => 'string', + 'required' => false, + 'example' => '01560000'."\n" + ."\n", + ], + ], + [ + 'name' => 'MerchantUserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Your custom user ID or other identifiers that can recognize specific users, such as phone numbers or email addresses. It is strongly recommended to pre-desensitize the value of this field, for example, by hashing it.', + 'type' => 'string', + 'required' => false, + 'example' => '1221****6543', + ], + ], + [ + 'name' => 'SceneCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scene code. (IDV product input parameter)', + 'type' => 'string', + 'required' => false, + 'example' => '123****123', + ], + ], + [ + 'name' => 'Pages', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page configuration for collection, multiple pages are connected using commas. The value range is as follows:'."\n" + .'- **01**: Front side of the document'."\n" + ."\n" + .'- **01,02**: Front and back sides of the document'."\n" + ."\n" + .'> When this value is 01,02, currently only Chinese and Vietnamese IDs are supported.', + 'type' => 'string', + 'required' => false, + 'example' => '01', + ], + ], + [ + 'name' => 'FacePictureBase64', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Base64 encoded face image. If you choose to pass the face image via FacePictureBase64, please check the image size and do not upload images larger than 1 MB.'."\n" + .'When productCode is FV_GLOBAL, choose one of the parameters between FacePictureBase64 and FacePictureUrl to pass in.', + 'type' => 'string', + 'required' => false, + 'example' => 'Base64', + ], + ], + [ + 'name' => 'FacePictureUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'Face image URL. A publicly accessible HTTP or HTTPS link. When productCode is FV_GLOBAL, choose one of the parameters between FacePictureUrl and FacePictureBase to pass in.', + 'type' => 'string', + 'required' => false, + 'example' => '***', + ], + ], + [ + 'name' => 'Crop', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to crop. (IDV product input parameter)', + 'type' => 'string', + 'required' => false, + 'example' => 'N', + ], + ], + [ + 'name' => 'Ocr', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to enable OCR. (IDV product input parameter)', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + [ + 'name' => 'IdFaceQuality', + 'in' => 'query', + 'schema' => [ + 'description' => 'Face image quality. (IDV product input parameter)', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + [ + 'name' => 'IdSpoof', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to enable certificate anti-counterfeiting detection. (IDV product input parameter)', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + [ + 'name' => 'ReturnUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'Client-side callback address.', + 'type' => 'string', + 'required' => false, + 'example' => 'http*****', + ], + ], + [ + 'name' => 'Authorize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to enable authoritative identity verification, currently applicable only to the second-generation ID card in mainland China. (IDV product input parameter)', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + [ + 'name' => 'DocScanMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Document capture mode.'."\n" + ."\n" + .'- manual: Manual capture.'."\n" + .'- auto: Automatic capture (default)', + 'type' => 'string', + 'required' => false, + 'example' => 'manual', + ], + ], + [ + 'name' => 'ProductFlow', + 'in' => 'query', + 'schema' => [ + 'description' => 'Supports card and face sequential arrangement:'."\n" + ."\n" + .'- DOC_FACE (default)'."\n" + .'- FACE_DOC'."\n" + ."\n" + .'Note: This parameter is required only when ProductCode is KYC_GLOBAL.', + 'type' => 'string', + 'required' => false, + 'example' => 'DOC_FACE', + ], + ], + [ + 'name' => 'CallbackUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'Callback notification address for authentication results. The default callback request method is GET, and the callback address must start with https. After completing the authentication, the platform will call back this address and automatically add the transactionId, passed, and subcode fields.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.aliyun.com?callbackToken=1000004826&transactionId=shaxxxx&passed=Y&subCode=200', + ], + ], + [ + 'name' => 'CallbackToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'Security Token, used for preventing duplication and tampering. If this parameter is passed, the CallbackToken field will be displayed in the callback address.', + 'type' => 'string', + 'required' => false, + 'example' => '7ca5c68d869344ea8eeb30cdfd544544-6358700', + ], + ], + [ + 'name' => 'LanguageConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'Language configuration. (IDV product input parameter)', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + [ + 'name' => 'SecurityLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'Represents different security levels in the authentication process. The available values are as follows:'."\n" + ."\n" + .'01: Normal mode (default).'."\n" + .'02: Secure mode, a relatively strict mode, suitable for high-risk scenarios. (IDV product input parameter)', + 'type' => 'string', + 'required' => false, + 'example' => '01', + ], + ], + [ + 'name' => 'StyleConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'Custom UI configuration. Based on the configuration template, convert your custom UI configuration into a JSON string and pass it through this interface. For more information, see [IDV UI Customization](https://www.alibabacloud.com/help/zh/ekyc/latest/idv-kyc-custom-skin?spm=a2c63.p38356.0.i60).', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "guidepage:": {****}, '."\n" + .' "ocrPage": {****},'."\n" + .' "ocrResultPage": [****],'."\n" + .' "facePage": {****},'."\n" + .'}', + ], + ], + [ + 'name' => 'ExperienceCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Experience code', + 'type' => 'string', + 'required' => false, + 'example' => '9be7b7d0180041219e5ab03ac6dab5fb', + ], + ], + [ + 'name' => 'DocVideo', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to require a video for evidence.'."\n" + ."\n" + .'- N: Not required (default).'."\n" + ."\n" + .'- Y: During the authentication process, a 1~2 second video of the user\'s face will be captured and returned via the query interface.'."\n" + ."\n" + .'> Due to the large size of the video file, the system may discard it when the network is unstable, prioritizing the transmission of necessary images for authentication.', + 'type' => 'string', + 'required' => false, + 'example' => 'N', + ], + ], + [ + 'name' => 'Model', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of liveness detection to be performed:'."\n" + ."\n" + .'- **LIVENESS** (default): Blinking action liveness detection.'."\n" + ."\n" + .'- **PHOTINUS_LIVENESS**: Blinking action liveness + photinus liveness dual detection.'."\n" + ."\n" + .'> '."\n" + .'> - For supported SDK versions, see [SDK Publishing Record](https://www.alibabacloud.com/help/zh/ekyc/latest/sdk-publishing-record?spm=a2c63.p38356.0.i99).'."\n" + .'> - PC does not support photinus liveness dual detection.', + 'type' => 'string', + 'required' => false, + 'example' => 'PHOTINUS_LIVENESS', + ], + ], + [ + 'name' => 'IdThreshold', + 'in' => 'query', + 'schema' => [ + 'description' => 'Custom OCR quality detection threshold mode:'."\n" + .'- **0**: Standard mode'."\n" + .'- **1**: Strict mode'."\n" + .'- **2**: Lenient mode'."\n" + .'- **3** (default): Disable quality detection', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ShowAlbumIcon', + 'in' => 'query', + 'schema' => [ + 'description' => 'In the document OCR recognition step, whether to display the album upload entry:'."\n" + ."\n" + .'- **1**: Display (default)'."\n" + ."\n" + .'- **0**: Do not display', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ShowOcrResult', + 'in' => 'query', + 'schema' => [ + 'description' => 'In the document OCR recognition step, whether to display the recognition result page:'."\n" + ."\n" + .'- **1**: Display (default)'."\n" + ."\n" + .'- **0**: Do not display', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ShowGuidePage', + 'in' => 'query', + 'schema' => [ + 'description' => 'Switch to control whether to display the guide page:'."\n" + ."\n" + .'- **1**: Display (default)'."\n" + ."\n" + .'- **0**: Do not display', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ProcedurePriority', + 'in' => 'query', + 'schema' => [ + 'description' => 'When compatibility issues occur with H5-based mobile authentication, whether to allow a fallback handling method.'."\n" + ."\n" + .'- **url** (default): Support fallback. The page displays the authentication URL, which users can copy and open in another browser to continue the authentication process.'."\n" + ."\n" + .'- **keep**: Do not support fallback. Directly return the error reason and end the authentication process.'."\n" + ."\n\n" + .'> '."\n" + .'> - This switch is not supported on PC.'."\n" + .'> - If the business scenario involves completing authentication through an embedded web page in an app, it is recommended to set this parameter to `keep` to disallow URL fallback.', + 'type' => 'string', + 'required' => false, + 'example' => 'url', + ], + ], + [ + 'name' => 'AppQualityCheck', + 'in' => 'query', + 'schema' => [ + 'description' => '<warning>This feature is currently not supported by **Web SDK**. Please refer to the App SDK integration if needed.</warning>'."\n" + ."\n" + .'Whether to enable strict face quality detection:'."\n" + .'- Y: Enable (default)'."\n" + .'- N: Disable', + 'type' => 'string', + 'required' => false, + 'example' => 'N', + ], + ], + [ + 'name' => 'DocPageConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Customer-defined input to specify whether to collect more pages', + 'type' => 'array', + 'items' => [ + 'description' => 'Collection page', + 'type' => 'string', + 'required' => false, + 'example' => 'OCR_ID_BACK', + ], + 'required' => false, + ], + ], + [ + 'name' => 'MRTDInput', + 'in' => 'query', + 'schema' => [ + 'description' => 'Source of MRTD verification parameters. This parameter is required to decrypt information when reading the document chip via NFC.'."\n" + ."\n" + .'- **0**: User input'."\n" + ."\n" + .'- **1**: OCR read'."\n" + ."\n" + .'- **2**: Passed through the API', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'DocumentNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Document number'."\n" + ."\n" + .'**MRTDInput = 2** is required.', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'DateOfBirth', + 'in' => 'query', + 'schema' => [ + 'description' => 'Date of birth on the document'."\n" + ."\n" + .'**MRTDInput = 2** is required.', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'DateOfExpiry', + 'in' => 'query', + 'schema' => [ + 'description' => 'Expiration date on the document'."\n" + ."\n" + .'**MRTDInput = 2** is required.', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'UseNFC', + 'in' => 'query', + 'schema' => [ + 'description' => 'When **DocType**=01000000 (global passport), you can choose whether to enable NFC verification.'."\n" + .'- **Y** (enable)'."\n" + .'- **N** (disable)', + 'type' => 'string', + 'required' => false, + 'example' => 'N', + ], + ], + [ + 'name' => 'ChameleonFrameEnable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to enable adaptive color-changing window border'."\n" + .'- **Y**: Enable'."\n" + .'- **N**: Disable', + 'type' => 'string', + 'required' => false, + 'example' => 'N', + ], + ], + [ + 'name' => 'DocNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'User\'s document number.', + 'type' => 'string', + 'required' => false, + 'example' => '411xxxxxxxxxxx0001', + ], + ], + [ + 'name' => 'DocName', + 'in' => 'query', + 'schema' => [ + 'description' => 'User\'s real name.', + 'type' => 'string', + 'required' => false, + 'example' => '张三', + ], + ], + [ + 'name' => 'EditOcrResult', + 'in' => 'query', + 'schema' => [ + 'description' => 'In the document OCR recognition step, whether the recognition result page is editable:'."\n" + ."\n" + .'- **0**: Not editable'."\n" + ."\n" + .'- **1** (default): Editable', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'VerifyModel', + 'in' => 'query', + 'schema' => [ + 'title' => '验证的类型', + 'description' => 'Type of verification', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'FaceGroupCodes', + 'in' => 'query', + 'schema' => [ + 'title' => '需要比对的人脸库', + 'description' => 'Face library to be compared', + 'type' => 'string', + 'required' => false, + 'example' => '0e0c34a77f', + ], + ], + [ + 'name' => 'TargetFacePicture', + 'in' => 'query', + 'schema' => [ + 'title' => '人像照片Base64编码。', + 'description' => 'Base64 encoding of the portrait photo.', + 'type' => 'string', + 'required' => false, + 'example' => 'base64', + ], + ], + [ + 'name' => 'TargetFacePictureUrl', + 'in' => 'query', + 'schema' => [ + 'title' => '人像图片地址，公网可访问的HTTP、HTTPS链接。', + 'description' => 'Portrait image URL, accessible via public HTTP or HTTPS link.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.xxxxx.com/1.jpg', + ], + ], + [ + 'name' => 'AutoRegistration', + 'in' => 'query', + 'schema' => [ + 'title' => '是否开启自动注册', + 'description' => 'Whether to enable automatic registration', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'FaceRegisterGroupCode', + 'in' => 'query', + 'schema' => [ + 'title' => '注册人脸库。', + 'description' => 'Face library for registration.', + 'type' => 'string', + 'required' => false, + 'example' => '0e0c34a77f', + ], + ], + [ + 'name' => 'SaveFacePicture', + 'in' => 'query', + 'schema' => [ + 'title' => '是否保存人脸图片', + 'description' => 'Whether to save the face image', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'FaceVerifyThreshold', + 'in' => 'query', + 'schema' => [ + 'title' => '人脸验证阈值', + 'description' => 'Face verification threshold', + 'type' => 'string', + 'required' => false, + 'example' => '0.5', + ], + ], + [ + 'name' => 'ReturnFaces', + 'in' => 'query', + 'schema' => [ + 'title' => '返回重复人脸数量', + 'description' => 'Number of duplicate faces returned', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '4EB35****87EBA1', + ], + 'Code' => [ + 'description' => 'Return code', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'Return message', + 'type' => 'string', + 'example' => 'success', + ], + 'Result' => [ + 'description' => 'Return result', + 'type' => 'object', + 'properties' => [ + 'TransactionId' => [ + 'description' => 'Authentication ID', + 'type' => 'string', + 'example' => '08573be80f944d95ac812e019e3655a8', + ], + 'ClientCfg' => [ + 'description' => 'Client configuration', + 'type' => 'string', + 'example' => '***', + ], + 'TransactionUrl' => [ + 'description' => 'Web authentication URL', + 'type' => 'string', + 'example' => 'http****', + ], + 'Protocol' => [ + 'description' => 'Standard encryption protocol for authentication.'."\n" + ."\n" + .'> This field is required when integrating with H5 web pages using iframe embedding.', + 'type' => 'string', + 'example' => 'hksb7ba1b28130d24e015d*********', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"08573be80f944d95ac812e019e3655a8\\",\\n \\"ClientCfg\\": \\"***\\",\\n \\"TransactionUrl\\": \\"http****\\",\\n \\"Protocol\\": \\"hksb7ba1b28130d24e015d*********\\"\\n }\\n}","type":"json"}]', + 'title' => 'Initialization', + 'translator' => 'machine', + ], + 'CheckResult' => [ + 'summary' => 'Result Query', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '149753', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthCS0SDG', + ], + ], + 'parameters' => [ + [ + 'name' => 'MerchantBizId', + 'in' => 'query', + 'schema' => [ + 'description' => 'A unique business identifier defined by the merchant, used for subsequent troubleshooting. It supports a combination of letters and numbers, with a maximum length of 32 characters. Please ensure its uniqueness.', + 'type' => 'string', + 'required' => false, + 'example' => 'djs20d***9-dsskc', + ], + ], + [ + 'name' => 'TransactionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Authentication ID.', + 'type' => 'string', + 'required' => false, + 'example' => '4ab0b***cbde97', + ], + ], + [ + 'name' => 'IsReturnImage', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to return images.'."\n" + .'- Y: Return'."\n" + .'- N: Do not return', + 'type' => 'string', + 'required' => false, + 'example' => 'N', + ], + ], + [ + 'name' => 'ExtraImageControlList', + 'in' => 'query', + 'schema' => [ + 'description' => 'Return additional information.', + 'type' => 'string', + 'required' => false, + 'example' => '***', + ], + ], + [ + 'name' => 'ReturnFiveCategorySpoofResult', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to return anti-fraud detection results.', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'ID of the request', + 'type' => 'string', + 'example' => '4EB35****87EBA1', + ], + 'Code' => [ + 'description' => 'Return code.', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'Result' => [ + 'description' => 'Return result.', + 'type' => 'object', + 'properties' => [ + 'EkycResult' => [ + 'description' => 'Authentication result.', + 'type' => 'string', + 'example' => '**', + ], + 'ExtBasicInfo' => [ + 'description' => 'Extended basic information.', + 'type' => 'string', + 'example' => '**', + ], + 'ExtFaceInfo' => [ + 'description' => 'Face information.', + 'type' => 'string', + 'example' => '**', + ], + 'ExtIdInfo' => [ + 'description' => 'ID information.', + 'type' => 'string', + 'example' => '**', + ], + 'ExtRiskInfo' => [ + 'description' => 'Risk information.', + 'type' => 'string', + 'example' => '**', + ], + 'Passed' => [ + 'description' => 'Whether the authentication is passed.'."\n" + ."\n" + .'- Y: Passed'."\n" + .'- N: Not passed', + 'type' => 'string', + 'example' => 'Y', + ], + 'SubCode' => [ + 'description' => 'Sub-result code.', + 'type' => 'string', + 'example' => '***', + ], + 'ExtInfo' => [ + 'type' => 'string', + 'description' => 'Extended information', + 'example' => '{}', + ], + 'ExtSourceInfo' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"EkycResult\\": \\"**\\",\\n \\"ExtBasicInfo\\": \\"**\\",\\n \\"ExtFaceInfo\\": \\"**\\",\\n \\"ExtIdInfo\\": \\"**\\",\\n \\"ExtRiskInfo\\": \\"**\\",\\n \\"Passed\\": \\"Y\\",\\n \\"SubCode\\": \\"***\\",\\n \\"ExtInfo\\": \\"{}\\",\\n \\"ExtSourceInfo\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => 'Query Authentication Result', + 'translator' => 'machine', + ], + 'EkycVerify' => [ + 'summary' => 'This topic describes how to integrate with ID Verification using only the server-side API.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '190721', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The product solution to integrate. Set the value to **eKYC_MIN**.', + 'type' => 'string', + 'required' => false, + 'example' => 'eKYC_MIN', + ], + ], + [ + 'name' => 'MerchantBizId', + 'in' => 'query', + 'schema' => [ + 'description' => 'A unique business identifier that you customize. It is used to locate and troubleshoot issues. The identifier can be up to 32 characters in length and can contain letters and digits. Make sure that the identifier is unique.', + 'type' => 'string', + 'required' => false, + 'example' => 'e0c34a77f5ac40a5aa5e6ed20c353888', + ], + ], + [ + 'name' => 'MerchantUserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'A custom user ID or another identifier that can identify a specific user, such as a mobile number or an email address. Desensitize the value of this field in advance, for example, by hashing the value.', + 'type' => 'string', + 'required' => false, + 'example' => '123456', + ], + ], + [ + 'name' => 'DocType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The certificate type, which is uniquely identified by an 8-digit number. For more information, see [Certificate types](https://www.alibabacloud.com/help/en/ekyc/latest/im1u641gyesiqmbg?spm=a2c63.p38356.0.i18#Hu5TG).', + 'type' => 'string', + 'required' => false, + 'example' => '00000001', + ], + ], + [ + 'name' => 'DocName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The user\'s real name.'."\n" + ."\n" + .'> If Authorize is set to T and the certificate type is Chinese mainland resident ID card, you must enter at least one of the following groups of information:'."\n" + .'> - DocName and DocNo.'."\n" + .'> - IdOcrPictureBase64 or IdOcrPictureUrl.', + 'type' => 'string', + 'required' => false, + 'example' => 'Zhang San', + ], + ], + [ + 'name' => 'DocNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The user\'s certificate number.'."\n" + ."\n\n" + .'> If Authorize is set to **T** and the certificate type is Chinese mainland resident ID card, you must enter at least one of the following groups of information:'."\n" + .'> - DocName and DocNo.'."\n" + .'> - IdOcrPictureBase64 or IdOcrPictureUrl.', + 'type' => 'string', + 'required' => false, + 'example' => '410***************', + ], + ], + [ + 'name' => 'IdOcrPictureUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URL of the certificate image. The URL must be an HTTP or HTTPS link accessible over the Internet.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://digital-cardocr-prod8.oss-cn-hangzhou.aliyuncs.com/1669520556530-expo/default/face/20221127114236530_w3kx2e6t.jpg'."\n", + ], + ], + [ + 'name' => 'IdOcrPictureBase64', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The Base64 encoding of the certificate image.'."\n" + ."\n" + .'> If you use this method to pass the certificate image, check the image size. Do not pass an oversized image.', + 'type' => 'string', + 'required' => false, + 'example' => 'dsjisaj***oekwodsm'."\n", + ], + ], + [ + 'name' => 'FacePictureUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URL of the portrait image. The URL must be an HTTP or HTTPS link accessible over the Internet.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://digital-face-prod8.oss-cn-hangzhou.aliyuncs.com/1669520556530-expo/default/face/20221127114236530_w3kx2e6t.jpg', + ], + ], + [ + 'name' => 'FacePictureBase64', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The Base64 encoding of the portrait image.'."\n" + ."\n" + .'> If you use this method to pass the certificate image, check the image size. Do not pass an oversized image.', + 'type' => 'string', + 'required' => false, + 'example' => 'dsjisaj***oekwodsm', + ], + ], + [ + 'name' => 'Crop', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to crop the face image:'."\n" + ."\n" + .'- **T**: Allows cropping.'."\n" + ."\n" + .'- **F**: Disallows cropping. (Default)', + 'type' => 'string', + 'required' => false, + 'example' => 'F', + ], + ], + [ + 'name' => 'Authorize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable identity verification against the official database:'."\n" + ."\n" + .'- **T**: Enable.'."\n" + ."\n" + .'- **F**: Disable. (Default)'."\n" + ."\n" + .'> This feature is currently available only for second-generation resident ID cards of the Chinese mainland.', + 'type' => 'string', + 'required' => false, + 'example' => 'T', + ], + ], + [ + 'name' => 'IdThreshold', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom OCR quality detection threshold mode:'."\n" + ."\n" + .'- **0**: Standard mode'."\n" + ."\n" + .'- **1**: Strict mode'."\n" + ."\n" + .'- **2**: Loose mode'."\n" + ."\n" + .'- **3** (default): Disables quality detection', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '4EB356FE-BB6A-5DCC-B4C5-E8051787EBA1', + ], + 'Code' => [ + 'description' => 'The [response code](https://www.alibabacloud.com/help/en/ekyc/latest/im1u641gyesiqmbg?spm=a2c63.p38356.0.i18#GiGmf).', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'A detailed description of the response code.', + 'type' => 'string', + 'example' => 'success', + ], + 'Result' => [ + 'description' => 'Result object', + 'type' => 'object', + 'properties' => [ + 'TransactionId' => [ + 'description' => 'The transaction ID.', + 'type' => 'string', + 'example' => '4ab0b***cbde97', + ], + 'SubCode' => [ + 'description' => 'A description of the authentication result. For more information, see [Error codes for ResultObject.SubCode](https://www.alibabacloud.com/help/en/ekyc/latest/im1u641gyesiqmbg?spm=a2c63.p38356.0.i18#HCGLb).', + 'type' => 'string', + 'example' => '205', + ], + 'Passed' => [ + 'description' => 'The final authentication result. Valid values:'."\n" + ."\n" + .'- **Y**: The authentication is passed.'."\n" + ."\n" + .'- **N**: The authentication fails.', + 'type' => 'string', + 'example' => 'Y', + ], + 'ExtFaceInfo' => [ + 'description' => 'Information about the face liveness verification result. For the JSON format, see the example on the right. For more information, see [ExtFaceInfo](https://www.alibabacloud.com/help/en/ekyc/latest/im1u641gyesiqmbg?spm=a2c63.p38356.0.i18#JJ40j).', + 'type' => 'string', + 'example' => '{'."\n" + .'"faceAttack": "N",'."\n" + .'"faceComparisonScore": 52.57,'."\n" + .'"facePassed": "N",'."\n" + .'"authorityComparisonScore": 80.39'."\n" + .'}'."\n" + ."\n", + ], + 'ExtIdInfo' => [ + 'description' => 'Information about the certificate detection result.'."\n" + ."\n" + .'For the JSON format, see the example on the right. For more information, see [ExtIdInfo](https://www.alibabacloud.com/help/en/ekyc/latest/im1u641gyesiqmbg?spm=a2c63.p38356.0.i18#iWOBY).', + 'type' => 'string', + 'example' => '{'."\n" + .' "ocrIdInfo": {'."\n" + .' "expiryDate": "",'."\n" + .' "originOfIssue": "Exit and Entry Administration of the Ministry of Public Security",'."\n" + .' "englishName": "LI SI",'."\n" + .' "sex": "Male",'."\n" + .' "name": "Li Si",'."\n" + .' "idNumber": "H11111112",'."\n" + .' "issueDate": "2013-01-02",'."\n" + .' "birthDate": "1990-02-21"'."\n" + .' },'."\n" + .' "ocrIdPassed": "N",'."\n" + .' "spoofInfo": {'."\n" + .' "spoofResult": "Y",'."\n" + .' "spoofType": ['."\n" + .' "SCREEN_REMARK"'."\n" + .' ]'."\n" + .' }'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB356FE-BB6A-5DCC-B4C5-E8051787EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"4ab0b***cbde97\\",\\n \\"SubCode\\": \\"205\\",\\n \\"Passed\\": \\"Y\\",\\n \\"ExtFaceInfo\\": \\"{\\\\n\\\\\\"faceAttack\\\\\\": \\\\\\"N\\\\\\",\\\\n\\\\\\"faceComparisonScore\\\\\\": 52.57,\\\\n\\\\\\"facePassed\\\\\\": \\\\\\"N\\\\\\",\\\\n\\\\\\"authorityComparisonScore\\\\\\": 80.39\\\\n}\\\\n\\\\n\\",\\n \\"ExtIdInfo\\": \\"{\\\\n \\\\\\"ocrIdInfo\\\\\\": {\\\\n \\\\\\"firstName\\\\\\": \\\\\\"**龙\\\\\\",\\\\n \\\\\\"lastName\\\\\\": \\\\\\"**\\\\\\",\\\\n \\\\\\"countryCode\\\\\\": \\\\\\"CHN\\\\\\",\\\\n \\\\\\"docType\\\\\\": \\\\\\"01560001\\\\\\",\\\\n \\\\\\"dateOfBirth\\\\\\": \\\\\\"2002-08-04\\\\\\",\\\\n \\\\\\"idNumber\\\\\\": \\\\\\"410************19\\\\\\"\\\\n },\\\\n \\\\\\"ocrIdPassed\\\\\\": \\\\\\"N\\\\\\",\\\\n \\\\\\"spoofInfo\\\\\\": {\\\\n \\\\\\"spoofResult\\\\\\": \\\\\\"Y\\\\\\",\\\\n }\\\\n}\\\\n\\\\n\\"\\n }\\n}","type":"json"}]', + 'title' => 'Pure server-side eKYC API', + ], + 'FaceLiveness' => [ + 'summary' => 'Passive liveness detection (FaceLiveness) is a service that detects whether a pre-captured facial image, submitted to an API operation, is a real face. The algorithm primarily detects presentation attacks, such as screen replays and printed photos. This service is suitable for low-risk business scen', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '175619', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The product solution to use. Set the value to **FACE_LIVENESS_MIN** to use the passive liveness detection API.', + 'type' => 'string', + 'required' => false, + 'example' => 'FACE_LIVENESS_MIN', + ], + ], + [ + 'name' => 'MerchantBizId', + 'in' => 'query', + 'schema' => [ + 'description' => 'A custom unique business identifier. You can use this identifier to track and troubleshoot issues. The identifier can be up to 32 characters in length and can contain letters and digits. Make sure the identifier is unique.'."\n" + ."\n" + .'> Alibaba Cloud servers do not check the uniqueness of this value. For better tracking, ensure this value is unique.', + 'type' => 'string', + 'required' => false, + 'example' => 'e0c34a77f5ac40a5aa5e6ed20c353888', + ], + ], + [ + 'name' => 'MerchantUserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'A custom user ID or another identifier for a specific user, such as a mobile number or email address. For security, desensitize this value in advance, for example, by hashing it.', + 'type' => 'string', + 'required' => false, + 'example' => '123456789', + ], + ], + [ + 'name' => 'FacePictureUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URL of the portrait image. The URL must be an HTTP or HTTPS link accessible over the Internet.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://digital-face-prod8.oss-cn-hangzhou.aliyuncs.com/1669520556530-expo/default/face/20221127114236530_w3kx2e6t.jpg', + ], + ], + [ + 'name' => 'FacePictureBase64', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The Base64-encoded image. If you use this parameter to pass the facial image, check the image size. Do not pass an oversized image.', + 'type' => 'string', + 'required' => false, + 'example' => 'dsjisaj***oekwodsm', + ], + ], + [ + 'name' => 'FaceQuality', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return the facial image quality score. The default value is F.'."\n" + ."\n" + .'- **T**: returns the score.'."\n" + ."\n" + .'- **F**: does not return the score.', + 'type' => 'string', + 'required' => false, + 'example' => 'T', + ], + ], + [ + 'name' => 'Crop', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to crop the facial image. The default value is F.'."\n" + ."\n" + .'- **T**: allows cropping.'."\n" + ."\n" + .'- **F**: Forbidden', + 'type' => 'string', + 'required' => false, + 'example' => 'T', + ], + ], + [ + 'name' => 'Occlusion', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable occlusion detection. The default value is F.'."\n" + ."\n" + .'- **T**: enables the feature.'."\n" + ."\n" + .'- **F**: disables the feature.', + 'type' => 'string', + 'required' => false, + 'example' => 'T', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '42EA58CA-5DF4-55D5-82C4-5E7A40DA62BA', + ], + 'Code' => [ + 'description' => '[The response code.](https://www.alibabacloud.com/help/en/ekyc/latest/cadqvlft48igbpdc?spm=a2c63.p38356.0.i54#3d0ed52f967g6)', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'A detailed description of the response code.', + 'type' => 'string', + 'example' => 'success', + ], + 'Result' => [ + 'description' => 'Result object', + 'type' => 'object', + 'properties' => [ + 'TransactionId' => [ + 'description' => 'The transaction ID.'."\n", + 'type' => 'string', + 'example' => '08573be80f944d95ac812e019e3655a8', + ], + 'Passed' => [ + 'description' => 'The authentication result. Valid values:'."\n" + ."\n" + .'- Y: The authentication is passed.'."\n" + ."\n" + .'- N: The authentication is not passed.', + 'type' => 'string', + 'example' => 'N', + ], + 'SubCode' => [ + 'description' => 'The code that corresponds to the verification result. For more information, see [ResultObject.SubCode error codes](https://www.alibabacloud.com/help/en/ekyc/latest/cadqvlft48igbpdc?spm=a2c63.p38356.0.i54#5ff3e16174tl2).', + 'type' => 'string', + 'example' => '205', + ], + 'ExtFaceInfo' => [ + 'description' => 'The results of the passive liveness detection. The value is in the JSON format. For more information, see [ExtFaceInfo](https://www.alibabacloud.com/help/en/ekyc/latest/cadqvlft48igbpdc?spm=a2c63.p38356.0.i54#5ff42f7274agz).', + 'type' => 'object', + 'properties' => [ + 'FaceQualityScore' => [ + 'description' => 'Optional. The quality score of the live face. The value ranges from 0 to 100.', + 'type' => 'number', + 'format' => 'double', + 'example' => '87.19', + ], + 'OcclusionResult' => [ + 'description' => 'Optional. Indicates whether the face is occluded. Y means the face is occluded. N means the face is not occluded.', + 'type' => 'string', + 'example' => 'Y', + ], + 'FaceAttack' => [ + 'description' => 'Indicates whether a presentation attack was detected on the captured face. Y means an attack was detected. N means no attack was detected.', + 'type' => 'string', + 'example' => 'Y', + ], + 'FaceGender' => [ + 'description' => 'The predicted gender of the person in the image. The prediction may fail, resulting in an empty value.'."\n" + ."\n" + .'- **M**: Male'."\n" + ."\n" + .'- **F**: Female', + 'type' => 'string', + 'example' => 'M', + ], + 'FaceAge' => [ + 'description' => 'The predicted age of the person in the image. The prediction may fail, resulting in an empty value.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '18', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42EA58CA-5DF4-55D5-82C4-5E7A40DA62BA\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"08573be80f944d95ac812e019e3655a8\\",\\n \\"Passed\\": \\"N\\",\\n \\"SubCode\\": \\"205\\",\\n \\"ExtFaceInfo\\": {\\n \\"FaceQualityScore\\": 87.19,\\n \\"OcclusionResult\\": \\"Y\\",\\n \\"FaceAttack\\": \\"Y\\",\\n \\"FaceGender\\": \\"M\\",\\n \\"FaceAge\\": 18\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Pure server-side passive liveness capability', + ], + 'FaceDuplicationCheckIntl' => [ + 'summary' => 'Face Duplication Detection API', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Product code', + 'type' => 'string', + 'required' => true, + 'example' => 'FACE_IDU_MIN', + ], + ], + [ + 'name' => 'SceneCode', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Your custom authentication scenario ID.', + 'type' => 'string', + 'required' => false, + 'example' => '1234567890', + ], + ], + [ + 'name' => 'MerchantBizId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'A unique business identifier for troubleshooting purposes. It supports a combination of 32 alphanumeric characters, please ensure its uniqueness.', + 'type' => 'string', + 'required' => true, + 'example' => 'e0c34a77f5ac40a5aa5e6ed20c35****', + ], + ], + [ + 'name' => 'MerchantUserId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Your custom user ID or other identifiers that can uniquely identify a specific user, such as a phone number or email address. It is strongly recommended to pre-desensitize the value of this field, for example, by hashing it.', + 'type' => 'string', + 'required' => true, + 'example' => '1234567890', + ], + ], + [ + 'name' => 'VerifyModel', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Verification type'."\n" + .'- 0- 1:N (default)'."\n" + .'- 1- 1:1'."\n" + .'- 2- 1:N + 1:1', + 'type' => 'string', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'Liveness', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Whether to enable silent liveness detection'."\n" + .'- 0- Disabled'."\n" + .'- 1- Enabled', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'FaceGroupCodes', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The face library code created through the console, supporting up to 10 face libraries simultaneously. When multiple face library codes are passed, they should be separated by commas.', + 'type' => 'string', + 'required' => false, + 'example' => '1232344，23444', + ], + ], + [ + 'name' => 'SourceFacePicture', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Base64 encoded portrait photo.', + 'type' => 'string', + 'required' => false, + 'example' => 'base64', + ], + ], + [ + 'name' => 'SourceFacePictureUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Portrait image URL, accessible via public HTTP or HTTPS link.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://***face1.jpeg', + ], + ], + [ + 'name' => 'TargetFacePicture', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Base64 encoded portrait photo.', + 'type' => 'string', + 'required' => false, + 'example' => 'base64', + ], + ], + [ + 'name' => 'TargetFacePictureUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Portrait image URL, accessible via public HTTP or HTTPS link.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://***face2.jpeg', + ], + ], + [ + 'name' => 'AutoRegistration', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Indicates whether to automatically register the face to the specified face library if no duplicate face is found.'."\n" + .'- 0- Auto-register (default)'."\n" + .'- 1- Do not register', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'FaceRegisterGroupCode', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Face registration library.', + 'type' => 'string', + 'required' => false, + 'example' => '0e0c34a77f', + ], + ], + [ + 'name' => 'SaveFacePicture', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Distinguishes between saving the face image and features'."\n" + .'- 0- Face (default)'."\n" + .'- 1- Features', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'FaceVerifyThreshold', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Face matching threshold.', + 'type' => 'string', + 'required' => false, + 'example' => '0.5', + ], + ], + [ + 'name' => 'ReturnFaces', + 'in' => 'formData', + 'schema' => [ + 'description' => 'When there are multiple faces above the matching threshold, you can use this parameter to customize the number of returned faces'."\n" + .'- Default returns 1'."\n" + .'- Maximum support 5', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'ID of the request', + 'type' => 'string', + 'example' => '5E63B760-0ECB-5C07-8503-A65C27876968', + ], + 'Code' => [ + 'description' => 'Return code.', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'Result' => [ + 'description' => 'Return result.', + 'type' => 'object', + 'properties' => [ + 'FacePassed' => [ + 'description' => 'Final authentication result, values:'."\n" + .'- Y: Passed'."\n" + .'- N: Not passed', + 'type' => 'string', + 'example' => 'Y', + ], + 'FaceComparisonScore' => [ + 'description' => 'When the verification mode is 1 or 2, returns the 1:1 verification comparison score'."\n" + .'Comparison score range 0～100.', + 'type' => 'string', + 'example' => '98', + ], + 'DuplicateFace' => [ + 'description' => 'Returns the face library face ID and UserID when a duplicate face is detected.', + 'type' => 'string', + 'example' => '['."\n" + .'{\\"faceGroupCode\\":\\"sg7****uzt\\",\\"faceId\\":\\"f5a921*******9e792ec84c8f0ca592a\\"}'."\n" + .']', + ], + 'FaceRegistrationResult' => [ + 'description' => 'Face registration result '."\n" + .'- 0- Failed '."\n" + .'- 1- Succeeded', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'FaceRegistrationId' => [ + 'description' => 'Returns the corresponding FACEID only when the customer sets auto-registration and the face registration is successful.', + 'type' => 'string', + 'example' => '9e792ec84c8f0ca592a', + ], + 'FaceAttack' => [ + 'description' => 'Indicates whether the captured face involves a liveness attack, Y for an attack, N for no attack.'."\n" + .'Returned when silent liveness detection is enabled.', + 'type' => 'string', + 'example' => 'N', + ], + 'FaceAttackScore' => [ + 'description' => 'The probability of a liveness attack detected by silent liveness detection. The value range is 0 to 100.'."\n" + .'Returned when silent liveness detection is enabled.', + 'type' => 'string', + 'example' => '99', + ], + 'FaceAge' => [ + 'description' => 'The estimated age of the face, which may not be returned if the prediction fails.', + 'type' => 'string', + 'example' => '30', + ], + 'FaceGender' => [ + 'description' => 'The predicted gender of the face in the image, which may not be returned if the prediction fails.'."\n" + .'- M: Male'."\n" + .'- F: Female', + 'type' => 'string', + 'example' => 'M', + ], + 'SubCode' => [ + 'description' => 'Description of the authentication result. For more information, see ResultObject.SubCode error code description.', + 'type' => 'string', + 'example' => '200', + ], + 'TransactionId' => [ + 'description' => 'Unique identifier of the authentication request.', + 'type' => 'string', + 'example' => '4ab0b***cbde97', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5E63B760-0ECB-5C07-8503-A65C27876968\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"FacePassed\\": \\"Y\\",\\n \\"FaceComparisonScore\\": \\"98\\",\\n \\"DuplicateFace\\": \\"[\\\\n {\\\\n \\\\\\"faceGroupCode\\\\\\": \\\\\\"sg7****uzt\\\\\\",\\\\n \\\\\\"faceId\\\\\\": \\\\\\"f5a921*******9e792ec84c8f0ca592a\\\\\\",\\\\n \\\\\\"merchantUserId\\\\\\": \\\\\\"fa****01\\\\\\"\\\\n }\\\\n]\\",\\n \\"FaceRegistrationResult\\": 0,\\n \\"FaceRegistrationId\\": \\"9e792ec84c8f0ca592a\\",\\n \\"FaceAttack\\": \\"N\\",\\n \\"FaceAttackScore\\": \\"99\\",\\n \\"FaceAge\\": \\"30\\",\\n \\"FaceGender\\": \\"M\\",\\n \\"SubCode\\": \\"200\\",\\n \\"TransactionId\\": \\"4ab0b***cbde97\\"\\n }\\n}","type":"json"}]', + 'title' => 'Face Duplication Detection API', + 'translator' => 'machine', + ], + 'DeepfakeDetectIntlStream' => [ + 'summary' => 'deepfake file stream API', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthNYJI62', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The product solution to be integrated.'."\n" + .'Value: FACE_DEEPFAKE', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'FACE_DEEPFAKE', + ], + ], + [ + 'name' => 'SceneCode', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Your custom authentication scenario ID, used for querying related records by entering this scenario ID in the console later.'."\n" + ."\n" + .'Supports a combination of 10 characters, including letters, numbers, or underscores.', + 'type' => 'string', + 'required' => false, + 'example' => '123****123', + ], + ], + [ + 'name' => 'MerchantBizId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'A unique identifier for the merchant\'s request, consisting of a 32-character alphanumeric combination.'."\n" + ."\n" + .'The first few characters are composed of a custom abbreviation defined by the merchant, the middle part can include a period of time, and the latter part can use a random or incremental sequence.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'e0c34a***353888', + ], + ], + [ + 'name' => 'FaceInputType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Face material input type:'."\n" + ."\n" + .'- IMAGE (default): Face image'."\n" + .'- VIDEO: Face video'."\n" + ."\n" + .'Note: Video processing takes longer, it is recommended to set the timeout > 3S.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'IMAGE' => 'IMAGE', + 'VIDEO' => 'VIDEO', + ], + 'example' => 'IMAGE', + ], + ], + [ + 'name' => 'FaceUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Enter the URL address of the face image.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg', + ], + ], + [ + 'name' => 'FaceBase64', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Enter the Base64 encoded format of the face image; for video formats, it is recommended to input via stream.', + 'type' => 'string', + 'required' => false, + 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx', + ], + ], + [ + 'name' => 'FaceFile', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Image input stream.', + 'type' => 'string', + 'required' => false, + 'example' => '-', + 'isFileTransferUrl' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '4EB35****87EBA1', + ], + 'Code' => [ + 'description' => 'Return code', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'Return message', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => 'Returned result information.', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => 'Risk result:'."\n" + ."\n" + .'- **0**: Low risk'."\n" + .'- **1**: High risk'."\n" + .'- **2**: Suspicious', + 'type' => 'string', + 'example' => '1', + ], + 'RiskTag' => [ + 'description' => 'Risk tags. Multiple tags are separated by commas (,), including:'."\n" + ."\n" + .'- SuspectDeepForgery: Suspected deep forgery'."\n" + .'- SuspectPSFace: Suspected synthetic attack'."\n" + .'- SuspectTemple: Suspected template attack'."\n" + .'- SuspectRemake: Suspected presentation attack', + 'type' => 'string', + 'example' => 'SuspectDeepForgery', + ], + 'RiskScore' => [ + 'description' => 'Risk score map.', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{'."\n" + .' "SuspectPSFace": "0.9796",'."\n" + .' "SuspectRemake": "0.0000",'."\n" + .' "SuspectDeepForgery": "0.9500",'."\n" + .' "SuspectAIGCFace": "0.0001"'."\n" + .' }', + 'description' => 'Returns the corresponding tag score when a risk is hit.', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"Result\\": \\"1\\",\\n \\"RiskTag\\": \\"SuspectDeepForgery\\",\\n \\"RiskScore\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"SuspectPSFace\\\\\\": \\\\\\"0.9796\\\\\\",\\\\n \\\\\\"SuspectRemake\\\\\\": \\\\\\"0.0000\\\\\\",\\\\n \\\\\\"SuspectDeepForgery\\\\\\": \\\\\\"0.9500\\\\\\",\\\\n \\\\\\"SuspectAIGCFace\\\\\\": \\\\\\"0.0001\\\\\\"\\\\n }\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Deepfake Detection Capability for Faces', + 'description' => 'Input a face image and use the algorithm to detect if there is a risk of deepfake. This includes risk scenarios such as AIGC-generated faces, deepfake face swaps, template faces, and rephotographed faces, and outputs risk labels and confidence scores.', + 'translator' => 'machine', + ], + 'DeepfakeDetectIntl' => [ + 'summary' => 'Face Credential Verification', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthNYJI62', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The product solution to be integrated. Value: **FACE_DEEPFAKE**.', + 'type' => 'string', + 'required' => true, + 'example' => 'FACE_DEEPFAKE', + ], + ], + [ + 'name' => 'SceneCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Your custom authentication scenario ID, used for querying related records by entering this scenario ID in the console later. Supports a combination of 10 characters, including letters, numbers, or underscores.', + 'type' => 'string', + 'required' => false, + 'example' => '1234567890', + ], + ], + [ + 'name' => 'MerchantBizId', + 'in' => 'query', + 'schema' => [ + 'description' => 'A unique identifier for the merchant\'s request, consisting of a 32-character alphanumeric combination. The first few characters are composed of a custom abbreviation defined by the merchant, the middle part can include a period of time, and the latter part can use a random or incremental sequence.', + 'type' => 'string', + 'required' => true, + 'example' => 'e0c34a77f5ac40a5aa5e6ed20c******', + ], + ], + [ + 'name' => 'FaceInputType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Input **IMAGE**, indicating a face image.', + 'type' => 'string', + 'required' => false, + 'example' => 'IMAGE', + ], + ], + [ + 'name' => 'FaceUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'Input the URL address of the face image.'."\n" + .'> Choose one of FaceUrl or FaceBase64 to input.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg', + ], + ], + [ + 'name' => 'FaceBase64', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Input the Base64 encoded format of the face image.'."\n" + .'> Choose one of FaceUrl or FaceBase64 to input.', + 'type' => 'string', + 'required' => false, + 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260', + ], + 'Code' => [ + 'description' => 'Return code: 200 indicates a successful request, any other value indicates failure.', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => 'Returned result information.', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => 'Risk result:'."\n" + ."\n" + .'- **0**: Low risk'."\n" + .'- **1**: High risk'."\n" + .'- **2**: Suspicious', + 'type' => 'string', + 'example' => '1', + ], + 'RiskTag' => [ + 'description' => 'Risk tags. Multiple tags are separated by commas (,). Includes:'."\n" + ."\n" + .'- **SuspectDeepForgery** Suspected deep forgery '."\n" + .'- **SuspectPSFace** Suspected synthetic attack '."\n" + .'- **SuspectWarterMark** Suspected watermark presence '."\n" + .'- **SuspectTemple** Suspected template attack '."\n" + .'- **SuspectAIGCFace** Suspected generated face '."\n" + .'- **SuspectRemake** Suspected rephotographed face', + 'type' => 'string', + 'example' => 'SuspectDeepForgery,SuspectWarterMark', + ], + 'RiskScore' => [ + 'description' => 'Risk score map.', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{'."\n" + .' "SuspectPSFace": "0.9796",'."\n" + .' "SuspectRemake": "0.0000",'."\n" + .' "SuspectDeepForgery": "0.9500",'."\n" + .' "SuspectAIGCFace": "0.0001",'."\n" + .' "SuspectWaterMark": "0.0000"'."\n" + .' }', + 'description' => 'Backend parameter name.', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"Result\\": \\"1\\",\\n \\"RiskTag\\": \\"SuspectDeepForgery,SuspectWarterMark\\",\\n \\"RiskScore\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"SuspectPSFace\\\\\\": \\\\\\"0.9796\\\\\\",\\\\n \\\\\\"SuspectRemake\\\\\\": \\\\\\"0.0000\\\\\\",\\\\n \\\\\\"SuspectDeepForgery\\\\\\": \\\\\\"0.9500\\\\\\",\\\\n \\\\\\"SuspectAIGCFace\\\\\\": \\\\\\"0.0001\\\\\\",\\\\n \\\\\\"SuspectWaterMark\\\\\\": \\\\\\"0.0000\\\\\\"\\\\n }\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Face Deepfake Detection Service', + 'description' => 'Input a face image and use the algorithm to detect if there is a risk of deep forgery. This includes risk scenarios such as AIGC-generated faces, deepfake face swapping, template faces, and rephotographed faces, and outputs risk labels and confidence levels.', + 'translator' => 'machine', + ], + 'FaceGuardRisk' => [ + 'summary' => 'This topic describes how to set up the server for FACE_GUARD.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '253422', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthCS0SDG', + ], + ], + 'parameters' => [ + [ + 'name' => 'DeviceToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The deviceToken obtained from the client SDK.', + 'type' => 'string', + 'required' => false, + 'example' => 'Tk9SSUQuMS*****************ZDNmNWY5NzQxOW1o', + ], + ], + [ + 'name' => 'MerchantBizId', + 'in' => 'query', + 'schema' => [ + 'description' => 'A custom unique business identifier. It is used to locate and troubleshoot issues. The identifier can be a combination of letters and digits up to 32 characters long. Ensure that it is unique.', + 'type' => 'string', + 'required' => false, + 'example' => '0c83ce0101d34eff886b1f7d1cdef67f', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The product code. Set this to the static field **FACE_GUARD**.', + 'type' => 'string', + 'required' => false, + 'example' => 'FACE_GUARD', + ], + ], + [ + 'name' => 'BizId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the current business authentication. It is used with FACE_GUARD for verification during queries.', + 'type' => 'string', + 'required' => false, + 'example' => 'LMALL20******001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '595E387B-3F0E-5C52-BD02-8EFE63D41FD5', + ], + 'Code' => [ + 'description' => 'The return code. A value of Success indicates that the API operation responded successfully. For more information about how to determine the authentication result, expand the **Return codes** section below.', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'A detailed description of the return code.', + 'type' => 'string', + 'example' => 'success', + ], + 'Result' => [ + 'description' => 'Result object', + 'type' => 'object', + 'properties' => [ + 'RiskTags' => [ + 'description' => 'The device risk tags. Multiple risk tags are separated by commas (**,**). For more information about the risk tags and their meanings, expand the **Risk tags (RiskTags)** section below.', + 'type' => 'string', + 'example' => 'ROOT,VPN,HOOK', + ], + 'RiskExtends' => [ + 'description' => 'Extended information. This is empty by default.', + 'type' => 'string', + 'example' => '{'."\n" + .' "code": 200'."\n" + .' "message":"success"'."\n" + .' "umid":"07d3295d3d597b425d102a7f********",'."\n" + .' "sip":"198.51.100.1",'."\n" + .' "durationMs" : 4968931'."\n" + .' "queryCount":1,'."\n" + .' "querySessionCount":1,'."\n" + .' "queryUmidCount":1'."\n" + .' "platform":"Android'."\n" + .'}', + ], + 'TransactionId' => [ + 'description' => 'The transaction ID.'."\n", + 'type' => 'string', + 'example' => 'hk573be80f944d95ac812e019e3655a8', + ], + 'GuardRiskScore' => [ + 'description' => 'The device risk probability predicted by the Device Guard algorithm. A higher score indicates a higher device risk.'."\n" + ."\n" + .'Valid values: 0 to 100.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"595E387B-3F0E-5C52-BD02-8EFE63D41FD5\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"RiskTags\\": \\"ROOT,VPN,HOOK\\",\\n \\"RiskExtends\\": \\"默认为空\\",\\n \\"TransactionId\\": \\"hk573be80f944d95ac812e019e3655a8\\",\\n \\"GuardRiskScore\\": 0\\n }\\n}","type":"json"}]', + 'title' => 'FaceGuard pure server-side API', + ], + 'FaceCompare' => [ + 'summary' => 'This topic describes how to integrate FaceCompare using only the server-side API.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '165986', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth0KJCLK', + ], + ], + 'parameters' => [ + [ + 'name' => 'MerchantBizId', + 'in' => 'query', + 'schema' => [ + 'description' => 'A custom unique business ID used for troubleshooting. It can be a combination of up to 32 letters and digits. Make sure that the ID is unique.', + 'type' => 'string', + 'required' => false, + 'example' => 'e0c34a77f5ac40a5aa5e6ed20c353888', + ], + ], + [ + 'name' => 'SourceFacePicture', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The Base64 encoding of the portrait photo.'."\n" + ."\n" + .'> If you use this method to pass the image, check the image size. Do not pass an oversized image.', + 'type' => 'string', + 'required' => false, + 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx', + ], + ], + [ + 'name' => 'SourceFacePictureUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URL of the portrait photo. The URL must be an HTTP or HTTPS link accessible over the Internet.'."\n" + ."\n" + .'> You must specify either SourceFacePicture or SourceFacePictureUrl.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://***face1.jpeg', + ], + ], + [ + 'name' => 'TargetFacePicture', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The Base64 encoding of the base photo.'."\n" + ."\n" + .'> If you use this method to pass the image, check the image size. Do not pass an oversized image.', + 'type' => 'string', + 'required' => false, + 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx', + ], + ], + [ + 'name' => 'TargetFacePictureUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URL of the base portrait photo. The URL must be an HTTP or HTTPS link accessible over the Internet.'."\n" + ."\n\n" + ."\n" + .'> You must specify either TargetFacePicture or TargetFacePictureUrl.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://***face2.jpeg', + ], + ], + [ + 'name' => 'FacePictureQualityCheck', + 'in' => 'query', + 'schema' => [ + 'title' => '是否开启传入人脸图片质量检测', + 'description' => '是否开启传入人脸图片质量检测', + 'type' => 'string', + 'required' => false, + 'example' => 'N', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '4EB356FE-BB6A-5DCC-B4C5-E8051787EBA1', + ], + 'Code' => [ + 'description' => 'The [response code](https://www.alibabacloud.com/help/en/ekyc/latest/facecompare?spm=a3c0i.23458820.2359477120.28.21167d3fzUmXQC#c43fd16d07mae).', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The detailed description of the response code.', + 'type' => 'string', + 'example' => 'success', + ], + 'Result' => [ + 'description' => 'Result object', + 'type' => 'object', + 'properties' => [ + 'TransactionId' => [ + 'description' => 'The transaction ID.'."\n", + 'type' => 'string', + 'example' => '08573be80f944d95ac812e019e3655a8', + ], + 'Passed' => [ + 'description' => 'The final authentication result. Valid values:'."\n" + ."\n" + .'- **Y**: The authentication is passed.'."\n" + ."\n" + .'- **N**: The authentication failed.', + 'type' => 'string', + 'example' => 'Y', + ], + 'FaceComparisonScore' => [ + 'description' => 'The face comparison score. The value ranges from 0 to 100.', + 'type' => 'number', + 'format' => 'double', + 'example' => '98', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB356FE-BB6A-5DCC-B4C5-E8051787EBA1\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"08573be80f944d95ac812e019e3655a8\\",\\n \\"Passed\\": \\"Y\\",\\n \\"FaceComparisonScore\\": 98\\n }\\n}","type":"json"}]', + 'title' => 'Face comparison', + ], + 'FaceCrossCompareIntl' => [ + 'summary' => 'Face Cross Comparison', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Product solution to be integrated. Value: '."\n" + .'FACE_CROSS_COMPARE', + 'type' => 'string', + 'required' => true, + 'example' => ' FACE_CROSS_COMPARE', + ], + ], + [ + 'name' => 'SceneCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Custom business scenario ID', + 'type' => 'string', + 'required' => false, + 'example' => '1234567890', + ], + ], + [ + 'name' => 'MerchantBizId', + 'in' => 'query', + 'schema' => [ + 'description' => 'A unique business identifier for subsequent troubleshooting. It supports a combination of 32 alphanumeric characters, please ensure its uniqueness.', + 'type' => 'string', + 'required' => true, + 'example' => 'e0c34a77f5ac40a5aa5e6ed20c35****', + ], + ], + [ + 'name' => 'CompareModel', + 'in' => 'query', + 'schema' => [ + 'description' => 'Comparison mode'."\n" + .'- 0-Chain comparison (default): A:B and B:C'."\n" + .'- 1-Circular comparison: A:B and B:C and C:A', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'SourceAFacePicture', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Base64 encoded portrait photo.', + 'type' => 'string', + 'required' => false, + 'example' => 'base64', + ], + ], + [ + 'name' => 'SourceAFacePictureUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'Portrait image URL, accessible via HTTP or HTTPS on the public network.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.xxx.com/1.jpg', + ], + ], + [ + 'name' => 'SourceBFacePicture', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Base64 encoded portrait photo.', + 'type' => 'string', + 'required' => false, + 'example' => 'base64'."\n", + ], + ], + [ + 'name' => 'SourceBFacePictureUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'Portrait image URL, accessible via HTTP or HTTPS on the public network.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.xxx.com/1.jpg', + ], + ], + [ + 'name' => 'SourceCFacePicture', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Base64 encoded portrait photo.', + 'type' => 'string', + 'required' => false, + 'example' => 'base64'."\n", + ], + ], + [ + 'name' => 'SourceCFacePictureUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'Portrait image URL, accessible via HTTP or HTTPS on the public network.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.xxx.com/1.jpg', + ], + ], + [ + 'name' => 'FaceVerifyThreshold', + 'in' => 'query', + 'schema' => [ + 'description' => 'Face matching threshold.', + 'type' => 'string', + 'required' => false, + 'example' => '0.5', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'ID of the request', + 'type' => 'string', + 'example' => '130A2C10-B9EE-4D84-88E3-5384FF039795', + ], + 'Code' => [ + 'description' => 'Return code.', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'Result' => [ + 'description' => 'Return result.', + 'type' => 'object', + 'properties' => [ + 'FacePassed' => [ + 'description' => 'Final verification result, values:'."\n" + .'- Y: Pass'."\n" + .'- N: Fail', + 'type' => 'string', + 'example' => 'Y', + ], + 'FaceComparisonScoreA2B' => [ + 'description' => 'A to B comparison score, range 0～100.', + 'type' => 'number', + 'format' => 'double', + 'example' => '99', + ], + 'FaceComparisonScoreB2C' => [ + 'description' => 'B to C comparison score, range 0～100.', + 'type' => 'number', + 'format' => 'double', + 'example' => '99', + ], + 'FaceComparisonScoreC2A' => [ + 'description' => 'C to A comparison score, range 0～100.', + 'type' => 'number', + 'format' => 'double', + 'example' => '99', + ], + 'TransactionId' => [ + 'description' => 'Unique identifier for the authentication request.', + 'type' => 'string', + 'example' => '4ab0b***cbde97', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"130A2C10-B9EE-4D84-88E3-5384FF039795\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"FacePassed\\": \\"Y\\",\\n \\"FaceComparisonScoreA2B\\": 0.9999999999999999,\\n \\"FaceComparisonScoreB2C\\": 0.9999999999999999,\\n \\"FaceComparisonScoreC2A\\": 0.9999999999999999,\\n \\"TransactionId\\": \\"4ab0b***cbde97\\"\\n }\\n}","type":"json"}]', + 'title' => 'Face Cross Comparison', + 'translator' => 'machine', + ], + 'DocOcrMax' => [ + 'summary' => 'Global Document OCR Recognition Interface', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthCW0JNH', + 'FEATUREcloudauthHOSIED', + 'FEATUREcloudauthWSJE4H', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The product solution to be integrated.'."\n" + ."\n" + .'Value: ID_OCR_MAX', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ID_OCR_MAX', + ], + ], + [ + 'name' => 'SceneCode', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Custom scene code, used to distinguish business scenarios, a 10-digit number.', + 'type' => 'string', + 'required' => false, + 'example' => '1234567890', + ], + ], + [ + 'name' => 'MerchantBizId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'A unique business identifier defined by the merchant, used for subsequent problem localization and troubleshooting. It supports a combination of letters and numbers, with a maximum length of 32 characters. Please ensure its uniqueness.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'e0c34a77f5ac40a5aa5e6ed20c******', + ], + ], + [ + 'name' => 'MerchantUserId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Your custom user ID or other identifiers that can uniquely identify a specific user, such as a phone number or email address. It is strongly recommended to pre-desensitize the value of this field, for example, by hashing it.', + 'type' => 'string', + 'required' => false, + 'example' => '123456789', + ], + ], + [ + 'name' => 'IdOcrPictureBase64', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Document image, base64 encoded binary stream', + 'type' => 'string', + 'required' => false, + 'example' => 'base64', + ], + ], + [ + 'name' => 'IdOcrPictureUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Document image URL', + 'type' => 'string', + 'required' => false, + 'example' => 'https://***********.oss-cn-hangzhou.aliyuncs.com/1669520556530-expo/default/face/20221127114236530_w3kx2e6t.jpg'."\n", + ], + ], + [ + 'name' => 'OcrModel', + 'in' => 'formData', + 'schema' => [ + 'description' => 'OCR recognition mode.'."\n" + .'0: General document mode.'."\n" + .'1: Custom mode.', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'DocType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Document type.'."\n" + .'Format: Country (region) code + document type abbreviation + page (optional)'."\n" + .'Note: If provided, it will automatically check if it matches the model recognition result; if empty, the document type will be returned after model recognition.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'CNSSC01', + ], + ], + [ + 'name' => 'Prompt', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Prompt (for custom mode)', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxocr识别', + ], + ], + [ + 'name' => 'Spoof', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Whether to enable document anti-counterfeiting function, default is not enabled.'."\n" + ."\n" + .'- T: Enable document anti-counterfeiting function.'."\n" + .'- F: Do not enable.', + 'type' => 'string', + 'required' => false, + 'example' => 'F', + ], + ], + [ + 'name' => 'IdThreshold', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Custom OCR quality detection threshold mode:'."\n" + ."\n" + .'- 0: System default'."\n" + .'- 1: Strict mode'."\n" + .'- 2: Lenient mode'."\n" + .'- 3 (default): Disable quality detection', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'IdSpoof', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Whether to turn on the certificate anti-counterfeiting function:'."\n" + ."\n" + .'- T: open'."\n" + ."\n" + .'- F (default): not turned on.', + 'type' => 'string', + 'required' => false, + 'example' => 'F', + ], + ], + [ + 'name' => 'DocPage', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Page expected to be recognized'."\n" + ."\n" + .'- 01 (default): ID portrait.'."\n" + ."\n" + .'- 02: Back of the certificate', + 'type' => 'string', + 'required' => false, + 'example' => '01', + ], + ], + [ + 'name' => 'OcrValueStandard', + 'in' => 'query', + 'schema' => [ + 'title' => 'OcrValueStandard是否需要开启OCR识别关键字段标准化； 0否(默认) 1是', + 'description' => 'Specifies whether to return additional OCR fields in a standardized format:'."\n" + ."\n" + .'- **0**: No (default)'."\n" + ."\n" + .'- **1**: Yes', + 'type' => 'string', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'Authorize', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Specifies whether to enable verification with an authoritative data source to enhance document anti-spoofing capabilities.'."\n" + ."\n" + .'- **T**: Enable'."\n" + ."\n" + .'- **F**: Disable (default)'."\n" + ."\n" + .'> '."\n" + .'> - **Applicable document types**: Chinese resident ID cards (CHN01001) and Chinese mainland driver\'s licenses (CHN02001).'."\n" + .'> - **Data transfer declaration**: If you enable this parameter, you agree to transfer the user\'s name and certificate number to an authoritative data source in the Chinese mainland for consistency verification.'."\n" + .'> - **Performance impact:** After you enable this feature, the response time of the API operation increases by 1 to 2 seconds. Adjust the timeout setting.', + 'type' => 'string', + 'required' => false, + 'example' => 'T', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'ID of the request', + 'type' => 'string', + 'example' => '4EB35****87EBA1', + ], + 'Code' => [ + 'description' => 'Return code', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'Return message', + 'type' => 'string', + 'example' => 'success', + ], + 'Result' => [ + 'description' => 'Return result', + 'type' => 'object', + 'properties' => [ + 'Passed' => [ + 'description' => 'Whether the authentication passed.'."\n" + ."\n" + .'- Y: Passed.'."\n" + .'- N: Not passed.', + 'type' => 'string', + 'example' => 'Y', + ], + 'SubCode' => [ + 'description' => 'Sub-result code.', + 'type' => 'string', + 'example' => '200', + ], + 'ExtIdInfo' => [ + 'description' => 'Card and document recognition result Only returned when the interface response is successful', + 'type' => 'string', + 'example' => '{'."\n" + .' "docType": "PPTW01",'."\n" + .' "ocrIdInfo": {'."\n" + .' "passportNo": "36*******",'."\n" + .' "expiryDate": "2032/02/10",'."\n" + .' "placeOfBirth": "TAIWAN",'."\n" + .' "surname": "CHEN",'."\n" + .' "givenname": "LIN-CHUN",'."\n" + .' "countryCode": "TWN",'."\n" + .' "sex": "F",'."\n" + .' "personalNo": "S22********",'."\n" + .' "issueDate": "2022/02/10",'."\n" + .' "birthDate": "1988/10/04"'."\n" + .' }'."\n" + .'}', + ], + 'TransactionId' => [ + 'description' => 'Authentication ID', + 'type' => 'string', + 'example' => 'hk573be80f944d95ac812e0*******a8', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"Passed\\": \\"Y\\",\\n \\"SubCode\\": \\"200\\",\\n \\"ExtIdInfo\\": \\"{\\\\n \\\\\\"docType\\\\\\": \\\\\\"PPTW01\\\\\\",\\\\n \\\\\\"ocrIdInfo\\\\\\": {\\\\n \\\\\\"passportNo\\\\\\": \\\\\\"36*******\\\\\\",\\\\n \\\\\\"expiryDate\\\\\\": \\\\\\"2032/02/10\\\\\\",\\\\n \\\\\\"placeOfBirth\\\\\\": \\\\\\"TAIWAN\\\\\\",\\\\n \\\\\\"surname\\\\\\": \\\\\\"CHEN\\\\\\",\\\\n \\\\\\"givenname\\\\\\": \\\\\\"LIN-CHUN\\\\\\",\\\\n \\\\\\"countryCode\\\\\\": \\\\\\"TWN\\\\\\",\\\\n \\\\\\"sex\\\\\\": \\\\\\"F\\\\\\",\\\\n \\\\\\"personalNo\\\\\\": \\\\\\"S22********\\\\\\",\\\\n \\\\\\"issueDate\\\\\\": \\\\\\"2022/02/10\\\\\\",\\\\n \\\\\\"birthDate\\\\\\": \\\\\\"1988/10/04\\\\\\"\\\\n }\\\\n}\\",\\n \\"TransactionId\\": \\"hk573be80f944d95ac812e0*******a8\\"\\n }\\n}","type":"json"}]', + 'title' => 'New Card and Document OCR Recognition Interface', + 'translator' => 'machine', + ], + 'DocOcr' => [ + 'summary' => 'Card and document OCR pure server-side', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '181950', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthCW0JNH', + ], + ], + 'parameters' => [ + [ + 'name' => 'MerchantBizId', + 'in' => 'query', + 'schema' => [ + 'description' => 'A unique business identifier defined by the merchant, used for subsequent troubleshooting. It supports a combination of letters and numbers, with a maximum length of 32 characters. Please ensure uniqueness.', + 'type' => 'string', + 'required' => false, + 'example' => 'dso9322***dsjsd22', + ], + ], + [ + 'name' => 'MerchantUserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'A custom user ID in the business, please keep it unique.', + 'type' => 'string', + 'required' => false, + 'example' => '123456789', + ], + ], + [ + 'name' => 'IdOcrPictureBase64', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'Base64 of the front side of the document image', + 'example' => 'base64', + ], + ], + [ + 'name' => 'IdOcrPictureUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'URL of the front side of the document image', + 'type' => 'string', + 'required' => false, + 'example' => 'https://digital-cardocr-prod8.oss-cn-hangzhou.aliyuncs.com/1669520556530-expo/default/face/20221127114236530_w3kx2e6t.jpg'."\n", + ], + ], + [ + 'name' => 'DocType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Document type', + 'type' => 'string', + 'required' => false, + 'example' => '00000006', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Product code', + 'type' => 'string', + 'required' => false, + 'example' => '产品方案类型ID_OCR_MIN', + ], + ], + [ + 'name' => 'Ocr', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to perform document OCR'."\n" + .'- T: Indicates that document OCR is required'."\n" + .'- F: Indicates that document OCR is not required', + 'type' => 'string', + 'required' => false, + 'example' => 'T', + ], + ], + [ + 'name' => 'IdFaceQuality', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to perform ID face quality detection'."\n" + .'- T: Indicates that detection is required'."\n" + .'- F: Indicates that detection is not required (default F)', + 'type' => 'string', + 'required' => false, + 'example' => 'F', + ], + ], + [ + 'name' => 'Spoof', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to enable anti-counterfeiting detection'."\n" + .'- T: Indicates that anti-counterfeiting is enabled'."\n" + .'- F: Indicates that anti-counterfeiting is disabled', + 'type' => 'string', + 'required' => false, + 'example' => 'F', + ], + ], + [ + 'name' => 'IdThreshold', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => '0', + 'description' => 'IdThreshold', + ], + ], + [ + 'name' => 'CardSide', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'CardSide', + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'ID of the request', + 'type' => 'string', + 'example' => '86C40EC3-5940-5F47-995C-BFE90B70E540', + ], + 'Code' => [ + 'description' => 'Return code', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'Result' => [ + 'description' => 'Return result', + 'type' => 'object', + 'properties' => [ + 'TransactionId' => [ + 'description' => 'Unique identifier of the authentication request', + 'type' => 'string', + 'example' => '08573be80f944d95ac812e019e3655a8', + ], + 'Passed' => [ + 'description' => 'Whether the authentication passed.'."\n" + ."\n" + .'- Y: Passed'."\n" + .'- N: Not passed', + 'type' => 'string', + 'example' => 'Y', + ], + 'SubCode' => [ + 'description' => 'Sub-result code', + 'type' => 'string', + 'example' => '200', + ], + 'ExtIdInfo' => [ + 'description' => 'Card and document recognition result Only returned when the interface response is successful', + 'type' => 'string', + 'example' => '{'."\n" + .' "idFaceQualityScore": 98.0'."\n" + .' "ocrIdInfo": {'."\n" + .' "expiryDate": "",'."\n" + .' "originOfIssue": "公安部出入境管理局",'."\n" + .' "englishName": "LI SI",'."\n" + .' "sex": "男",'."\n" + .' "name": "李四",'."\n" + .' "idNumber": "H11111112",'."\n" + .' "issueDate": "2013-01-02",'."\n" + .' "birthDate": "1990-02-21"'."\n" + .' },'."\n" + .' "spoofInfo": {'."\n" + .' "spoofResult": "Y",'."\n" + .' "spoofType": ['."\n" + .' "SCREEN_REMARK"'."\n" + .' ]'."\n" + .' }'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86C40EC3-5940-5F47-995C-BFE90B70E540\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"08573be80f944d95ac812e019e3655a8\\",\\n \\"Passed\\": \\"Y\\",\\n \\"SubCode\\": \\"200\\",\\n \\"ExtIdInfo\\": \\"{\\\\n \\\\\\"idFaceQualityScore\\\\\\": 98.0\\\\n \\\\\\"ocrIdInfo\\\\\\": {\\\\n \\\\\\"expiryDate\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"originOfIssue\\\\\\": \\\\\\"公安部出入境管理局\\\\\\",\\\\n \\\\\\"englishName\\\\\\": \\\\\\"LI SI\\\\\\",\\\\n \\\\\\"sex\\\\\\": \\\\\\"男\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"李四\\\\\\",\\\\n \\\\\\"idNumber\\\\\\": \\\\\\"H11111112\\\\\\",\\\\n \\\\\\"issueDate\\\\\\": \\\\\\"2013-01-02\\\\\\",\\\\n \\\\\\"birthDate\\\\\\": \\\\\\"1990-02-21\\\\\\"\\\\n },\\\\n \\\\\\"spoofInfo\\\\\\": {\\\\n \\\\\\"spoofResult\\\\\\": \\\\\\"Y\\\\\\",\\\\n \\\\\\"spoofType\\\\\\": [\\\\n \\\\\\"SCREEN_REMARK\\\\\\"\\\\n ]\\\\n }\\\\n}\\"\\n }\\n}","type":"json"}]', + 'title' => 'Card and Document OCR Pure Server-side Capability API', + 'translator' => 'machine', + ], + 'Id2MetaVerifyIntl' => [ + 'summary' => 'Verifies that a name and an ID card number are consistent.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '199203', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The product plan. This is a static field. Set the value to **ID_2META**.', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_2META', + ], + ], + [ + 'name' => 'ParamType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The parameter type.'."\n" + ."\n" + .'**normal**: The original value in plaintext.'."\n" + ."\n" + .'> Due to limitations of the authoritative data source, two-factor ID verification does not support MD5 encryption.', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID card number.'."\n" + ."\n" + .'> Only ID cards of residents in the Chinese mainland are supported.', + 'type' => 'string', + 'required' => false, + 'example' => '429001********8211'."\n", + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name.', + 'type' => 'string', + 'required' => false, + 'example' => 'Zhang*', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'EFA11401-C961-5E89-A2D3-BF9883E5CC3D', + ], + 'Code' => [ + 'description' => '[Status codes](https://www.alibabacloud.com/help/en/ekyc/latest/ok4bwxwmu1n94o76?spm=a2c63.p38356.0.i54#942707fca218x).', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The detailed description of the response code.', + 'type' => 'string', + 'example' => 'success', + ], + 'Result' => [ + 'description' => 'Return result', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => 'The verification result:'."\n" + ."\n" + .'- 1: The information is consistent. This result is billable.'."\n" + ."\n" + .'- 2: The information is inconsistent. This result is billable.'."\n" + ."\n" + .'- 3: No record is found. This result is not billable.', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EFA11401-C961-5E89-A2D3-BF9883E5CC3D\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"BizCode\\": \\"1\\"\\n }\\n}","type":"json"}]', + 'title' => 'Identity Two-Element Verification API', + ], + 'Id2MetaPeriodVerifyIntl' => [ + 'summary' => 'This operation verifies the authenticity and consistency of a name, ID card number, and the start and end dates of the ID card\'s validity period against an authoritative source.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '261144', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The product solution to integrate. Set the value to **eKYC_Date_MIN**.', + 'type' => 'string', + 'required' => true, + 'example' => 'eKYC_Date_MIN', + ], + ], + [ + 'name' => 'SceneCode', + 'in' => 'formData', + 'schema' => [ + 'description' => 'A custom authentication scenario ID. You can use this ID to query related records in the console. The ID can be up to 10 characters in length and can contain letters, digits, and underscores (_).', + 'type' => 'string', + 'required' => false, + 'example' => '1234567890', + ], + ], + [ + 'name' => 'MerchantBizId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'A unique business identifier that you can customize. Use this identifier to locate and troubleshoot issues. The identifier can be up to 32 characters in length and can contain letters and digits. Make sure that the identifier is unique.', + 'type' => 'string', + 'required' => true, + 'example' => 'e0c34a77f5ac40a5aa5e6ed20c35****', + ], + ], + [ + 'name' => 'MerchantUserId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'A custom user ID or another identifier for a specific user, such as a mobile number or email address. Desensitize the value of this field in advance, for example, by hashing the value.', + 'type' => 'string', + 'required' => false, + 'example' => '1234567890', + ], + ], + [ + 'name' => 'DocType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The certificate type, which is uniquely identified by an 8-digit number.'."\n" + ."\n" + .'Currently, only second-generation resident ID cards from the Chinese mainland are supported. Set the value to the static field: **00000001**.'."\n" + ."\n" + .'For more information, see [Certificate types](https://www.alibabacloud.com/help/en/ekyc/latest/im1u641gyesiqmbg?spm=a2c63.p38356.0.i13#Hu5TG).', + 'type' => 'string', + 'required' => true, + 'example' => '00000001'."\n" + ."\n", + ], + ], + [ + 'name' => 'DocName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The user\'s name.', + 'type' => 'string', + 'required' => true, + 'example' => 'Zhang San', + ], + ], + [ + 'name' => 'DocNo', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The user\'s certificate number.', + 'type' => 'string', + 'required' => true, + 'example' => '411xxxxxxxxxxx0001', + ], + ], + [ + 'name' => 'ValidityStartDate', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The start date of the validity period. The format is YYYYMMDD.', + 'type' => 'string', + 'required' => true, + 'example' => '20201001', + ], + ], + [ + 'name' => 'ValidityEndDate', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The expiration date of the ID card\'s validity period. The format is YYYYMMDD.'."\n" + ."\n" + .'> If the ID card is valid for a long term, enter **long-term** for this parameter.', + 'type' => 'string', + 'required' => true, + 'example' => '20301001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '7B97D932-7FF5-517D-BF39-7CA1BEE3CDD9', + ], + 'Code' => [ + 'description' => '[Return to Code](https://www.alibabacloud.com/help/en/ekyc/latest/dateverify?spm=a2c63.p38356.0.i32#22facb6ab6ui1).', + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'description' => 'A detailed description of the response code.', + 'type' => 'string', + 'example' => 'success', + ], + 'Result' => [ + 'description' => 'Return result', + 'type' => 'object', + 'properties' => [ + 'Passed' => [ + 'description' => 'The final authentication result. Valid values:'."\n" + ."\n" + .'- **Y**, via'."\n" + ."\n" + .'- **N**: The authentication is not passed.', + 'type' => 'string', + 'example' => 'Y', + ], + 'SubCode' => [ + 'description' => 'A description of the authentication result. For more information, see [ResultObject.SubCode error codes](https://www.alibabacloud.com/help/en/ekyc/latest/dateverify?spm=a2c63.p38356.0.i32#d1f36d445az8i).', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B97D932-7FF5-517D-BF39-7CA1BEE3CDD9\\",\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"Passed\\": \\"Y\\",\\n \\"SubCode\\": \\"200\\"\\n }\\n}","type":"json"}]', + 'title' => 'Identity two-element validity period verification', + ], + 'BankMetaVerifyIntl' => [ + 'summary' => 'Bank Card Verification', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth883TGF', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Fixed value: BANK_CARD_N_META', + 'type' => 'string', + 'required' => true, + 'example' => 'BANK_CARD_N_META'."\n", + ], + ], + [ + 'name' => 'ParamType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Encryption method:'."\n" + .'- normal: no encryption'."\n" + .'- md5: md5 encryption'."\n" + ."\n" + .'Important:'."\n" + ."\n" + .'- All encrypted parameters should be in the form of a 32-character lowercase MD5 string.'."\n" + .'- The ciphertext generated by different MD5 tools may vary. If the interface works before encryption but not after, try changing the MD5 tool.', + 'type' => 'string', + 'required' => true, + 'example' => 'normal', + ], + ], + [ + 'name' => 'VerifyMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'VERIFY_BANK_CARD: Bank card authentication mode. This indicates whether the provided bank card number matches the user\'s real name, ID number, and phone number.', + 'type' => 'string', + 'required' => true, + 'example' => 'VERIFY_BANK_CARD', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Product type to call:'."\n" + ."\n" + .'- BANK_CARD_2_META: Bank card number + name verification.'."\n" + .'- BANK_CARD_3_META: Bank card number + name + ID number verification.'."\n" + .'- BANK_CARD_4_META: Bank card number + name + ID number + phone number verification.', + 'type' => 'string', + 'required' => true, + 'example' => 'BANK_CARD_4_META', + ], + ], + [ + 'name' => 'BankCard', + 'in' => 'query', + 'schema' => [ + 'description' => 'Bank card number.'."\n" + ."\n" + .'- When paramType is set to normal, enter the plaintext bank card number.'."\n" + .'- When paramType is set to md5, enter the plaintext part of the card number except the last 6 digits, followed by the MD5 value of the last 6 digits (32-character lowercase).', + 'type' => 'string', + 'required' => true, + 'example' => '● 明文：12345678******'."\n" + .'● 密文：'."\n" + .'12345678f8ee21920e37807b43e7e912ab829b6e', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Name.'."\n" + ."\n" + .'- When paramType is set to normal, enter the plaintext name.'."\n" + .'- When paramType is set to md5, encrypt the first character of the name with MD5 (32-character lowercase MD5) and append the rest of the name in plaintext.', + 'type' => 'string', + 'required' => true, + 'example' => '张*'."\n", + ], + ], + [ + 'name' => 'IdentityType', + 'in' => 'query', + 'schema' => [ + 'description' => 'ID type (default to ID card if left empty, see the table below for other types).', + 'type' => 'string', + 'required' => false, + 'example' => '01', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'ID number:'."\n" + .'- When paramType is normal: Enter the plaintext ID number.'."\n" + .'- When paramType is md5:'."\n" + .' - First 6 digits of the ID number (plaintext) + date of birth (ciphertext) + last 4 digits of the ID number (plaintext).'."\n" + .' - For other IDs, encrypt the last two digits with MD5.'."\n" + ."\n" + .'Important'."\n" + .'This field is required when ProductType is one of the following:'."\n" + .'- BANK_CARD_3_META'."\n" + .'- BANK_CARD_4_META', + 'type' => 'string', + 'required' => false, + 'example' => '● 明文：429001********8211'."\n" + .'● 密文：'."\n" + .'42900132fa7bcd874161bea8ec8fd98f390ec98211', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'query', + 'schema' => [ + 'description' => 'Phone number:'."\n" + .'- When paramType is normal: Enter the plaintext phone number.'."\n" + .'- When paramType is md5: Enter the ciphertext phone number.'."\n" + ."\n" + .'Important'."\n" + ."\n" + .'- This field is required when ProductType = BANK_CARD_4_META.', + 'type' => 'string', + 'required' => false, + 'example' => '● 明文：186****2055'."\n" + .'● 密文：'."\n" + .'849169cd3b20621c1c78bd61a11a4fc2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '4EB35****87EBA1', + ], + 'Code' => [ + 'description' => 'Return code: 200 for success, others for failure.', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Return message', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => 'Returned result information', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => 'Verification result code.'."\n" + .'- 1: Consistent (charged)'."\n" + .'- 2: Inconsistent (charged)'."\n" + .'- 3: No record found (not charged)', + 'type' => 'string', + 'example' => '1', + ], + 'SubCode' => [ + 'description' => 'Verification details:'."\n" + ."\n" + .'- **101**: Verification passed.'."\n" + .'- **201**: Authentication information does not match, cardholder information is incorrect.'."\n" + .'- **202**: Authentication information does not match, bank card has not been activated for authenticated payments.'."\n" + .'- **203**: Authentication information does not match, bank card has expired.'."\n" + .'- **204**: Authentication information does not match, bank card is a restricted card.'."\n" + .'- **205**: Authentication information does not match, this card has been confiscated.'."\n" + .'- **206**: Authentication information does not match, bank card is invalid.'."\n" + .'- **207**: Authentication information does not match, this card has no corresponding issuing bank.'."\n" + .'- **208**: Authentication information does not match, this card is uninitialized or dormant.'."\n" + .'- **209**: Authentication information does not match, this card is a cheating card or swallowed card.'."\n" + .'- **210**: Authentication information does not match, this card has been reported lost.'."\n" + .'- **211**: Authentication information does not match, password error limit exceeded.'."\n" + .'- **212**: Authentication information does not match, issuing bank does not support this transaction.'."\n" + .'- **213**: Authentication information does not match, card status is abnormal or card is invalid.'."\n" + .'- **214**: Authentication information does not match, no phone number reserved.'."\n" + .'- **215**: Authentication information does not match, entered password, expiration date, or CVN2 is incorrect.'."\n" + .'- **216**: Authentication information does not match, other card anomalies.'."\n" + .'- **301**: Unable to verify, bank card does not support this service.'."\n" + .'- **302**: Unable to verify, verification failed or bank refused verification, please contact the issuing bank.'."\n" + .'- **303**: Unable to verify, bank card does not currently support phone number verification.'."\n" + .'- **304**: Unable to verify, bank card number is incorrect.'."\n" + .'- **305**: Unable to verify, other reasons.'."\n" + .'- **306**: Unable to verify, verification attempt limit exceeded.', + 'type' => 'string', + 'example' => '101', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"SubCode\\": \\"101\\"\\n }\\n}","type":"json"}]', + 'title' => 'Bank Card Element Verification', + 'description' => 'Verification of bank card elements, including: two-element verification (name + bank card number), three-element verification (name + ID number + bank card number), and four-element verification (name + ID number + phone number + bank card number) for consistency.', + 'translator' => 'machine', + ], + 'Mobile2MetaVerifyIntl' => [ + 'summary' => 'Verifies the authenticity and consistency of a mobile number and name against an authoritative data source.', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthPZCZ2I', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The product to use. Set this parameter to the static value **MOBILE_2META**.', + 'type' => 'string', + 'required' => true, + 'example' => 'MOBILE_2META', + ], + ], + [ + 'name' => 'ParamType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The parameter type:'."\n" + ."\n" + .'- **normal**: plaintext'."\n" + ."\n" + .'- **md5**: MD5-encrypted', + 'type' => 'string', + 'required' => true, + 'example' => 'normal', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name.'."\n" + ."\n" + .'> '."\n" + .'> - If **paramType** is set to **normal**, enter the plaintext value.'."\n" + .'> - If **paramType** is set to **md5**, enter the 32-bit lowercase MD5 string.', + 'type' => 'string', + 'required' => true, + 'example' => 'Zhang*', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The mobile number.'."\n" + ."\n" + .'>'."\n" + .'> - If **paramType** is set to **normal**, enter the plaintext value.'."\n" + .'> - If **paramType** is set to **md5**, enter the 32-bit lowercase MD5 string.', + 'type' => 'string', + 'required' => true, + 'example' => '186****1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '4EB35****87EBA1', + ], + 'Code' => [ + 'description' => '[Status codes](https://www.alibabacloud.com/help/en/ekyc/latest/mobile-2meta?spm=a2c63.p38356.0.i13#cbf2539971xzr).', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'A detailed description of the response code.', + 'type' => 'string', + 'example' => 'success', + ], + 'Result' => [ + 'description' => 'Return result', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => 'The verification result:'."\n" + ."\n" + .'- 1: The information is consistent. (Billed)'."\n" + ."\n" + .'- 2: The information is inconsistent. (Billed)'."\n" + ."\n" + .'- 3: No record is found. (Not billed)', + 'type' => 'string', + 'example' => '1', + ], + 'IspName' => [ + 'description' => 'The carrier name:'."\n" + ."\n" + .'- CMCC: China Mobile'."\n" + ."\n" + .'- CUCC: China Unicom'."\n" + ."\n" + .'- CTCC: China Telecom', + 'type' => 'string', + 'example' => 'CMCC', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"IspName\\": \\"CMCC\\"\\n }\\n}","type":"json"}]', + 'title' => 'Mobile Number Two-Element Verification', + ], + 'Mobile3MetaVerifyIntl' => [ + 'summary' => 'International Version of Mobile Three Elements API', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '199210', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthPZCZ2I', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The product solution to be integrated, with a fixed value: MOBILE_3META', + 'type' => 'string', + 'required' => false, + 'example' => 'MOBILE_3META', + ], + ], + [ + 'name' => 'ParamType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Parameter type:'."\n" + ."\n" + .'- normal: unencrypted'."\n" + .'- md5: md5 encrypted', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'ID number'."\n" + ."\n" + .'- When paramType is set to normal, enter the plaintext'."\n" + .'- When paramType is set to md5, enter a 32-character lowercase md5 string', + 'type' => 'string', + 'required' => false, + 'example' => '429001********8211'."\n", + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Name'."\n" + ."\n" + .'- When paramType is set to normal, enter the plaintext'."\n" + .'- When paramType is set to md5, enter a 32-character lowercase md5 string', + 'type' => 'string', + 'required' => false, + 'example' => '张*'."\n", + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'query', + 'schema' => [ + 'description' => 'Mobile phone number.'."\n" + ."\n" + .'- When paramType is set to normal, enter the plaintext'."\n" + .'- When paramType is set to md5, enter a 32-character lowercase md5 string', + 'type' => 'string', + 'required' => false, + 'example' => '186****1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Request ID', + 'type' => 'string', + 'example' => 'D241532C-4EE9-5A2A-A5A5-C1FD98CE2EDD', + ], + 'Code' => [ + 'description' => 'Return code', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'Return message', + 'type' => 'string', + 'example' => 'success', + ], + 'Result' => [ + 'description' => 'Return result', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => 'Verification result code.'."\n" + .'- 1: Verification consistent'."\n" + .'- 2: Verification inconsistent'."\n" + .'- 3: No record found', + 'type' => 'string', + 'example' => '1', + ], + 'SubCode' => [ + 'description' => 'Detailed verification results'."\n" + ."\n" + .'- 101: Verification passed '."\n" + .'- 201: Mobile number and name do not match, mobile number and ID number do not match '."\n" + .'- 202: Mobile number and name match, but mobile number and ID number do not match '."\n" + .'- 203: Mobile number and ID number match, but mobile number and name do not match '."\n" + .'- 204: Other inconsistencies'."\n" + .'- 301: No record found', + 'type' => 'string', + 'example' => '101', + ], + 'IspName' => [ + 'description' => 'ISP name'."\n" + ."\n" + .'- CMCC: China Mobile'."\n" + .'- CUCC: China Unicom'."\n" + .'- CTCC: China Telecom', + 'type' => 'string', + 'example' => 'CMCC', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D241532C-4EE9-5A2A-A5A5-C1FD98CE2EDD\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"SubCode\\": \\"101\\",\\n \\"IspName\\": \\"CMCC\\"\\n }\\n}","type":"json"}]', + 'title' => 'Mobile Three Elements Verification', + 'translator' => 'machine', + ], + 'CredentialRecognitionIntl' => [ + 'summary' => 'Credential Recognition', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthNYJI62', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The product solution to be integrated. Value: CREDENTIAL_RECOGNITION.', + 'type' => 'string', + 'required' => true, + 'example' => 'CREDENTIAL_RECOGNITION', + ], + ], + [ + 'name' => 'CredentialOcrPictureBase64', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Base64 encoded image. If you choose to upload the photo via IdOcrPictureBase64 (photo Base64 encoding), please check the photo size and do not upload overly large photos.', + 'type' => 'string', + 'required' => false, + 'example' => 'base64', + ], + ], + [ + 'name' => 'CredentialOcrPictureUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Image URL, accessible over the public network via HTTP or HTTPS links.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://***', + ], + ], + [ + 'name' => 'DocType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Voucher type.'."\n" + .'- Transaction Voucher: 01 (including: water, electricity, gas, credit card, and other types of e-bill images)', + 'type' => 'string', + 'required' => true, + 'example' => '01', + ], + ], + [ + 'name' => 'OcrArea', + 'in' => 'query', + 'schema' => [ + 'description' => 'Extraction type:'."\n" + .'- 0101: E-bill Address & Name Module (extracts address and name modules through intelligent analysis)', + 'type' => 'string', + 'required' => true, + 'example' => '0101', + ], + ], + [ + 'name' => 'FraudCheck', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to enable tampering detection'."\n" + .'- true: Enable'."\n" + .'- false: Disable', + 'type' => 'string', + 'required' => true, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '4EB35****87EBA1', + ], + 'Code' => [ + 'description' => 'Return code.', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'Response message for the returned information.', + 'type' => 'string', + 'example' => 'success', + ], + 'Result' => [ + 'description' => 'Returned result.', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Extraction result. Values:'."\n" + .'- S: Success.'."\n" + .'- F: Failure.', + 'type' => 'string', + 'example' => 'S', + ], + 'SubCode' => [ + 'description' => 'Authentication result description', + 'type' => 'string', + 'example' => '200', + ], + 'ExtIdInfo' => [ + 'description' => 'Identified key information in JSON format.', + 'type' => 'string', + 'example' => '{'."\n" + .' "address": "",'."\n" + .' "name":""'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"Success\\": \\"S\\",\\n \\"SubCode\\": \\"200\\",\\n \\"ExtIdInfo\\": \\"{\\\\n \\\\\\"address\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"name\\\\\\":\\\\\\"\\\\\\"\\\\n}\\"\\n }\\n}","type":"json"}]', + 'title' => 'Credential Recognition Service', + 'description' => 'Detects whether a voucher (such as water, electricity, gas, credit card, etc., e-bills) is forged using AI technology and extracts key information from the voucher.', + 'translator' => 'machine', + ], + 'CredentialSubmitIntl' => [ + 'summary' => 'Credential Recognition Submission', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthS6WIN6', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The product solution to be integrated. Value: CREDENTIAL_RECOGNITION.', + 'type' => 'string', + 'required' => true, + 'example' => 'CREDENTIAL_RECOGNITION', + ], + ], + [ + 'name' => 'SceneCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Your custom authentication scenario ID, used for querying related records by entering this scenario ID in the console later. Supports a combination of 10 characters, digits, or underscores.', + 'type' => 'string', + 'required' => true, + 'example' => '123****123', + ], + ], + [ + 'name' => 'MerchantBizId', + 'in' => 'query', + 'schema' => [ + 'description' => 'A unique business identifier defined on the merchant side, used for troubleshooting issues later. Supports a combination of letters and digits, with a maximum length of 32 characters. Ensure uniqueness.', + 'type' => 'string', + 'required' => true, + 'example' => 'e0c34a***353888', + ], + ], + [ + 'name' => 'CredentialOcrPictureBase64', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Base64 encoding of the image. If you choose to upload the photo this way, please check the photo size and avoid uploading overly large photos.', + 'type' => 'string', + 'required' => false, + 'example' => 'base64', + ], + ], + [ + 'name' => 'CredentialOcrPictureUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Image URL, accessible via HTTP or HTTPS on the public network.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://***', + ], + ], + [ + 'name' => 'DocType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Credential type:'."\n" + .'- 02: Vehicle registration certificate', + 'type' => 'string', + 'required' => true, + 'example' => '02', + ], + ], + [ + 'name' => 'OcrArea', + 'in' => 'query', + 'schema' => [ + 'description' => 'Extraction type:'."\n" + ."\n" + .'- 0201: Thai vehicle registration certificate', + 'type' => 'string', + 'required' => true, + 'example' => '0201', + ], + ], + [ + 'name' => 'FraudCheck', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to enable tampering detection'."\n" + .'- true: Enable'."\n" + .'- false: Disable', + 'type' => 'string', + 'required' => true, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'ID of the request', + 'type' => 'string', + 'example' => '5E63B760-0ECB-5C07-8503-A65C27876968', + ], + 'Code' => [ + 'description' => 'Return code', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'Result' => [ + 'description' => 'Return result.', + 'type' => 'object', + 'properties' => [ + 'TransactionId' => [ + 'description' => 'Unique identifier of the authentication request.', + 'type' => 'string', + 'example' => '4ab0b***cbde97', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5E63B760-0ECB-5C07-8503-A65C27876968\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"4ab0b***cbde97\\"\\n }\\n}","type":"json"}]', + 'title' => 'Credential Recognition Information Submission', + 'description' => 'Initialization interface for credential recognition OCR, through which you can obtain the transactionId.', + 'translator' => 'machine', + ], + 'CredentialGetResultIntl' => [ + 'summary' => 'Credential Recognition Query', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthS6WIN6', + ], + ], + 'parameters' => [ + [ + 'name' => 'TransactionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Unique identifier for the authentication request', + 'type' => 'string', + 'required' => true, + 'example' => '4ab0b***abde97', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'ID of the request', + 'type' => 'string', + 'example' => '5E63B760-0ECB-5C07-8503-A65C27876968', + ], + 'Code' => [ + 'description' => 'Return code.', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'Result' => [ + 'description' => 'Return result.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Task status:'."\n" + .'- PROCESSING: In progress (please continue polling)'."\n" + .'- SUCCESS: Execution succeeded'."\n" + .'- FAILED: Execution failed', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'SubCode' => [ + 'description' => 'Authentication result description. For more information, see ResultObject.SubCode error codes.', + 'type' => 'string', + 'example' => '200', + ], + 'ExtIdInfo' => [ + 'description' => 'Identified key information, in JSON format.', + 'type' => 'string', + 'example' => '{'."\n" + .' "address": "",'."\n" + .' "name":""'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5E63B760-0ECB-5C07-8503-A65C27876968\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"SubCode\\": \\"200\\",\\n \\"ExtIdInfo\\": \\"{\\\\n \\\\\\"address\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"name\\\\\\":\\\\\\"\\\\\\"\\\\n}\\"\\n }\\n}","type":"json"}]', + 'title' => 'Credential Recognition Result Query', + 'description' => 'After obtaining the TransactionId, you can use this interface on the server side to get the corresponding authentication result.', + 'translator' => 'machine', + ], + 'CredentialVerifyIntl' => [ + 'summary' => 'Credential Verification', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthNYJI62', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CredType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Credential type:'."\n" + ."\n" + .'- 03: Enterprise Qualification'."\n" + .'- 04: Transaction Voucher', + 'type' => 'string', + 'required' => true, + 'example' => '03', + ], + ], + [ + 'name' => 'CredName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Credential name (numeric code):'."\n" + ."\n" + .'- Starting with 03: Enterprise Qualification'."\n" + .' - 0301: Mainland China Business License'."\n" + .'- Starting with 04, Transaction Voucher'."\n" + .' - 0401: Bank Statement'."\n" + .' - 0402: Pay Slip'."\n" + .' - 0403: Utility Bill'."\n" + .' - 0405: Credit Card Statement'."\n" + .' - 0499: Others', + 'type' => 'string', + 'required' => true, + 'example' => '0301', + ], + ], + [ + 'name' => 'ImageUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URL of the image.'."\n" + .'> Choose either ImageUrl or ImageFile.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://oss-bj01.avic.com/eavic-prod-commodity/pic/commodity/94677ee6-1067-4287-8ff4-6e030ef3a5a8.jpg', + ], + ], + [ + 'name' => 'ImageFile', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Image input stream.'."\n" + .'> Choose either ImageUrl or ImageFile.', + 'type' => 'string', + 'required' => false, + 'example' => '无', + 'isFileTransferUrl' => true, + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Invocation mode:'."\n" + .'- ANTI_FAKE_CHECK: Image quality and tampering detection.', + 'type' => 'string', + 'required' => true, + 'example' => '取值：ANTI_FAKE_CHECK', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '130A2C10-B9EE-4D84-88E3-5384FF039795', + ], + 'Code' => [ + 'description' => 'Return code: 200 for success, others for failure.', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => 'Returned result information.', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => 'Risk result:'."\n" + ."\n" + .'- **0**: Low risk'."\n" + .'- **1**: High risk'."\n" + .'- **2**: Suspicious', + 'type' => 'string', + 'example' => '1', + ], + 'RiskTag' => [ + 'description' => 'Risk tags, separated by commas (,). Includes:'."\n" + ."\n" + .'- PS: Image manipulation (Photoshop)'."\n" + .'- SCREEN_PHOTO: Screen recapture'."\n" + .'- SCREENSHOT: Screenshot'."\n" + .'- ORIGINAL_PHOTO: Not original image', + 'type' => 'string', + 'example' => 'PS', + ], + 'RiskScore' => [ + 'description' => 'Risk score map', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{'."\n" + .'"PS": "0.0211",'."\n" + .'"SCREEN_PHOTO": "0.0101",'."\n" + .'"SCREENSHOT": "0.0521"'."\n" + .'}', + 'description' => 'Risk score', + ], + ], + 'MaterialInfo' => [ + 'description' => 'Other information in JSON format.', + 'type' => 'string', + 'example' => '{'."\n" + .' "sameBackgroundDetail": {'."\n" + .' // 相似背景对于的原始图请求RequestId'."\n" + .' "originalRequestId": "130A2C10-B9EE-4D84-88E3-5384FF03****";'."\n" + .' // 相似背景对于的原始图请求商户ID '."\n" + .' "originalMerchantId": "xxxxxxxx" '."\n" + .' }'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"130A2C10-B9EE-4D84-88E3-5384FF039795\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"Result\\": \\"1\\",\\n \\"RiskTag\\": \\"PS\\",\\n \\"RiskScore\\": {\\n \\"key\\": \\"{\\\\n\\\\\\"PS\\\\\\": \\\\\\"0.0211\\\\\\",\\\\n\\\\\\"SCREEN_PHOTO\\\\\\": \\\\\\"0.0101\\\\\\",\\\\n\\\\\\"SCREENSHOT\\\\\\": \\\\\\"0.0521\\\\\\"\\\\n}\\"\\n },\\n \\"MaterialInfo\\": \\"{\\\\n \\\\\\"sameBackgroundDetail\\\\\\": {\\\\n // 相似背景对于的原始图请求RequestId\\\\n \\\\\\"originalRequestId\\\\\\": \\\\\\"130A2C10-B9EE-4D84-88E3-5384FF03****\\\\\\";\\\\n // 相似背景对于的原始图请求商户ID \\\\n \\\\\\"originalMerchantId\\\\\\": \\\\\\"xxxxxxxx\\\\\\" \\\\n }\\\\n}\\"\\n }\\n}","type":"json"}]', + 'title' => 'Credential Verification Service', + 'description' => 'Input credential image information, perform image quality, tampering, and forgery detection, and return the detection results.', + 'translator' => 'machine', + ], + 'AddressVerifyV2Intl' => [ + 'summary' => 'This topic describes the address verification API operation, which verifies the region and address of a device using device data and carrier big data capabilities.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Fixed value: ADD_VERIFY_PRO', + 'type' => 'string', + 'required' => true, + 'example' => 'ADD_VERIFY_PRO', + ], + ], + [ + 'name' => 'VerifyType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Address verification method:'."\n" + ."\n" + .'- **HOME**: Home address verification'."\n" + ."\n" + .'- **WORK**: Work address verification', + 'type' => 'string', + 'required' => false, + 'example' => 'HOME', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'query', + 'schema' => [ + 'description' => 'Supported: Chinese mobile phone numbers', + 'type' => 'string', + 'required' => false, + 'example' => '1872334****', + ], + ], + [ + 'name' => 'RegCountry', + 'in' => 'query', + 'schema' => [ + 'description' => 'List of prohibited countries or regions', + 'type' => 'string', + 'required' => true, + 'example' => 'Currently supported: USA', + ], + ], + [ + 'name' => 'Text', + 'in' => 'query', + 'schema' => [ + 'description' => 'Detailed address text content', + 'type' => 'string', + 'required' => false, + 'example' => '浙江省杭州市西湖区灯彩街云谷园区', + ], + ], + [ + 'name' => 'DeviceToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'DeviceToken obtained via the client SDK', + 'type' => 'string', + 'required' => true, + 'example' => 'Tk9SSUQuMS*****************ZDNmNWY5NzQxOW1o', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '7F971622-38C0-5F56-B2EC-315367979B4F', + ], + 'Code' => [ + 'description' => '[Return Code](https://www.alibabacloud.com/help/zh/ekyc/latest/add-verify-pro-api?spm=a2c63.p38356.0.i4#ae60001a3804w)', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'Detailed description of the return code', + 'type' => 'string', + 'example' => 'success', + ], + 'Result' => [ + 'description' => 'Result object', + 'type' => 'object', + 'properties' => [ + 'TransactionId' => [ + 'description' => 'The transaction ID', + 'type' => 'string', + 'example' => 'hksb7ba1b28130d24e015d69********', + ], + 'BizCode' => [ + 'description' => 'The verification result. Valid values:'."\n" + ."\n" + .'- **1**: Passed (billed)'."\n" + .'- **2**: Failed (The device is in a prohibited region) (billed)'."\n" + .'- **3**: Unknown (billed)', + 'type' => 'string', + 'example' => '1', + ], + 'Detail' => [ + 'description' => 'Verification details, including：'."\n" + ."\n" + .'- **DistanceRange**：Position rang：[DistanceRange description](https://www.alibabacloud.com/help/zh/ekyc/latest/add-verify-pro-api?spm=a2c63.p38356.0.i27#ee274c08976er)。'."\n" + .'> If the input phone number or address is empty, or if no carrier information is found, this field will not be returned.'."\n" + ."\n" + .'- **IspName**: The carrier name:'."\n" + .' - **CMCC**: China Mobile'."\n" + .' - **CTCC**: China Telecom'."\n" + .' - **CUCC**: China Unicom'."\n" + .'> This parameter is not returned if the mobile phone number or address is empty in the request, or if carrier information is not found.'."\n" + ."\n" + .'- **PhoneStatus**: The status of the mobile phone:'."\n" + .' - **0**: Abnormal'."\n" + .' - **1**: Normal'."\n" + ."\n" + .'> This parameter is not returned if the mobile phone number is empty in the request.', + 'type' => 'string', + 'example' => '{'."\n" + .' "distanceRange": "0-3000",'."\n" + .' "ispName": "CTCC",'."\n" + .' "phoneStatus": "1"'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7F971622-38C0-5F56-B2EC-315367979B4F\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"hksb7ba1b28130d24e015d69********\\",\\n \\"BizCode\\": \\"1\\",\\n \\"Detail\\": \\"{\\\\n \\\\\\"distanceRange\\\\\\": \\\\\\"0-3000\\\\\\",\\\\n \\\\\\"ispName\\\\\\": \\\\\\"CTCC\\\\\\",\\\\n \\\\\\"phoneStatus\\\\\\": \\\\\\"1\\\\\\"\\\\n}\\"\\n }\\n}","type":"json"}]', + 'title' => 'Address Verification V2', + ], + 'AddressCompareIntl' => [ + 'summary' => 'Address Similarity Comparison', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthNOQ41U', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'ADD_VERIFY', + 'type' => 'string', + 'required' => true, + 'example' => 'fixed value：ADD_VERIFY', + ], + ], + [ + 'name' => 'Text1', + 'in' => 'query', + 'schema' => [ + 'description' => 'Address 1', + 'type' => 'string', + 'required' => true, + 'example' => '杭州市阿里巴巴西溪园区', + ], + ], + [ + 'name' => 'Text2', + 'in' => 'query', + 'schema' => [ + 'description' => 'Address 2', + 'type' => 'string', + 'required' => true, + 'example' => '杭州市文一西路969号1号楼', + ], + ], + [ + 'name' => 'DefaultCountry', + 'in' => 'query', + 'schema' => [ + 'description' => 'Country name'."\n" + .'- China', + 'type' => 'string', + 'required' => true, + 'example' => 'fixed value：中国', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '86C40EC3-5940-5F47-995C-BFE90B70E540'."\n", + ], + 'Code' => [ + 'description' => 'Return code.', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'Result' => [ + 'description' => 'Return result.', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The values of sameLevel include:'."\n" + .'- all: Exactly the same'."\n" + .'- prov: Provincial level'."\n" + .'- city: City level'."\n" + .'- district: District level'."\n" + .'- town: Town level'."\n" + .'- road: Road level'."\n" + .'- roadno: Road number'."\n" + .'- poi: Point of interest (e.g., residential area)'."\n" + .'- roomno: Room number', + 'type' => 'string', + 'example' => '{'."\n" + .' sameLevel: "city", '."\n" + .' distance: 5997.34m, -- 地址相差距离'."\n" + .' same_info: { -- 相同信息'."\n" + .' prov: "浙江省",'."\n" + .' city: "杭州市",'."\n" + .' district: "西湖区"'."\n" + .' } '."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86C40EC3-5940-5F47-995C-BFE90B70E540\\\\n\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"Data\\": \\"{\\\\n sameLevel: \\\\\\"city\\\\\\", \\\\n distance: 5997.34m, -- 地址相差距离\\\\n same_info: { -- 相同信息\\\\n prov: \\\\\\"浙江省\\\\\\",\\\\n city: \\\\\\"杭州市\\\\\\",\\\\n district: \\\\\\"西湖区\\\\\\"\\\\n } \\\\n}\\"\\n }\\n}","type":"json"}]', + 'title' => 'Address Similarity Comparison', + 'description' => 'API for comparing two addresses, standardizing and checking address consistency.', + 'translator' => 'machine', + ], + 'KeepaliveIntl' => [ + 'summary' => 'If your server makes infrequent calls to the ID Verification API, you can call the KeepaliveIntl operation to maintain the client connection.', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthNOQ41U', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '4EB35****87EBA1', + ], + 'Code' => [ + 'description' => 'The [return code.](https://www.alibabacloud.com/help/en/ekyc/latest/client-connection-hold?spm=a3c0i.23458820.2359477120.1.48207d3ftEYld2#74d291dfaaxci)', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'A detailed description of the Code.', + 'type' => 'string', + 'example' => 'success', + ], + 'Result' => [ + 'description' => 'Return result', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => 'The result of the call.', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"Result\\": \\"SUCCESS\\"\\n }\\n}","type":"json"}]', + 'title' => 'Client connection keep-alive', + ], + 'DeleteVerifyResult' => [ + 'summary' => 'Delete user authentication record results', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'TransactionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Unique identifier of the authentication request', + 'type' => 'string', + 'required' => false, + 'example' => '4ab0b***cbde97', + ], + ], + [ + 'name' => 'DeleteAfterQuery', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to depend on the query interface when deleting data', + 'type' => 'string', + 'required' => false, + 'example' => 'Y / N', + ], + ], + [ + 'name' => 'DeleteType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Type of data to be deleted', + 'type' => 'string', + 'required' => false, + 'example' => 'Img / Text / All', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Return result', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'ID of this request', + 'type' => 'string', + 'example' => '4EB35****87EBA1', + ], + 'Code' => [ + 'description' => 'Return code', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Return message', + 'type' => 'string', + 'example' => 'success', + ], + 'Result' => [ + 'description' => 'Return result', + 'type' => 'object', + 'properties' => [ + 'TransactionId' => [ + 'description' => 'Unique identifier of the authentication request', + 'type' => 'string', + 'example' => '4ab0b***cbde97', + ], + 'DeleteResult' => [ + 'description' => 'Deletion result. Y indicates successful deletion, N indicates failed deletion', + 'type' => 'string', + 'example' => 'Y/N', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"4ab0b***cbde97\\",\\n \\"DeleteResult\\": \\"Y/N\\"\\n }\\n}","type":"json"}]', + 'title' => 'Logical Deletion Interface for Authentication Records', + 'translator' => 'machine', + ], + 'CheckVerifyLog' => [ + 'summary' => 'Authentication Log Query Interface', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '266432', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthCS0SDG', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MerchantBizId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'A unique business identifier defined by the merchant, used for subsequent problem localization and troubleshooting. Supports a combination of letters and numbers, with a maximum length of 32 characters. Ensure uniqueness.', + 'type' => 'string', + 'required' => false, + 'example' => 'e0c34a***353888', + ], + ], + [ + 'name' => 'TransactionId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The unique identifier for the entire authentication process. This value needs to be obtained by calling Initialize.', + 'type' => 'string', + 'required' => false, + 'example' => 'hksb7ba1b*********015d694361bee4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'ID of the request', + 'type' => 'string', + 'example' => '4EB35****87EBA1', + ], + 'Code' => [ + 'description' => 'Backend error code.', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'Return message', + 'type' => 'string', + 'example' => 'success', + ], + 'Result' => [ + 'description' => 'Return result.', + 'type' => 'object', + 'properties' => [ + 'Passed' => [ + 'description' => 'Whether the authentication passed.'."\n" + ."\n" + .'- Y: Passed.'."\n" + .'- N: Not passed.', + 'type' => 'string', + 'example' => 'Y', + ], + 'SubCode' => [ + 'description' => 'Sub-result code', + 'type' => 'string', + 'example' => '200', + ], + 'VerifyStatus' => [ + 'description' => 'Authentication status, values:'."\n" + ."\n" + .'- 0: finished (authentication completed)'."\n" + .'- 1: unfinished (authentication interrupted)'."\n" + .'- 2: notstart (authentication not started)', + 'type' => 'string', + 'example' => '1', + ], + 'InterruptPage' => [ + 'description' => 'Records the last page where the authentication was interrupted.'."\n" + ."\n" + .'- Page not started'."\n" + .'- OCR guide page'."\n" + .'- OCR camera authorization'."\n" + .'- OCR document capture page'."\n" + .'- OCR recognition loading'."\n" + .'- OCR recognition result editing page'."\n" + .'- OCR recognition result editing loading'."\n" + .'- Liveness detection guide page'."\n" + .'- Liveness detection camera authorization page'."\n" + .'- Liveness detection page'."\n" + .'- Liveness detection fallback page'."\n" + .'- Liveness detection retry'."\n" + .'- Liveness detection loading', + 'type' => 'string', + 'example' => 'OCR拍摄证件页面', + ], + 'VerifyErrorCode' => [ + 'description' => 'Authentication interruption error codes'."\n" + ."\n" + .'- 1000: The user completed the face scanning process, and the suggested authentication result is pass'."\n" + .'- 1001: The user completed the face scanning process, and the suggested authentication result is fail'."\n" + .'- 1002: System error'."\n" + .'- 1003: SDK initialization failed, please check if the client time is correct'."\n" + .'- 1004: Camera permission error'."\n" + .'- 1005: Network error'."\n" + .'- 1006: User exited'."\n" + .'- 1007: Invalid TransactionId'."\n" + .'- 1009: Client timestamp error'."\n" + .'- 1011: Incorrect document type submitted'."\n" + .'- 1012: Missing or format validation failure of key information on the recognized document'."\n" + .'- 1013: Poor image quality'."\n" + .'- 1014: Exceeded the upper limit of errors'."\n" + .'- 1015: Android system version too low'."\n" + .'- 1016: Camera permission not obtained'."\n" + .'- 9999: Suspected authentication process interruption', + 'type' => 'string', + 'example' => '1001', + ], + 'LogInfo' => [ + 'description' => 'SDK operation log details', + 'type' => 'array', + 'items' => [ + 'description' => 'Operation logs', + 'type' => 'string', + 'example' => '['."\n" + .' "2025-03-21 10:31:25 Loading阶段结束",'."\n" + .' "2025-03-21 10:31:25 用户进入OCR页面",'."\n" + .' "2025-03-21 10:31:39 OCR认证阶段点击相册选择按钮",'."\n" + .' "2025-03-21 10:31:39 OCR认证阶段点击OCR提交按钮",'."\n" + .' "2025-03-21 10:31:42 OCR认证阶段中断弹窗弹出",'."\n" + .' "2025-03-21 10:31:43 OCR认证阶段中断重试",'."\n" + .' "2025-03-21 10:31:43 OCR认证阶段中断弹窗关闭",'."\n" + .' "2025-03-21 10:31:59 OCR认证阶段点击相册选择按钮",'."\n" + .' "2025-03-21 10:31:59 OCR认证阶段点击OCR提交按钮",'."\n" + .' "2025-03-21 10:32:02 OCR认证阶段结束",'."\n" + .' "2025-03-21 10:32:02 用户进入OCR编辑页面",'."\n" + .' "2025-03-21 10:32:03 OCR编辑阶段点击OCR结果确认无误按钮",'."\n" + .' "2025-03-21 10:32:04 OCR编辑阶段结束",'."\n" + .' "2025-03-21 10:32:04 用户进入活体页面",'."\n" + .' "2025-03-21 10:32:12 活体检测阶段结束"'."\n" + .' ]', + ], + ], + 'ExtInfo' => [ + 'description' => 'Extended information', + 'type' => 'string', + 'example' => '{}', + ], + 'LogStatisticsInfo' => [ + 'description' => 'SDK operation log statistics details', + 'type' => 'string', + 'example' => '{'."\n" + .' "faceOverTimes": 0,'."\n" + .' "hasFaceOverTimes": false,'."\n" + .' "hasFacePermissionRefuse": false,'."\n" + .' "hasOcrEdit": true,'."\n" + .' "hasOcrEditOverTimes": false,'."\n" + .' "hasOcrOverTimes": true,'."\n" + .' "hasOcrPermissionRefuse": false,'."\n" + .' "ocrEditOverTimes": 0,'."\n" + .' "ocrEditTimes": 1,'."\n" + .' "ocrOverTimes": 1,'."\n" + .' "pageStayTimeInfo": {'."\n" + .' "LOADING": "1615",'."\n" + .' "OCR_SCAN": "37446",'."\n" + .' "OCR_RESULT": "1338",'."\n" + .' "FACE": "8707"'."\n" + .' }'."\n" + .' }', + ], + 'LogInfoEn' => [ + 'description' => 'SDK Operation Log Details (English Version)', + 'type' => 'array', + 'items' => [ + 'description' => 'Operation logs', + 'type' => 'string', + 'example' => '['."\n" + .' "2025-03-21 10:31:25 LOADING_ENTER",'."\n" + .' "2025-03-21 10:31:25 LOADING_EXIT",'."\n" + .' "2025-03-21 10:31:39 GUIDE_PAGE_SHOW",'."\n" + .' "2025-03-21 10:31:39 GUIDE_PAGE_LEAVE",'."\n" + .' "2025-03-21 10:31:42 FACE_ENTER",'."\n" + .' "2025-03-21 10:31:43 FACE_EXIT"'."\n" + .']', + ], + ], + 'InterruptPageEn' => [ + 'description' => 'The page where the authentication process stops. Possible English values:'."\n" + ."\n" + .'The following are the values in an unordered list:'."\n" + ."\n" + .'- LOADING'."\n" + ."\n" + .'- GUIDE'."\n" + ."\n" + .'- FACE'."\n" + ."\n" + .'- OCR_SCAN'."\n" + ."\n" + .'- OCR_RESULT'."\n" + ."\n" + .'- NFC_INPUT'."\n" + ."\n" + .'- NFC_READ', + 'type' => 'string', + 'example' => 'LOADING', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"Passed\\": \\"Y\\",\\n \\"SubCode\\": \\"200\\",\\n \\"VerifyStatus\\": \\"1\\",\\n \\"InterruptPage\\": \\"OCR拍摄证件页面\\",\\n \\"VerifyErrorCode\\": \\"1001\\",\\n \\"LogInfo\\": [\\n \\"[\\\\n \\\\\\"2025-03-21 10:31:25 Loading阶段结束\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:25 用户进入OCR页面\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:39 OCR认证阶段点击相册选择按钮\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:39 OCR认证阶段点击OCR提交按钮\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:42 OCR认证阶段中断弹窗弹出\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:43 OCR认证阶段中断重试\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:43 OCR认证阶段中断弹窗关闭\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:59 OCR认证阶段点击相册选择按钮\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:59 OCR认证阶段点击OCR提交按钮\\\\\\",\\\\n \\\\\\"2025-03-21 10:32:02 OCR认证阶段结束\\\\\\",\\\\n \\\\\\"2025-03-21 10:32:02 用户进入OCR编辑页面\\\\\\",\\\\n \\\\\\"2025-03-21 10:32:03 OCR编辑阶段点击OCR结果确认无误按钮\\\\\\",\\\\n \\\\\\"2025-03-21 10:32:04 OCR编辑阶段结束\\\\\\",\\\\n \\\\\\"2025-03-21 10:32:04 用户进入活体页面\\\\\\",\\\\n \\\\\\"2025-03-21 10:32:12 活体检测阶段结束\\\\\\"\\\\n ]\\"\\n ],\\n \\"ExtInfo\\": \\"{}\\",\\n \\"LogStatisticsInfo\\": \\"{\\\\n \\\\\\"faceOverTimes\\\\\\": 0,\\\\n \\\\\\"hasFaceOverTimes\\\\\\": false,\\\\n \\\\\\"hasFacePermissionRefuse\\\\\\": false,\\\\n \\\\\\"hasOcrEdit\\\\\\": true,\\\\n \\\\\\"hasOcrEditOverTimes\\\\\\": false,\\\\n \\\\\\"hasOcrOverTimes\\\\\\": true,\\\\n \\\\\\"hasOcrPermissionRefuse\\\\\\": false,\\\\n \\\\\\"ocrEditOverTimes\\\\\\": 0,\\\\n \\\\\\"ocrEditTimes\\\\\\": 1,\\\\n \\\\\\"ocrOverTimes\\\\\\": 1,\\\\n \\\\\\"pageStayTimeInfo\\\\\\": {\\\\n \\\\\\"LOADING\\\\\\": \\\\\\"1615\\\\\\",\\\\n \\\\\\"OCR_SCAN\\\\\\": \\\\\\"37446\\\\\\",\\\\n \\\\\\"OCR_RESULT\\\\\\": \\\\\\"1338\\\\\\",\\\\n \\\\\\"FACE\\\\\\": \\\\\\"8707\\\\\\"\\\\n }\\\\n }\\",\\n \\"LogInfoEn\\": [\\n \\"[\\\\n \\\\\\"2025-03-21 10:31:25 LOADING_ENTER\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:25 LOADING_EXIT\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:39 GUIDE_PAGE_SHOW\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:39 GUIDE_PAGE_LEAVE\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:42 FACE_ENTER\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:43 FACE_EXIT\\\\\\"\\\\n]\\"\\n ],\\n \\"InterruptPageEn\\": \\"LOADING\\"\\n }\\n}","type":"json"}]', + 'title' => 'Authentication Log Query Interface', + 'translator' => 'machine', + ], + 'AddFaceRecord' => [ + 'summary' => '人脸图片入库', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'FaceGroupCode', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'sgl****7uc', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'FACE_ENROLL', + ], + ], + [ + 'name' => 'MerchantUserId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '130A2C10B9EE4D8488E35384FF03hst', + ], + ], + [ + 'name' => 'FacePicture', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'base64', + ], + ], + [ + 'name' => 'FacePictureUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.xxxxx.com/test.jpg', + ], + ], + [ + 'name' => 'FacePictureFile', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'InputStream', + 'isFileTransferUrl' => true, + ], + ], + [ + 'name' => 'FaceQualityCheck', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'N', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '7A0D192A-CC0C-5DE5-A3B6-A14CF45508F2', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'Result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Passed' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Y', + ], + 'ExtFaceInfo' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{'."\n" + .'"faceQuality": "HIGH"'."\n" + .'}'."\n" + ."\n", + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7A0D192A-CC0C-5DE5-A3B6-A14CF45508F2\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"Passed\\": \\"Y\\",\\n \\"ExtFaceInfo\\": \\"{\\\\n\\\\\\"faceQuality\\\\\\": \\\\\\"HIGH\\\\\\"\\\\n}\\\\n\\\\n\\"\\n }\\n}","type":"json"}]', + ], + 'DownloadVerifyRecordIntl' => [ + 'summary' => 'Console Export Records', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '225500', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth6RJHVQ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Code', + 'in' => 'query', + 'schema' => [ + 'description' => 'Query code.', + 'type' => 'string', + 'required' => false, + 'example' => 'vrf_intl_verify_record_real_id_idv_invoke_statistics_query', + ], + ], + [ + 'name' => 'Param', + 'in' => 'query', + 'schema' => [ + 'description' => 'Parameters related to the export and download query task.', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"productCode\\":\\"FACE_LIVENESS\\",\\"startDs\\":\\"20251121\\",\\"endDs\\":\\"20251128\\",\\"language\\":\\"en\\"}', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Product Code.', + 'type' => 'string', + 'required' => false, + 'example' => 'KYC', + ], + ], + [ + 'name' => 'DownloadMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Download mode:'."\n" + ."\n" + .'- **async**: Asynchronous'."\n" + .'- **sync**: Synchronous', + 'type' => 'string', + 'required' => false, + 'example' => 'async', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Business type:'."\n" + .'- INVOKE_STATISTICS'."\n" + .'- INVOKE_RECORD', + 'type' => 'string', + 'required' => false, + 'example' => 'INVOKE_RECORD', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response Schema', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'ID of the request', + 'type' => 'string', + 'example' => '86C40EC3-5940-5F47-995C-BFE90B70E540'."\n", + ], + 'Code' => [ + 'description' => 'Return code.', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => 'Returned data.', + 'type' => 'object', + 'properties' => [ + 'DownloadTaskId' => [ + 'description' => 'Task ID, returned in asynchronous mode, used later with QueryDownloadTaskIntl to download the exported file.', + 'type' => 'string', + 'example' => '202511284106866', + ], + 'Url' => [ + 'description' => 'Exported file download link.', + 'type' => 'string', + 'example' => 'https://cn-shanghai-aliyun-cloudauth.oss-cn-shanghai.aliyuncs.com/console/xxxxxx/KYC_INVOKE_STATISTICS.xlxs', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86C40EC3-5940-5F47-995C-BFE90B70E540\\\\n\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"DownloadTaskId\\": \\"202511284106866\\",\\n \\"Url\\": \\"https://cn-shanghai-aliyun-cloudauth.oss-cn-shanghai.aliyuncs.com/console/xxxxxx/KYC_INVOKE_STATISTICS.xlxs\\"\\n }\\n}","type":"json"}]', + 'title' => 'Download Authentication Records', + 'translator' => 'machine', + ], + 'QueryFaceGroup' => [ + 'summary' => 'Query Face Group', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test008', + ], + ], + [ + 'name' => 'GroupCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'groupCode001', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'WpY9RBGa5Vrzxi3+mp2Cdw==', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '5E63B760-0ECB-5C07-8503-A65C27876968', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'TotalPage' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CurrentPage' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Items' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '162261', + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test-888', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'faceGroup001', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'desc', + ], + ], + ], + ], + 'MaxResults' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'NextToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'N/zmQeG/x9TDWmaB/pbfBQ==', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5E63B760-0ECB-5C07-8503-A65C27876968\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"TotalCount\\": 0,\\n \\"TotalPage\\": 1,\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 100,\\n \\"Items\\": [\\n {\\n \\"Id\\": 162261,\\n \\"Name\\": \\"test-888\\",\\n \\"Code\\": \\"faceGroup001\\",\\n \\"Description\\": \\"desc\\"\\n }\\n ],\\n \\"MaxResults\\": 50,\\n \\"NextToken\\": \\"N/zmQeG/x9TDWmaB/pbfBQ==\\"\\n}","type":"json"}]', + 'title' => 'Query Face Group', + 'translator' => 'machine', + ], + 'ModifyFaceGroup' => [ + 'summary' => 'Modify Face Group', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '65c030cd54b23283ceb27b4ade5da49d', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test008', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'description', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '4EB35****87EBA1', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": 1\\n}","type":"json"}]', + 'title' => 'Modify Face Group', + 'translator' => 'machine', + ], + 'DeleteFaceGroup' => [ + 'summary' => 'Delete Face Group', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Primary key ID', + 'type' => 'string', + 'required' => true, + 'example' => '16681', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'ID of the request', + 'type' => 'string', + 'example' => '595E387B-3F0E-5C52-BD02-8EFE63D41FD5', + ], + 'Code' => [ + 'description' => 'Return code', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'Return message', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => 'Return result.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"595E387B-3F0E-5C52-BD02-8EFE63D41FD5\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": 1\\n}","type":"json"}]', + 'title' => 'Delete Face Group', + 'translator' => 'machine', + ], + 'QueryFaceRecord' => [ + 'summary' => 'Query Face Records', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'FaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Face ID.', + 'type' => 'string', + 'required' => false, + 'example' => '5006538', + ], + ], + [ + 'name' => 'MerchantUserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Merchant User ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'CuN6hiD08qr', + ], + ], + [ + 'name' => 'RegistrationType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Registration Type.', + 'type' => 'string', + 'required' => false, + 'example' => 'MANUAL', + ], + ], + [ + 'name' => 'FaceGroupCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Face Group Code.', + 'type' => 'string', + 'required' => true, + 'example' => 'Cu****D08q', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'Current Page.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of items per page.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of rows per page for paginated queries.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'Used to request the next page of search results.', + 'type' => 'string', + 'required' => false, + 'example' => 'AAAAARbaCuN6hiD08qrLdwJ9Fh0OP1yH8z+7FV4KKGUw4X32', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'ID of the request', + 'type' => 'string', + 'example' => '7F971622-38C0-5F56-B2EC-315367979B4F', + ], + 'Code' => [ + 'description' => 'Return code.', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'TotalCount' => [ + 'description' => 'Total number of records.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'TotalPage' => [ + 'description' => 'Total number of pages.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CurrentPage' => [ + 'description' => 'Current query page number.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'PageSize' => [ + 'description' => 'Number of items per page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Items' => [ + 'description' => 'List of returned information.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of the returned object.', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'Primary key ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16112', + ], + 'FaceId' => [ + 'description' => 'Face ID.', + 'type' => 'string', + 'example' => '230642938', + ], + 'GmtCreate' => [ + 'description' => 'Creation time.', + 'type' => 'string', + 'example' => '2025-01-15T02:20:28Z', + ], + 'RegistrationType' => [ + 'description' => 'Registration type.', + 'type' => 'string', + 'example' => 'MANUAL', + ], + 'ImgOssUrl' => [ + 'description' => 'Face image URL.', + 'type' => 'string', + 'example' => 'http://www.xxxx.com/1.jpg', + ], + 'MerchantUserId' => [ + 'description' => 'Merchant User ID.', + 'type' => 'string', + 'example' => 'CuN6hiD08qr', + ], + ], + ], + ], + 'MaxResults' => [ + 'description' => 'Maximum number of data entries per page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'NextToken' => [ + 'description' => 'Token for the next query start.', + 'type' => 'string', + 'example' => 'AAAAARfZmVDe9NvRXloR5+8CK9nwqHyx44CQz3pa71+mmu0e', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7F971622-38C0-5F56-B2EC-315367979B4F\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"TotalCount\\": 6,\\n \\"TotalPage\\": 1,\\n \\"CurrentPage\\": 2,\\n \\"PageSize\\": 10,\\n \\"Items\\": [\\n {\\n \\"Id\\": 16112,\\n \\"FaceId\\": \\"230642938\\",\\n \\"GmtCreate\\": \\"2025-01-15T02:20:28Z\\",\\n \\"RegistrationType\\": \\"MANUAL\\",\\n \\"ImgOssUrl\\": \\"http://www.xxxx.com/1.jpg\\",\\n \\"MerchantUserId\\": \\"CuN6hiD08qr\\"\\n }\\n ],\\n \\"MaxResults\\": 100,\\n \\"NextToken\\": \\"AAAAARfZmVDe9NvRXloR5+8CK9nwqHyx44CQz3pa71+mmu0e\\"\\n}","type":"json"}]', + 'title' => 'Query Face Records', + 'translator' => 'machine', + ], + 'ModifyFaceRecord' => [ + 'summary' => 'Add New Face', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ImgOssInfos', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'JSON', + ], + ], + [ + 'name' => 'FaceGroupCode', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '4EB35****87', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '4EB35****87EBA1', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": 1\\n}","type":"json"}]', + 'title' => 'Edit Face Record', + 'translator' => 'machine', + ], + 'DeleteFaceRecord' => [ + 'summary' => 'Delete Face', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Primary Key ID', + 'type' => 'string', + 'required' => false, + 'example' => '344537', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'ID of the request', + 'type' => 'string', + 'example' => '4EB35****87EBA1', + ], + 'Code' => [ + 'description' => 'Return code.', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => 'Return result.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": 1\\n}","type":"json"}]', + 'title' => 'Delete Face Record', + 'translator' => 'machine', + ], + 'TempOssUrlIntl' => [ + 'summary' => 'Get Temporary File URL', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ObjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Object name.', + 'type' => 'string', + 'required' => true, + 'example' => '20250512/pdf/579047.pdf', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'ID of the request', + 'type' => 'string', + 'example' => 'EFA11401-C961-5E89-A2D3-BF9883E5CC3D', + ], + 'Code' => [ + 'description' => 'Return code.', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => 'Result.', + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'description' => 'File URL', + 'type' => 'string', + 'example' => 'http://bzxh.cdn.weijin365.com/assets/index-55338127.png', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EFA11401-C961-5E89-A2D3-BF9883E5CC3D\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Url\\": \\"http://bzxh.cdn.weijin365.com/assets/index-55338127.png\\"\\n }\\n}","type":"json"}]', + 'title' => 'Get Temporary File URL', + 'translator' => 'machine', + ], + 'TempAccessTokenIntl' => [ + 'summary' => 'Get Temporary Token', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthNYJI62', + ], + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Type.', + 'type' => 'string', + 'required' => false, + 'example' => 'none', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'ID of the request', + 'type' => 'string', + 'example' => '86C40EC3-5940-5F47-995C-BFE90B70E540', + ], + 'Code' => [ + 'description' => 'Return code', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => 'Return result.', + 'type' => 'object', + 'properties' => [ + 'AccessKeyId' => [ + 'description' => 'AccessKeyId for temporary file upload credentials.', + 'type' => 'string', + 'example' => '***', + ], + 'AccessKeySecret' => [ + 'description' => 'Temporary authorization secret.', + 'type' => 'string', + 'example' => '3hxuRpEJ3Jv2Rtzyg4HooFCYqps762XcNtzhn19wQymk', + ], + 'SecurityToken' => [ + 'description' => 'Security token for temporary file upload credentials.', + 'type' => 'string', + 'example' => '***', + ], + 'OssEndPoint' => [ + 'description' => 'OSS endpoint.', + 'type' => 'string', + 'example' => ' ossEndPoint', + ], + 'BucketName' => [ + 'description' => 'Bucket name.', + 'type' => 'string', + 'example' => 'liyi', + ], + 'FileNamePrefix' => [ + 'description' => 'File prefix.', + 'type' => 'string', + 'example' => 'test001', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86C40EC3-5940-5F47-995C-BFE90B70E540\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"AccessKeyId\\": \\"***\\",\\n \\"AccessKeySecret\\": \\"3hxuRpEJ3Jv2Rtzyg4HooFCYqps762XcNtzhn19wQymk\\",\\n \\"SecurityToken\\": \\"***\\",\\n \\"OssEndPoint\\": \\" ossEndPoint\\",\\n \\"BucketName\\": \\"liyi\\",\\n \\"FileNamePrefix\\": \\"test001\\"\\n }\\n}","type":"json"}]', + 'title' => 'Get Temporary Token', + 'translator' => 'machine', + ], + 'CardOcr' => [ + 'summary' => 'Pure server-side interface for document OCR recognition', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '178782', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthCW0JNH', + 'FEATUREcloudauthHOSIED', + 'FEATUREcloudauthWSJE4H', + ], + ], + 'parameters' => [ + [ + 'name' => 'MerchantBizId', + 'in' => 'query', + 'schema' => [ + 'description' => 'A unique business identifier defined by the merchant, used for subsequent troubleshooting. It supports a combination of letters and numbers, with a maximum length of 32 characters. Please ensure uniqueness.', + 'type' => 'string', + 'required' => false, + 'example' => 'dso9322***dsjsd22', + ], + ], + [ + 'name' => 'MerchantUserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Merchant user ID or other identifiers that can be used to identify specific users, such as phone numbers, email addresses, etc. It is strongly recommended to pre-desensitize the value of the userId field, for example, by hashing the value.', + 'type' => 'string', + 'required' => false, + 'example' => '123456789', + ], + ], + [ + 'name' => 'IdOcrPictureBase64', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'Base64 on the front of the document image', + 'example' => 'base64', + ], + ], + [ + 'name' => 'IdOcrPictureUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'URL of the front side of the document image', + 'type' => 'string', + 'required' => false, + 'example' => 'https://digital-cardocr-prod8.oss-cn-hangzhou.aliyuncs.com/1669520556530-expo/default/face/20221127114236530_w3kx2e6t.jpg'."\n", + ], + ], + [ + 'name' => 'DocType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Document type.', + 'type' => 'string', + 'required' => false, + 'example' => '00000006', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Product code', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_OCR_MIN', + ], + ], + [ + 'name' => 'Ocr', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to perform document OCR'."\n" + .'- T: Indicates that document OCR is required (default T)'."\n" + .'- F: Indicates that it is not required', + 'type' => 'string', + 'required' => false, + 'example' => 'T', + ], + ], + [ + 'name' => 'IdFaceQuality', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to perform face quality detection on the document'."\n" + .'- T: Indicates that detection is needed'."\n" + .'- F: Indicates that detection is not needed (default F)', + 'type' => 'string', + 'required' => false, + 'example' => 'F', + ], + ], + [ + 'name' => 'Spoof', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to enable anti-counterfeiting detection'."\n" + .'- T: Indicates to enable anti-counterfeiting'."\n" + .'- F: Indicates to disable (default F)', + 'type' => 'string', + 'required' => false, + 'example' => 'F', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'ID of the request', + 'type' => 'string', + 'example' => '4EB356FE-BB6A-5DCC-B4C5-E8051787EBA1', + ], + 'Code' => [ + 'description' => 'Return code', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'Return message', + 'type' => 'string', + 'example' => 'success', + ], + 'Result' => [ + 'description' => 'Return result', + 'type' => 'object', + 'properties' => [ + 'TransactionId' => [ + 'description' => 'Unique identifier for the authentication request', + 'type' => 'string', + 'example' => '08573be80f944d95ac812e019e3655a8', + ], + 'Passed' => [ + 'description' => 'Whether the authentication passed.'."\n" + ."\n" + .'- Y: Passed.'."\n" + .'- N: Not passed.', + 'type' => 'string', + 'example' => 'Y', + ], + 'SubCode' => [ + 'description' => 'Sub-result code.', + 'type' => 'string', + 'example' => '200', + ], + 'ExtIdInfo' => [ + 'description' => 'Additional result information', + 'type' => 'string', + 'example' => '**', + ], + 'ExtCardInfo' => [ + 'description' => 'Document recognition result', + 'type' => 'string', + 'example' => '{'."\n" + .' "idFaceQualityScore": 98.90,'."\n" + .' "ocrIdInfo": {'."\n" + .' "expiryDate": "2024-04-20",'."\n" + .' "placeOfIssue": "广东",'."\n" + .' "englishName": "ZHENGJIAN,YANGBEN",'."\n" + .' "originOfIssue": "公安部出入境管理局",'."\n" + .' "sex": "女",'."\n" + .' "name": "证件样本",'."\n" + .' "idNumber": "C00000000",'."\n" + .' "issueDate": "2014-04-21",'."\n" + .' "birthDate": "1981-08-03"'."\n" + .' },'."\n" + .' "spoofInfo": {'."\n" + .' "spoofResult": "N",'."\n" + .' "spoofType": ['."\n" + .' "SCREEN_REMARK"'."\n" + .' ]'."\n" + .' }'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'Cloudauth-intl::2022-08-09::DocOcr', + ], + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB356FE-BB6A-5DCC-B4C5-E8051787EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"08573be80f944d95ac812e019e3655a8\\",\\n \\"Passed\\": \\"Y\\",\\n \\"SubCode\\": \\"200\\",\\n \\"ExtIdInfo\\": \\"**\\",\\n \\"ExtCardInfo\\": \\"{\\\\n \\\\\\"idFaceQualityScore\\\\\\": 98.90,\\\\n \\\\\\"ocrIdInfo\\\\\\": {\\\\n \\\\\\"expiryDate\\\\\\": \\\\\\"2024-04-20\\\\\\",\\\\n \\\\\\"placeOfIssue\\\\\\": \\\\\\"广东\\\\\\",\\\\n \\\\\\"englishName\\\\\\": \\\\\\"ZHENGJIAN,YANGBEN\\\\\\",\\\\n \\\\\\"originOfIssue\\\\\\": \\\\\\"公安部出入境管理局\\\\\\",\\\\n \\\\\\"sex\\\\\\": \\\\\\"女\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"证件样本\\\\\\",\\\\n \\\\\\"idNumber\\\\\\": \\\\\\"C00000000\\\\\\",\\\\n \\\\\\"issueDate\\\\\\": \\\\\\"2014-04-21\\\\\\",\\\\n \\\\\\"birthDate\\\\\\": \\\\\\"1981-08-03\\\\\\"\\\\n },\\\\n \\\\\\"spoofInfo\\\\\\": {\\\\n \\\\\\"spoofResult\\\\\\": \\\\\\"N\\\\\\",\\\\n \\\\\\"spoofType\\\\\\": [\\\\n \\\\\\"SCREEN_REMARK\\\\\\"\\\\n ]\\\\n }\\\\n}\\"\\n }\\n}","type":"json"}]', + 'title' => 'Card OCR Pure Server Capability API', + 'translator' => 'machine', + ], + 'FraudResultCallBack' => [ + 'summary' => 'Anti-Fraud Callback Interface', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '184671', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthCW0JNH', + 'FEATUREcloudauthHOSIED', + 'FEATUREcloudauthWSJE4H', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CertifyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Unique identifier for real-person authentication, corresponding to Ant\'s verifyId.', + 'type' => 'string', + 'required' => false, + 'example' => 'shs2b27333914876c01de4cb22f5841f', + ], + ], + [ + 'name' => 'ResultCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether the anti-fraud check passed'."\n" + .'- PASS (Passed)'."\n" + .'- REJECT (Rejected)', + 'type' => 'string', + 'required' => false, + 'example' => 'PASS', + ], + ], + [ + 'name' => 'VerifyDeployEnv', + 'in' => 'query', + 'schema' => [ + 'description' => 'Environment routing parameter'."\n" + .'- staging (Staging environment)'."\n" + .'- production (Production environment)', + 'type' => 'string', + 'required' => false, + 'example' => 'production', + ], + ], + [ + 'name' => 'ExtParams', + 'in' => 'query', + 'schema' => [ + 'description' => 'Extended parameters, in JSON string format.', + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '4EB35****87EBA1', + ], + 'Success' => [ + 'description' => 'Whether the call was successful.'."\n" + .'- **true**: Call succeeded.'."\n" + .'- **false**: Call failed.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => 'Return code', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'Return message', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'Anti-Fraud Callback Interface', + 'translator' => 'machine', + ], + 'AddressVerifyIntl' => [ + 'summary' => 'Address Verification', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Fixed value: ADD_VERIFY_PRO', + 'type' => 'string', + 'required' => true, + 'example' => 'ADD_VERIFY_PRO', + ], + ], + [ + 'name' => 'VerifyType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Address verification method:'."\n" + .'- HOME: Home address verification'."\n" + .'- WORK: Work address verification', + 'type' => 'string', + 'required' => true, + 'example' => 'HOME', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'query', + 'schema' => [ + 'description' => 'Supports Chinese mobile phone numbers.', + 'type' => 'string', + 'required' => true, + 'example' => '1872334****', + ], + ], + [ + 'name' => 'DefaultCountry', + 'in' => 'query', + 'schema' => [ + 'description' => 'Country name, currently only supports: China', + 'type' => 'string', + 'required' => true, + 'example' => '中国', + ], + ], + [ + 'name' => 'AddressType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Verification address type:'."\n" + .'- “0”: Text address'."\n" + .'- “1”: Latitude and longitude', + 'type' => 'string', + 'required' => true, + 'example' => '“0”', + ], + ], + [ + 'name' => 'Longitude', + 'in' => 'query', + 'schema' => [ + 'description' => 'Longitude.', + 'type' => 'string', + 'required' => false, + 'example' => '“121.4737”', + ], + ], + [ + 'name' => 'Latitude', + 'in' => 'query', + 'schema' => [ + 'description' => 'Latitude.', + 'type' => 'string', + 'required' => false, + 'example' => '“31.2304”', + ], + ], + [ + 'name' => 'Text', + 'in' => 'query', + 'schema' => [ + 'description' => 'Detailed address text content', + 'type' => 'string', + 'required' => false, + 'example' => '阿里巴巴西溪园区', + ], + ], + [ + 'name' => 'DefaultProvince', + 'in' => 'query', + 'schema' => [ + 'description' => 'Default province', + 'type' => 'string', + 'required' => false, + 'example' => '浙江省', + ], + ], + [ + 'name' => 'DefaultCity', + 'in' => 'query', + 'schema' => [ + 'description' => 'Default city', + 'type' => 'string', + 'required' => false, + 'example' => '杭州市', + ], + ], + [ + 'name' => 'DefaultDistrict', + 'in' => 'query', + 'schema' => [ + 'description' => 'Default district', + 'type' => 'string', + 'required' => false, + 'example' => '余杭区', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '86C40EC3-5940-5F47-995C-BFE90B70E540', + ], + 'Code' => [ + 'description' => 'Return code.', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => 'Returned result information.', + 'type' => 'object', + 'properties' => [ + 'TransactionId' => [ + 'description' => 'Unique identifier for the authentication request.', + 'type' => 'string', + 'example' => 'hksb7ba1b28130d24e015d69********', + ], + 'Passed' => [ + 'description' => 'Verification result, values:'."\n" + .'- Y: Yes, the verified address distance is less than or equal to 10KM.'."\n" + .'- N: No, the verified address distance is greater than 10KM.', + 'type' => 'string', + 'example' => 'Y', + ], + 'SubCode' => [ + 'description' => 'Authentication result description.', + 'type' => 'string', + 'example' => '200', + ], + 'AddressInfo' => [ + 'description' => 'Address verification details.', + 'type' => 'string', + 'example' => '0-3000', + ], + 'IspName' => [ + 'description' => 'Operator name:'."\n" + .'- CMCC: China Mobile'."\n" + .'- CTCC: China Telecom'."\n" + .'- CUCC: China Unicom', + 'type' => 'string', + 'example' => 'CMCC', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'Cloudauth-intl::2022-08-09::AddressVerifyV2Intl', + ], + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86C40EC3-5940-5F47-995C-BFE90B70E540\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"TransactionId\\": \\"hksb7ba1b28130d24e015d69********\\",\\n \\"Passed\\": \\"Y\\",\\n \\"SubCode\\": \\"200\\",\\n \\"AddressInfo\\": \\"0-3000\\",\\n \\"IspName\\": \\"CMCC\\"\\n }\\n}","type":"json"}]', + 'title' => 'Address Verification', + 'description' => 'Based on the operator\'s capabilities, input the phone number and address (or latitude and longitude) to verify whether the provided address is the user\'s usual residence.', + 'translator' => 'machine', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'cloudauth-intl.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'cloudauth-intl.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'cloudauth-intl.ap-southeast-5.aliyuncs.com', + ], + ], +]; |