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/2019-03-07/api-docs.php | |
| download | acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/cloudauth/2019-03-07/api-docs.php')
| -rw-r--r-- | data/en_us/cloudauth/2019-03-07/api-docs.php | 17276 |
1 files changed, 17276 insertions, 0 deletions
diff --git a/data/en_us/cloudauth/2019-03-07/api-docs.php b/data/en_us/cloudauth/2019-03-07/api-docs.php new file mode 100644 index 0000000..0d1ef0a --- /dev/null +++ b/data/en_us/cloudauth/2019-03-07/api-docs.php @@ -0,0 +1,17276 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Cloudauth', + 'version' => '2019-03-07', + ], + 'directories' => [ + [ + 'id' => 172202, + 'title' => 'Enhanced Real Person Certification', + 'type' => 'directory', + 'children' => [ + 'LivenessFaceVerify', + 'CompareFaceVerify', + 'ContrastFaceVerify', + 'DescribeFaceVerify', + 'InitFaceVerify', + 'DescribeFaceGuardRisk', + 'AIGCFaceVerify', + 'DeleteFaceVerifyResult', + ], + ], + [ + 'id' => 187371, + 'title' => 'information verification', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 322831, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DeepfakeDetect', + ], + ], + [ + 'id' => 322832, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CredentialProductVerifyV2', + 'CredentialVerifyV2', + 'CredentialVerify', + ], + ], + [ + 'id' => 322833, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'BankMetaVerify', + ], + ], + [ + 'id' => 322834, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'MobileRecycledMetaVerify', + 'MobileDetect', + 'Mobile3MetaSimpleVerify', + 'Mobile3MetaDetailVerify', + 'Mobile2MetaVerify', + 'MobileOnlineTime', + 'MobileOnlineStatus', + 'Mobile3MetaSimpleStandardVerify', + 'Mobile3MetaDetailStandardVerify', + ], + ], + [ + 'id' => 322835, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'Id2MetaStandardVerify', + 'Id2MetaVerify', + 'Id2MetaVerifyWithOCR', + 'Id3MetaVerify', + 'Id2MetaPeriodVerify', + 'InitCardVerify', + 'DescribeCardVerify', + 'Id3MetaVerifyWithOCR', + ], + ], + [ + 'id' => 187373, + 'title' => 'vehicle information identification', + 'type' => 'directory', + 'children' => [ + 'VehicleMetaVerifyV2', + 'VehicleMetaVerify', + 'Vehicle5ItemQuery', + 'VehicleQuery', + 'VehicleInsureQuery', + ], + ], + ], + ], + [ + 'id' => 186118, + 'title' => 'Real person certification (stopped selling, documents stopped updating)', + 'type' => 'directory', + 'children' => [ + 'VerifyMaterial', + 'DescribeVerifyToken', + 'DescribeVerifyResult', + 'CompareFaces', + 'DetectFaceAttributes', + ], + ], + [ + 'id' => 172203, + 'title' => 'Other', + 'type' => 'directory', + 'children' => [ + 'DescribePageFaceVerifyData', + 'CreateCloudauthstScene', + 'DeleteCloudauthstScene', + 'DescribeSmartStatisticsPageList', + 'CreateAntCloudAuthScene', + 'UpdateAntCloudAuthScene', + 'DeleteAntCloudAuthScene', + 'RemoveWhiteListSetting', + 'InsertWhiteListSetting', + 'PageQueryWhiteListSetting', + [ + 'id' => 172209, + 'title' => 'AIGC generated image detection', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 59190, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateAuthKey', + 'DescribeOssUploadToken', + ], + ], + [ + 'id' => 59198, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateVerifySetting', + ], + ], + [ + 'id' => 59208, + 'title' => 'SDK', + 'type' => 'directory', + 'children' => [ + 'DescribeVerifySDK', + ], + ], + [ + 'id' => 59215, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ModifyDeviceInfo', + 'DescribeDeviceInfo', + ], + ], + ], + ], + 'DeleteWhitelistSetting', + 'CreateWhitelistSetting', + 'DescribeWhitelistSetting', + 'DescribeAntAndCloudAuthUserStatus', + 'DescribeCloudauthstSceneList', + 'DescribeListAntCloudAuthScenes', + 'DescribeListFaceVerifyData', + 'DescribeListFaceVerifyInfos', + 'DescribeOssStatus', + 'DescribePageSetting', + 'DescribeProductCode', + 'DescribeVerifyDeviceRiskStatistics', + 'DescribeVerifyFailStatistics', + 'DescribeVerifyPersonasDeviceModelStatistics', + 'DescribeVerifyPersonasOsStatistics', + 'DescribeVerifyPersonasProvinceStatistics', + 'DescribeVerifyPersonasSexStatistics', + 'DescribeVerifySearchPageList', + 'DescribeVerifyStatistics', + 'DescribeMetaSearchPageList', + 'DescribeMetaStatisticsList', + 'DescribeMetaStatisticsPageList', + 'QuerySceneConfigs', + 'CreateSceneConfig', + 'UpdateSceneConfig', + 'DeleteSceneConfig', + 'QueryVerifyDownloadTask', + 'DownloadVerifyRecords', + 'QueryVerifyFlowPackage', + 'QueryVerifyInvokeSatistic', + 'QueryCustomizeFlowStrategy', + 'DeleteCustomizeFlowStrategy', + 'DeleteAllCustomizeFlowStrategy', + 'ModifyCustomizeFlowStrategyList', + 'ModifyControlStrategy', + 'QueryControlStrategy', + 'DeleteControlStrategy', + 'ModifyBlackListStrategy', + 'QueryBlackListStrategy', + 'DeleteBlackListStrategy', + 'DescribeInfoCheckExportRecord', + 'DescribeOssStatusV2', + 'DescribeAuthVerify', + 'InitAuthVerify', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'LivenessFaceVerify' => [ + 'summary' => 'Silent Liveness Face (LivenessFaceVerify) refers to a service that performs real face detection by inputting pre-obtained face images through an API. The algorithm primarily identifies whether the face is from a screen recording, printed picture, or other types of liveness attacks. This service is suitable for low-risk business scenarios or in conjunction with offline facial recognition SDKs. If your business has higher requirements for real face security, it is recommended to integrate App or WebSDK mode, or integrate with Deepfake face detection services to assist in identifying more dimensions of face forgery risks.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '59165', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Authentication scenario ID. This ID is automatically generated after creating an authentication scenario in the console.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => ' '."\n" + .'100000****', + ], + ], + [ + 'name' => 'OuterOrderNo', + 'in' => 'formData', + 'schema' => [ + 'description' => 'A unique business identifier defined by the client side, used for subsequent troubleshooting. The value should be a combination of letters and numbers up to 32 characters long, ensuring uniqueness.', + 'type' => 'string', + 'required' => false, + 'example' => 'e0c34a77f5ac40a5aa5e6ed20c353888', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Fixed value: LR_FR_MIN.', + 'type' => 'string', + 'required' => false, + 'example' => 'LR_FR_MIN', + ], + ], + [ + 'name' => 'FaceContrastPicture', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Base64 encoded photo.', + 'type' => 'string', + 'required' => false, + 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx', + ], + ], + [ + 'name' => 'DeviceToken', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Device token, used for risk identification.', + 'type' => 'string', + 'required' => false, + 'example' => ' '."\n" + .'McozS1ZWRcRZStlERcZZo_QOytx5jcgZoZJEoRLOxxxxxxx', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'formData', + 'schema' => [ + 'description' => 'User\'s mobile phone number.', + 'type' => 'string', + 'required' => false, + 'example' => '130xxxxxxxx', + ], + ], + [ + 'name' => 'Ip', + 'in' => 'formData', + 'schema' => [ + 'description' => 'User\'s network IP address.', + 'type' => 'string', + 'required' => false, + 'example' => '114.xxx.xxx.xxx', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Your custom user ID (up to 100 characters), please ensure it is unique.', + 'type' => 'string', + 'required' => false, + 'example' => '123456789', + ], + ], + [ + 'name' => 'FaceContrastPictureUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Image URL.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://ware.cdeledu.com/upfile/uploadPic/2025/03/21/dd62fbb9c966433ab0ba9a7252816b30.jpg', + ], + ], + [ + 'name' => 'CertifyId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Unique identifier for real-person authentication.', + 'type' => 'string', + 'required' => false, + 'example' => '91707dc296d469ad38e4c5efa6a0f24b', + ], + ], + [ + 'name' => 'OssBucketName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Authorized OSS bucket name.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai-aliyun-cloudauth-1494517779820665', + ], + ], + [ + 'name' => 'OssObjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Authorized OSS file name.', + 'type' => 'string', + 'required' => false, + 'example' => 'facedetect/17483113370916034.jpg', + ], + ], + [ + 'name' => 'Model', + 'in' => 'query', + 'schema' => [ + 'description' => 'Liveness detection parameters.', + 'type' => 'string', + 'required' => false, + 'example' => 'FRONT_CAMERA_LIVENESS', + ], + ], + [ + 'name' => 'Crop', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Whether to allow cropping of the face image:'."\n" + ."\n" + .'- T: Allow cropping'."\n" + ."\n" + .'- F (default): Do not allow cropping.', + 'type' => 'string', + 'required' => false, + 'example' => 'T', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'Return code, **200** indicates successful API response.', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => 'ID of this request.', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'ResultObject' => [ + 'description' => 'Return result.', + 'type' => 'object', + 'properties' => [ + 'CertifyId' => [ + 'description' => 'Unique identifier for the real-person authentication request.', + 'type' => 'string', + 'example' => '91707dc296d469ad38e4c5efa6a0f24b', + ], + 'SubCode' => [ + 'description' => 'Authentication result code.', + 'type' => 'string', + 'example' => '200', + ], + 'MaterialInfo' => [ + 'description' => 'Attachment information of the face authentication subject, including data such as face quality, face attack, face or OCR image, and intent verification.', + 'type' => 'string', + 'example' => '{"faceAttack": "F","facialPictureFront": {"qualityScore": 88.3615493774414,"verifyScore": 50.28594166529785}}', + ], + 'Passed' => [ + 'description' => 'Authentication result, values:'."\n" + ."\n" + .'- T: Passed'."\n" + ."\n" + .'- F: Not passed', + 'type' => 'string', + 'example' => 'T', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"ResultObject\\": {\\n \\"CertifyId\\": \\"91707dc296d469ad38e4c5efa6a0f24b\\",\\n \\"SubCode\\": \\"200\\",\\n \\"MaterialInfo\\": \\"{\\\\\\"faceAttack\\\\\\": \\\\\\"F\\\\\\",\\\\\\"facialPictureFront\\\\\\": {\\\\\\"qualityScore\\\\\\": 88.3615493774414,\\\\\\"verifyScore\\\\\\": 50.28594166529785}}\\",\\n \\"Passed\\": \\"T\\"\\n }\\n}","type":"json"}]', + 'title' => 'Silent Liveness Face Detection', + 'description' => 'Invoke the LivenessFaceVerify interface to perform liveness detection on a face image.', + 'translator' => 'machine', + ], + 'CompareFaceVerify' => [ + 'summary' => 'Financial-grade Pure Server-Side API for Face Comparison.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '59095', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Authentication scenario ID.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000000006', + ], + ], + [ + 'name' => 'OuterOrderNo', + 'in' => 'formData', + 'schema' => [ + 'description' => 'A unique identifier for the merchant\'s request. The value is a 32-character alphanumeric combination, where the first few characters are a custom abbreviation defined by the merchant, followed by a period, and the latter part can be a random or incrementing sequence.', + 'type' => 'string', + 'required' => false, + 'example' => 'e0c34a77f5ac40a5aa5e6ed20c353888', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Fixed value: PV_FC.', + 'type' => 'string', + 'required' => false, + 'example' => 'PV_FC', + ], + ], + [ + 'name' => 'SourceFaceContrastPicture', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Base64 encoding of the photo.'."\n" + .'> Choose one of the four ways to input a face photo: FaceContrastPicture, FaceContrastPictureUrl, CertifyId, or OSS.', + 'type' => 'string', + 'required' => false, + 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx', + 'maxLength' => 1048676, + ], + ], + [ + 'name' => 'SourceFaceContrastPictureUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => 'OSS photo URL, currently only supports authorized OSS photo URLs.'."\n" + .'> Four ways to input face photos: FaceContrastPicture, FaceContrastPictureUrl, CertifyId, and OSS. Choose one of them to input.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg', + ], + ], + [ + 'name' => 'SourceCertifyId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The CertifyId of a previously successful real-person verification, where the photo taken during that verification is used as the face comparison photo.'."\n" + .'> Among the four ways to input facial photos (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, OSS), choose one to provide.', + 'type' => 'string', + 'required' => false, + 'example' => '0bfa7c493f850e5178b9f8613634c9xx', + ], + ], + [ + 'name' => 'SourceOssBucketName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Name of the authorized OSS bucket.'."\n" + .'> Choose one of the four ways to input face photos: FaceContrastPicture, FaceContrastPictureUrl, CertifyId, or OSS.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai-aliyun-cloudauth-xxxxx', + ], + ], + [ + 'name' => 'SourceOssObjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Filename of the authorized OSS space.'."\n" + .'> Choose one of the four ways to input face photos: FaceContrastPicture, FaceContrastPictureUrl, CertifyId, or OSS.', + 'type' => 'string', + 'required' => false, + 'example' => 'verify/xxxxx/xxxxxx.jpeg', + ], + ], + [ + 'name' => 'TargetFaceContrastPicture', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Base64 encoding of the reference photo.'."\n" + ."\n" + .'> Choose one of the four methods to provide the reference face photo: FaceContrastPicture, FaceContrastPictureUrl, CertifyId, or OSS.', + 'type' => 'string', + 'required' => false, + 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx', + 'maxLength' => 1048676, + ], + ], + [ + 'name' => 'TargetFaceContrastPictureUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => 'OSS address of the reference photo. Currently, only authorized OSS addresses are supported.'."\n" + ."\n" + .'> Choose one of the four methods to provide the reference face photo: FaceContrastPicture, FaceContrastPictureUrl, CertifyId, or OSS.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg', + ], + ], + [ + 'name' => 'TargetCertifyId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'CertifyId from a previously successful real-person authentication, where the photo taken during the authentication is used for face comparison.'."\n" + ."\n" + .'> Choose one of the four methods to provide the reference face photo: FaceContrastPicture, FaceContrastPictureUrl, CertifyId, or OSS.', + 'type' => 'string', + 'required' => false, + 'example' => '0bfa7c493f850e5178b9f8613634c9xx', + ], + ], + [ + 'name' => 'TargetOssBucketName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Name of the authorized OSS bucket.'."\n" + ."\n" + .'> Choose one of the four methods to provide the reference face photo: FaceContrastPicture, FaceContrastPictureUrl, CertifyId, or OSS.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai-aliyun-cloudauth-xxxxx', + ], + ], + [ + 'name' => 'TargetOssObjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'File name in the authorized OSS space.'."\n" + ."\n" + .'> Choose one of the four methods to provide the reference face photo: FaceContrastPicture, FaceContrastPictureUrl, CertifyId, or OSS.', + 'type' => 'string', + 'required' => false, + 'example' => 'verify/xxxxx/xxxxxx.jpeg', + ], + ], + [ + 'name' => 'Crop', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Whether cropping is allowed. Default is not allowed, T/F.'."\n" + ."\n" + .'- T: Indicates that cropping is required'."\n" + .'- F: Indicates that cropping is not required (default F)', + 'type' => 'string', + 'required' => false, + 'example' => 'T', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'Return code: 200 for success, other values indicate failure.', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '130A2C10-B9EE-4D84-88E3-5384FF039795', + ], + 'ResultObject' => [ + 'description' => 'Face comparison result information.', + 'type' => 'object', + 'properties' => [ + 'CertifyId' => [ + 'description' => 'Unique identifier for the real-person authentication request.', + 'type' => 'string', + 'example' => '08573be80f944d95ac812e019e3655a8', + ], + 'VerifyScore' => [ + 'description' => 'Face comparison score.', + 'type' => 'number', + 'format' => 'float', + 'example' => '99.60875', + ], + 'Passed' => [ + 'description' => 'Whether the verification passed, T for pass, F for fail.', + 'type' => 'string', + 'example' => 'T', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"130A2C10-B9EE-4D84-88E3-5384FF039795\\",\\n \\"ResultObject\\": {\\n \\"CertifyId\\": \\"08573be80f944d95ac812e019e3655a8\\",\\n \\"VerifyScore\\": 99.60875,\\n \\"Passed\\": \\"T\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'Pure Server-Side API for Face Comparison Solution', + 'description' => '- API Name: CompareFaceVerify.'."\n" + .'- Service Address: cloudauth.aliyuncs.com.'."\n" + .'- Request Method: HTTPS POST and GET.'."\n" + .'- API Description: An interface to achieve real-person authentication through server-side integration.'."\n" + ."\n" + .'#### Photo Format Requirements'."\n" + .'When performing face comparison, please upload 2 facial photos that meet all the following conditions:'."\n" + ."\n" + .'- Recent photo/recent database photo, with a complete, clear, unobstructed face, natural expression, and facing the camera directly.'."\n" + .'- Clear photo with normal exposure, no overly dark, overly bright, or halo effects on the face, and no significant angle deviation.'."\n" + .'- Resolution not exceeding 1920*1080, at least 640*480, recommended to scale the shorter side to 720 pixels, with a compression ratio greater than 0.9.'."\n" + .'- Photo size: <1MB.'."\n" + .'- Supports 90, 180, and 270-degree photos; in cases of multiple faces, the largest face will be selected.', + 'requestParamsDescription' => '> Parameters starting with Source represent the parameters for the recent facial photo you are uploading, while parameters starting with Target represent the parameters for the recent database facial photo. For photo format requirements, please refer to [Photo Format Requirements](#photo-format-requirements).'."\n" + .'If you choose to upload facial photos via OSS, you must provide both OssBucketName and OssObjectName fields. The OSS parameter format only supports URLs, Buckets, and file names generated from an authorized OSS when enabling real-person authentication. For how to check authorized OSS, see [Enable OSS Space and Authorization](https://help.aliyun.com/document_detail/163532.html?spm=a2c4g.11186623.2.15.36945bc3y5uWz6#title-409-lcd-pp0) .'."\n" + .'If you choose to upload facial photos via FaceContrastPicture (Base64 encoded photo), please ensure the photo size is not too large; you can use the OSS method to upload larger facial photos.', + 'responseParamsDescription' => '返回值示例：'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "Code": "200",'."\n" + .' "Message": "success",'."\n" + .' "RequestId": "23699272-B263-4B6C-BC04-0EBA1AB6F6D5",'."\n" + .' "ResultObject": {'."\n" + .' "Passed": "T",'."\n" + .' "VerifyScore": 99.60875'."\n" + .' }'."\n" + .'}'."\n" + .'```', + 'extraInfo' => ' ## 返回码'."\n" + ."\n" + .'|返回码|返回信息|描述|'."\n" + .'|----|-------|--|'."\n" + .'|200|success|成功。|'."\n" + .'|400|参数不能为空|参数不能为空。|'."\n" + .'|401|参数非法|非法参数。传入的姓名、身份证号码长度必须符合国家标准且不得包含英文字母等特殊字符。|'."\n" + .'|402|应用配置不存在|应用配置不存在。|'."\n" + .'|404|认证场景配置不存在|认证场景配置不存在，请先在控制台上创建认证场景。|'."\n" + .'|410|未开通服务|未开通OSS产品或未完成OSS读写授权，请登录控制台完成授权。|'."\n" + .'|411|RAM 无权限|需要给子账号授予AliyunAntCloudAuthFullAccess的操作权限。|'."\n" + .'|412|欠费中|金融级实人认证或OSS存在欠费，请充值后操作。|'."\n" + .'|419|传入图片不可用|图片无法下载、图片内容为空、图片分辨率不符合要求或提取不到人脸特征，建议更换图片。|'."\n" + .'|420|数据重复|图片传入方式超过2种。<ul> <li> FaceContrastPicture</li> <li> FaceContrastPictureUrl </li><li> Oss</li> <li> CertifyId</li><ul>|'."\n" + .'|421|传入图片过大|图片超过了1 MB，建议压缩图片或更换图片上传方式。|'."\n" + .'|422|下载图片超时|图片下载超过了3秒，请排查网络后重新操作。|'."\n" + .'|423|状态错误|传入的certifyID认证状态需要为T，您也可以更换其他方式传入图片。|'."\n" + .'|500|系统错误|系统内部错误，请联系工程师排查。|'."\n" + ."\n\n" + ."\n\n", + 'translator' => 'machine', + ], + 'ContrastFaceVerify' => [ + 'summary' => 'This interface is used to submit authentication materials for verification and comparison, and it synchronously returns the authentication result.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '59096', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Authentication scenario ID.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000000006', + ], + ], + [ + 'name' => 'OuterOrderNo', + 'in' => 'formData', + 'schema' => [ + 'description' => 'A unique identifier for the merchant\'s request. It is a 32-character alphanumeric combination. The first few characters are a custom abbreviation defined by the merchant, followed by a period, and the latter part can be a random or incrementing sequence.', + 'type' => 'string', + 'required' => false, + 'example' => 'e0c34a77f5ac40a5aa5e6ed20c353888', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Fixed value: ID_MIN.', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_MIN', + ], + ], + [ + 'name' => 'CertType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Type of identification. Currently, only IDENTITY_CARD is supported and must be provided.', + 'type' => 'string', + 'required' => false, + 'example' => 'IDENTITY_CARD', + ], + ], + [ + 'name' => 'CertName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Real name.', + 'type' => 'string', + 'required' => false, + 'example' => '张三', + ], + ], + [ + 'name' => 'CertNo', + 'in' => 'formData', + 'schema' => [ + 'description' => 'ID number', + 'type' => 'string', + 'required' => false, + 'example' => '330103xxxxxxxxxxxx', + ], + ], + [ + 'name' => 'FaceContrastPicture', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Base64 encoded photo', + 'type' => 'string', + 'required' => false, + 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx', + ], + ], + [ + 'name' => 'DeviceToken', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Risk Identification - Device Token', + 'type' => 'string', + 'required' => false, + 'example' => 'McozS1ZWRcRZStlERcZZo_QOytx5jcgZoZJEoRLOxxxxxxx', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'formData', + 'schema' => [ + 'description' => 'User\'s phone number.', + 'type' => 'string', + 'required' => false, + 'example' => '130xxxxxxxx', + ], + ], + [ + 'name' => 'Ip', + 'in' => 'formData', + 'schema' => [ + 'description' => 'User IP.', + 'type' => 'string', + 'required' => false, + 'example' => '114.xxx.xxx.xxx', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Custom user ID defined by the customer\'s business.', + 'type' => 'string', + 'required' => false, + 'example' => '123456789', + ], + ], + [ + 'name' => 'FaceContrastPictureUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => 'OSS photo URL, currently only supports authorized OSS photo URLs.'."\n" + .'> Among the four ways to input images (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, OSS), choose one to input.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg', + ], + ], + [ + 'name' => 'CertifyId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The CertifyId of a previously passed real-person authentication, with the photo taken during that authentication used as the comparison photo. '."\n" + .'> Among the four ways to input images (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, OSS), choose one to provide.', + 'type' => 'string', + 'required' => false, + 'example' => '0bfa7c493f850e5178b9f8613634c9xx', + ], + ], + [ + 'name' => 'OssBucketName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Authorized OSS space Bucket name. In the methods of passing images, including FaceContrastPicture, FaceContrastPictureUrl, CertifyId, and OSS, choose one to pass in.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai-aliyun-cloudauth-xxxxx', + ], + ], + [ + 'name' => 'OssObjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Filename of the authorized OSS space.'."\n" + .'> Among the four ways to input images (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, OSS), choose one to input.', + 'type' => 'string', + 'required' => false, + 'example' => 'verify/xxxxx/xxxxxx.jpeg', + ], + ], + [ + 'name' => 'Model', + 'in' => 'query', + 'schema' => [ + 'description' => 'Liveness detection type. Possible values:'."\n" + ."\n" + .'• **NO_LIVENESS** – Liveness detection is disabled.'."\n" + ."\n" + .'• **FRONT_CAMERA_LIVENESS** (default) – Liveness detection on face images captured with the mobile device’s front camera.'."\n" + ."\n" + .'• **REAR_CAMERA_LIVENESS** – Liveness detection on face images captured in other scenarios (e.g., via the rear camera).', + 'type' => 'string', + 'required' => false, + 'example' => 'FRONT_CAMERA_LIVENESS', + ], + ], + [ + 'name' => 'FaceContrastFile', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Local video file.', + 'type' => 'string', + 'required' => false, + 'example' => '-', + 'isFileTransferUrl' => true, + ], + ], + [ + 'name' => 'Crop', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Allow face image cropping:'."\n" + ."\n" + .'- **T** – Cropping is allowed.'."\n" + .'- **F** (default) – Cropping is not allowed.', + 'type' => 'string', + 'required' => false, + 'example' => 'T', + ], + ], + [ + 'name' => 'EncryptType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Encryption type. Leave it empty if no encryption is required.'."\n" + ."\n" + .'If you enable encrypted transmission, you must specify the encryption algorithm; currently, only the SM2 (Chinese national standard) algorithm is supported.'."\n" + ."\n" + .'When an encryption algorithm is specified, encrypt both **CertName** and **CertNo** and submit the resulting ciphertext. For more details on parameter encryption, see the [Parameter Encryption documentation](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/description-of-parameter-encryption?spm=a2c4g.11186623.0.0.49541a8554cELI#task-2229332).', + 'type' => 'string', + 'required' => false, + 'example' => 'SM2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'Return code: 200 for success, others for failure.', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '130A2C10-B9EE-4D84-88E3-5384FF039795', + ], + 'ResultObject' => [ + 'description' => 'Request result', + 'type' => 'object', + 'properties' => [ + 'CertifyId' => [ + 'description' => 'Unique identifier for the real-person verification request.', + 'type' => 'string', + 'example' => '91707dc296d469ad38e4c5efa6a0****', + ], + 'SubCode' => [ + 'description' => 'Description of the authentication result. For details, see the SubCode explanation below.', + 'type' => 'string', + 'example' => '200', + ], + 'MaterialInfo' => [ + 'description' => 'Attachment information of the authenticated entity, mainly image materials, in JSON format, as follows.', + 'type' => 'string', + 'example' => '{"faceAttack": "F","facialPictureFront": {"qualityScore": 88.3615493774414,"verifyScore": 50.28594166529785}}', + ], + 'IdentityInfo' => [ + 'description' => 'Information about the authenticated entity, which is usually empty in general authentication scenarios.', + 'type' => 'string', + 'example' => 'null', + ], + 'Passed' => [ + 'description' => 'Whether it passed, T for pass, F for fail.', + 'type' => 'string', + 'example' => 'T', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"130A2C10-B9EE-4D84-88E3-5384FF039795\\",\\n \\"ResultObject\\": {\\n \\"CertifyId\\": \\"91707dc296d469ad38e4c5efa6a0****\\",\\n \\"SubCode\\": \\"200\\",\\n \\"MaterialInfo\\": \\"{\\\\\\"faceAttack\\\\\\": \\\\\\"F\\\\\\",\\\\\\"facialPictureFront\\\\\\": {\\\\\\"qualityScore\\\\\\": 88.3615493774414,\\\\\\"verifyScore\\\\\\": 50.28594166529785}}\\",\\n \\"IdentityInfo\\": \\"null\\",\\n \\"Passed\\": \\"T\\"\\n }\\n}","type":"json"}]', + 'title' => 'Pure Server-Side API for Real Person Authentication', + 'description' => '- Interface Name: ContrastFaceVerify.'."\n" + .'- Service Address: cloudauth.aliyuncs.com.'."\n" + .'- Request Method: HTTPS POST and GET.'."\n" + .'- Interface Description: An interface for real person authentication through server-side integration.'."\n" + ."\n" + .'#### Image Format Requirements'."\n" + .'When performing real person authentication, please ensure that the images you upload meet all of the following conditions:'."\n" + ."\n" + .'- Recent photo with a clear, unobstructed, and natural expression, facing the camera directly.'."\n" + .'- Clear and properly exposed photo, without overly dark, bright, or haloed faces, and with minimal angle deviation.'."\n" + .'- Resolution not exceeding 1920*1080, at least 640*480, with the shorter side recommended to be resized to 720 pixels, and a compression ratio greater than 0.9.'."\n" + .'- Photo size: <1MB.'."\n" + .'- Supports 90, 180, and 270-degree photos; in cases of multiple faces, the largest face will be selected.'."\n", + 'requestParamsDescription' => '> If you choose to upload the face image via OSS, you must provide the OssBucketName and OssObjectName fields. The OSS input parameter format only supports URLs, Buckets, and file names generated from an authorized OSS when the real person authentication service was activated.'."\n" + .'If you choose to upload the face image using FaceContrastPicture (Base64 encoded photo), please check the photo size and avoid uploading excessively large photos; you can use the OSS method to upload larger face images.', + 'responseParamsDescription' => 'ResultObject.MaterialInfo的JSON格式示例：'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' // 是否为攻击：攻击为T，非攻击为F'."\n" + .' "faceAttack": "F",'."\n" + .' "facialPictureFront": {'."\n" + .' // 活体人脸质量分数'."\n" + .' "qualityScore": 88.3615493774414,'."\n" + .' // 人脸比对分数'."\n" + .' "verifyScore": 50.28594166529785'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n", + 'extraInfo' => '## 返回码'."\n" + ."\n" + .'|返回码|返回信息|描述|'."\n" + .' |----|-------|--|'."\n" + .' |200|success|成功。|'."\n" + .' |400|参数不能为空|参数不能为空。|'."\n" + .' |401|参数非法|非法参数。传入的姓名、身份证号码长度必须符合国家标准且不得包含英文字母等特殊字符。|'."\n" + .' |402|应用配置不存在|应用配置不存在。|'."\n" + .' |404|认证场景配置不存在|认证场景配置不存在，请先在控制台上创建认证场景。|'."\n" + .' |405|您的年龄未满14周岁，不允许使用此产品|未满14周岁的用户无法使用本产品，建议人工审核。|'."\n" + .' |410|未开通服务|未开通OSS产品或未完成OSS读写授权，请登录控制台完成授权。|'."\n" + .' |411|RAM无权限|需要给子账号授予 AliyunAntCloudAuthFullAccess 的操作权限。|'."\n" + .' |412|欠费中|金融级实人认证或OSS存在欠费，请充值后操作。|'."\n" + .' |417|无法使用刷脸服务|当前身份信息比对源不可用。若信息正确，建议人工审核。|'."\n" + .' |418|刷脸失败次数过多|当天刷脸认证次数过多，请明天再试。|'."\n" + .' |419|传入图片不可用|图片无法下载、图片内容为空、图片分辨率不符合要求或提取不到人脸特征，建议更换图片。|'."\n" + .' |420|数据重复|图片传入方式超过1种。<ul> <li> FaceContrastPicture</li> <li> FaceContrastPictureUrl </li><li> Oss</li> <li> CertifyId</li><ul>|'."\n" + .' |421|传入图片过大|图片超过了1 MB，建议压缩图片或更换图片上传方式。|'."\n" + .'|422|下载图片超时|图片下载超过了3秒，请排查网络后重新操作。|'."\n" + .'|423|状态错误|传入的certifyID认证状态需要为T，您也可以更换其他方式传入图片。|'."\n" + .'|500|系统错误|系统内部错误，请反馈工程师排查。|'."\n" + ."\n\n" + .'ResultObject.SubCode说明：'."\n" + ."\n" + .'|错误码|认证描述文案|是否计费|可能原因和运营建议|'."\n" + .'|---|------|----|---------|'."\n" + .'|200|认证通过|是| |'."\n" + .'|201|姓名和身份证不一致|是|可能用户的信息有误或假信息，建议用户确认后重新操作。|'."\n" + .'|202|查询不到身份信息|是|可能是用户户口迁移、军人等特殊状态导致，建议预留人工审核入口，进行人工审核。|'."\n" + .'|203|查询不到照片或照片不可用|是|可能是公安库数据问题导致，建议预留人工审核入口，进行人工审核。|'."\n" + .'|204|人脸比对不一致|是|可能不是同一人或活体照片质量较低，建议根据业务情况分层处理，若为同一人可重新操作。|'."\n" + .'|205|活体检测存在风险|是|可能存在攻击风险，建议人工审核分层处理，若为真人可重新操作。|'."\n" + .'|206|业务策略限制|是|可能存在异常风险操作，建议人工确认后操作。|', + 'translator' => 'machine', + ], + 'DescribeFaceVerify' => [ + 'summary' => 'After the mobile end of the integrator receives the callback, its server can call this interface to obtain the corresponding authentication status and authentication information.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59117', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Authentication scene ID.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000000006', + ], + ], + [ + 'name' => 'CertifyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Unique identifier for real-person authentication.', + 'type' => 'string', + 'required' => false, + 'example' => '91707dc296d469ad38e4c5efa6a0f24b', + ], + ], + [ + 'name' => 'PictureReturnType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Image return type.', + 'type' => 'string', + 'required' => false, + 'example' => 'JPG', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'Return code: 200 indicates success, other values indicate failure.', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Error message', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '130A2C10-B9EE-4D84-88E3-5384FF039795', + ], + 'ResultObject' => [ + 'description' => 'Returned result information', + 'type' => 'object', + 'properties' => [ + 'SubCode' => [ + 'description' => 'Description of the authentication result. For details, see the SubCode explanation below.', + 'type' => 'string', + 'example' => '200', + ], + 'MaterialInfo' => [ + 'description' => 'Attachment information of the authenticated subject, mainly image materials. JSON format, see example below.', + 'type' => 'string', + 'example' => '{"faceAttack": "F","facialPictureFront": {"qualityScore": 88.3615493774414,"pictureUrl": "https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg","ossBucketName": "cn-shanghai-aliyun-cloudauth-1260051251634779","ossObjectName": "verify/1260051251634779/6ba7bcfccf33f56cdb44ed086f36ce3e0.jpeg"}}', + ], + 'IdentityInfo' => [ + 'description' => 'Information about the authenticated subject, usually empty in general authentication scenarios.', + 'type' => 'string', + 'example' => 'null', + ], + 'DeviceToken' => [ + 'description' => 'Device token.', + 'type' => 'string', + 'example' => 'McozS1ZWRcRZStlERcZZo_QOytx5jcgZoZJEoRLOxxxxxxx', + ], + 'Passed' => [ + 'description' => 'Whether it passed, T for pass, F for fail.', + 'type' => 'string', + 'example' => 'T', + ], + 'DeviceRisk' => [ + 'description' => 'Device risk label.', + 'type' => 'string', + 'example' => 'ROOT,VPN,HOOK', + ], + 'Success' => [ + 'description' => 'Whether the response was successful.', + 'type' => 'string', + 'example' => 'True', + ], + 'UserInfo' => [ + 'description' => 'Records the identity information and corresponding encoding entered by the user under the rare character mode. The returned data is a JSON formatted string, which will be an empty string if there are no rare characters in the name.'."\n" + ."\n" + .'- name: Refers to the name entered by the user.'."\n" + ."\n" + .'- verifyName: Refers to the final name encoding after verification. For example, if a rare character is verified through transcoding: “Mr. Wang”, the actual verified name is “Wang Xiansheng”.'."\n" + ."\n" + .'- number: Refers to the identification number entered by the user.', + 'type' => 'string', + 'example' => '{'."\n" + .' "number": "610***********1110",'."\n" + .' "name": "王先生",'."\n" + .' "verifyName": "王先"'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"130A2C10-B9EE-4D84-88E3-5384FF039795\\",\\n \\"ResultObject\\": {\\n \\"SubCode\\": \\"200\\",\\n \\"MaterialInfo\\": \\"{\\\\\\"faceAttack\\\\\\": \\\\\\"F\\\\\\",\\\\\\"facialPictureFront\\\\\\": {\\\\\\"qualityScore\\\\\\": 88.3615493774414,\\\\\\"pictureUrl\\\\\\": \\\\\\"https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg\\\\\\",\\\\\\"ossBucketName\\\\\\": \\\\\\"cn-shanghai-aliyun-cloudauth-1260051251634779\\\\\\",\\\\\\"ossObjectName\\\\\\": \\\\\\"verify/1260051251634779/6ba7bcfccf33f56cdb44ed086f36ce3e0.jpeg\\\\\\"}}\\",\\n \\"IdentityInfo\\": \\"null\\",\\n \\"DeviceToken\\": \\"McozS1ZWRcRZStlERcZZo_QOytx5jcgZoZJEoRLOxxxxxxx\\",\\n \\"Passed\\": \\"T\\",\\n \\"DeviceRisk\\": \\"ROOT,VPN,HOOK\\",\\n \\"Success\\": \\"True\\",\\n \\"UserInfo\\": \\"{\\\\n \\\\\\"number\\\\\\": \\\\\\"610***********1110\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"王先生\\\\\\",\\\\n \\\\\\"verifyName\\\\\\": \\\\\\"王先\\\\\\"\\\\n}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<ResultObject>\\n <Passed>T</Passed>\\n <DeviceToken>McozS1ZWRcRZStlERcZZo_QOytx5jcgZoZJEoRLOxxxxxxx</DeviceToken>\\n <IdentityInfo>null</IdentityInfo>\\n <MaterialInfo>{\\"faceAttack\\": \\"F\\",\\"facialPictureFront\\": {\\"qualityScore\\": 88.3615493774414,\\"pictureUrl\\": \\"https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg\\",\\"ossBucketName\\": \\"cn-shanghai-aliyun-cloudauth-1260051251634779\\",\\"ossObjectName\\": \\"verify/1260051251634779/6ba7bcfccf33f56cdb44ed086f36ce3e0.jpeg\\"}}</MaterialInfo>\\n <SubCode>200</SubCode>\\n</ResultObject>\\n<RequestId>130A2C10-B9EE-4D84-88E3-5384FF039795</RequestId>\\n<Message>success</Message>\\n<Code>200</Code>","errorExample":""}]', + 'title' => 'Query Authentication Details Interface', + 'description' => '- Service Address: cloudauth.aliyuncs.com.'."\n" + .'- Request Method: HTTPS POST and GET.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '> Determine the authentication result based on the ResultObject.Passed or ResultObject.SubCode field.'."\n" + ."\n" + .'#### Example JSON format of ResultObject.MaterialInfo'."\n" + .'- APP Authentication Solution & Live Face Verification Solution'."\n" + ."\n" + .' ```'."\n" + .'{'."\n" + .' // Whether it is an attack: T indicates an attack, F indicates no attack'."\n" + .' "faceAttack": "F", '."\n" + .' // Information of the authenticated photo'."\n" + .' "facialPictureFront": {'."\n" + .' // Live face quality score'."\n" + .' "qualityScore": 88.3615493774414,'."\n" + .' // Face comparison score'."\n" + .' "verifyScore": 50.28594166529785,'."\n" + .' // Photo HTTPS URL, valid for 15 minutes starting from the query time '."\n" + .' "pictureUrl": "https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg",'."\n" + .' // The photo is stored in the customer\'s OSS in the Shanghai region; this is the bucket name'."\n" + .' "ossBucketName": "cn-shanghai-aliyun-cloudauth-1260051251634779",'."\n" + .' // The photo is stored in the customer\'s OSS in the Shanghai region; this is the file name'."\n" + .' "ossObjectName": "verify/1260051251634779/6ba7bcfccf33f56cdb44ed086f36ce3e0.jpeg" '."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- Live Detection Solution'."\n" + ."\n" + .' ```'."\n" + .' {'."\n" + .' // Whether it is an attack: T indicates an attack, F indicates no attack'."\n" + .' "faceAttack": "F", '."\n" + .' // Information of the authenticated photo'."\n" + .' "facialPictureFront": {'."\n" + .' // Live face quality score'."\n" + .' "qualityScore": 88.3615493774414,'."\n" + .' // Photo HTTPS URL, valid for 15 minutes starting from the query time '."\n" + .' "pictureUrl": "https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg",'."\n" + .' // The photo is stored in the customer\'s OSS in the Shanghai region; this is the bucket name'."\n" + .' "ossBucketName": "cn-shanghai-aliyun-cloudauth-1260051251634779",'."\n" + .' // The photo is stored in the customer\'s OSS in the Shanghai region; this is the file name'."\n" + .' "ossObjectName": "verify/1260051251634779/6ba7bcfccf33f56cdb44ed086f36ce3e0.jpeg" '."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n\n" + ."\n" + .'#### Description of ResultObject.SubCode'."\n" + ."\n\n" + .'|Error Code|Authentication Description| Billing |Possible Causes & Operational Suggestions|'."\n" + .'|---|------|----|---------|'."\n" + .' |200|Authentication passed|Yes| |'."\n" + .'|201|Name and ID card do not match|Yes|The user\'s information may be incorrect or false. Advise the user to verify and try again.|'."\n" + .'|202|Unable to find identity information|Yes|The user\'s household registration transfer, military status or other special situations may cause this. Suggest providing a manual review path.|'."\n" + .'|203|Unable to find photo or photo unavailable|Yes|Possible issue with public security database data. Suggest providing manual review.|'."\n" + .'|204|Face comparison mismatch|Yes|May not be the same person or live photo quality is low. Layered handling based on business scenario; if it is the same person, they can try again.|'."\n" + .'|205|Risk detected in live detection|Yes|Possible attack risk. Suggest layered manual review; if it is a real person they can retry.'."\n" + .'|206|Business policy restricted|Yes|Possible abnormal risky operation. Advise manual confirmation before proceeding.|', + 'extraInfo' => '## Result Codes'."\n" + ."\n" + .'|Code|Message| Description |'."\n" + .'|----|-------|--|'."\n" + .'|200|success|Success.|'."\n" + .'|400|Parameter cannot be null| The parameter cannot be null.|'."\n" + .'|401|Invalid parameter|Illegal parameter. The length of the name and ID number must comply with national standards and must not contain letters or other special characters.|'."\n" + .'|403|Authentication not completed|Authentication not completed.'."\n" + .'|404|Authentication scenario configuration does not exist|The authentication scenario configuration does not exist. Please create the authentication scenario in the console first.'."\n" + .'|406| Invalid certifyId|Invalid certifyId.|'."\n" + .'|410|Service not enabled|The OSS product has not been enabled or OSS read/write authorization has not been completed.|'."\n" + .'|411|No RAM permission|Grant the sub-account the AliyunAntCloudAuthFullAccess permission.|'."\n" + .'|424|Identity authentication record does not exist|The specified certifyId has no corresponding identity authentication submission record.'."\n" + .'|500|System error|Internal system error.|', + 'translator' => 'machine', + ], + 'InitFaceVerify' => [ + 'summary' => 'Real-Person Server Initialization Interface', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '59164', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthGDLZVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Authentication Scene ID.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000000006', + ], + ], + [ + 'name' => 'OuterOrderNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'Unique identifier for the merchant\'s request.'."\n" + ."\n" + .'The value is a 32-character alphanumeric combination. The first few characters are a custom abbreviation defined by the merchant, followed by a period, and the latter part can be a random or incremental sequence.', + 'type' => 'string', + 'required' => false, + 'example' => 'e0c34a77f5ac40a5aa5e6ed20c353888', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Fixed value. The parameter value differs based on the product solution:'."\n" + .'- APP Authentication Scheme: Fixed value is ID_PRO'."\n" + .'- Live Face Verification Scheme: Fixed value is PV_FV'."\n" + .'- Liveness Detection Scheme: Fixed value is LR_FR', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_PRO', + ], + ], + [ + 'name' => 'CertType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Document type.'."\n" + .'Currently, only IDENTITY_CARD (ID card) is supported.', + 'type' => 'string', + 'required' => false, + 'example' => 'IDENTITY_CARD', + ], + ], + [ + 'name' => 'CertName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Real name.', + 'type' => 'string', + 'required' => false, + 'example' => '张三', + ], + ], + [ + 'name' => 'CertNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'Document number.', + 'type' => 'string', + 'required' => false, + 'example' => '330103xxxxxxxxxxxx', + ], + ], + [ + 'name' => 'ReturnUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'Target URL for the merchant\'s business page to redirect to. ', + 'type' => 'string', + 'required' => false, + 'example' => 'www.aliyun.com', + ], + ], + [ + 'name' => 'FaceContrastPicture', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Base64 encoded photo.'."\n" + ."\n" + .'> Choose one of the following methods to upload the image: FaceContrastPicture, FaceContrastPictureUrl, CertifyId, or OSS.'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx', + 'maxLength' => 1548576, + ], + ], + [ + 'name' => 'MetaInfo', + 'in' => 'query', + 'schema' => [ + 'description' => 'Metainfo environment parameter, which needs to be obtained through the client SDK.', + 'type' => 'string', + 'required' => false, + 'example' => '{"zimVer":"3.0.0","appVersion": "1","bioMetaInfo": "4.1.0:11501568,0","appName": "com.aliyun.antcloudauth","deviceType": "ios","osVersion": "iOS 10.3.2","apdidToken": "","deviceModel": "iPhone9,1"}', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'query', + 'schema' => [ + 'description' => 'User\'s phone number.', + 'type' => 'string', + 'required' => false, + 'example' => '130xxxxxxxx', + ], + ], + [ + 'name' => 'Ip', + 'in' => 'query', + 'schema' => [ + 'description' => 'User\'s IP address.', + 'type' => 'string', + 'required' => false, + 'example' => '114.xxx.xxx.xxx', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Custom user ID for the customer\'s business, please ensure it is unique.', + 'type' => 'string', + 'required' => false, + 'example' => '123456789', + ], + ], + [ + 'name' => 'FaceContrastPictureUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS photo address, currently only supports authorized OSS photo addresses.'."\n" + ."\n" + .'> Among the four image input methods (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, OSS), choose one to input.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg', + ], + ], + [ + 'name' => 'CertifyId', + 'in' => 'query', + 'schema' => [ + 'description' => '><warning>To be deprecated></warning>'."\n" + ."\n" + .'Previously passed CertifyId for real-person authentication, where the photo taken during authentication is used as the comparison photo.'."\n" + ."\n" + .'> Among the four image input methods (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, OSS), choose one to input.', + 'type' => 'string', + 'required' => false, + 'example' => '0bfa7c493f850e5178b9f8613634c9xx', + ], + ], + [ + 'name' => 'OssBucketName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Authorized OSS bucket name.'."\n" + ."\n" + .'> Among the four image input methods (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, OSS), choose one to input.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai-aliyun-cloudauth-xxxxx', + ], + ], + [ + 'name' => 'OssObjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Authorized OSS object name.'."\n" + ."\n" + .'> Among the four image input methods (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, OSS), choose one to input.', + 'type' => 'string', + 'required' => false, + 'example' => 'verify/xxxxx/xxxxxx.jpeg', + ], + ], + [ + 'name' => 'Model', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Liveness detection type, with values:'."\n" + .'> Only the following liveness detection types are supported; custom actions or combinations are not supported at this time.'."\n" + ."\n" + .'Note'."\n" + .'Only the following liveness detection types are supported; custom actions or combinations are not supported at this time.'."\n" + ."\n" + .'- **LIVENESS** (default): Blinking'."\n" + ."\n" + .'- **PHOTINUS_LIVENESS**: Blinking + Colorful Light'."\n" + ."\n" + .'- **MULTI_ACTION**: Blinking + Head Shaking (the order of blinking and head shaking is random)'."\n" + ."\n" + .'- **MOVE_ACTION** (recommended): Moving Closer and Farther + Blinking'."\n" + ."\n" + .'- **MOVE_PHOTINUS**: Moving Closer and Farther + Colorful Light'."\n" + ."\n" + .'> '."\n" + .'>- The **default liveness detection type** is supported in the following versions:'."\n" + .'> - Android SDK 1.2.6 and above'."\n" + .'> - iOS SDK 1.2.4 and above'."\n" + .'> - Harmony SDK 1.0.0 and above'."\n" + .'>- Other types are supported in the latest SDK versions for Android/iOS/Harmony. It is recommended to integrate the latest version.', + 'type' => 'string', + 'required' => false, + 'example' => 'MOVE_ACTION', + ], + ], + [ + 'name' => 'CallbackUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'Callback notification address for the authentication result, with the default callback request method being GET. The callback address must start with `https`. After completing the authentication, the platform will call back this address and automatically add the `certifyId` and `passed` fields, where the value of the `passed` field is the subcode, for example: `https://www.aliyun.com?callbackToken=1000004826&certifyId=shaxxxx&passed=200`.'."\n" + ."\n" + .'<notice>'."\n" + ."\n" + .'- Callbacks are triggered only when the authentication is completed (including both successful and unsuccessful authentications). If the authentication is abandoned, interrupted abnormally, or not performed, no notification will be sent. It is recommended that you retrieve detailed authentication information through a query interface if needed after receiving the callback notification.'."\n" + .'- The accessibility of the provided address will be verified before the API call. If the address cannot be accessed over the public network, a 401 error will be returned.'."\n" + .'- The callback interface must return an HTTP status code of 200; otherwise, it will trigger a retry, with two callbacks within 3 seconds.'."\n" + ."\n" + .'</notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.aliyun.com', + ], + ], + [ + 'name' => 'CallbackToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'Security token, generated by you, used for preventing duplication and tampering.'."\n" + ."\n" + .'If this value is set, the **CallbackToken** field will be displayed in the callback address.', + 'type' => 'string', + 'required' => false, + 'example' => 'NMjvQanQgplBSaEI0sL86WnQplB', + ], + ], + [ + 'name' => 'Crop', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Whether to allow cropping of the face image, with the default being not allowed.'."\n" + ."\n" + .'- T: Indicates allowing cropping.'."\n" + ."\n" + .'- F: Indicates not allowing cropping.'."\n" + ."\n" + .'> If the image you are requesting is not from a standard liveness detection SDK, it is recommended to allow face image cropping. When this feature is enabled, the requested image will first undergo face cropping and alignment, and then the service request will be initiated.', + 'type' => 'string', + 'required' => false, + 'example' => 'T', + ], + ], + [ + 'name' => 'CertifyUrlType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Web SDK device type, with values **WEB** or **H5**.'."\n" + ."\n" + .'> Only Web SDK device types are supported.', + 'type' => 'string', + 'required' => false, + 'example' => 'WEB', + ], + ], + [ + 'name' => 'AuthId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'User authorization ID, with a maximum length of 64 characters.', + 'type' => 'string', + 'required' => false, + 'example' => '92d46b9e9e2d703f2897f350d5bd4149', + ], + ], + [ + 'name' => 'EncryptType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Encryption algorithm to be used, currently supporting only the SM2 national encryption algorithm.'."\n" + ."\n" + .'After enabling encrypted transmission, you need to pass in the encrypted CertName and CertNo. For how to encrypt, please refer to [Parameter Encryption Instructions](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/description-of-parameter-encryption?spm=a2c4g.11186623.0.0.1a9d566eWdqwy8#task-2229332).', + 'type' => 'string', + 'required' => false, + 'example' => 'SM2', + ], + ], + [ + 'name' => 'VoluntaryCustomizedContent', + 'in' => 'query', + 'schema' => [ + 'description' => 'Customized content. Required when personalized settings are enabled. The format is a JSON String of a String List.'."\n" + ."\n" + .'- For the follow-reading scenario: It should not exceed 60 Chinese characters (excluding punctuation), and the List contains only one element.'."\n" + ."\n" + .'- For the Q&A scenario: Up to 3 questions can be set, with each question not exceeding 30 Chinese characters, and each question being an element in the List.', + 'type' => 'string', + 'required' => false, + 'example' => '["本人王先生同意***协议。"]', + ], + ], + [ + 'name' => 'SuitableType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Aging-friendly configuration parameters that take effect for each authentication request. You can choose different parameters based on your app\'s business attributes, customer distribution, operational characteristics, etc., for each authentication request. The options include the following, with the default being 0.'."\n" + ."\n" + .'- **0**: Not enabled, indicating that the current authentication request does not enable aging-friendly mode.'."\n" + ."\n" + .'- **1**: Enabled, indicating that the current authentication request enables aging-friendly mode.'."\n" + ."\n" + .'- **2**: User choice.'."\n" + ."\n\n" + .'Supports end-users in choosing the authentication mode. The product guide page provides two authentication entry points: \'Enable Authentication\' and \'Elderly Authentication Mode\'. When the user selects \'Elderly Authentication Mode\', the system enters aging-friendly mode.'."\n" + .'> '."\n" + .'> - Aging-friendly parameters are only effective when the liveness detection type **Model** is set to **LIVENESS** or **MULTI_ACTION**.', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ProcedurePriority', + 'in' => 'query', + 'schema' => [ + 'description' => 'Degradation configuration for mobile H5 authentication when WebRTC or Webassembly is incompatible.'."\n" + ."\n" + .'- **keep**: Does not support degradation, returns directly.'."\n" + ."\n" + .'- **url** (default): Supports degradation, returns an authentication URL. Users can use this URL to open or switch browsers for authentication.'."\n" + ."\n" + .'- **video**: Supports degradation, uses the system camera to record a 3~5 second blinking video for authentication.'."\n" + ."\n\n" + .'> '."\n" + .'> When the degradation mode is Video, the following functions will be disabled, and the product security will decrease. It is recommended to configure it only for secure scenarios.'."\n" + .'> - Liveness detection type settings will not take effect.'."\n" + .'> - The VideoEvidence function is not supported.', + 'type' => 'string', + 'required' => false, + 'example' => 'url', + ], + ], + [ + 'name' => 'Mode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Method to obtain passport NFC verification elements:'."\n" + ."\n" + .'- **1**: User input, where the end-user manually inputs the document information using the UI interface provided by the Alibaba Cloud SDK.'."\n" + ."\n" + .'- **3**: External parameter input, where the document information is passed through external parameters.'."\n" + ."\n" + .'> When decoding the encrypted information from the passport chip using NFC, three elements of the passport need to be obtained, including name, date of birth, and document expiration date.', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ReadImg', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to read the document photo:'."\n" + ."\n" + .'- **Y**: Read'."\n" + ."\n" + .'- **N**: Do not read'."\n" + ."\n" + .'> If the document face photo is needed in subsequent authentication steps, it is recommended to set this parameter to Y.', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + [ + 'name' => 'Birthday', + 'in' => 'query', + 'schema' => [ + 'description' => 'Date of birth on the document.'."\n" + ."\n" + .'This field is required when the document type **CertType** is **PASSPORT** and **Mode** is **3**.', + 'type' => 'string', + 'required' => false, + 'example' => '1993-10-10', + ], + ], + [ + 'name' => 'ValidityDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'Document expiration date.'."\n" + ."\n" + .'This field is required when the document type **CertType** is **PASSPORT** and **Mode** is **3**.', + 'type' => 'string', + 'required' => false, + 'example' => '2039-06-10', + ], + ], + [ + 'name' => 'CertifyUrlStyle', + 'in' => 'query', + 'schema' => [ + 'description' => 'Types of **CertifyUrl** returned, including:'."\n" + ."\n" + .'- **L**: Original long link'."\n" + ."\n" + .'- **S** (default): Short link', + 'type' => 'string', + 'required' => false, + 'example' => 'L', + ], + ], + [ + 'name' => 'FaceGuardOutput', + 'in' => 'query', + 'schema' => [ + 'description' => 'Device assistant label type, with the value: **DeviceRisk**.'."\n" + ."\n" + .'>'."\n" + .'> - Choosing to output the device assistant will incur additional costs. For details, see [Paid Value-Added Services](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/face-guard?spm=a2c4g.11186623.0.0.443e5522rbHsR4).'."\n" + .'> - If you do not need to output the device assistant label, you can either not pass the parameter or pass an empty value.', + 'type' => 'string', + 'required' => false, + 'example' => 'DeviceRisk', + ], + ], + [ + 'name' => 'RarelyCharacters', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to enable rare character mode:'."\n" + ."\n" + .'- **Y**: Enable. A message input box will pop up before the user authenticates, requiring the input of the rare character name and ID number. The user must agree to the terms before starting the authentication process.'."\n" + ."\n" + .'- **N**: Not enabled (default)', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + [ + 'name' => 'UiCustomUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'UI configuration file URL.'."\n" + ."\n" + .'You can view the complete configuration in the [Web SDK UI Customization Description](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/web-sdk-ui-custom-configuration-description?spm=a2c4g.11186623.0.0.4c683f5c8K3I9p).', + 'type' => 'string', + 'required' => false, + 'example' => 'www.aliyundoc.com', + ], + ], + [ + 'name' => 'VideoEvidence', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to enable video evidence:'."\n" + ."\n" + .'- **true**: Enable'."\n" + ."\n" + .'- **false** (default): Disable'."\n" + ."\n" + .'> Due to the large size of video files, when the network is unstable, the system will discard the video file to prioritize the transmission of necessary images for authentication. It is recommended that your business set a weak dependency on the video.', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AppQualityCheck', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether the SDK enables strict face quality detection:'."\n" + ."\n" + .'- **Y**: Enable'."\n" + ."\n" + .'- **N** (default): Disable'."\n" + ."\n\n" + .'> '."\n" + .'> - If this parameter is enabled, the SDK needs to integrate the [strict face quality detection module](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/description-of-sdk-package-clipping?spm=a2c4g.11186623.0.0.1a9d35c6ySFUPW). Enabling strict quality detection may decrease the success rate of user face recognition.'."\n" + .'> - Only supported in Android SDK version 2.3.24 and above.', + 'type' => 'string', + 'required' => false, + 'example' => 'N', + ], + ], + [ + 'name' => 'CameraSelection', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to enable the camera selection feature:'."\n" + ."\n" + .'- **Y**: Enable'."\n" + ."\n" + .'- **N** (default): Disable'."\n" + ."\n" + .'> This feature only takes effect in PC integration mode. When enabled, it allows users to select the camera for authentication.', + 'type' => 'string', + 'required' => false, + 'example' => 'N', + ], + ], + [ + 'name' => 'NeedMultiFaceCheck', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to intercept when multiple faces are detected, with the following values:'."\n" + ."\n" + .'- **Y**: Intercept, and the client prompts the user to re-scan their face.'."\n" + ."\n" + .'- **N** (default): Do not intercept, and send the largest face in the scanned image to the server for security checks.', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + [ + 'name' => 'H5DegradeConfirmBtn', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'H5 Downgrade Confirmation Button Switch:'."\n" + ."\n" + .'- **Y**: Enabled (On)'."\n" + .'- **N (default)**: Disabled (Off)', + 'example' => 'Y', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'Return code: 200 indicates success, other values indicate failure.', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '130A2C10-B9EE-4D84-88E3-5384FF039795', + ], + 'ResultObject' => [ + 'description' => 'Result object.', + 'type' => 'object', + 'properties' => [ + 'CertifyId' => [ + 'description' => 'Unique identifier for real-person authentication.', + 'type' => 'string', + 'example' => '91707dc296d469ad38e4c5efa6a0f24b', + ], + 'CertifyUrl' => [ + 'description' => 'URL for real-person authentication in a Web browser, which will redirect according to the ReturnUrl parameter after authentication.'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'- The CertifyUrl returned by the initialization interface is valid for **30 minutes and can only be used once**. Please use it within the validity period to avoid reuse.'."\n" + .'- This parameter requires the correct input of **MetaInfo** to return a CertifyUrl that matches the client. If you cannot obtain it, please check whether **MetaInfo** and other input parameters are correct.'."\n" + ."\n" + .'- The domain name of this URL may change with service updates. To ensure normal service availability, it is recommended not to apply access control to this domain name.'."\n" + ."\n" + .'- When redirecting in the browser, try not to use incognito mode or modify the URL, as this may result in a **signature error**.'."\n" + ."\n" + .'></notice>', + 'type' => 'string', + 'example' => 'https://t.aliyun.com/****', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"130A2C10-B9EE-4D84-88E3-5384FF039795\\",\\n \\"ResultObject\\": {\\n \\"CertifyId\\": \\"91707dc296d469ad38e4c5efa6a0f24b\\",\\n \\"CertifyUrl\\": \\"https://t.aliyun.com/****\\"\\n }\\n}","type":"json"}]', + 'title' => 'Initialization Interface', + 'description' => '- Service Address: cloudauth.aliyuncs.com'."\n" + .'- Request Method: HTTPS POST and GET.'."\n" + .'- This interface uses different parameters for different product solutions. For details, please refer to the [official documentation](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/product-overview/introduction/?spm=a2c4g.11186623.help-menu-2401581.d_0_0.13f644ecRzFHfm&scm=20140722.H_99169._.OR_help-T_cn~zh-V_1).'."\n" + ."\n" + .'#### Image Format Requirements'."\n" + .'When performing real-person authentication, please provide images that meet all of the following conditions:'."\n" + .'- Recent photo with a clear, unobstructed face, natural expression, and facing the camera directly.'."\n" + .'- Clear photo with normal exposure, no overexposure, underexposure, or halo effects, and no significant angle deviation.'."\n" + .'- Resolution not exceeding 1920*1080, at least 640*480, recommended short side scaled to 720 pixels, compression ratio greater than 0.9.'."\n" + .'- Photo size: <1MB.'."\n" + .'- Supports 90, 180, and 270-degree photos; in the case of multiple faces, the largest face will be selected.', + 'requestParamsDescription' => '> If you choose to upload the face image via OSS, you must provide the OssBucketName and OssObjectName fields.'."\n" + .'The OSS input format only supports URLs, Buckets, and file names generated by the OSS authorized when enabling the real-person authentication service. For how to query the authorized OSS, see [Enable OSS Space and Authorization](https://help.aliyun.com/document_detail/163108.html?spm=a2c4g.11186623.2.14.7dd9f397RmV0jw#section-4w2-trd-8q6).'."\n" + .'If you choose to upload the face photo via FaceContrastPicture (Base64 encoded photo), please check the photo size and do not upload overly large photos; you can use the OSS method to upload larger face photos.'."\n" + ."\n" + .'Depending on the chosen authentication scheme, the required fields may differ. Please refer to the table below for specific details.'."\n" + ."\n" + .'Field|APP Authentication Scheme|Live Face Verification Scheme|Liveness Detection Scheme'."\n" + .'--|--|--|--'."\n" + .'CertType|Yes|Optional|Optional'."\n" + .'CertName|Yes|Optional|Optional'."\n" + .'CertNo|Yes|Optional|Optional'."\n" + .'UserId|Optional|Yes|Yes'."\n" + .'FaceContrastPicture|No|Yes|No'."\n" + .'FaceContrastPictureUrl|No|Yes|No'."\n" + .'CertifyId|No|Yes|No'."\n" + .'OssBucketName|No|Yes|No'."\n" + .'OssObjectName|No|Yes|No', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## Result Codes'."\n" + ."\n" + .'| Result Code | Message | Description |'."\n" + .'|----|-------|--|'."\n" + .'|200|success|Success.|'."\n" + .'|400|Parameter cannot be empty|The parameter cannot be empty.|'."\n" + .'|401|Invalid parameter|Invalid parameter. The length of the name and ID number must comply with national standards and must not contain English letters or other special characters.|'."\n" + .'|402|Application configuration does not exist|Application configuration does not exist.|'."\n" + .'|404|Authentication scenario configuration does not exist|Authentication scenario configuration does not exist. Please create an authentication scenario in the console first.|'."\n" + .'|405|Age under 14, not allowed to use this product|Users under 14 years old cannot use this product; manual review is recommended.|'."\n" + .'|410|Service not enabled|The OSS product has not been enabled or OSS read/write authorization has not been completed. Please log in to the console to complete authorization.|'."\n" + .'|411|No RAM permission|Grant the sub-account the AliyunAntCloudAuthFullAccess permission.|'."\n" + .'|412|In arrears|Financial-grade real-person authentication or OSS has outstanding payments. Please recharge before proceeding.|'."\n" + .'|414|Device type not supported|The current mobile device does not support face authentication. Please change devices and try again.|'."\n" + .'|415|SDK version not supported|The current authentication SDK version does not support face authentication. Please upgrade the SDK and try again.|'."\n" + .'|416|OS version not supported|The current operating system version does not support face authentication. Please upgrade the OS or change the device.|'."\n" + .'|417|Face authentication service unavailable|The identity information comparison source is unavailable. If the information is correct, manual review is recommended.|'."\n" + .'|418|Too many face authentication failures|Too many face authentication attempts today. Please try again tomorrow.|'."\n" + .'|419|Invalid image supplied|The image cannot be downloaded, the content is empty, the resolution does not meet requirements, or no facial features can be extracted. Please use another image.|'."\n" + .'|420|Duplicate data|More than one image input method provided.<ul><li>FaceContrastPicture</li><li>FaceContrastPictureUrl</li><li>Oss</li><li>CertifyId</li></ul>|'."\n" + .'|421|Image too large|The image exceeds 1 MB; compress it or choose another upload method.|'."\n" + .'|422|Image download timeout|Image download exceeded 3 seconds. Check your network and try again.|'."\n" + .'|423|Invalid status|The certifyID status must be T. You can also submit the image via another method.|'."\n" + .'|500|System error|Internal system error. Please contact engineers for troubleshooting.|', + 'translator' => 'machine', + ], + 'DescribeFaceGuardRisk' => [ + 'summary' => 'Financial-Grade Face Guard Service', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '250715', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthCPTLY3', + ], + ], + 'parameters' => [ + [ + 'name' => 'DeviceToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'Risk identification - device token.', + 'type' => 'string', + 'required' => false, + 'example' => 'McozS1ZWRcRZStlERcZZo_QOytx5jcgZoZJEoRLOxxxxxxx', + ], + ], + [ + 'name' => 'OuterOrderNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'This identifier is used for subsequent troubleshooting, and you need to ensure that this value is unique in your business.'."\n" + ."\n" + .'Supports the use of English letters (including uppercase and lowercase) and numbers, with a maximum length of 32 characters.', + 'type' => 'string', + 'required' => false, + 'example' => 'e0c34a77f5ac40a5aa5e6ed20c35xxxx', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Product code, fixed value: FACE_GUARD', + 'type' => 'string', + 'required' => false, + 'example' => 'FACE_GUARD', + ], + ], + [ + 'name' => 'BizId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Authentication ID', + 'type' => 'string', + 'required' => false, + 'example' => 'aba9830f471a4335af4612c8adaa91b0', + ], + ], + ], + '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' => 'D6163397-15C5-419C-9ACC-B7C83E0B4C10', + ], + 'Code' => [ + 'description' => 'Return code, **200** indicates successful response from the interface.', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => 'Returned result information.', + 'type' => 'object', + 'properties' => [ + 'RiskExtends' => [ + 'description' => 'Extended information, in JSON format. (Customized return based on tenant requirements)', + 'type' => 'string', + 'example' => '{'."\n" + .' "code": 200'."\n" + .' "badNet":false,'."\n" + .' "umid":"74e37355171ab62230063569350d368e",'."\n" + .' "fileTags":"basic_root,basic_hook",'."\n" + .' "queryCount":1,'."\n" + .' "querySessionCount":1,'."\n" + .' "queryUmidCount":1'."\n" + .' "platform":"Android"'."\n" + .'}', + ], + 'RiskTags' => [ + 'description' => 'Device risk tags.'."\n" + ."\n" + .'- Multiple device risk tags are separated by commas (,). For example, “ROOT,VPN,HOOK”,'."\n" + ."\n" + .'- For more information about device risk tags and their meanings, please refer to the official documentation on Face Guard Tag Descriptions.', + 'type' => 'string', + 'example' => 'ROOT,VPN,HOOK', + ], + 'CertifyId' => [ + 'description' => 'Unique real-person authentication identifier.', + 'type' => 'string', + 'example' => 'sha43d9cabd52d370d9f4cca9468f71e', + ], + 'GuardRiskScore' => [ + 'type' => 'number', + 'format' => 'double', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6163397-15C5-419C-9ACC-B7C83E0B4C10\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"RiskExtends\\": \\"{\\\\n \\\\\\"code\\\\\\": 200\\\\n \\\\\\"badNet\\\\\\":false,\\\\n \\\\\\"umid\\\\\\":\\\\\\"74e37355171ab62230063569350d368e\\\\\\",\\\\n \\\\\\"fileTags\\\\\\":\\\\\\"basic_root,basic_hook\\\\\\",\\\\n \\\\\\"queryCount\\\\\\":1,\\\\n \\\\\\"querySessionCount\\\\\\":1,\\\\n \\\\\\"queryUmidCount\\\\\\":1\\\\n \\\\\\"platform\\\\\\":\\\\\\"Android\\\\\\"\\\\n}\\",\\n \\"RiskTags\\": \\"ROOT,VPN,HOOK\\",\\n \\"CertifyId\\": \\"sha43d9cabd52d370d9f4cca9468f71e\\",\\n \\"GuardRiskScore\\": 80\\n }\\n}","type":"json"}]', + 'title' => 'Pure Server-Side Face Guard API', + 'translator' => 'machine', + ], + 'AIGCFaceVerify' => [ + 'summary' => 'Add AIGC Face Detection Capability', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '206861', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Authentication scene ID. This ID is automatically generated after creating an authentication scene in the console. For how to create an authentication scene, see Adding an Authentication Scene.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000xxxx', + ], + ], + [ + 'name' => 'OuterOrderNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'A unique business identifier defined by the client side, used for subsequent troubleshooting. The value should be a combination of letters and numbers with a maximum length of 32 characters, please ensure its uniqueness.', + 'type' => 'string', + 'required' => false, + 'example' => 'e0c34a77f5ac40a5aa5e6ed20c353888', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Product solution', + 'type' => 'string', + 'required' => false, + 'example' => 'LR_FR_AIGC', + ], + ], + [ + 'name' => 'FaceContrastPicture', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Base64 encoded photo.'."\n" + .'> Choose one of the three ways to input images: FaceContrastPicture, FaceContrastPictureUrl, or OSS.', + 'type' => 'string', + 'required' => false, + 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx'."\n", + ], + ], + [ + 'name' => 'FaceContrastPictureUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'Portrait address, accessible via public HTTP or HTTPS link.'."\n" + ."\n" + .'> Choose one of the three ways to input images: FaceContrastPicture, FaceContrastPictureUrl, or OSS.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg', + ], + ], + [ + 'name' => 'OssBucketName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Authorized OSS bucket name.'."\n" + .'> Choose one of the three ways to input images: FaceContrastPicture, FaceContrastPictureUrl, or OSS.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai-aliyun-cloudauth-xxxxx'."\n", + ], + ], + [ + 'name' => 'OssObjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Authorized OSS file name.'."\n" + .'> Choose one of the three ways to input images: FaceContrastPicture, FaceContrastPictureUrl, or OSS.', + 'type' => 'string', + 'required' => false, + 'example' => ' '."\n" + .'verify/xxxxx/xxxxxx.jpeg'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response object', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'Message' => [ + 'description' => 'Message.', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => 'Return code: 200 for success, others for failure.', + 'type' => 'string', + 'example' => '200', + ], + 'ResultObject' => [ + 'description' => 'Returned result', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => 'Authentication result. Values:'."\n" + ."\n" + .'● Y: AIGC-generated face.'."\n" + ."\n" + .'● N: Not detected', + 'type' => 'string', + 'enumValueTitles' => [ + 'Y' => 'AIGC生成人脸', + 'N' => '非AIGC生成人脸', + ], + 'example' => 'Y', + ], + 'Score' => [ + 'description' => 'Detection score', + 'type' => 'string', + 'example' => '1.0000', + ], + 'CertifyId' => [ + 'description' => 'Unique real-person authentication identifier.', + 'type' => 'string', + 'example' => '91707dc296d469ad38e4c5efa6a0****', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": \\"200\\",\\n \\"ResultObject\\": {\\n \\"Result\\": \\"Y\\",\\n \\"Score\\": \\"1.0000\\",\\n \\"CertifyId\\": \\"91707dc296d469ad38e4c5efa6a0****\\"\\n }\\n}","type":"json"}]', + 'title' => 'AIGC Image Generation Detection', + 'translator' => 'machine', + ], + 'DeleteFaceVerifyResult' => [ + 'summary' => 'Financial Level Sensitive Data Deletion Interface', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '247721', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth6RJHVQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'CertifyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Unique identifier for real-person authentication.', + 'type' => 'string', + 'required' => false, + 'example' => 'shae18209d29ce4e8ba252caae98ab15', + ], + ], + [ + 'name' => 'DeleteAfterQuery', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether deletion depends on having already obtained relevant data from the corresponding authentication process.'."\n" + ."\n" + .'- Y: Required. To successfully delete the related data, you must have obtained the processing result through the DescribeFaceVerify interface.'."\n" + .'- N: Not required (default). For pure server-side API integration, you can directly pass N.', + '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' => '5A6229C0-E156-48E4-B6EC-0F528BDF60D2', + ], + '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' => [ + 'CertifyId' => [ + 'description' => 'Unique identifier for real-person authentication.', + 'type' => 'string', + 'example' => 'sha58aeae7ea2f5ed069530f58df4e6d', + ], + 'DeleteResult' => [ + 'description' => 'Deletion result. Possible values are as follows:'."\n" + ."\n" + .'- Y: Deletion successful.'."\n" + .'- N: Deletion failed.', + 'type' => 'string', + 'example' => 'N', + ], + 'FailReason' => [ + 'description' => 'Reason for deletion failure'."\n" + ."\n" + .'- NOT_DELETE_REPEATEDLY: Cannot be deleted repeatedly'."\n" + .'- NEED_QUERY_VERIFY_RESULT: Need to query the verification result first, then delete', + 'type' => 'string', + 'example' => 'NOT_DELETE_REPEATEDLY', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A6229C0-E156-48E4-B6EC-0F528BDF60D2\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"CertifyId\\": \\"sha58aeae7ea2f5ed069530f58df4e6d\\",\\n \\"DeleteResult\\": \\"N\\",\\n \\"FailReason\\": \\"NOT_DELETE_REPEATEDLY\\"\\n }\\n}","type":"json"}]', + 'title' => 'Financial Level New Service Deletion Interface', + 'description' => 'Deletes all personal information fields in the request, including name, ID number, phone number, IP, images, videos, and device information, etc.', + 'translator' => 'machine', + ], + 'DeepfakeDetect' => [ + 'summary' => 'Face Credential Verification Service', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '226413', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthS6WIN6', + ], + ], + 'parameters' => [ + [ + 'name' => 'OuterOrderNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'A unique identifier for the merchant\'s request, consisting of a 32-character alphanumeric combination. The first few characters can be a custom abbreviation defined by the merchant, the middle part may include a timestamp, and the latter part can use a random or incrementing sequence.', + 'type' => 'string', + 'required' => false, + 'example' => 'e0c34a77f5ac40a5aa5e6ed20c******', + ], + ], + [ + 'name' => 'FaceInputType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Input **IMAGE** to indicate an image type.', + 'type' => 'string', + 'required' => false, + 'example' => 'IMAGE', + ], + ], + [ + 'name' => 'FaceUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'Enter the URL of the face image.'."\n" + .'> Either FaceUrl or FaceBase64 must be provided.', + '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 string of the face image.'."\n" + .'> Either FaceUrl or FaceBase64 must be provided.', + 'type' => 'string', + 'required' => false, + 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx'."\n", + ], + ], + ], + '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 success, others indicate 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" + .'- Suspected deep forgery SuspectDeepForgery'."\n" + .'- Suspected synthetic attack SuspectPSFace'."\n" + .'- Suspected watermark SuspectWarterMark'."\n" + .'- Suspected black industry attack SuspectTemple'."\n" + .'- Suspected generated face SuspectAIGC Face'."\n" + .'- Suspected rephotographed face SuspectRemake', + 'type' => 'string', + 'example' => 'SuspectDeepForgery,SuspectWarterMark', + ], + 'RiskScore' => [ + 'description' => 'Risk score map.', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{'."\n" + .' "SuspectPSFace": "1.0000",'."\n" + .' "SuspectDeepForgery": "0.8619",'."\n" + .' "SuspectWaterMark": "0.0126",'."\n" + .' "SuspectTemple": "0.0985"'."\n" + .' }', + 'description' => 'Risk score labels and their values.', + ], + ], + ], + ], + ], + ], + ], + ], + '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, SuspectPSFace\\",\\n \\"RiskScore\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"SuspectPSFace\\\\\\": \\\\\\"1.0000\\\\\\",\\\\n \\\\\\"SuspectDeepForgery\\\\\\": \\\\\\"0.8619\\\\\\",\\\\n \\\\\\"SuspectRemake\\\\\\": \\\\\\"0.0126\\\\\\",\\\\n \\\\\\"SuspectTemple\\\\\\": \\\\\\"0.0985\\\\\\"\\\\n }\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Face Deepfake Detection Service', + 'description' => '> The Face Deepfake Detection API is currently in the free public beta stage, which will end on August 30, 2024, at 23:59:59. During the public beta, the QPS (Queries Per Second) cannot exceed 3 times/second.'."\n" + ."\n" + .'- Service address: cloudauth.aliyuncs.com (IPv4) or cloudauth-dualstack.aliyuncs.com (IPv6).'."\n" + .'- Request method: POST and GET.'."\n" + .'- Transfer protocol: HTTPS.', + 'requestParamsDescription' => 'To ensure stable model performance, you need to make sure that the image contains a face with a normal angle. Additionally, the following conditions must be met:'."\n" + ."\n" + .'- Image format: JPG, JPEG.'."\n" + .'- Image size: Recommended 50~100 KB, not exceeding 1 MB.'."\n" + .'- Image resolution: Suggested 640×480 (height×width), not exceeding 1920×1080 (height×width), and the height of the photo should be greater than its width. It is recommended to resize the shorter side to 720 pixels with a compression ratio of 0.8.'."\n" + .'- Image quality: The photo should be clear and properly exposed, without overly dark, overly bright, or haloed faces.'."\n" + .'- Image face: If multiple faces appear in the image, the system will default to detecting the largest face.', + 'translator' => 'machine', + ], + 'CredentialProductVerifyV2' => [ + 'summary' => 'Product Credential Verification', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '219634', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthNYJI62', + ], + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CredType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Credential type: Only supports value 05 (product image).', + 'type' => 'string', + 'required' => true, + 'example' => '05', + 'enum' => [ + '05', + ], + ], + ], + [ + 'name' => 'CredName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Credential name: Only supports value 0501 (product image).', + 'type' => 'string', + 'required' => true, + 'example' => '0501', + 'enum' => [ + '0501', + ], + ], + ], + [ + 'name' => 'ImageUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'URL of the image.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://aliyundoc.com/picture*****.jpeg', + ], + ], + [ + 'name' => 'ImageFile', + 'in' => 'formData', + 'schema' => [ + 'description' => 'InputStream object of the image.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://aliyundoc.com/picture*****.jpeg', + 'isFileTransferUrl' => true, + ], + ], + [ + 'name' => 'MerchantId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Merchant ID.', + 'type' => 'string', + 'required' => false, + 'example' => '无。', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Invocation mode:'."\n" + .'Only supports value ANTI_FAKE_CHECK.', + 'type' => 'string', + 'required' => true, + 'example' => 'ANTI_FAKE_CHECK', + 'enum' => [ + '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' => 'Result object.', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => '- 0: Low risk'."\n" + .'- 1: High risk'."\n" + .'- 2: Suspicious', + 'type' => 'string', + 'example' => '1', + ], + 'RiskTag' => [ + 'description' => 'Risk tags, separated by commas, including:'."\n" + .'- PS: Image has been photoshopped'."\n" + .'- LOW_QUALITY_PRODUCT: Low quality (low clarity)'."\n" + .'- SAME_BACKGROUND: Similar background', + 'type' => 'string', + 'example' => 'PS,LOW_QUALITY_PRODUCT', + ], + 'RiskScore' => [ + 'description' => 'Map of risk scores.', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{'."\n" + .'"PS": "0.0211",'."\n" + .'"SAME_BACKGROUND": "0.0861"'."\n" + .'}', + 'description' => 'Risk score.'."\n" + .'Only supports PS and SAME_BACKGROUND to return scores.', + ], + ], + 'MaterialInfo' => [ + 'description' => 'Additional 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', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"130A2C10-B9EE-4D84-88E3-5384FF039795\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"Result\\": \\"1\\",\\n \\"RiskTag\\": \\"PS,LOW_QUALITY_PRODUCT\\",\\n \\"RiskScore\\": {\\n \\"key\\": \\"{\\\\n\\\\\\"PS\\\\\\": \\\\\\"0.0211\\\\\\",\\\\n\\\\\\"SAME_BACKGROUND\\\\\\": \\\\\\"0.0861\\\\\\"\\\\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' => 'Product Image Tampering Detection Service', + 'description' => 'Upload e-commerce product images to perform tampering, quality (clarity), and similar image detection, returning risk labels and scores.', + 'translator' => 'machine', + ], + 'CredentialVerifyV2' => [ + 'summary' => 'Credential Verification', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '219634', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthNYJI62', + ], + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CredType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Credential type:'."\n" + ."\n" + .'- 01: Personal ID cards'."\n" + .'- 02: Business scenario'."\n" + .'- 03: Corporate qualifications', + 'type' => 'string', + 'required' => false, + 'example' => '01', + ], + ], + [ + 'name' => 'CredName', + 'in' => 'query', + 'schema' => [ + 'description' => '- 01: Personal ID cards'."\n" + .' - 0101: ID card'."\n" + .' - 0102: Bank card'."\n" + .' - 0104: Teacher qualification certificate'."\n" + .' - 0107: Student ID card'."\n" + .'- 02: Business scenario'."\n" + .' - 0201: Storefront photo'."\n" + .' - 0202: Counter photo'."\n" + .' - 0203: Scene photo'."\n" + .'- 03: Corporate qualifications'."\n" + .' - 0301: Business license', + 'type' => 'string', + 'required' => false, + 'example' => '0104'."\n", + ], + ], + [ + 'name' => 'ImageUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'Image URL, choose one from `imageUrl`, `imageFile`, or `imageContext`.', + 'type' => 'string', + 'required' => false, + 'example' => 'http://marry.momocdn.com/avatar/3B/B6/3BB6527E-7467-926E-1048-B43614F20CC420230803_L.jpg', + ], + ], + [ + 'name' => 'ImageFile', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Image input stream, choose one from `imageUrl`, `imageFile`, or `imageContext`.', + 'type' => 'string', + 'required' => false, + 'example' => 'none', + 'isFileTransferUrl' => true, + ], + ], + [ + 'name' => 'ImageContext', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Base64 encoded image, choose one from `imageUrl`, `imageFile`, or `imageContext`.', + 'type' => 'string', + 'required' => false, + 'example' => 'base64', + ], + ], + [ + 'name' => 'IsOcr', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to use OCR', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'IsCheck', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to enable authoritative authentication'."\n" + ."\n" + .'- ****0****: No'."\n" + .'- **1**: Yes', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Name.', + 'type' => 'string', + 'required' => false, + 'example' => '张三', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'ID number.', + 'type' => 'string', + 'required' => false, + 'example' => '4****************1', + ], + ], + [ + 'name' => 'CertNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'Relevant certificate number.', + 'type' => 'string', + 'required' => false, + 'example' => '4601*****', + ], + ], + [ + 'name' => 'MerchantId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Merchant ID. This field is required when ****CredName**** is set to **02**.', + 'type' => 'string', + 'required' => false, + 'example' => 'none', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Invocation mode:'."\n" + ."\n" + .'- ANTI_FAKE_CHECK: Image anti-forgery check'."\n" + ."\n" + .'- ANTI_FAKE_VL: Image anti-forgery check and semantic understanding'."\n" + ."\n" + .'- IMAGE_VL_COG: Image semantic understanding'."\n" + ."\n" + .'Default value: ANTI_FAKE_CHECK'."\n" + ."\n" + .'When CredType is set to 02, ProductCode can only be ANTI_FAKE_VL or IMAGE_VL_COG.', + 'type' => 'string', + 'required' => false, + 'example' => 'ANTI_FAKE_CHECK', + ], + ], + [ + 'name' => 'PromptModel', + 'in' => 'query', + 'schema' => [ + 'description' => 'Prompt acquisition method for image semantic understanding:'."\n" + ."\n" + .'- DEFAULT: System default'."\n" + ."\n" + .'- CUSTOM: Customer-defined'."\n" + ."\n" + .'Note: When ProductCode is set to ANTI_FAKE_VL or IMAGE_VL_COG, this parameter must be provided.', + 'type' => 'string', + 'required' => false, + 'example' => 'DEFAULT', + ], + ], + [ + 'name' => 'Prompt', + 'in' => 'query', + 'schema' => [ + 'description' => 'Customer-defined prompt content for image semantic understanding.'."\n" + ."\n" + .'This field is required when PromptModel is set to CUSTOM.', + 'type' => 'string', + 'required' => false, + 'example' => 'none'."\n", + ], + ], + [ + 'name' => 'MerchantDetail', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Merchant details:'."\n" + ."\n" + .'MerchantName: Merchant name'."\n" + ."\n" + .'BusinessType: Industry information'."\n" + ."\n" + .'BusinessContent: Business content'."\n" + ."\n" + .'This field is required when PromptModel is set to DEFAULT.', + 'type' => 'array', + 'items' => [ + 'description' => 'Keyword', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'Keyword key.', + 'type' => 'string', + 'required' => false, + 'example' => 'MerchantName', + ], + 'Value' => [ + 'description' => 'Keyword value.', + 'type' => 'string', + 'required' => false, + 'example' => '***', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + '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' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + '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 (,), including:'."\n" + ."\n" + .'- PS: Image manipulation.'."\n" + .'- SCREEN_PHOTO: Screen recapture.'."\n" + .'- SCREENSHOT: Screenshot.'."\n" + .'- WATERMARK: Watermark.'."\n" + .'- SAME_BACKGROUND: Similar background.'."\n" + .'- ORIGINAL_PHOTO: Not the original image', + 'type' => 'string', + 'example' => 'PS,SCREEN_PHOTO', + ], + 'RiskScore' => [ + 'description' => 'Risk score map.', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{'."\n" + .' "PS": "0.9458",'."\n" + .' "SCREEN_PHOTO": "0.1781",'."\n" + .' "WATERMARK": "0.1863"'."\n" + .'}', + 'description' => 'Risk score.', + ], + ], + 'OcrInfo' => [ + 'description' => 'OCR recognition result.', + 'type' => 'string', + 'example' => '{'."\n" + .' "certNo":"20216*********",'."\n" + .' "certType":"小学教师资格",'."\n" + .' "gender":"男",'."\n" + .' "subject":"美术",'."\n" + .' "name":"李**",'."\n" + .' "ext_info":"{}",'."\n" + .' "birthDate":"1998-07-28",'."\n" + .' "idNo":"620************",'."\n" + .' "certOrg":""'."\n" + .'}', + ], + 'VerifyResult' => [ + 'description' => 'Authority verification result', + 'type' => 'string', + 'example' => ' *', + ], + 'VerifyDetail' => [ + 'description' => 'Authority verification details.', + 'type' => 'string', + 'example' => '**', + ], + 'MaterialInfo' => [ + 'description' => 'Additional information in JSON format.', + 'type' => 'string', + 'example' => '{'."\n" + ."\n" + .'"sameBackgroundDetail": {'."\n" + ."\n" + .'// 相似背景对于的原始图请求RequestId'."\n" + ."\n" + .'"originalRequestId": "130A2C10-B9EE-4D84-88E3-5384FF03****";'."\n" + ."\n" + .'// 相似背景对于的原始图请求商户ID'."\n" + ."\n" + .'"originalMerchantId": "xxxxxxxx"'."\n" + ."\n" + .'}'."\n" + ."\n" + .'}', + ], + 'VlResult' => [ + 'description' => 'Qwen interpretation.', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Qwen interpretation success indicator'."\n" + ."\n" + .'true: Success'."\n" + ."\n" + .'false: Failure', + 'type' => 'boolean', + 'example' => 'true', + ], + 'VlContent' => [ + 'description' => 'Image understanding result:'."\n" + ."\n" + .'- When PromptModel is DEFAULT, the output format refers to the example on the right.'."\n" + ."\n" + .'- When PromptModel is CUSTOM, the output format follows the agreed format of the Prompt.', + 'type' => 'string', + 'example' => '{'."\n" + .' "CHK_DOOR_PHOTO":1, -- 是否门头照 1：是 0：否'."\n" + .' "CHK_INTERIOR_PHOTO":0, -- 是否内景照 1：是 0：否'."\n" + .' "CHK_COUNTER_PHOTO":0 -- 是否柜台照 1：是 0：否'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"Result\\": \\"1\\",\\n \\"RiskTag\\": \\"PS,SCREEN_PHOTO\\",\\n \\"RiskScore\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"PS\\\\\\": \\\\\\"0.9458\\\\\\",\\\\n \\\\\\"SCREEN_PHOTO\\\\\\": \\\\\\"0.1781\\\\\\",\\\\n \\\\\\"WATERMARK\\\\\\": \\\\\\"0.1863\\\\\\"\\\\n}\\"\\n },\\n \\"OcrInfo\\": \\"{\\\\n \\\\\\"certNo\\\\\\":\\\\\\"20216*********\\\\\\",\\\\n \\\\\\"certType\\\\\\":\\\\\\"小学教师资格\\\\\\",\\\\n \\\\\\"gender\\\\\\":\\\\\\"男\\\\\\",\\\\n \\\\\\"subject\\\\\\":\\\\\\"美术\\\\\\",\\\\n \\\\\\"name\\\\\\":\\\\\\"李**\\\\\\",\\\\n \\\\\\"ext_info\\\\\\":\\\\\\"{}\\\\\\",\\\\n \\\\\\"birthDate\\\\\\":\\\\\\"1998-07-28\\\\\\",\\\\n \\\\\\"idNo\\\\\\":\\\\\\"620************\\\\\\",\\\\n \\\\\\"certOrg\\\\\\":\\\\\\"\\\\\\"\\\\n}\\",\\n \\"VerifyResult\\": \\" *\\",\\n \\"VerifyDetail\\": \\"**\\",\\n \\"MaterialInfo\\": \\"{\\\\n\\\\n\\\\\\"sameBackgroundDetail\\\\\\": {\\\\n\\\\n// 相似背景对于的原始图请求RequestId\\\\n\\\\n\\\\\\"originalRequestId\\\\\\": \\\\\\"130A2C10-B9EE-4D84-88E3-5384FF03****\\\\\\";\\\\n\\\\n// 相似背景对于的原始图请求商户ID\\\\n\\\\n\\\\\\"originalMerchantId\\\\\\": \\\\\\"xxxxxxxx\\\\\\"\\\\n\\\\n}\\\\n\\\\n}\\",\\n \\"VlResult\\": {\\n \\"Success\\": true,\\n \\"VlContent\\": \\"{\\\\n \\\\\\"CHK_DOOR_PHOTO\\\\\\":1, -- 是否门头照 1：是 0：否\\\\n \\\\\\"CHK_INTERIOR_PHOTO\\\\\\":0, -- 是否内景照 1：是 0：否\\\\n \\\\\\"CHK_COUNTER_PHOTO\\\\\\":0 -- 是否柜台照 1：是 0：否\\\\n}\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Credential Verification V2', + 'description' => 'Input credential image information, perform image tampering and forgery detection, and image semantic understanding. Return the risk detection results.', + 'translator' => 'machine', + ], + 'CredentialVerify' => [ + 'summary' => 'Credential verification', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '219634', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthNYJI62', + ], + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CredType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Credential type:'."\n" + ."\n" + .'- 01: Personal ID cards'."\n" + .'- 02: Business scenario'."\n" + .'- 03: Corporate qualifications', + 'type' => 'string', + 'required' => false, + 'example' => '01', + ], + ], + [ + 'name' => 'CredName', + 'in' => 'query', + 'schema' => [ + 'description' => '- 01: Personal ID cards'."\n" + .' - **0101**: ID card'."\n" + .' - **0102**: Bank card'."\n" + .' - **0104**: Teacher qualification certificate'."\n" + .' - **0107**: Student ID card'."\n" + .'- 02: Business scenario'."\n" + .' - **0201**: Storefront photo'."\n" + .' - **0202**: Counter photo'."\n" + .' - **0203**: Scene photo'."\n" + .'- 03: Corporate qualifications'."\n" + .' - **0301**: Business license', + 'type' => 'string', + 'required' => false, + 'example' => '0104', + ], + ], + [ + 'name' => 'ImageUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'Image URL, choose one from `imageUrl`, `imageFile`, or `imageContext`.', + 'type' => 'string', + 'required' => false, + 'example' => 'http://marry.momocdn.com/avatar/3B/B6/3BB6527E-7467-926E-1048-B43614F20CC420230803_L.jpg', + ], + ], + [ + 'name' => 'ImageContext', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Base64 encoded image, choose one from `imageUrl`, `imageFile`, or `imageContext`.', + 'type' => 'string', + 'required' => false, + 'example' => 'base64', + ], + ], + [ + 'name' => 'IsOCR', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to enable OCR recognition.'."\n" + ."\n" + .'- **0**: No'."\n" + .'- **1**: Yes'."\n" + ."\n" + .'> IsOCR can be set to 1 only when **CredType** is 01.', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'IsCheck', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to enable authoritative authentication'."\n" + ."\n" + .'- ****0****: No'."\n" + .'- **1**: Yes', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => 'UserName', + 'type' => 'string', + 'required' => false, + 'example' => '张*', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'ID number:'."\n" + ."\n" + .'Note'."\n" + .'Only supports the ID numbers of second-generation resident IDs and Hong Kong, Macao, and Taiwan residence permits.'."\n" + ."\n" + .'- When paramType is normal: enter the plaintext ID number.'."\n" + ."\n" + .'- When paramType is md5: first 6 digits of the ID number (plaintext) + date of birth (ciphertext) + last 4 digits of the ID number (plaintext).', + 'type' => 'string', + 'required' => false, + 'example' => '429001********8211', + ], + ], + [ + 'name' => 'CertNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'Relevant certificate number.', + 'type' => 'string', + 'required' => false, + 'example' => '4601*****', + ], + ], + [ + 'name' => 'MerchantId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Merchant ID. '."\n" + ."\n" + .'> This field is required when ****CredName**** is set to **02**.', + 'type' => 'string', + 'required' => false, + 'example' => '913100********KW8P', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Invocation mode:'."\n" + ."\n" + .'- **ANTI_FAKE_CHECK**: Image anti-forgery check'."\n" + ."\n" + .'- **ANTI_FAKE_VL**: Image anti-forgery check and semantic understanding'."\n" + ."\n" + .'- **IMAGE_VL_COG**: Image semantic understanding'."\n" + ."\n" + .'Default value: ANTI_FAKE_CHECK'."\n" + ."\n" + .'> When **CredType** is set to 02, **ProductCode** can only be ANTI_FAKE_VL or IMAGE_VL_COG.', + 'type' => 'string', + 'required' => false, + 'example' => 'ANTI_FAKE_CHECK', + ], + ], + [ + 'name' => 'PromptModel', + 'in' => 'query', + 'schema' => [ + 'description' => 'Prompt acquisition method for image semantic understanding:'."\n" + ."\n" + .'- **DEFAULT**: System default'."\n" + ."\n" + .'- **CUSTOM**: Customer-defined'."\n" + ."\n" + .'> When **ProductCode** is set to **ANTI_FAKE_VL** or **IMAGE_VL_COG**, this parameter must be provided.', + 'type' => 'string', + 'required' => false, + 'example' => 'DEFAULT', + ], + ], + [ + 'name' => 'Prompt', + 'in' => 'query', + 'schema' => [ + 'description' => 'Customer-defined prompt content for image semantic understanding.'."\n" + ."\n\n" + .'> This field is required when PromptModel is set to CUSTOM.', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'MerchantDetail', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Merchant details:'."\n" + ."\n\n" + .'> This field is required when PromptModel is set to DEFAULT.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The private key of the certificate.'."\n" + ."\n" + .'> If this parameter is specified, you must also specify **CertName** and **Cert**. If **CertName**, **Cert**, and **Key** are specified, you do not need to specify **CertId**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'keyword', + ], + 'Value' => [ + 'description' => 'Keyword value.', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + 'required' => false, + 'description' => 'Merchant details object', + ], + 'required' => false, + ], + ], + ], + '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' => 'D6163397-15C5-419C-9ACC-B7C83E0B4C10', + ], + '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', + '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 (,), including:'."\n" + ."\n" + .'- **PS**: Image manipulation.'."\n" + .'- **SCREEN_PHOTO**: Screen recapture.'."\n" + .'- **SCREENSHOT**: Screenshot.'."\n" + .'- **WATERMARK**: Watermark.'."\n" + .'- **SAME_BACKGROUND**: Similar background.'."\n" + .'- **ORIGINAL_PHOTO**: Not the original image', + 'type' => 'string', + 'example' => 'PS,SCREEN_PHOTO', + ], + 'RiskScore' => [ + 'description' => 'Risk score map.', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{'."\n" + .' "PS": "0.9458",'."\n" + .' "SCREEN_PHOTO": "0.1781",'."\n" + .' "WATERMARK": "0.1863"'."\n" + .'}', + 'description' => 'Risk score map.', + ], + ], + 'OcrInfo' => [ + 'description' => 'OCR recognition result.', + 'type' => 'string', + 'example' => '{'."\n" + .' "certNo":"20216*********",'."\n" + .' "certType":"小学教师资格",'."\n" + .' "gender":"男",'."\n" + .' "subject":"美术",'."\n" + .' "name":"李**",'."\n" + .' "ext_info":"{}",'."\n" + .' "birthDate":"1998-07-28",'."\n" + .' "idNo":"620************",'."\n" + .' "certOrg":""'."\n" + .'}', + ], + 'VerifyResult' => [ + 'description' => 'The verification result.', + 'type' => 'string', + 'example' => ' *', + ], + 'VerifyDetail' => [ + 'description' => 'Authority verification details.', + 'type' => 'string', + 'example' => '**', + ], + 'MaterialInfo' => [ + 'description' => 'Additional information in JSON format.', + 'type' => 'string', + 'example' => '{'."\n" + ."\n" + .'"sameBackgroundDetail": {'."\n" + ."\n" + .'// 相似背景对于的原始图请求RequestId'."\n" + ."\n" + .'"originalRequestId": "130A2C10-B9EE-4D84-88E3-5384FF03****";'."\n" + ."\n" + .'// 相似背景对于的原始图请求商户ID'."\n" + ."\n" + .'"originalMerchantId": "xxxxxxxx"'."\n" + ."\n" + .'}'."\n" + ."\n" + .'}', + ], + 'VlResult' => [ + 'description' => 'Qwen interpretation.', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'VlContent' => [ + 'description' => 'Image understanding result:'."\n" + ."\n" + .'- When PromptModel is DEFAULT, the output format refers to the example on the right.'."\n" + ."\n" + .'- When PromptModel is CUSTOM, the output format follows the agreed format of the Prompt.', + 'type' => 'string', + 'example' => '{\\"这张图有没有明显的PS特征\\":0,\\"图片是否为正常经营照片\\":1,\\"图片中有没有58、美团、大众点评字样\\":0,\\"这张图有没有网站信息\\":0,\\"图片经营的场景是否为酒店\\":0}'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6163397-15C5-419C-9ACC-B7C83E0B4C10\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"Result\\": \\"1\\",\\n \\"RiskTag\\": \\"PS,SCREEN_PHOTO\\",\\n \\"RiskScore\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"PS\\\\\\": \\\\\\"0.9458\\\\\\",\\\\n \\\\\\"SCREEN_PHOTO\\\\\\": \\\\\\"0.1781\\\\\\",\\\\n \\\\\\"WATERMARK\\\\\\": \\\\\\"0.1863\\\\\\"\\\\n}\\"\\n },\\n \\"OcrInfo\\": \\"{\\\\n \\\\\\"certNo\\\\\\":\\\\\\"20216*********\\\\\\",\\\\n \\\\\\"certType\\\\\\":\\\\\\"小学教师资格\\\\\\",\\\\n \\\\\\"gender\\\\\\":\\\\\\"男\\\\\\",\\\\n \\\\\\"subject\\\\\\":\\\\\\"美术\\\\\\",\\\\n \\\\\\"name\\\\\\":\\\\\\"李**\\\\\\",\\\\n \\\\\\"ext_info\\\\\\":\\\\\\"{}\\\\\\",\\\\n \\\\\\"birthDate\\\\\\":\\\\\\"1998-07-28\\\\\\",\\\\n \\\\\\"idNo\\\\\\":\\\\\\"620************\\\\\\",\\\\n \\\\\\"certOrg\\\\\\":\\\\\\"\\\\\\"\\\\n}\\",\\n \\"VerifyResult\\": \\" *\\",\\n \\"VerifyDetail\\": \\"**\\",\\n \\"MaterialInfo\\": \\"{\\\\n\\\\n\\\\\\"sameBackgroundDetail\\\\\\": {\\\\n\\\\n// 相似背景对于的原始图请求RequestId\\\\n\\\\n\\\\\\"originalRequestId\\\\\\": \\\\\\"130A2C10-B9EE-4D84-88E3-5384FF03****\\\\\\";\\\\n\\\\n// 相似背景对于的原始图请求商户ID\\\\n\\\\n\\\\\\"originalMerchantId\\\\\\": \\\\\\"xxxxxxxx\\\\\\"\\\\n\\\\n}\\\\n\\\\n}\\",\\n \\"VlResult\\": {\\n \\"Success\\": true,\\n \\"VlContent\\": \\"{\\\\\\\\\\\\\\"这张图有没有明显的PS特征\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"图片是否为正常经营照片\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"图片中有没有58、美团、大众点评字样\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"这张图有没有网站信息\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"图片经营的场景是否为酒店\\\\\\\\\\\\\\":0}\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Credential verification', + ], + 'BankMetaVerify' => [ + 'summary' => 'Bank Card Element Verification Interface', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '208613', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth883TGF', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Parameter type:'."\n" + ."\n" + .'- normal: Unencrypted.'."\n" + .'- md5: MD5 encrypted.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'normal' => 'normal', + 'md5' => 'md5', + ], + 'example' => 'normal', + ], + ], + [ + 'name' => 'VerifyMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'VERIFY_BANK_CARD: Bank card authentication mode. It indicates whether the provided bank card number matches the user\'s real name, ID number, and mobile phone number.', + 'type' => 'string', + 'required' => false, + '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 + mobile phone number verification.', + 'type' => 'string', + 'required' => false, + 'example' => 'BANK_CARD_2_META', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Name.'."\n" + ."\n" + .'- When `paramType` is `normal`, enter the plain text name.'."\n" + .'- When `paramType` is `md5`, encrypt the first character of the name with MD5 (32 lowercase MD5) + the rest of the name in plain text.', + 'type' => 'string', + 'required' => false, + 'example' => '张*', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'ID number.'."\n" + ."\n" + .'- When `ProductType` is `BANK_CARD_3_META`, this field is required.'."\n" + .'- When `paramType` is `normal`, enter the plain text ID number.'."\n" + .'- When `paramType` is `md5`, enter the first 6 digits of the ID number in plain text + the birth date encrypted with MD5 (32 lowercase MD5) + the last 4 digits of the ID number.', + 'type' => 'string', + 'required' => false, + 'example' => '429001********8211', + ], + ], + [ + 'name' => 'BankCard', + 'in' => 'query', + 'schema' => [ + 'description' => 'Bank card number.'."\n" + ."\n" + .'- When `paramType` is `normal`, enter the plain text bank card number.'."\n" + .'- When `paramType` is `md5`, enter the part of the card number except the last 6 digits in plain text + the last 6 digits encrypted with MD5 (32 lowercase).', + 'type' => 'string', + 'required' => false, + 'example' => '610*************1181', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'query', + 'schema' => [ + 'description' => 'Mobile phone number.'."\n" + ."\n" + .'- When `ProductType` is `BANK_CARD_4_META`, this field is required.'."\n" + .'- When `paramType` is `normal`, enter the plain text mobile phone number.'."\n" + .'- When `paramType` is `md5`, enter the mobile phone number (32 lowercase MD5).', + 'type' => 'string', + 'required' => false, + 'example' => '138******11', + ], + ], + [ + 'name' => 'IdentityType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Identity type.', + 'type' => 'string', + 'required' => false, + 'example' => '01', + ], + ], + ], + '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' => '473469C7-A***B-A3DC0DE3C83E', + ], + '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.'."\n" + ."\n" + .'- 1: Consistent (billable)'."\n" + .'- 2: Inconsistent (billable)'."\n" + .'- 3: No record found (non-billable)', + '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 enabled authentication payment.'."\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, the card is uninitialized or a dormant card.'."\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, the number of password errors exceeds the limit.'."\n" + .'- **212**: Authentication information does not match, the issuing bank does not support this transaction.'."\n" + .'- **213**: Authentication information does not match, the card status is abnormal or the card is invalid.'."\n" + .'- **214**: Authentication information does not match, no mobile phone number reserved.'."\n" + .'- **215**: Authentication information does not match, the entered password, expiration date, or CVN2 is incorrect.'."\n" + .'- **216**: Authentication information does not match, other card anomalies.'."\n" + .'- **301**: Unable to verify, the bank card does not support this service.'."\n" + .'- **302**: Unable to verify, verification failed or the bank refused to verify, please contact the issuing bank.'."\n" + .'- **303**: Unable to verify, the bank card does not currently support mobile phone number verification.'."\n" + .'- **304**: Unable to verify, the bank card number is incorrect.'."\n" + .'- **305**: Unable to verify, other reasons.'."\n" + .'- **306**: Unable to verify, the number of verifications exceeds the limit.', + 'type' => 'string', + 'example' => '101', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-A***B-A3DC0DE3C83E\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"SubCode\\": \\"101\\"\\n }\\n}","type":"json"}]', + 'title' => 'Verification of Two, Three, and Four Elements of Bank Card', + 'description' => 'Bank card verification, including: two elements (name + bank card number), three elements (name + ID number + bank card number), and four elements (name + ID number + mobile phone number + bank card number) consistency verification.'."\n" + .'- Service address:'."\n" + .' - Beijing region: cloudauth.cn-beijing.aliyuncs.com (IPv4) or cloudauth-dualstack.cn-beijing.aliyuncs.com (IPv6).'."\n" + .' - Shanghai region: cloudauth.cn-shanghai.aliyuncs.com (IPv4) or cloudauth-dualstack.cn-shanghai.aliyuncs.com (IPv6).'."\n" + .'- Request method: POST and GET.'."\n" + .'- Transfer protocol: HTTPS.', + 'translator' => 'machine', + ], + 'MobileRecycledMetaVerify' => [ + 'summary' => '手机号二次放号核验', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthPZCZ2I', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'normal', + ], + ], + [ + 'name' => 'RegisterDate', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + ], + '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' => '8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'ResultObject' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'SubCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '101', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": \\"200\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"SubCode\\": \\"101\\"\\n }\\n}","type":"json"}]', + ], + 'MobileDetect' => [ + 'summary' => 'Number Detection', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '218021', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthPZCZ2I', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Encryption method:'."\n" + .'- normal: plaintext, no encryption'."\n" + .'- md5: MD5 encryption', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'Mobiles', + 'in' => 'formData', + 'schema' => [ + 'description' => 'List of phone numbers.', + 'type' => 'string', + 'required' => false, + 'example' => '19833232569', + ], + ], + ], + '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' => '969434DF-926B-4997-9881-4DE94E39F805', + ], + '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' => [ + 'ChargeCount' => [ + 'description' => 'Billing count, the total billing count in one request', + 'type' => 'string', + 'example' => '2', + ], + 'Items' => [ + 'description' => 'Verification results set', + 'type' => 'array', + 'items' => [ + 'description' => 'List of returned data.', + 'type' => 'object', + 'properties' => [ + 'Mobile' => [ + 'description' => 'Phone number', + 'type' => 'string', + 'example' => '131********', + ], + 'BizCode' => [ + 'description' => 'Verification result'."\n" + ."\n" + .'- 1: Available online '."\n" + .'- 2: Not available online'."\n" + .'- 3: No query result', + 'type' => 'string', + 'example' => '1', + ], + 'SubCode' => [ + 'description' => 'Verification details'."\n" + ."\n" + .'- 101: Available number'."\n" + .'- 102: Empty number'."\n" + .'- 103: Suspended '."\n" + .'- 104: Silent number (inactive small number, new number, non-smartphone user within the last six months) '."\n" + .'- 105: Risky number (long-term shutdown or no voice service activated and prone to complaints)'."\n" + .'- 301: No record found', + 'type' => 'string', + 'example' => '101', + ], + 'IspName' => [ + 'description' => 'Operator name'."\n" + ."\n" + .'- CMCC: China Mobile '."\n" + .'- CUCC: China Unicom '."\n" + .'- CTCC: China Telecom', + 'type' => 'string', + 'example' => 'CMCC', + ], + 'Area' => [ + 'description' => 'Phone number\'s area (only for plaintext phone numbers)', + 'type' => 'string', + 'example' => '安徽-马**', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"969434DF-926B-4997-9881-4DE94E39F805\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"ChargeCount\\": \\"2\\",\\n \\"Items\\": [\\n {\\n \\"Mobile\\": \\"131********\\",\\n \\"BizCode\\": \\"1\\",\\n \\"SubCode\\": \\"101\\",\\n \\"IspName\\": \\"CMCC\\",\\n \\"Area\\": \\"安徽-马**\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Batch Number Detection', + 'translator' => 'machine', + ], + 'Mobile3MetaSimpleVerify' => [ + 'summary' => 'Mobile Three Elements Simplified Interface', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '194556', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthPZCZ2I', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Encryption method:'."\n" + ."\n" + .'- normal: plaintext, not encrypted'."\n" + ."\n" + .'- md5: MD5 encryption', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'formData', + 'schema' => [ + 'description' => 'ID number:'."\n" + ."\n" + .'Note'."\n" + .'Only supports the ID numbers of second-generation resident IDs and Hong Kong, Macao, and Taiwan residence permits.'."\n" + ."\n" + .'- When paramType is normal: enter the plaintext ID number.'."\n" + ."\n" + .'- When paramType is md5: enter the encrypted ID number.', + 'type' => 'string', + 'required' => false, + 'example' => '明文：429001********8211'."\n" + ."\n" + .'密文：'."\n" + ."\n" + .'32fa7bcd874161bea8ec8fd98f390ec9', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Name:'."\n" + ."\n" + .'- When paramType is normal: enter the plaintext name.'."\n" + ."\n" + .'- When paramType is md5: enter the encrypted name.', + 'type' => 'string', + 'required' => false, + 'example' => '明文：张三'."\n" + ."\n" + .'密文：'."\n" + ."\n" + .'32fa7bcd874161bea8ec8fd98f390ec9', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Mobile phone number:'."\n" + ."\n" + .'- When paramType is normal: enter the plaintext mobile phone number.'."\n" + ."\n" + .'- When paramType is md5: enter the encrypted mobile phone number.', + 'type' => 'string', + 'required' => false, + 'example' => '明文：186****2055'."\n" + ."\n" + .'密文：'."\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' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + '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.', + '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', + ], + '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\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"IspName\\": \\"CMCC\\"\\n }\\n}","type":"json"}]', + 'title' => 'Mobile Three Elements Simplified Interface', + 'description' => '- Service address: cloudauth.aliyuncs.com (IPv4) or cloudauth-dualstack.aliyuncs.com (IPv6).'."\n" + .'- Request method: POST and GET.'."\n" + .'- Transfer protocol: HTTPS.', + 'translator' => 'machine', + ], + 'Mobile3MetaDetailVerify' => [ + 'summary' => 'Detailed Mobile Three-Element Verification Interface', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '194557', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthPZCZ2I', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Encryption method:'."\n" + ."\n" + .'- normal: plaintext, unencrypted'."\n" + ."\n" + .'- md5: MD5 encryption', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'formData', + 'schema' => [ + 'description' => 'ID number:'."\n" + ."\n" + .'Note'."\n" + .'Only supports the ID numbers of second-generation resident IDs and Hong Kong, Macao, and Taiwan residence permits.'."\n" + ."\n" + .'- When paramType is normal: enter the plaintext ID number.'."\n" + ."\n" + .'- When paramType is md5: enter the encrypted ID number.', + 'type' => 'string', + 'required' => false, + 'example' => '明文：429001********8211'."\n" + ."\n" + .'密文：'."\n" + ."\n" + .'32fa7bcd874161bea8ec8fd98f390ec9', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Name:'."\n" + ."\n" + .'- When paramType is normal: enter the plaintext name.'."\n" + ."\n" + .'- When paramType is md5: enter the encrypted name.', + 'type' => 'string', + 'required' => false, + 'example' => '明文：张三'."\n" + ."\n" + .'密文：'."\n" + ."\n" + .'32fa7bcd874161bea8ec8fd98f390ec9', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Mobile phone number:'."\n" + ."\n" + .'- When paramType is normal: enter the plaintext mobile phone number.'."\n" + ."\n" + .'- When paramType is md5: enter the encrypted mobile phone number.', + 'type' => 'string', + 'required' => false, + 'example' => '明文：186****2055'."\n" + ."\n" + .'密文：'."\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' => '5A6229C0-E156-48E4-B6EC-0F528BDF60D2', + ], + 'Code' => [ + 'description' => 'Return code, **200** indicates a successful API response.', + '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**: 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' => 'Operator 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\\": \\"5A6229C0-E156-48E4-B6EC-0F528BDF60D2\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"SubCode\\": \\"101\\",\\n \\"IspName\\": \\"CMCC\\"\\n }\\n}","type":"json"}]', + 'title' => 'Detailed Mobile Three-Element Verification Interface', + 'description' => '- Service address: cloudauth.aliyuncs.com (IPv4) or cloudauth-dualstack.aliyuncs.com (IPv6).'."\n" + .'- Request method: POST and GET.'."\n" + .'- Transfer protocol: HTTPS.', + 'translator' => 'machine', + ], + 'Mobile2MetaVerify' => [ + 'summary' => 'Mobile Two-Factor Verification', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Encryption method:'."\n" + .'- normal: plaintext without encryption'."\n" + .'- md5: MD5 encryption', + 'type' => 'string', + 'required' => true, + 'example' => 'normal', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Name:'."\n" + .'- When paramType is normal: input the plaintext name.'."\n" + .'- When paramType is md5: input the encrypted name.', + 'type' => 'string', + 'required' => true, + 'example' => '● 明文：张三'."\n" + .'● 密文：'."\n" + .'32fa7bcd874161bea8ec8fd98f390ec9', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Phone number:'."\n" + .'- When paramType is normal: input the plaintext phone number.'."\n" + .'- When paramType is md5: input the encrypted phone number.', + 'type' => 'string', + 'required' => true, + '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' => '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' => 'Result object.', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => 'Verification result:'."\n" + .'- 1: Consistent verification'."\n" + .'- 2: Inconsistent verification'."\n" + .'- 3: No record found', + 'type' => 'string', + 'example' => '1', + ], + 'IspName' => [ + 'description' => 'Operator name:'."\n" + .'- CMCC: China Mobile'."\n" + .'- CUCC: China Unicom'."\n" + .'- CTCC: China Telecom', + 'type' => 'string', + 'example' => 'CMCC', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"130A2C10-B9EE-4D84-88E3-5384FF039795\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"IspName\\": \\"CMCC\\"\\n }\\n}","type":"json"}]', + 'title' => 'Mobile Two-Factor Verification', + 'description' => 'Input the phone number and name, verify their authenticity and consistency through authoritative data sources.', + 'translator' => 'machine', + ], + 'MobileOnlineTime' => [ + 'summary' => 'Query the online duration of a mobile number', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '216495', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthNOQ41U', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Parameter type:'."\n" + ."\n" + .'- normal: unencrypted.'."\n" + .'- md5: md5 encrypted.', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Mobile number:'."\n" + .'- When `paramType` is `normal`: provide the plaintext mobile number.'."\n" + .'- When `paramType` is `md5`: provide the encrypted mobile number.', + 'type' => 'string', + 'required' => false, + 'example' => '明文：186****2055'."\n" + ."\n" + .'密文：'."\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' => 'B506328A-D84B-4750-82C7-6A207C585CF1', + ], + '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: Verification consistent'."\n" + .'- 2: Verification inconsistent'."\n" + .'- 3: No record found', + 'type' => 'string', + 'example' => '1', + ], + 'IspName' => [ + 'description' => 'Operator name'."\n" + ."\n" + .'- CMCC: China Mobile '."\n" + .'- CUCC: China Unicom '."\n" + .'- CTCC: China Telecom', + 'type' => 'string', + 'example' => 'CMCC', + ], + 'TimeCode' => [ + 'description' => '- 1: [0,3) indicates the online duration is 0~3 months '."\n" + .'- 2: [3,6) indicates the online duration is 3~6 months '."\n" + .'- 3: [6,12) indicates the online duration is 6~12 months '."\n" + .'- 4: [12,24) indicates the online duration is 12~24 months '."\n" + .'- 5: [24,+) indicates the online duration is more than 24 months', + 'type' => 'string', + 'example' => '5', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B506328A-D84B-4750-82C7-6A207C585CF1\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"IspName\\": \\"CMCC\\",\\n \\"TimeCode\\": \\"5\\"\\n }\\n}","type":"json"}]', + 'title' => 'Mobile Online Duration', + 'translator' => 'machine', + ], + 'MobileOnlineStatus' => [ + 'summary' => 'Query the online status of a mobile number', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '216535', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthNOQ41U', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Parameter type:'."\n" + ."\n" + .'- normal: unencrypted.'."\n" + .'- md5: md5 encrypted.', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Mobile number:'."\n" + ."\n" + .'- When `paramType` is `normal`: provide the plaintext mobile number.'."\n" + .'- When `paramType` is `md5`: provide the encrypted mobile number.', + 'type' => 'string', + 'required' => false, + 'example' => '13665148158', + ], + ], + ], + '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' => 'B506328A-D84B-4750-82C7-6A207C585CF1', + ], + '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'."\n" + ."\n" + .'- 1: Available online '."\n" + .'- 2: Not available online (see subCode for details)'."\n" + .'- 3: No query result', + 'type' => 'string', + 'example' => '1', + ], + 'IspName' => [ + 'description' => 'ISP name'."\n" + ."\n" + .'- CMCC: China Mobile '."\n" + .'- CUCC: China Unicom '."\n" + .'- CTCC: China Telecom', + 'type' => 'string', + 'example' => 'CMCC', + ], + 'SubCode' => [ + 'description' => 'Verification details'."\n" + ."\n" + .'- 101: Available online '."\n" + .'- 201: Suspended '."\n" + .'- 202: Disconnected '."\n" + .'- 203: Online but not available '."\n" + .'- 204: Not online '."\n" + .'- 301: No record found', + 'type' => 'string', + 'example' => '101', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B506328A-D84B-4750-82C7-6A207C585CF1\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"IspName\\": \\"CMCC\\",\\n \\"SubCode\\": \\"101\\"\\n }\\n}","type":"json"}]', + 'title' => 'Mobile Online Status', + 'translator' => 'machine', + ], + 'Mobile3MetaSimpleStandardVerify' => [ + 'summary' => 'Simplified Three-Element Verification for Phone Number_Standard Version', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '257102', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthPZCZ2I', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Parameter type:'."\n" + ."\n" + .'- normal: Unencrypted.'."\n" + .'- md5: MD5 encrypted.', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'formData', + 'schema' => [ + 'description' => 'ID number:'."\n" + ."\n" + .'- When `paramType` is `normal`: Input the plain text of the ID number.'."\n" + .'- When `paramType` is `md5`: Input the encrypted ID number.', + 'type' => 'string', + 'required' => false, + 'example' => '429001********8211', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Name:'."\n" + ."\n" + .'- When `paramType` is `normal`: Input the plain text of the name.'."\n" + .'- When `paramType` is `md5`: Input the encrypted name.', + 'type' => 'string', + 'required' => false, + 'example' => '张*', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Phone number:'."\n" + ."\n" + .'- When `paramType` is `normal`: Input the plain text of the phone number.'."\n" + .'- When `paramType` is `md5`: Input the encrypted phone number.', + 'type' => 'string', + 'required' => false, + 'example' => '130********', + ], + ], + ], + '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' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + '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:'."\n" + ."\n" + .'- 1: Consistent (billable)'."\n" + .'- 2: Inconsistent (billable)'."\n" + .'- 3: No record found (non-billable)', + 'type' => 'string', + 'example' => '1', + ], + 'IspName' => [ + 'description' => 'Operator name:'."\n" + ."\n" + .'- **CMCC**: China Mobile.'."\n" + .'- **CUCC**: China Unicom.'."\n" + .'- **CTCC**: China Telecom.'."\n" + .'- **CBCC**: China Broadcasting Network.', + 'type' => 'string', + 'example' => 'CMCC', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"IspName\\": \\"CMCC\\"\\n }\\n}","type":"json"}]', + 'title' => 'Simplified Three-Element Verification for Phone Number - Standard Version', + 'description' => 'Input the phone number, name, and ID number to verify their authenticity and consistency through authoritative data sources.', + 'translator' => 'machine', + ], + 'Mobile3MetaDetailStandardVerify' => [ + 'summary' => 'Detailed Three-Element Verification for Phone Number_Standard Version', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '257106', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthPZCZ2I', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Parameter type:'."\n" + ."\n" + .'- normal: Unencrypted.'."\n" + .'- md5: Encrypted with MD5.', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'formData', + 'schema' => [ + 'description' => 'ID number:'."\n" + ."\n" + .'- When `paramType` is `normal`: Input the plain text of the ID number.'."\n" + .'- When `paramType` is `md5`: Input the encrypted text of the ID number.', + 'type' => 'string', + 'required' => false, + 'example' => '429001********8211', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Name:'."\n" + ."\n" + .'- When `paramType` is `normal`: Input the plain text of the name.'."\n" + .'- When `paramType` is `md5`: Input the encrypted text of the name.', + 'type' => 'string', + 'required' => false, + 'example' => '张*', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Phone number:'."\n" + ."\n" + .'- When `paramType` is `normal`: Input the plain text of the phone number.'."\n" + .'- When `paramType` is `md5`: Input the encrypted text of the phone number.', + 'type' => 'string', + 'required' => false, + 'example' => '138********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response schema', + '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 API response.', + '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**: Verification matches.'."\n" + .'- **2**: Verification does not match.'."\n" + .'- **3**: No record found.', + 'type' => 'string', + 'example' => '1', + ], + 'SubCode' => [ + 'description' => 'Detailed verification results:'."\n" + ."\n" + .'- 101: Passed, three elements are consistent.'."\n" + .'- 201: The phone number does not match the name and ID number.'."\n" + .'- 202: The phone number matches the name but does not match the ID number.'."\n" + .'- 203: The phone number does not match the name but matches the ID number.'."\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.'."\n" + .'- **CBCC**: China Broadcasting Network.', + 'type' => 'string', + 'example' => 'CMCC', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"SubCode\\": \\"101\\",\\n \\"IspName\\": \\"CMCC\\"\\n }\\n}","type":"json"}]', + 'title' => 'Detailed Three-Element Verification for Phone Number - Standard Version', + 'description' => 'Input the phone number, name, and ID number to verify their authenticity and consistency through authoritative data sources. If they do not match, the reason for the mismatch is returned.', + 'translator' => 'machine', + ], + 'Id2MetaStandardVerify' => [ + 'summary' => 'Identity Two-Factor Standard', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '250706', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Parameter type:'."\n" + ."\n" + .'- normal: unencrypted.'."\n" + .'- md5: md5 encrypted.', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'formData', + 'schema' => [ + 'description' => 'ID number:'."\n" + ."\n" + .'- When `paramType` is normal: enter the plain text of the ID number.'."\n" + .'- When `paramType` is md5:'."\n" + .'The first 6 digits (plain text) + date of birth (encrypted) + last 4 digits (plain text).', + 'type' => 'string', + 'required' => false, + 'example' => '4****************1', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Name:'."\n" + ."\n" + .'- When `paramType` is normal: enter the plain text of the name.'."\n" + .'- When `paramType` is md5: the first character of the name (encrypted) + the rest of the name (plain text).', + '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' => 'ID of the request', + 'type' => 'string', + 'example' => 'D6163397-15C5-419C-9ACC-B7C83E0B4C10', + ], + '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**: verification matches.'."\n" + .'- **2**: verification does not match.'."\n" + .'- **3**: no record found.', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6163397-15C5-419C-9ACC-B7C83E0B4C10\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\"\\n }\\n}","type":"json"}]', + 'title' => 'Identity Two-Factor Standard Verification Interface', + 'translator' => 'machine', + ], + 'Id2MetaVerify' => [ + 'summary' => 'Identity Two-Factor Interface', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '194526', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Encryption method:'."\n" + ."\n" + .'- normal: plaintext, no encryption'."\n" + ."\n" + .'- md5: MD5 encryption', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'formData', + 'schema' => [ + 'description' => 'ID number:'."\n" + ."\n" + .'Note'."\n" + .'Only supports the ID numbers of second-generation resident IDs and Hong Kong, Macao, and Taiwan residence permits.'."\n" + ."\n" + .'- When paramType is normal: enter the plaintext ID number.'."\n" + ."\n" + .'- When paramType is md5: first 6 digits of the ID number (plaintext) + date of birth (ciphertext) + last 4 digits of the ID number (plaintext).', + 'type' => 'string', + 'required' => false, + 'example' => '明文：429001********8211'."\n" + ."\n" + .'密文：'."\n" + ."\n" + .'42900132fa7bcd874161bea8ec8fd98f390ec98211', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Name:'."\n" + ."\n" + .'- When paramType is normal: enter the plaintext name.'."\n" + ."\n" + .'- When paramType is md5: first character of the name in ciphertext + rest of the name in plaintext.', + 'type' => 'string', + 'required' => false, + 'example' => '明文：张三'."\n" + ."\n" + .'密文：'."\n" + ."\n" + .'6499fc7409049355527ef6a2ba5706b8三', + ], + ], + ], + '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' => 'D6163397-15C5-419C-9ACC-B7C83E0B4C10', + ], + 'Code' => [ + 'description' => 'Return code, **200** indicates successful API response.', + '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**: Verification consistent.'."\n" + .'- **2**: Verification inconsistent.'."\n" + .'- **3**: No record found.', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6163397-15C5-419C-9ACC-B7C83E0B4C10\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\"\\n }\\n}","type":"json"}]', + 'title' => 'Identity Two-Factor Verification Interface', + 'description' => '- Service address: cloudauth.aliyuncs.com (IPv4) or cloudauth-dualstack.aliyuncs.com (IPv6).'."\n" + .'- Request method: POST and GET.'."\n" + .'- Transfer protocol: HTTPS.', + 'translator' => 'machine', + ], + 'Id2MetaVerifyWithOCR' => [ + 'summary' => 'ID Two-Factor Image Verification', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + ], + ], + 'parameters' => [ + [ + 'name' => 'CertUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Portrait side of the ID card image.'."\n" + .'A publicly accessible HTTP or HTTPS link.'."\n" + .'Choose one between CertUrl and CertFile.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.aliyun.com/cert.jpeg', + ], + ], + [ + 'name' => 'CertFile', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Input stream for the portrait side of the ID card image.'."\n" + .'Choose one between CertUrl and CertFile.', + 'type' => 'string', + 'required' => false, + 'example' => '无', + 'isFileTransferUrl' => true, + ], + ], + [ + 'name' => 'CertNationalUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => 'National emblem side of the ID card image URL. National emblem side'."\n" + .'A publicly accessible HTTP or HTTPS link.'."\n" + .'Choose one between CertNationalUrl and CertNationalFile, or omit both.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.aliyun.com/cert.jpeg'."\n", + ], + ], + [ + 'name' => 'CertNationalFile', + 'in' => 'formData', + 'schema' => [ + 'description' => 'National emblem side of the ID card image address.'."\n" + .'Choose one between CertNationalUrl and CertNationalFile, or omit both.', + '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' => '130A2C10-B9EE-4D84-88E3-5384FF03****', + ], + 'Code' => [ + 'description' => 'Return code: 200 indicates success, any other value indicates failure.'."\n" + .'**Important**'."\n" + .'- This parameter indicates whether the API was called correctly. For detailed return code explanations, please refer to the error codes.'."\n" + .'- Check the business verification results through the fields in ResultObject.', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'API call return message.'."\n" + .'**Important**'."\n" + .'This parameter only indicates if there was an exception with the API call.', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => 'Result object', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => 'Identity verification result:'."\n" + .'- 1: Consistent'."\n" + .'- 2: Inconsistent'."\n" + .'- 3: No record found', + 'type' => 'string', + 'example' => '1', + ], + 'CardInfo' => [ + 'description' => '{"address":"Zhejiang Province, Hangzhou City, Yu*****","birthDate":"19901226","certName":"Zhang San","certNo":"1234561990122*****","nationality":"Han","authority":"xxx Public Security Bureau","startDate":"20201130","endDate":"20301130"}', + 'type' => 'string', + 'example' => 'OCR读取的身份证信息。', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"130A2C10-B9EE-4D84-88E3-5384FF03****\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"CardInfo\\": \\"OCR读取的身份证信息。\\"\\n }\\n}","type":"json"}]', + 'title' => 'ID Two-Factor Image Verification', + 'description' => 'Upload both sides of the ID card, and get the verification result of the two factors from an authoritative data source.', + 'translator' => 'machine', + ], + 'Id3MetaVerify' => [ + 'summary' => 'Identity Three Elements Verification', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Encryption method:'."\n" + .'- normal: plaintext without 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' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'formData', + 'schema' => [ + 'description' => 'ID number:'."\n" + .'- When `paramType` is `normal`: enter the plaintext ID number.'."\n" + .'- When `paramType` is `md5`:'."\n" + .'The first 6 digits (plaintext) + date of birth (ciphertext) + last 4 digits (plaintext).', + 'type' => 'string', + 'required' => false, + 'example' => '● 明文：429001********8211'."\n" + .'● 密文：'."\n" + .'42900132fa7bcd874161bea8ec8fd98f39****8211', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Name:'."\n" + .'- When `paramType` is `normal`: enter the plaintext name.'."\n" + .'- When `paramType` is `md5`: the first character of the name (ciphertext) + the rest of the name (plaintext).', + 'type' => 'string', + 'required' => false, + 'example' => '● 明文：张三'."\n" + .'● 密文：'."\n" + .'6499fc7409049355527ef6a2ba5706b8三', + ], + ], + [ + 'name' => 'FaceUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Portrait side of the ID card image.'."\n" + .'Accessible HTTP or HTTPS link on the public network.'."\n" + .'Choose one between `CertUrl` and `CertFile`.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.aliyun.com/cert.jpeg', + ], + ], + [ + 'name' => 'FaceFile', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Portrait side of the ID card image input stream.'."\n" + .'Choose one between `CertUrl` and `CertFile`.', + 'type' => 'string', + 'required' => false, + 'example' => '无', + 'isFileTransferUrl' => true, + ], + ], + [ + 'name' => 'Crop', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Whether to allow cropping of the face image, default is not allowed.'."\n" + .'- T: Allow cropping.'."\n" + .'- F: Do not allow cropping.'."\n" + ."\n" + .'**Note**'."\n" + ."\n" + .'If the image you request is not collected from a standard liveness detection SDK, it is recommended to allow cropping of the face image. After enabling this feature, the system will first crop and correct the requested image, then initiate the service request.', + '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' => 'Request ID.', + 'type' => 'string', + 'example' => '130A2C10-B9EE-4D84-88E3-5384FF03****', + ], + 'Code' => [ + 'description' => 'Return code: 200 indicates success, others indicate failure.'."\n" + .'**Important**'."\n" + .'- This parameter indicates whether the interface was called correctly. For detailed return code explanations, please refer to the error codes.'."\n" + .'- Check the business verification result through the fields in `ResultObject`.', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Interface call return message.'."\n" + ."\n" + .'**Important**'."\n" + ."\n" + .'This parameter only indicates whether there was an exception with the interface.', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => 'Result object.', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => 'Identity verification result:'."\n" + ."\n" + .'- 1: Consistent'."\n" + .'- 2: Inconsistent'."\n" + .'- 3: No record found', + 'type' => 'string', + 'example' => '1', + ], + 'FaceDetail' => [ + 'description' => 'Image comparison score.', + 'type' => 'string', + 'example' => '{'."\n" + .' "verifyScore": 50.28594166529785'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"130A2C10-B9EE-4D84-88E3-5384FF03****\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"FaceDetail\\": \\"{\\\\n \\\\\\"verifyScore\\\\\\": 50.28594166529785\\\\n}\\"\\n }\\n}","type":"json"}]', + 'title' => 'Identity Three Elements Verification', + 'description' => 'Input name, ID number, and face photo to verify their authenticity and consistency through authoritative sources.', + 'translator' => 'machine', + ], + 'Id2MetaPeriodVerify' => [ + 'summary' => 'Two-Factor Validity Verification API', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '259667', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Parameter type:'."\n" + ."\n" + .'- normal: Unencrypted.'."\n" + .'- md5: MD5 encrypted.', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'formData', + 'schema' => [ + 'description' => 'ID number:'."\n" + ."\n" + .'- When `paramType` is `normal`: Enter the plain text of the ID number.'."\n" + .'- When `paramType` is `md5`:'."\n" + .'The first 6 digits (plain text) + date of birth (encrypted) + last 4 digits (plain text).', + 'type' => 'string', + 'required' => false, + 'example' => '4****************1', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Name.'."\n" + ."\n" + .'- When `paramType` = `normal`: Enter the plain text of the name.'."\n" + .'- When `paramType` = `md5`: The first character of the name MD5 encrypted (32 lowercase MD5) + the rest of the name in plain text.', + 'type' => 'string', + 'required' => false, + 'example' => '张*', + ], + ], + [ + 'name' => 'ValidityStartDate', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Start date of ID validity, format: YYYYMMDD', + 'type' => 'string', + 'required' => false, + 'example' => '20201001', + ], + ], + [ + 'name' => 'ValidityEndDate', + 'in' => 'formData', + 'schema' => [ + 'description' => 'End date of ID validity, format: YYYYMMDD', + 'type' => 'string', + 'required' => false, + 'example' => '20301001', + ], + ], + ], + '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' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + '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**: Verification consistent.'."\n" + .'- **2**: Verification inconsistent.'."\n" + .'- **3**: No record found.', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\"\\n }\\n}","type":"json"}]', + 'title' => 'Two-Factor Validity Verification', + 'translator' => 'machine', + ], + 'InitCardVerify' => [ + 'summary' => 'Initiate an authentication request for image verification', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MerchantBizId', + 'in' => 'query', + 'schema' => [ + 'description' => 'A unique business identifier you define, used for subsequent troubleshooting.'."\n" + .'Supports a combination of 32 alphanumeric characters, please ensure uniqueness.', + 'type' => 'string', + 'required' => true, + 'example' => 'e0c34a77f5ac40a5aa5e6ed20c35****', + ], + ], + [ + 'name' => 'MetaInfo', + 'in' => 'query', + 'schema' => [ + 'description' => 'MetaInfo environment parameter, which needs to be obtained through the client SDK.', + 'type' => 'string', + 'required' => true, + 'example' => '{"zimVer":"3.0.0","appVersion": "1","bioMetaInfo": "4.1.0:1150****,0","appName": "com.aliyun.antcloudauth","deviceType": "ios","osVersion": "iOS 10.3.2","apdidToken": "","deviceModel": "iPhone9,1"}', + ], + ], + [ + 'name' => 'CardType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Type of identification'."\n" + .'- Resident Second Generation ID Card: IDENTITY_CARD', + 'type' => 'string', + 'required' => true, + 'example' => 'IDENTITY_CARD', + ], + ], + [ + 'name' => 'Model', + 'in' => 'query', + 'schema' => [ + 'description' => 'Verification method, value:'."\n" + .'- OCR_VERIFY: OCR recognition and verification mode.', + 'type' => 'string', + 'required' => true, + 'example' => 'OCR_VERIFY', + ], + ], + [ + 'name' => 'VerifyMeta', + 'in' => 'query', + 'schema' => [ + 'description' => 'Verification type, value:'."\n" + .'- Identity two elements (name + ID number): ID_2_META', + 'type' => 'string', + 'required' => true, + 'example' => 'ID_2_META', + ], + ], + [ + 'name' => 'CardPageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of card pages collected by the SDK'."\n" + .'- You can input 1 or 2; input 1 to collect the front side, input 2 to collect both the front and back sides.'."\n" + ."\n" + .'- If the verification type is ID period (VerifyMeta value is ID_PERIOD), you must input 2.', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PictureSave', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to temporarily store the images collected by the app.'."\n" + .'- Y: Yes'."\n" + .'- N: No'."\n" + .'- If \'Yes\' is selected here, the query interface will support returning the card image information.', + 'type' => 'string', + 'required' => true, + 'example' => 'Y', + ], + ], + [ + 'name' => 'CallbackUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '- The callback notification address for the authentication result, which must start with https.'."\n" + .'- The platform will call back this address after completing the authentication and automatically add the certifyId and passed fields, example: https://www.aliyun.com?certifyId=xxxx&passed=T'."\n" + .'- Warning'."\n" + .'The callback is triggered only when the authentication is completed. If the authentication is abandoned, interrupted abnormally, or not performed, no notification will be sent. It is recommended that when you receive the callback notification, if necessary, you can obtain detailed authentication information through the query interface.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.aliyun.com', + ], + ], + [ + 'name' => 'CallbackToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'Security Token, used for anti-replay and anti-tampering checks. If this parameter is passed, the CallbackToken field will be displayed in the callback address.', + 'type' => 'string', + 'required' => false, + 'example' => 'NMjvQanQgplBSaEI0sL86WnQplB', + ], + ], + [ + 'name' => 'DocScanMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Enumeration of photo-taking methods (manual/auto)'."\n" + .'- Take a photo: shoot'."\n" + .'- Scan: scan '."\n" + .'- Auto switch: auto', + 'type' => 'string', + 'required' => false, + 'example' => 'shoot', + ], + ], + ], + '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.'."\n" + .'Important'."\n" + .'- This parameter indicates whether the interface was called correctly. For detailed return code descriptions, see the error codes.'."\n" + .'- Business results should be viewed through the fields in ResultObject.', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => 'Return result.', + 'type' => 'object', + 'properties' => [ + 'CertifyId' => [ + 'description' => 'Verification request ID, a unique identifier for the verification service\'s authentication request.'."\n" + .'- When querying the authentication result, the authentication request ID must be provided.'."\n" + ."\n" + .'- The CertifyId field is a billing statistics field. To facilitate subsequent bill reconciliation, please retain this field information locally. The CertifyId returned by the initialization interface is valid for 30 minutes and can only be submitted once for authentication. Please apply it within the validity period to avoid reuse.', + 'type' => 'string', + 'example' => '91707dc296d469ad38e4c5efa6a0****', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"130A2C10-B9EE-4D84-88E3-5384FF039795\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"CertifyId\\": \\"91707dc296d469ad38e4c5efa6a0****\\"\\n }\\n}","type":"json"}]', + 'title' => 'Initialization Interface', + 'description' => 'Before each authentication, use this interface to obtain the CertifyId, which is used to link various interfaces in the authentication request.', + 'translator' => 'machine', + ], + 'DescribeCardVerify' => [ + 'summary' => 'Obtain Authentication Results from Image Element Verification', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + ], + ], + 'parameters' => [ + [ + 'name' => 'CertifyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Authentication request ID.'."\n" + .'You must first call the initialization interface InitCardVerify to submit an authentication request in order to get the authentication request ID.', + 'type' => 'string', + 'required' => true, + 'example' => '91707dc296d469ad38e4c5efa6a0xxxx', + ], + ], + ], + '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-5384FF03****', + ], + 'Code' => [ + 'description' => 'Return code: 200 indicates success, all others indicate failure.'."\n" + .'Important'."\n" + .'- This parameter indicates whether the interface was called correctly. For detailed return code explanations, please refer to the error codes.'."\n" + .'- Please check the business verification results through the fields in ResultObject.', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Interface call return message.'."\n" + .'Important'."\n" + .'- This parameter only indicates whether there was an exception with the interface.', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => 'Result object.', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => 'Identity verification result:'."\n" + .'- 1: Consistent'."\n" + .'- 2: Inconsistent'."\n" + .'- 3: No Record Found', + 'type' => 'string', + 'example' => '1', + ], + 'CardInfo' => [ + 'description' => 'Submitted ID card information for verification.', + 'type' => 'string', + 'example' => '{"address":"浙江省杭州市余杭区文一西路969号","birthDate":"19901226","certName":"张三","certNo":"1234561990122*****","nationality":"汉","authority":"xxx公安局","startDate":"20201130","endDate":"20301130"}', + ], + 'PictureInfo' => [ + 'description' => 'Returned photo URLs.'."\n" + .'- certUrl Front side'."\n" + .'- certNationalUrl National emblem side', + 'type' => 'string', + 'example' => '{'."\n" + .' "certUrl": "https://cn-shanghai-aliyun-nmeta.cn-shanghai.oss.aliyuncs.com/verify/xxxxxxx/xxxxxxxxxx_ocridface_dbf2_normal.jpeg",'."\n" + .' "certNationalUrl": "https://cn-shanghai-aliyun-nmeta.cn-shanghai.oss.aliyuncs.com/verify/xxxxxxxxxx/xxxxxxxxxxx_ocridback_e8a3_normal.jpeg"'."\n" + .'}', + ], + 'OcrCardInfo' => [ + 'description' => 'ID card information read by OCR.', + 'type' => 'string', + 'example' => '{"address":"浙江省杭州市余杭区文一西路969号","birthDate":"19901226","certName":"张三","certNo":"1234561990122*****","nationality":"汉","authority":"xxx公安局","startDate":"20201130","endDate":"20301130"}', + ], + 'FaceDetail' => [ + 'description' => 'Image comparison score.', + 'type' => 'string', + 'example' => '{'."\n" + .' "verifyScore": 50.28594166529785'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"130A2C10-B9EE-4D84-88E3-5384FF03****\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"CardInfo\\": \\"{\\\\\\"address\\\\\\":\\\\\\"浙江省杭州市余杭区文一西路969号\\\\\\",\\\\\\"birthDate\\\\\\":\\\\\\"19901226\\\\\\",\\\\\\"certName\\\\\\":\\\\\\"张三\\\\\\",\\\\\\"certNo\\\\\\":\\\\\\"1234561990122*****\\\\\\",\\\\\\"nationality\\\\\\":\\\\\\"汉\\\\\\",\\\\\\"authority\\\\\\":\\\\\\"xxx公安局\\\\\\",\\\\\\"startDate\\\\\\":\\\\\\"20201130\\\\\\",\\\\\\"endDate\\\\\\":\\\\\\"20301130\\\\\\"}\\",\\n \\"PictureInfo\\": \\"{\\\\n \\\\\\"certUrl\\\\\\": \\\\\\"https://cn-shanghai-aliyun-nmeta.cn-shanghai.oss.aliyuncs.com/verify/xxxxxxx/xxxxxxxxxx_ocridface_dbf2_normal.jpeg\\\\\\",\\\\n \\\\\\"certNationalUrl\\\\\\": \\\\\\"https://cn-shanghai-aliyun-nmeta.cn-shanghai.oss.aliyuncs.com/verify/xxxxxxxxxx/xxxxxxxxxxx_ocridback_e8a3_normal.jpeg\\\\\\"\\\\n}\\",\\n \\"OcrCardInfo\\": \\"{\\\\\\"address\\\\\\":\\\\\\"浙江省杭州市余杭区文一西路969号\\\\\\",\\\\\\"birthDate\\\\\\":\\\\\\"19901226\\\\\\",\\\\\\"certName\\\\\\":\\\\\\"张三\\\\\\",\\\\\\"certNo\\\\\\":\\\\\\"1234561990122*****\\\\\\",\\\\\\"nationality\\\\\\":\\\\\\"汉\\\\\\",\\\\\\"authority\\\\\\":\\\\\\"xxx公安局\\\\\\",\\\\\\"startDate\\\\\\":\\\\\\"20201130\\\\\\",\\\\\\"endDate\\\\\\":\\\\\\"20301130\\\\\\"}\\",\\n \\"FaceDetail\\": \\"{\\\\n \\\\\\"verifyScore\\\\\\": 50.28594166529785\\\\n}\\"\\n }\\n}","type":"json"}]', + 'title' => 'Get Authentication Result Interface', + 'description' => 'After receiving the callback notification, you can use this interface on the server side to obtain the corresponding authentication status and information.', + 'translator' => 'machine', + ], + 'Id3MetaVerifyWithOCR' => [ + 'summary' => 'Identity Three Elements Image Verification', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CertUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Portrait side of the ID card image. A publicly accessible HTTP or HTTPS link. Choose either CertUrl or CertFile.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.aliyun.com/cert.jpeg'."\n", + ], + ], + [ + 'name' => 'CertFile', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Input stream for the portrait side of the ID card image. Choose either CertUrl or CertFile.', + 'type' => 'string', + 'required' => false, + 'example' => '无'."\n", + 'isFileTransferUrl' => true, + ], + ], + [ + 'name' => 'CertNationalUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => 'National emblem side of the ID card image URL. A publicly accessible HTTP or HTTPS link. You can choose either CertNationalUrl or CertNationalFile, or omit both.', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.aliyun.com/cert.jpeg', + ], + ], + [ + 'name' => 'CertNationalFile', + 'in' => 'formData', + 'schema' => [ + 'description' => 'URL for the national emblem side of the ID card image. Choose either CertNationalUrl or CertNationalFile, or omit both.', + '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' => '130A2C10-B9EE-4D84-88E3-5384FF03****'."\n", + ], + 'Code' => [ + 'description' => 'Return code: 200 indicates success, any other value indicates failure. **Important**'."\n" + ."\n" + .'- This parameter indicates whether the interface was called correctly. For a detailed explanation of return codes, please refer to the error codes.'."\n" + .'- The business verification result can be viewed through the fields in ResultObject.', + 'type' => 'string', + 'example' => '200'."\n", + ], + 'Message' => [ + 'description' => 'Interface call return message. **Important** This parameter only indicates whether there was an exception with the interface.', + 'type' => 'string', + 'example' => 'success'."\n", + ], + 'ResultObject' => [ + 'description' => 'Result object.', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => 'Identity verification result:'."\n" + ."\n" + .'- 1: Consistent'."\n" + .'- 2: Inconsistent'."\n" + .'- 3: No record found', + 'type' => 'string', + 'example' => '1', + ], + 'CardInfo' => [ + 'description' => 'Card ocr result.', + 'type' => 'string', + 'example' => '{"address":"浙江省杭州市余*****","birthDate":"19901226","certName":"张三","certNo":"1234561990122*****","nationality":"汉","authority":"xxx公安局","startDate":"20201130","endDate":"20301130"}', + ], + 'FaceDetail' => [ + 'description' => 'Face comparison score.', + 'type' => 'string', + 'example' => '{'."\n" + .' "verifyScore": 50.28594166529785'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"130A2C10-B9EE-4D84-88E3-5384FF03****\\\\n\\",\\n \\"Code\\": \\"200\\\\n\\",\\n \\"Message\\": \\"success\\\\n\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"CardInfo\\": \\"OCR读取的身份证信息。\\",\\n \\"FaceDetail\\": \\"{\\\\n \\\\\\"verifyScore\\\\\\": 50.28594166529785\\\\n}\\"\\n }\\n}","type":"json"}]', + 'title' => 'Identity Three Elements Image Verification', + 'description' => 'Upload both sides of the ID card to get the verification result of the three identity elements from an authoritative data source.', + 'translator' => 'machine', + ], + 'VehicleMetaVerifyV2' => [ + 'summary' => 'Enhanced Vehicle Element Verification', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '232381', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthA9Y5H0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Parameter type:'."\n" + ."\n" + .'- normal: Unencrypted.'."\n" + .'- md5: Md5 encrypted.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'normal' => '不加密', + 'md5' => 'md5加密', + ], + 'example' => 'normal', + ], + ], + [ + 'name' => 'VehicleType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Vehicle type', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 52 => '新能源小客车', + '02' => '普通小客车', + ], + 'example' => '02', + ], + ], + [ + 'name' => 'VerifyMetaType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Verification type'."\n" + ."\n" + .'> '."\n" + .'> - VEHICLE_2_META: Two-element verification, name + license plate number verification;'."\n" + .'> - VEHICLE_3_META: Three-element verification, name + license plate number + ID number verification;', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'VEHICLE_3_META' => '三要素核验', + 'VEHICLE_2_META' => '二要素核验', + ], + 'example' => 'VEHICLE_3_META', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'ID number.'."\n" + ."\n" + .'This is a required field when VerifyMetaType is VEHICLE_3_META.'."\n" + ."\n" + .'> '."\n" + .'> - When paramType is normal, enter plain text.'."\n" + .'> - When paramType is md5, enter the first 6 digits in plain text + MD5 (32 lowercase) of the birth date + the last 4 digits in plain text.', + 'type' => 'string', + 'required' => false, + 'example' => '4****************1', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Name'."\n" + .'> '."\n" + .'> - When paramType is normal, enter plain text.'."\n" + .'> - When paramType is md5, enter the first character of the name as MD5 (32 lowercase) + the rest of the name in plain text.', + 'type' => 'string', + 'required' => false, + 'example' => '张*', + ], + ], + [ + 'name' => 'VehicleNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'License plate number'."\n" + ."\n" + .'> '."\n" + .'> - When paramType is normal, enter plain text.'."\n" + .'> - When paramType is md5, enter all but the last two characters in plain text + the last two characters as MD5 (32 lowercase).', + 'type' => 'string', + 'required' => false, + 'example' => '陕A9****', + ], + ], + ], + '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' => '5A6229C0-E156-48E4-B6EC-0F528B******', + ], + 'Code' => [ + 'description' => 'Return code, **200** indicates successful API response.', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => 'Returned 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', + ], + 'VehicleInfo' => [ + 'description' => 'Detailed vehicle information.', + 'type' => 'string', + 'example' => '{'."\n" + .' "approvedCount": "7",'."\n" + .' "approvedLoad": "0",'."\n" + .' "axleCount": "2",'."\n" + .' "backWheelDistance": "1585",'."\n" + .' "brand": "雷克萨斯",'."\n" + .' "displacement": "4608",'."\n" + .' "engineNum": "1*********",'."\n" + .' "engineType": "1**",'."\n" + .' "frontWheelDistance": "1585",'."\n" + .' "fuelType": "汽油",'."\n" + .' "inspectionDate": "****-**-** **:**:**",'."\n" + .' "modelNum": "UR*****-******",'."\n" + .' "power": "228",'."\n" + .' "registrationDate": "****-**-** **:**:**",'."\n" + .' "retirementDate": "****-**-** **:**:**",'."\n" + .' "totalMass": "2940",'."\n" + .' "unladenMass": "2350",'."\n" + .' "useProperty": "非营运",'."\n" + .' "vehicleState": "正常",'."\n" + .' "vin": "JT***************",'."\n" + .' "wheelBase": "2790"'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A6229C0-E156-48E4-B6EC-0F528B******\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"VehicleInfo\\": \\"{\\\\n\\\\t\\\\\\"approvedCount\\\\\\": \\\\\\"7\\\\\\",\\\\n\\\\t\\\\\\"approvedLoad\\\\\\": \\\\\\"0\\\\\\",\\\\n\\\\t\\\\\\"axleCount\\\\\\": \\\\\\"2\\\\\\",\\\\n\\\\t\\\\\\"backWheelDistance\\\\\\": \\\\\\"1585\\\\\\",\\\\n\\\\t\\\\\\"brand\\\\\\": \\\\\\"雷克萨斯\\\\\\",\\\\n\\\\t\\\\\\"displacement\\\\\\": \\\\\\"4608\\\\\\",\\\\n\\\\t\\\\\\"engineNum\\\\\\": \\\\\\"1*********\\\\\\",\\\\n\\\\t\\\\\\"engineType\\\\\\": \\\\\\"1**\\\\\\",\\\\n\\\\t\\\\\\"frontWheelDistance\\\\\\": \\\\\\"1585\\\\\\",\\\\n\\\\t\\\\\\"fuelType\\\\\\": \\\\\\"汽油\\\\\\",\\\\n\\\\t\\\\\\"inspectionDate\\\\\\": \\\\\\"****-**-** **:**:**\\\\\\",\\\\n\\\\t\\\\\\"modelNum\\\\\\": \\\\\\"UR*****-******\\\\\\",\\\\n\\\\t\\\\\\"power\\\\\\": \\\\\\"228\\\\\\",\\\\n\\\\t\\\\\\"registrationDate\\\\\\": \\\\\\"****-**-** **:**:**\\\\\\",\\\\n\\\\t\\\\\\"retirementDate\\\\\\": \\\\\\"****-**-** **:**:**\\\\\\",\\\\n\\\\t\\\\\\"totalMass\\\\\\": \\\\\\"2940\\\\\\",\\\\n\\\\t\\\\\\"unladenMass\\\\\\": \\\\\\"2350\\\\\\",\\\\n\\\\t\\\\\\"useProperty\\\\\\": \\\\\\"非营运\\\\\\",\\\\n\\\\t\\\\\\"vehicleState\\\\\\": \\\\\\"正常\\\\\\",\\\\n\\\\t\\\\\\"vin\\\\\\": \\\\\\"JT***************\\\\\\",\\\\n\\\\t\\\\\\"wheelBase\\\\\\": \\\\\\"2790\\\\\\"\\\\n}\\"\\n }\\n}","type":"json"}]', + 'title' => 'Enhanced Vehicle Element Verification', + 'description' => 'Verifies the consistency of name, ID number, license plate number, and vehicle type, and supports returning detailed vehicle information.', + 'requestParamsDescription' => 'ParamType, VerifyMetaType, UserName, and VehicleNum are required parameters.', + 'translator' => 'machine', + ], + 'VehicleMetaVerify' => [ + 'summary' => 'Vehicle Element Verification', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '232494', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthA9Y5H0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Parameter type:'."\n" + ."\n" + .'- normal: Unencrypted.'."\n" + .'- md5: Encrypted with MD5.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'normal' => '不加密', + 'md5' => 'md5加密', + ], + 'example' => 'normal', + ], + ], + [ + 'name' => 'VehicleType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Vehicle type', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 52 => '新能源小客车', + '02' => '普通小客车', + ], + 'example' => '02', + ], + ], + [ + 'name' => 'VerifyMetaType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Verification type'."\n" + ."\n" + .'> '."\n" + .'> - VEHICLE_2_META: Two-element verification, name + vehicle license plate verification;'."\n" + .'> - VEHICLE_3_META: Three-element verification, name + vehicle license plate + ID number verification;', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'VEHICLE_3_META' => '三要素核验', + 'VEHICLE_2_META' => '二要素核验', + ], + 'example' => 'VEHICLE_2_META', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'ID number.'."\n" + ."\n" + .'This is a required field when VerifyMetaType is set to VEHICLE_3_META.'."\n" + .'> '."\n" + .'> - When paramType is set to normal, enter the plain text.'."\n" + .'> - When paramType is set to md5, enter the first 6 digits in plain text + the birth date encrypted with MD5 (32 lowercase characters) + the last 4 digits in plain text.', + 'type' => 'string', + 'required' => false, + 'example' => '4****************1', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Name'."\n" + ."\n" + .'> This is an explanation'."\n" + .'> - When paramType is set to normal, enter the plain text.'."\n" + .'> - When paramType is set to md5, encrypt the first character of the name with MD5 (32 lowercase characters) + the rest of the name in plain text.', + 'type' => 'string', + 'required' => false, + 'example' => '张**', + ], + ], + [ + 'name' => 'VehicleNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'Vehicle license plate'."\n" + ."\n" + .'> '."\n" + .'> - When paramType is set to normal, enter the plain text.'."\n" + .'> - When paramType is set to md5, enter the part of the license plate except for the last two characters in plain text + the last two characters of the license plate encrypted with MD5 (32 lowercase characters).', + 'type' => 'string', + 'required' => false, + 'example' => '陕A9****', + ], + ], + ], + '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' => '8FC3D6AC-9FED-4311-8DA7-C4BF4*****', + ], + 'Code' => [ + 'description' => 'Response code, **200** indicates that the API response was successful.', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Response message.', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => 'Returned result information.', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => 'Verification result.'."\n" + ."\n" + .'- 1: Consistent (billable)'."\n" + .'- 2: Inconsistent (billable)'."\n" + .'- 3: No record found (non-billable)', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8FC3D6AC-9FED-4311-8DA7-C4BF4*****\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\"\\n }\\n}","type":"json"}]', + 'title' => 'Vehicle Element Verification', + 'description' => 'Verifies the consistency of name, ID number, vehicle license plate, and vehicle type.', + 'requestParamsDescription' => 'ParamType, VerifyMetaType, VehicleNum, and UserName are required parameters.', + 'translator' => 'machine', + ], + 'Vehicle5ItemQuery' => [ + 'summary' => 'Five-Item Vehicle Information Recognition', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '232619', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthA9Y5H0', + ], + ], + 'parameters' => [ + [ + 'name' => 'VehicleType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Vehicle type'."\n" + ."\n" + .'> '."\n" + .'> - 02: Ordinary passenger car'."\n" + .'> - 52: New energy passenger car', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 52 => '新能源小客车', + '02' => '普通小客车', + ], + 'example' => '02', + ], + ], + [ + 'name' => 'VehicleNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'License plate number'."\n" + ."\n" + .'> '."\n" + .'> - When paramType is set to normal, enter the plain text.'."\n" + .'> - When paramType is set to md5, enter the plain text of all but the last two characters of the license plate + MD5 encryption (32-bit lowercase MD5) of the last two characters.', + 'type' => 'string', + 'required' => false, + 'example' => '陕A9****', + ], + ], + [ + 'name' => 'ParamType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Parameter type:'."\n" + ."\n" + .'- **normal**: Unencrypted.'."\n" + .'- **md5**: MD5 encrypted.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'normal' => '不加密', + 'md5' => 'md5加密', + ], + 'example' => 'normal', + ], + ], + ], + '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' => '473469C7-AA6F-4DC5-B3DB-A3DC0D******', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => 'Return code', + 'type' => 'string', + 'example' => '200', + ], + 'ResultObject' => [ + 'description' => 'Returned result information.', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => 'Verification result code:'."\n" + .'- **1**: Found (charged)'."\n" + .'- **3**: No record found (not charged)', + 'type' => 'string', + 'example' => '1', + ], + 'VehicleInfo' => [ + 'description' => 'Vehicle information', + 'type' => 'string', + 'example' => '{'."\n" + .' "engineNo": "F0******",'."\n" + .' "useProperty": 0,'."\n" + .' "registrationDate": "****-**-** **:**:**",'."\n" + .' "engineType": "B******",'."\n" + .' "vin": "A********",'."\n" + .' "state": "0",'."\n" + .' "modelNo": "B********",'."\n" + .' "type": "小型轿车",'."\n" + .' "brand": "宝马",'."\n" + .' "usePropertyDesc": "非营运",'."\n" + .' "stateDesc": "正常"'."\n" + .' }', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0D******\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": \\"200\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"VehicleInfo\\": \\"{\\\\n \\\\\\"engineNo\\\\\\": \\\\\\"F0******\\\\\\",\\\\n \\\\\\"useProperty\\\\\\": 0,\\\\n \\\\\\"registrationDate\\\\\\": \\\\\\"****-**-** **:**:**\\\\\\",\\\\n \\\\\\"engineType\\\\\\": \\\\\\"B******\\\\\\",\\\\n \\\\\\"vin\\\\\\": \\\\\\"A********\\\\\\",\\\\n \\\\\\"state\\\\\\": \\\\\\"0\\\\\\",\\\\n \\\\\\"modelNo\\\\\\": \\\\\\"B********\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"小型轿车\\\\\\",\\\\n \\\\\\"brand\\\\\\": \\\\\\"宝马\\\\\\",\\\\n \\\\\\"usePropertyDesc\\\\\\": \\\\\\"非营运\\\\\\",\\\\n \\\\\\"stateDesc\\\\\\": \\\\\\"正常\\\\\\"\\\\n }\\"\\n }\\n}","type":"json"}]', + 'title' => 'Five-Item Vehicle Information Recognition', + 'description' => 'Query basic vehicle information through the license plate number and vehicle type.', + 'requestParamsDescription' => 'ParamType and VehicleNum are required parameters.', + 'translator' => 'machine', + ], + 'VehicleQuery' => [ + 'summary' => 'Vehicle Information Recognition', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '232984', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthA9Y5H0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Parameter type:'."\n" + ."\n" + .'- **normal**: Unencrypted.'."\n" + .'- **md5**: MD5 encrypted.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'normal' => '不加密', + 'md5' => 'md5加密', + ], + 'example' => 'normal', + ], + ], + [ + 'name' => 'VehicleType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Vehicle type', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 52 => '新能源小客车', + '02' => '普通小客车', + ], + 'example' => '02', + ], + ], + [ + 'name' => 'VehicleNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'License plate number'."\n" + ."\n" + .'> '."\n" + .'> - When paramType is set to normal, enter the plain text.'."\n" + .'> - When paramType is set to md5, enter the unencrypted part of the license plate number except for the last two characters + the MD5 (32 lowercase) encryption of the last two characters of the license plate.', + 'type' => 'string', + 'required' => false, + 'example' => '陕A9****'."\n", + ], + ], + ], + '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' => 'D6163397-15C5-419C-9ACC-B7C83*******', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => 'Return code: 200 for success, others for failure', + 'type' => 'string', + 'example' => '200', + ], + 'ResultObject' => [ + 'description' => 'Request result', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => 'Verification result code:'."\n" + ."\n" + .'> '."\n" + .'> - 1: Found (charged)'."\n" + .'> - 3: No record found (not charged)', + 'type' => 'string', + 'example' => '1', + ], + 'VehicleInfo' => [ + 'description' => 'Vehicle information.', + 'type' => 'string', + 'example' => '{'."\n" + .' "approvedCount": 7,'."\n" + .' "approvedLoad": 0,'."\n" + .' "axleCount": 2,'."\n" + .' "backWheelDistance": 1585,'."\n" + .' "brand": "雷克萨斯",'."\n" + .' "compulsoryScrapTo": "****-**-** **:**:**",'."\n" + .' "displacement": 4608,'."\n" + .' "engineNo": "1UR0******",'."\n" + .' "engineType": "1**",'."\n" + .' "frontWheelDistance": 1585,'."\n" + .' "fuelType": "汽油",'."\n" + .' "high": 1860,'."\n" + .' "inspectionResultEffectiveTo": "****-**-** **:**:**",'."\n" + .' "modelNo": "UR*****-******",'."\n" + .' "power": 228,'."\n" + .' "registrationDate": "****-**-** **:**:**",'."\n" + .' "releaseDate": "",'."\n" + .' "state": "0",'."\n" + .' "stateDesc": "正常",'."\n" + .' "totalMass": 2940,'."\n" + .' "unladenMass": 2350,'."\n" + .' "useProperty": 0,'."\n" + .' "usePropertyDesc": "非营运",'."\n" + .' "long": 4890,'."\n" + .' "vin": "A***********",'."\n" + .' "wheelBase": 2790,'."\n" + .' "wide": 1910'."\n" + .'}'."\n", + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6163397-15C5-419C-9ACC-B7C83*******\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": \\"200\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"VehicleInfo\\": \\"{\\\\n\\\\t\\\\\\"approvedCount\\\\\\": 7,\\\\n\\\\t\\\\\\"approvedLoad\\\\\\": 0,\\\\n\\\\t\\\\\\"axleCount\\\\\\": 2,\\\\n\\\\t\\\\\\"backWheelDistance\\\\\\": 1585,\\\\n\\\\t\\\\\\"brand\\\\\\": \\\\\\"雷克萨斯\\\\\\",\\\\n\\\\t\\\\\\"compulsoryScrapTo\\\\\\": \\\\\\"****-**-** **:**:**\\\\\\",\\\\n\\\\t\\\\\\"displacement\\\\\\": 4608,\\\\n\\\\t\\\\\\"engineNo\\\\\\": \\\\\\"1UR0******\\\\\\",\\\\n\\\\t\\\\\\"engineType\\\\\\": \\\\\\"1**\\\\\\",\\\\n\\\\t\\\\\\"frontWheelDistance\\\\\\": 1585,\\\\n\\\\t\\\\\\"fuelType\\\\\\": \\\\\\"汽油\\\\\\",\\\\n\\\\t\\\\\\"high\\\\\\": 1860,\\\\n\\\\t\\\\\\"inspectionResultEffectiveTo\\\\\\": \\\\\\"****-**-** **:**:**\\\\\\",\\\\n\\\\t\\\\\\"modelNo\\\\\\": \\\\\\"UR*****-******\\\\\\",\\\\n\\\\t\\\\\\"power\\\\\\": 228,\\\\n\\\\t\\\\\\"registrationDate\\\\\\": \\\\\\"****-**-** **:**:**\\\\\\",\\\\n\\\\t\\\\\\"releaseDate\\\\\\": \\\\\\"\\\\\\",\\\\n\\\\t\\\\\\"state\\\\\\": \\\\\\"0\\\\\\",\\\\n\\\\t\\\\\\"stateDesc\\\\\\": \\\\\\"正常\\\\\\",\\\\n\\\\t\\\\\\"totalMass\\\\\\": 2940,\\\\n\\\\t\\\\\\"unladenMass\\\\\\": 2350,\\\\n\\\\t\\\\\\"useProperty\\\\\\": 0,\\\\n\\\\t\\\\\\"usePropertyDesc\\\\\\": \\\\\\"非营运\\\\\\",\\\\n\\\\t\\\\\\"long\\\\\\": 4890,\\\\n\\\\t\\\\\\"vin\\\\\\": \\\\\\"A***********\\\\\\",\\\\n\\\\t\\\\\\"wheelBase\\\\\\": 2790,\\\\n\\\\t\\\\\\"wide\\\\\\": 1910\\\\n}\\\\n\\"\\n }\\n}","type":"json"}]', + 'title' => 'Vehicle Information Recognition', + 'description' => 'Query detailed vehicle information through the license plate number and vehicle type.', + 'requestParamsDescription' => 'ParamType and VehicleNum are required fields.', + 'translator' => 'machine', + ], + 'VehicleInsureQuery' => [ + 'summary' => 'Vehicle Insurance Date Inquiry', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '232986', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthA9Y5H0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Parameter type:'."\n" + ."\n" + .'- **normal**: Unencrypted.'."\n" + .'- **md5**: MD5 encrypted.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'normal' => '不加密', + 'md5' => 'md5加密', + ], + 'example' => 'normal', + ], + ], + [ + 'name' => 'VehicleType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Driver\'s license vehicle type.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 52 => '新能源小客车', + '02' => '普通小客车', + ], + 'example' => '02', + ], + ], + [ + 'name' => 'VehicleNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'License plate number'."\n" + .'> '."\n" + .'> - When `paramType` is set to `normal`, enter the plain text.'."\n" + .'> - When `paramType` is set to `md5`, enter the plain text of all but the last two characters of the license plate + the MD5 encryption (32 lowercase characters) of the last two characters of the license plate.', + 'type' => 'string', + 'required' => false, + 'example' => '陕A9****', + ], + ], + [ + 'name' => 'Vin', + 'in' => 'query', + 'schema' => [ + 'description' => 'Vehicle identification code, i.e., the vehicle VIN'."\n" + ."\n\n" + .'> '."\n" + .'> - When `paramType` is set to `normal`, enter the plain text.'."\n" + .'> - When `paramType` is set to `md5`, enter the plain text of all but the last four characters of the VIN + the MD5 encryption (32 lowercase characters) of the last four characters of the VIN.', + 'type' => 'string', + 'required' => false, + 'example' => 'LB**************', + ], + ], + ], + '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' => '5A6229C0-E156-48E4-B6EC-0F52********', + ], + 'Message' => [ + 'description' => 'Response message for the request information.', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => 'Return code: 200 indicates success, others indicate failure.', + 'type' => 'string', + 'example' => '200', + ], + 'ResultObject' => [ + 'description' => 'Returned result information.', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => 'Verification result code:'."\n" + ."\n" + .'> '."\n" + .'> - 1: Found (charged)'."\n" + .'> - 3: No record found (not charged)', + 'type' => 'string', + 'example' => '1', + ], + 'VehicleInfo' => [ + 'description' => 'Insurance date information', + 'type' => 'string', + 'example' => '{'."\n" + .' "firstInsuranceDate": "****-**-**",'."\n" + .' "lastInsuranceDate": "****-**",'."\n" + .' "latestInsuranceDate": "****-**",'."\n" + .' "latestInsuranceDateStart": "****-**"'."\n" + .' }', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A6229C0-E156-48E4-B6EC-0F52********\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": \\"200\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"VehicleInfo\\": \\"{\\\\n \\\\\\"firstInsuranceDate\\\\\\": \\\\\\"****-**-**\\\\\\",\\\\n \\\\\\"lastInsuranceDate\\\\\\": \\\\\\"****-**\\\\\\",\\\\n \\\\\\"latestInsuranceDate\\\\\\": \\\\\\"****-**\\\\\\",\\\\n \\\\\\"latestInsuranceDateStart\\\\\\": \\\\\\"****-**\\\\\\"\\\\n }\\"\\n }\\n}","type":"json"}]', + 'title' => 'Vehicle Insurance Date Inquiry', + 'description' => 'Query the vehicle insurance date through the license plate number, vehicle type, and vehicle identification number (VIN).', + 'requestParamsDescription' => 'ParamType and Vin are required fields.', + 'responseParamsDescription' => 'None', + 'translator' => 'machine', + ], + 'VerifyMaterial' => [ + 'summary' => 'Call VerifyMaterial, in a pure server-side access authentication solution, input name, ID number, portrait photo, and front and back photos of the ID card (optional) for real-person authentication, and return the authentication result synchronously.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '59176', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHOSIED', + ], + ], + 'parameters' => [ + [ + 'name' => 'IdCardBackImageUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP or HTTPS link to the national emblem side of the ID card.', + 'type' => 'string', + 'required' => false, + 'example' => 'http://image-demo.img-cn-hangzhou.aliyuncs.com/example3.jpg', + ], + ], + [ + 'name' => 'FaceImageUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP or HTTPS link to the frontal face image.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Identifier for the business scenario using the real-person authentication service. Please refer to [Business Setup](~~127885~~) and complete the creation in the console first.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'RPMinTest', + ], + ], + [ + 'name' => 'BizId', + 'in' => 'query', + 'schema' => [ + 'description' => 'A unique ID that identifies a single authentication task, not exceeding 64 characters. For a single authentication task, the system supports unlimited submissions until the final authentication is passed and the task is completed.'."\n" + ."\n" + .'> Different BizIds are required for different authentication tasks.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '39ecf51e-2f81-4dc5-90ee-ff86125b****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'Name.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '张三', + ], + ], + [ + 'name' => 'IdCardNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'ID number.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '02343218901123****', + ], + ], + [ + 'name' => 'IdCardFrontImageUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP or HTTPS link to the portrait side of the ID card image.', + 'type' => 'string', + 'required' => false, + 'example' => 'http://image-demo.img-cn-hangzhou.aliyuncs.com/example2.jpg', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the end user, such as the account ID of the end user.', + 'type' => 'string', + 'required' => false, + 'example' => '54sdj', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AuthorityComparisionScore' => [ + 'description' => 'Comparison score between the facial photo submitted during the authentication process and authoritative data, with a range of **0**~**100**.'."\n" + ."\n" + .'Confidence threshold references:'."\n" + .'- False recognition rate 0.001% corresponds to a threshold of 95.'."\n" + .'- False recognition rate 0.01% corresponds to a threshold of 90.'."\n" + .'- False recognition rate 0.1% corresponds to a threshold of 80.'."\n" + .'- False recognition rate 1% corresponds to a threshold of 60.'."\n" + ."\n" + .'> This field only indicates the comparison result between the face and authoritative data, serving as a reference score. It is generally not recommended to use this score alone as the pass/fail criterion. For the comprehensive authentication result, please refer to the **VerifyStatus** field. The **VerifyStatus** result integrates the face-to-authoritative data comparison and other various strategies, enhancing security levels.', + 'type' => 'number', + 'format' => 'float', + 'example' => '97', + ], + 'VerifyStatus' => [ + 'description' => 'Authentication status. Values:'."\n" + ."\n" + .'- **1**: Authentication passed.'."\n" + .'- **2**~**n**: Authentication failed due to various reasons. For detailed descriptions, see the **Authentication Status Explanation** below.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'VerifyToken' => [ + 'description' => 'Token for this authentication, used to link various interfaces in the authentication request, valid for 30 minutes.', + 'type' => 'string', + 'example' => 'c302c0797679457685410ee51a5ba375', + ], + 'IdCardFaceComparisonScore' => [ + 'description' => 'Comparison score between the facial photo submitted during the authentication process and the face on the portrait side of the ID card image, with a range of **0**~**100**.'."\n" + ."\n" + .'Confidence threshold references:'."\n" + .'- False recognition rate 0.001% corresponds to a threshold of 95.'."\n" + .'- False recognition rate 0.01% corresponds to a threshold of 90.'."\n" + .'- False recognition rate 0.1% corresponds to a threshold of 80.'."\n" + .'- False recognition rate 1% corresponds to a threshold of 60.', + 'type' => 'number', + 'format' => 'float', + 'example' => '97', + ], + 'Material' => [ + 'description' => 'Authentication materials.', + 'type' => 'object', + 'properties' => [ + 'IdCardNumber' => [ + 'description' => 'ID number, corresponding to the request parameter **IdCardNumber**.', + 'type' => 'string', + 'example' => '02343218901123****', + ], + 'FaceGlobalUrl' => [ + 'description' => 'Global camera image captured by the real-person authentication SDK.'."\n" + ."\n" + .'> This parameter will take effect after configuration. If you need to use this parameter, please submit a [ticket](https://selfservice.console.aliyun.com/ticket/category/cloudauth/today) to contact us.', + 'type' => 'string', + 'example' => 'http://image-demo.img-cn-hangzhou.aliyuncs.com/face-global-example.jpg ', + ], + 'FaceImageUrl' => [ + 'description' => 'HTTP or HTTPS link to the frontal face image, corresponding to the request parameter **FaceImageUrl**. The link is valid for 5 minutes, and it is recommended to store it in your business to avoid affecting usage.', + 'type' => 'string', + 'example' => 'http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg', + ], + 'FaceMask' => [ + 'description' => 'Whether the face is wearing a mask. Values:'."\n" + .'- **true**: Wearing a mask'."\n" + .'- **false**: Not wearing a mask', + 'type' => 'string', + 'example' => 'false', + ], + 'IdCardName' => [ + 'description' => 'Name, corresponding to the request parameter **Name**.', + 'type' => 'string', + 'example' => '张三', + ], + 'FaceQuality' => [ + 'description' => 'The quality of the frontal face image. Possible values:'."\n" + .'- **UNQUALIFIED**: Poor quality'."\n" + .'- **LOW**: Low'."\n" + .'- **NORMAL**: Average'."\n" + .'- **HIGH**: High', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'IdCardInfo' => [ + 'description' => 'OCR result of the ID card information.'."\n" + ."\n" + .'> If there is no front or back of the ID card during the verification process, the OCR result of the ID card information will not be returned. Even if the front and back of the ID card are present during the verification process, it does not guarantee that all the information on the ID card will be returned. Due to issues such as poor ID card photography, the OCR may fail to recognize some information, leading to incomplete OCR results. It is recommended that the business side does not heavily rely on the ID card OCR information.', + 'type' => 'object', + 'properties' => [ + 'EndDate' => [ + 'description' => 'End date of the document\'s validity period. Format: yyyymmdd.', + 'type' => 'string', + 'example' => '20201101', + ], + 'Authority' => [ + 'description' => 'Issuing authority.', + 'type' => 'string', + 'example' => '杭州市公安局', + ], + 'Address' => [ + 'description' => 'Address.', + 'type' => 'string', + 'example' => '浙江省杭州市余杭区文一西路969号', + ], + 'Number' => [ + 'description' => 'ID number.', + 'type' => 'string', + 'example' => '02343218901123****', + ], + 'StartDate' => [ + 'description' => 'Start date of the document\'s validity period. Format: yyyymmdd.', + 'type' => 'string', + 'example' => '20201101', + ], + 'BackImageUrl' => [ + 'description' => 'HTTP or HTTPS link to the national emblem side of the ID card. The link is valid for 5 minutes. It is recommended to store it in your business system to avoid any impact on usage.', + 'type' => 'string', + 'example' => 'http://image-demo.img-cn-hangzhou.aliyuncs.com/example3.jpg', + ], + 'Nationality' => [ + 'description' => 'Nationality.', + 'type' => 'string', + 'example' => '汉', + ], + 'Birth' => [ + 'description' => 'Date of birth.', + 'type' => 'string', + 'example' => '19900101', + ], + 'Name' => [ + 'description' => 'Name.', + 'type' => 'string', + 'example' => '张三', + ], + 'FrontImageUrl' => [ + 'description' => 'HTTP or HTTPS link to the portrait side of the ID card. The link is valid for 5 minutes. It is recommended to store it in your business system to avoid any impact on usage.', + 'type' => 'string', + 'example' => 'http://image-demo.img-cn-hangzhou.aliyuncs.com/example2.jpg', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.MaterialsNotValid', + 'errorMessage' => 'The param materials is not valid.', + ], + ], + [ + [ + 'errorCode' => 'Error.InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"AuthorityComparisionScore\\": 97,\\n \\"VerifyStatus\\": 1,\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"VerifyToken\\": \\"c302c0797679457685410ee51a5ba375\\",\\n \\"IdCardFaceComparisonScore\\": 97,\\n \\"Material\\": {\\n \\"IdCardNumber\\": \\"02343218901123****\\",\\n \\"FaceGlobalUrl\\": \\"http://image-demo.img-cn-hangzhou.aliyuncs.com/face-global-example.jpg \\",\\n \\"FaceImageUrl\\": \\"http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg\\",\\n \\"FaceMask\\": \\"false\\",\\n \\"IdCardName\\": \\"张三\\",\\n \\"FaceQuality\\": \\"NORMAL\\",\\n \\"IdCardInfo\\": {\\n \\"EndDate\\": \\"20201101\\",\\n \\"Authority\\": \\"杭州市公安局\\",\\n \\"Address\\": \\"浙江省杭州市余杭区文一西路969号\\",\\n \\"Number\\": \\"02343218901123****\\",\\n \\"StartDate\\": \\"20201101\\",\\n \\"BackImageUrl\\": \\"http://image-demo.img-cn-hangzhou.aliyuncs.com/example3.jpg\\",\\n \\"Nationality\\": \\"汉\\",\\n \\"Birth\\": \\"19900101\\",\\n \\"Name\\": \\"张三\\",\\n \\"FrontImageUrl\\": \\"http://image-demo.img-cn-hangzhou.aliyuncs.com/example2.jpg\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n\\t<VerifyMaterialResponse>\\r\\n\\t\\t<VerifyToken>c302c0797679457685410ee51a5ba375</VerifyToken>\\r\\n\\t\\t<VerifyStatus>1</VerifyStatus>\\r\\n\\t\\t<Material>\\r\\n\\t\\t\\t<FaceImageUrl>http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg</FaceImageUrl>\\r\\n\\t\\t\\t<FaceMask>false</FaceMask>\\r\\n\\t\\t\\t<FaceQuality>NORMAL</FaceQuality>\\r\\n\\t\\t\\t<IdCardName>张三</IdCardName>\\r\\n\\t\\t\\t<IdCardNumber>02343218901123****</IdCardNumber>\\r\\n\\t\\t\\t<IdCardInfo>\\r\\n\\t\\t\\t\\t<FrontImageUrl>http://image-demo.img-cn-hangzhou.aliyuncs.com/example2.jpg</FrontImageUrl>\\r\\n\\t\\t\\t\\t<BackImageUrl>http://image-demo.img-cn-hangzhou.aliyuncs.com/example3.jpg</BackImageUrl>\\r\\n\\t\\t\\t\\t<Name>张三</Name>\\r\\n\\t\\t\\t\\t<Number>02343218901123****</Number>\\r\\n\\t\\t\\t\\t<Birth>19900101</Birth>\\r\\n\\t\\t\\t\\t<Address>浙江省杭州市余杭区文一西路969号</Address>\\r\\n\\t\\t\\t\\t<StartDate>20101101</StartDate>\\r\\n\\t\\t\\t\\t<EndDate>20201101</EndDate>\\r\\n\\t\\t\\t\\t<Authority>杭州市公安局</Authority>\\r\\n\\t\\t\\t</IdCardInfo>\\r\\n\\t\\t</Material>\\r\\n\\t\\t<AuthorityComparisonScore>97</AuthorityComparisonScore>\\r\\n\\t</VerifyMaterialResponse>","errorExample":""}]', + 'title' => 'VerifyMaterial', + 'description' => 'Preparation for Access: When integrating this API, please ensure that the corresponding preparatory work has been completed. For details, please refer to [Server-side Access Preparation](~~127471~~).'."\n" + ."\n" + .'Request Method: HTTPS POST and GET.'."\n" + ."\n" + .'API Description: The server of the access party submits the authentication materials to the real-person authentication service for verification and comparison, with the results returned synchronously.'."\n" + ."\n" + .'Applicable Scope: This interface is only applicable to pure server-side access authentication solutions.'."\n" + ."\n" + .'Image Upload Address Explanation:'."\n" + ."\n" + .'- HTTP or HTTPS address: Supports publicly accessible HTTP or HTTPS addresses. For example, `http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg`.'."\n" + .'- OSS address: If the images from the access party are local files, Alibaba Cloud also provides an upload SDK, supporting the business party to upload the images to the specified OSS bucket of the real-person authentication service, and use the obtained OSS address as the image address parameter in the interface. If your business needs to use the upload SDK, please submit a [ticket](https://selfservice.console.aliyun.com/ticket/category/cloudauth/today) to contact us for acquisition.'."\n" + ."\n" + .'Image Limitations:'."\n" + ."\n" + .'- Does not support relative or absolute paths of local images.'."\n" + .'- Please keep the size of a single image within 2 MB to avoid algorithm retrieval timeout.'."\n" + .'- The face area in the image should be at least 64*64 pixels.'."\n" + .'- There is an 8 MB size limit for the Body of a single request. Please calculate the total size of all images and other information in the request, and do not exceed the limit.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '**Authentication Status Explanation**'."\n" + ."\n" + .'|VerifyStatus|Reason Description |'."\n" + .'|--------------|--------------------------------------------------------------------------------------------------------------------------------------|'."\n" + .'| 1 | Authentication passed. |'."\n" + .'| 2 | Authentication failed, reason: real-name verification did not pass. |'."\n" + .'| 3 | Authentication failed, possible reasons: blurry ID photo, unrecognizable text due to lighting issues, inconsistency between ID photo information and the name on the ID to be verified, submitted photo is not an ID photo. |'."\n" + .'| 4 | Authentication failed, possible reasons: blurry ID photo, unrecognizable text due to lighting issues, inconsistency between ID photo information and the ID number on the ID to be verified, submitted photo is not an ID photo. |'."\n" + .'| 5 | Authentication failed, possible reason: the validity period on the ID photo has expired (or is about to expire). |'."\n" + .'| 6 | Authentication failed, possible reason: inconsistency between the face and the ID photo. |'."\n" + .'| 7 | Authentication failed, possible reason: inconsistency between the face and the police network photo. |'."\n" + .'| 8 | Authentication failed, possible reasons: the submitted ID photo is not the original ID photo, no valid ID photo was submitted. |'."\n" + .'| 9 | Authentication failed, possible reason: operation not performed by the account holder. |'."\n" + .'| 11| Authentication failed, possible reasons: missing police network photo, incorrect format of the police network photo, no face found in the police network photo. |'."\n" + .'| 12 | Authentication failed, possible reason: police network system anomaly, unable to perform photo comparison, etc. |', + 'extraInfo' => ' ', + 'translator' => 'machine', + ], + 'DescribeVerifyToken' => [ + 'summary' => 'Call DescribeVerifyToken to initiate an authentication request and obtain an authentication Token. This interface is suitable for authentication solutions using SDK + server-side integration.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59156', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth6RJHVQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'IdCardBackImageUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP or HTTPS link to the national emblem side of the ID card image.', + 'type' => 'string', + 'required' => false, + 'example' => 'http%3A%2F%2Fjiangsu.china.com.cn%2Fuploadfile%2F2015%2F0114%2F1421221304095989.jpg', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Identifier for the business scenario using the real person authentication service. Please refer to [Business Settings](~~127885~~) and complete the creation in the console first.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'RPBasicTest', + ], + ], + [ + 'name' => 'FailedRedirectUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'Redirect URL for failed verification.', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'FaceRetainedImageUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP or HTTPS link to the retained portrait photo.', + 'type' => 'string', + 'required' => false, + 'example' => 'http%3A%2F%2Fjiangsu.china.com.cn%2Fuploadfile%2F2015%2F0114%2F1421221304095989.jpg', + ], + ], + [ + 'name' => 'CallbackSeed', + 'in' => 'query', + 'schema' => [ + 'description' => 'Callback seed.', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'IdCardFrontImageUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP or HTTPS link to the portrait side of the ID card image.', + 'type' => 'string', + 'required' => false, + 'example' => 'http%3A%2F%2Fjiangsu.china.com.cn%2Fuploadfile%2F2015%2F0114%2F1421221304095989.jpg', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ID of the end user, such as the account ID of the end user.', + 'type' => 'string', + 'required' => false, + 'example' => 'user111', + ], + ], + [ + 'name' => 'BizId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Verification ID. A unique ID that identifies a verification task, not exceeding 64 characters. For a single verification task, the system supports unlimited submissions until the final verification is passed and the task is completed.'."\n" + ."\n" + .'> Different BizIds are required for different verification tasks.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '39ecf51e-2f81-4dc5-90ee-ff86125be683', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'Name.', + 'type' => 'string', + 'required' => false, + 'example' => '张三', + ], + ], + [ + 'name' => 'IdCardNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'ID card number.', + 'type' => 'string', + 'required' => false, + 'example' => '330100xxxxxxxxxxxx', + ], + ], + [ + 'name' => 'PassedRedirectUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'Redirect URL upon successful verification.', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'CallbackUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'Callback URL.', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'UserIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'User IP.', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.***.***', + ], + ], + [ + 'name' => 'UserPhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'User phone number.', + 'type' => 'string', + 'required' => false, + 'example' => '187********', + ], + ], + [ + 'name' => 'UserRegistTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'User registration time. Expressed in timestamp format, unit: milliseconds.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1577808000000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'VerifyPageUrl' => [ + 'description' => 'The entry link for the original H5 verification scheme, which has been discontinued and no longer supports new integrations. If you need to integrate an H5 verification scheme, it is recommended to use the [PC or mobile H5 web integration solution](~~173779~~) of financial-grade real-person authentication.', + 'type' => 'string', + 'example' => 'http%3A%2F%2Fjiangsu.china.com.cn%2Fuploadfile%2F2015%2F0114%2F1421221304095989.jpg', + ], + 'RequestId' => [ + 'description' => 'The ID of this request.', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'VerifyToken' => [ + 'description' => 'The token for this verification, used to link various interfaces in the verification request, valid for 30 minutes.', + 'type' => 'string', + 'example' => 'c302c0797679457685410ee51a5ba375', + ], + 'OssUploadToken' => [ + 'description' => 'OSS upload token information.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key required for file upload.', + 'type' => 'string', + 'example' => 'STS.NU8rUBj****', + ], + 'Token' => [ + 'description' => 'The token required for file upload.', + 'type' => 'string', + 'example' => 'uWia500nTS5knZaDzq4/KqpvhcLnO****', + ], + 'Secret' => [ + 'description' => 'The secret required for file upload.', + 'type' => 'string', + 'example' => 'FwmnyoqT8dHj7nJLuM67T****', + ], + 'Expired' => [ + 'description' => 'Expiration time. Expressed in timestamp format, unit: milliseconds.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1582636610000', + ], + 'Path' => [ + 'description' => 'File storage path.', + 'type' => 'string', + 'example' => 'prod/RdNLC@Ox2n-1s7NMt', + ], + 'EndPoint' => [ + 'description' => 'Access endpoint.', + 'type' => 'string', + 'example' => 'https://oss-cn-zhangjiakou.aliyuncs.com', + ], + 'Bucket' => [ + 'description' => 'OSS file storage bucket.', + 'type' => 'string', + 'example' => 'cloudauth-zhangjiakou-external', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ImageValuePatternError', + 'errorMessage' => 'The pattern of value of given image is not acceptable.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'RAM caller has no permission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"VerifyPageUrl\\": \\"http%3A%2F%2Fjiangsu.china.com.cn%2Fuploadfile%2F2015%2F0114%2F1421221304095989.jpg\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"VerifyToken\\": \\"c302c0797679457685410ee51a5ba375\\",\\n \\"OssUploadToken\\": {\\n \\"Key\\": \\"STS.NU8rUBj****\\",\\n \\"Token\\": \\"uWia500nTS5knZaDzq4/KqpvhcLnO****\\",\\n \\"Secret\\": \\"FwmnyoqT8dHj7nJLuM67T****\\",\\n \\"Expired\\": 1582636610000,\\n \\"Path\\": \\"prod/RdNLC@Ox2n-1s7NMt\\",\\n \\"EndPoint\\": \\"https://oss-cn-zhangjiakou.aliyuncs.com\\",\\n \\"Bucket\\": \\"cloudauth-zhangjiakou-external\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\r\\n<DescribeVerifyTokenResponse>\\r\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\r\\n <VerifyToken>c302c0797679457685410ee51a5ba375</VerifyToken>\\r\\n</DescribeVerifyTokenResponse>","errorExample":""}]', + 'title' => 'DescribeVerifyToken', + 'description' => 'Preparation for Access: When integrating this API, please ensure that the corresponding preparations have been completed. For details, see [Overview of Real Person Authentication Solution Integration Process](~~127536~~) and [Overview of Live Face Verification Solution (Liveness Detection Solution) Integration Process](~~127687~~).'."\n" + ."\n" + .'Request Method: HTTPS POST and GET'."\n" + ."\n" + .'API Description: Before each authentication, use this interface to obtain an authentication Token (VerifyToken), which is used to link various interfaces in the authentication request.'."\n" + ."\n" + .'Applicable Scope: This interface is suitable for wireless SDK integration.'."\n" + ."\n" + .'Image Address: Use HTTP or HTTPS addresses that are publicly accessible over the Internet. For example, `http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg`.'."\n" + ."\n" + .'Image Restrictions:'."\n" + ."\n" + .'- Relative or absolute paths of local images are not supported.'."\n" + .'- The size of a single image should be controlled within 2 MB to avoid algorithm retrieval timeout.'."\n" + .'- The face area in the image must be at least 64*64 pixels (px).'."\n" + .'- There is an 8 MB size limit for the Body of a single request. Please calculate the total size of all images and other information in the request to ensure it does not exceed the limit.', + 'requestParamsDescription' => 'Depending on the chosen authentication solution, the required fields to be passed may vary. Please refer to the table below for specific instructions.'."\n" + ."\n" + .'| Authentication Solution | Name Field | IdCardNumber Field | IdCardFrontImageUrl Field | IdCardBackImageUrl Field | FaceRetainedImageUrl Field |'."\n" + .'|-------------------------|------------|--------------------|---------------------------|--------------------------|----------------------------|'."\n" + .'| RPBasic | No | No | No | No | No |'."\n" + .'| RPManual | No | No | No | No | No |'."\n" + .'| RPBioID | Yes | Yes | No | No | No |'."\n" + .'| RPBioOnly | Yes | Yes | Optional | Optional | No |'."\n" + .'| FVBioOnly | No | No | No | No | Yes |'."\n" + .'| FDBioOnly | No | No | No | No | No |', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'translator' => 'machine', + ], + 'DescribeVerifyResult' => [ + 'summary' => 'Query the result of real-person authentication.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59150', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'BizId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Authentication ID. A unique ID that identifies an authentication task, not exceeding 64 characters. For a single authentication task, the system supports an unlimited number of submissions until the final authentication is successful and the task is completed. > You need to use a different BizId for each new authentication task.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '39ecf51e-2f81-4dc5-90ee-ff86125b****', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Business scenario identifier for real-person authentication service', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'FVBioOnlyTest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AuthorityComparisionScore' => [ + 'description' => 'The comparison score between the face photo submitted during the authentication process and the authoritative data, with a value range of **0** to **100**.'."\n" + .'Confidence threshold references:'."\n" + .'- When the false acceptance rate is 0.001%, the corresponding threshold is 95. - When the false acceptance rate is 0.01%, the corresponding threshold is 90. - When the false acceptance rate is 0.1%, the corresponding threshold is 80. - When the false acceptance rate is 1%, the corresponding threshold is 60.'."\n" + .'> This field only indicates the comparison result between the face and the authoritative data, for your reference only. It is generally not recommended to use this value alone as the standard for whether the authentication passes. For a comprehensive authentication result, please refer to the **VerifyStatus** field. The **VerifyStatus** result integrates the comparison of the face with the authoritative data and various other strategies, which can enhance security levels.', + 'type' => 'number', + 'format' => 'float', + 'example' => '97', + ], + 'VerifyStatus' => [ + 'description' => 'Authentication status, values:'."\n" + .'- **-1**: Not authenticated - **1**: Authentication passed - **2** to **n**: Authentication failed for various reasons. For detailed descriptions, see the authentication status explanation.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of this request.', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'FaceComparisonScore' => [ + 'description' => 'The comparison score between the face photo submitted during the authentication process and the face in the retained face image. The value range is **0**~**100**.'."\n" + ."\n" + .'Confidence threshold reference:'."\n" + ."\n" + .'- When the false recognition rate is 0.001%, the corresponding threshold is 95.'."\n" + .'- When the false recognition rate is 0.01%, the corresponding threshold is 90.'."\n" + .'- When the false recognition rate is 0.1%, the corresponding threshold is 80.'."\n" + .'- When the false recognition rate is 1%, the corresponding threshold is 60.', + 'type' => 'number', + 'format' => 'float', + 'example' => '97', + ], + 'IdCardFaceComparisonScore' => [ + 'description' => 'The comparison score between the face photo submitted during the authentication process and the face on the ID card\'s face side. The value range is **0**~**100**.'."\n" + ."\n" + .'Confidence threshold reference:'."\n" + ."\n" + .'- When the false recognition rate is 0.001%, the corresponding threshold is 95.'."\n" + .'- When the false recognition rate is 0.01%, the corresponding threshold is 90.'."\n" + .'- When the false recognition rate is 0.1%, the corresponding threshold is 80.'."\n" + .'- When the false recognition rate is 1%, the corresponding threshold is 60.', + 'type' => 'number', + 'format' => 'float', + 'example' => '97', + ], + 'Material' => [ + 'description' => 'Authentication materials.', + 'type' => 'object', + 'properties' => [ + 'IdCardNumber' => [ + 'description' => 'ID number.', + 'type' => 'string', + 'example' => '02343218901123****', + ], + 'FaceGlobalUrl' => [ + 'description' => 'The global camera image captured by the real-person authentication SDK.'."\n" + ."\n" + .'> This parameter will only take effect after configuration. If you need to use this parameter, please submit a [ticket](https://selfservice.console.aliyun.com/ticket/category/cloudauth/today) to contact us.', + 'type' => 'string', + 'example' => 'http://image-demo.img-cn-hangzhou.aliyuncs.com/face-global-example.jpg ', + ], + 'FaceImageUrl' => [ + 'description' => 'The HTTP or HTTPS link to the frontal face image. The link is valid for 5 minutes, and it is recommended to store it elsewhere to avoid any impact on usage.'."\n" + .'> If the HTTP or HTTPS link to the frontal face image expires, you can call [DescribeVerifyResult](~~154606~~) again to get the link.', + 'type' => 'string', + 'example' => 'http://image-demo.img-cn-hangzhou.aliyuncs.com/face-image-example.jpg', + ], + 'FaceMask' => [ + 'description' => 'Whether the face is wearing a mask. Values:'."\n" + .'- **true**: Wearing a mask'."\n" + .'- **false**: Not wearing a mask', + 'type' => 'boolean', + 'example' => 'false', + ], + 'IdCardName' => [ + 'description' => 'Name.', + 'type' => 'string', + 'example' => '张三', + ], + 'FaceQuality' => [ + 'description' => 'The quality of the frontal face image. Values:'."\n" + .'- **UNQUALIFIED**: Poor quality'."\n" + .'- **LOW**: Low'."\n" + .'- **NORMAL**: Normal'."\n" + .'- **HIGH**: High', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'VideoUrls' => [ + 'description' => 'The URL addresses of the recorded videos returned by the historical RPH5BioOnly solution.', + 'type' => 'array', + 'items' => [ + 'description' => 'The URL addresses of the recorded videos returned by the historical RPH5BioOnly solution.', + 'type' => 'string', + 'example' => '-', + ], + ], + 'IdCardInfo' => [ + 'description' => 'OCR results of the ID card information.'."\n" + .'> If there is no front and back information of the ID card during the authentication process, the real-person authentication service will not return the OCR results of the ID card. Even if there is front and back information of the ID card during the authentication process, the real-person authentication service does not guarantee to return all the information on the ID card. Due to issues with ID card photography, the OCR may fail to recognize some information, resulting in incomplete OCR information. It is recommended that your business does not strongly rely on the ID card OCR information.', + 'type' => 'object', + 'properties' => [ + 'EndDate' => [ + 'description' => 'The end date of the document\'s validity period. Format: yyyymmdd.', + 'type' => 'string', + 'example' => '20201101', + ], + 'Authority' => [ + 'description' => 'Issuing authority.', + 'type' => 'string', + 'example' => '杭州市公安局', + ], + 'Address' => [ + 'description' => 'Address.', + 'type' => 'string', + 'example' => '浙江省杭州市余杭区文一西路969号', + ], + 'Number' => [ + 'description' => 'ID card number.', + 'type' => 'string', + 'example' => '02343218901123****', + ], + 'StartDate' => [ + 'description' => 'Start date of the document\'s validity. Format: yyyymmdd.', + 'type' => 'string', + 'example' => '20201101', + ], + 'BackImageUrl' => [ + 'description' => 'HTTP/HTTPS link to the image of the back side (national emblem side) of the ID card. The link is valid for 5 minutes, and it is recommended to store it for business use to avoid any impact.'."\n" + .'> If the HTTP/HTTPS link to the front-facing portrait image expires, you can call DescribeVerifyResult again to get the link.', + 'type' => 'string', + 'example' => 'http://image-demo.img-cn-hangzhou.aliyuncs.com/example3.jpg', + ], + 'Nationality' => [ + 'description' => 'Nationality.', + 'type' => 'string', + 'example' => '汉', + ], + 'Birth' => [ + 'description' => 'Date of birth.', + 'type' => 'string', + 'example' => '19900101', + ], + 'Name' => [ + 'description' => 'Name.', + 'type' => 'string', + 'example' => '张三', + ], + 'FrontImageUrl' => [ + 'description' => 'HTTP/HTTPS link to the image of the front side (portrait side) of the ID card. The link is valid for 5 minutes, and it is recommended to store it for business use to avoid any impact.'."\n" + .'> If the HTTP/HTTPS link to the front-facing portrait image expires, you can call DescribeVerifyResult again to get the link.', + 'type' => 'string', + 'example' => 'http://image-demo.img-cn-hangzhou.aliyuncs.com/example2.jpg', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 410 => [ + [ + 'errorCode' => 'DataExpired', + 'errorMessage' => 'The data has expired and the records have been deleted.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AuthorityComparisionScore\\": 97,\\n \\"VerifyStatus\\": 1,\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"FaceComparisonScore\\": 97,\\n \\"IdCardFaceComparisonScore\\": 97,\\n \\"Material\\": {\\n \\"IdCardNumber\\": \\"02343218901123****\\",\\n \\"FaceGlobalUrl\\": \\"http://image-demo.img-cn-hangzhou.aliyuncs.com/face-global-example.jpg \\",\\n \\"FaceImageUrl\\": \\"http://image-demo.img-cn-hangzhou.aliyuncs.com/face-image-example.jpg\\",\\n \\"FaceMask\\": false,\\n \\"IdCardName\\": \\"张三\\",\\n \\"FaceQuality\\": \\"NORMAL\\",\\n \\"VideoUrls\\": [\\n \\"-\\"\\n ],\\n \\"IdCardInfo\\": {\\n \\"EndDate\\": \\"20201101\\",\\n \\"Authority\\": \\"杭州市公安局\\",\\n \\"Address\\": \\"浙江省杭州市余杭区文一西路969号\\",\\n \\"Number\\": \\"02343218901123****\\",\\n \\"StartDate\\": \\"20201101\\",\\n \\"BackImageUrl\\": \\"http://image-demo.img-cn-hangzhou.aliyuncs.com/example3.jpg\\",\\n \\"Nationality\\": \\"汉\\",\\n \\"Birth\\": \\"19900101\\",\\n \\"Name\\": \\"张三\\",\\n \\"FrontImageUrl\\": \\"http://image-demo.img-cn-hangzhou.aliyuncs.com/example2.jpg\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Query authentication result', + 'description' => 'Prerequisites: Before accessing this API, please ensure that you have completed the necessary preparations. For more details, see [Real Person Authentication Server-side Preparation](~~127471~~) and [Liveness Face Verification Server-side Preparation](~~127717~~).'."\n" + .'> Alibaba Cloud Real Person Authentication only stores authentication data for the last 180 days. For any subsequent business use, please call this interface in a timely manner to retrieve and store the data yourself to avoid any impact on usage.'."\n" + .'Request Method: HTTPS POST and GET.'."\n" + .'Interface Description: After the mobile end of the access party receives the callback, its server can call this interface to obtain the corresponding authentication status and authentication information.'."\n" + .'Applicable Scope: This interface is applicable to the authentication solution with SDK + server-side integration.', + 'responseParamsDescription' => '**Verification Status Explanation**'."\n" + .'| VerifyStatus | Reason Description | Remarks |'."\n" + .'|--------------|-------------------|---------|'."\n" + .'| -1 | Not Verified. This status usually occurs ... | |'."\n" + .'| 1 | Verification Passed. Appears in both real-person authentication and liveness face verification schemes. | |'."\n" + .'| 2 | Verification Failed. Possible reason: Real-name verification failed. | Only in real-person authentication scheme. |'."\n" + .'| 3 | Verification Failed. Possible reasons: The ID photo is blurry ... | Only in real-person authentication scheme. |'."\n" + .'| ... | ... | ... |'."\n", + 'translator' => 'machine', + ], + 'CompareFaces' => [ + 'summary' => 'Invoke CompareFaces for face comparison.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '59094', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth6RJHVQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'TargetImageType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Type of Image 2, with values:'."\n" + ."\n" + .'- **FacePic**: User\'s face photo'."\n" + .'- **IDPic**: Headshot from the user\'s second-generation ID card chip (typically obtained and decoded by a second-generation ID card reader)', + 'type' => 'string', + 'required' => false, + 'example' => 'FacePic', + 'docRequired' => true, + ], + ], + [ + 'name' => 'SourceImageType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Type of Image 1, with values:'."\n" + ."\n" + .'- **FacePic**: User\'s face photo'."\n" + .'- **IDPic**: Headshot from the user\'s second-generation ID card chip (typically obtained and decoded by a second-generation ID card reader)', + 'type' => 'string', + 'required' => false, + 'example' => 'FacePic', + 'docRequired' => true, + ], + ], + [ + 'name' => 'SourceImageValue', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Address of Image 1. Please refer to the instructions on uploading image addresses.', + 'type' => 'string', + 'required' => false, + 'example' => 'http%3A%2F%2Fjiangsu.china.com.cn%2Fuploadfile%2F2015%2F0114%2F1421221304095989.jpg', + 'docRequired' => true, + ], + ], + [ + 'name' => 'TargetImageValue', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Address of Image 2. Please refer to the instructions on uploading image addresses.', + 'type' => 'string', + 'required' => false, + 'example' => 'http%3A%2F%2Fjiangsu.china.com.cn%2Fuploadfile%2F2015%2F0114%2F1421221304095989.jpg', + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'HTTP status code.', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Error code.', + 'type' => 'string', + 'example' => 'Error.InternalError', + ], + 'RequestId' => [ + 'description' => 'ID of the current request.', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'Success' => [ + 'description' => 'Indicates whether the response was successful.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'Result of the face comparison.', + 'type' => 'object', + 'properties' => [ + 'SimilarityScore' => [ + 'description' => 'The degree of similarity between the faces in the two images. The value range is [0, 100], with higher values indicating greater similarity.', + 'type' => 'number', + 'format' => 'float', + 'example' => '98.7913', + ], + 'ConfidenceThresholds' => [ + 'description' => 'Confidence thresholds for face comparison. The returned content is a JSON Object, with the specific structure being `"key":"value"`.'."\n" + ."\n" + .'- `key` represents the false acceptance rate, which is the probability of misidentifying someone else as the specified person.'."\n" + .'- `value` is the corresponding threshold.'."\n" + ."\n\n" + .'> Regarding the confidence thresholds (confidenceThresholds) in the example:'."\n" + .'- `"0.0001": "90.07"` indicates that the threshold is 90.07 when the false acceptance rate is 0.01%.'."\n" + .'- `"0.001": "80.01"` indicates that the threshold is 80.01 when the false acceptance rate is 0.1%.'."\n" + .'- `"0.01": "70.02"` indicates that the threshold is 70.02 when the false acceptance rate is 1%.'."\n" + ."\n" + .'Confidence thresholds are dynamically provided based on different images and algorithms, so do not persist these thresholds.', + 'type' => 'string', + 'example' => '{"0.0001":"90.07","0.001":"80.01","0.01":"70.02"}', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Error.InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error', + ], + [ + 'errorCode' => 'InvalidParam.ParamsMissing', + 'errorMessage' => 'Please check if there is param empty in your imput', + ], + [ + 'errorCode' => 'InvalidParam.ImageTypeEmpty', + 'errorMessage' => 'The image type is empty', + ], + [ + 'errorCode' => 'InvalidParam.FacePicNotGiven', + 'errorMessage' => 'At least one of the two given images should have a type of FacePic', + ], + [ + 'errorCode' => 'InvalidParam.ImageValuePatternError', + 'errorMessage' => 'The pattern of value of given image is not acceptable', + ], + [ + 'errorCode' => 'InvalidParam.ImageTypeInvalid', + 'errorMessage' => 'The image type is not valid', + ], + [ + 'errorCode' => 'Error.NoFaceDetected', + 'errorMessage' => 'No face detected from given images', + ], + [ + 'errorCode' => 'InvalidParam.ImageNotFound', + 'errorMessage' => 'No images founded with given image address', + ], + ], + 403 => [ + [ + 'errorCode' => 'Error.NoPermissionAccess', + 'errorMessage' => 'No permission to access our service', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'RAM caller has no permission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Error.InternalError\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SimilarityScore\\": 98.7913,\\n \\"ConfidenceThresholds\\": \\"{\\\\\\"0.0001\\\\\\":\\\\\\"90.07\\\\\\",\\\\\\"0.001\\\\\\":\\\\\\"80.01\\\\\\",\\\\\\"0.01\\\\\\":\\\\\\"70.02\\\\\\"}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\r\\n<CompareFacesResponse>\\r\\n <Data>\\r\\n <ConfidenceThresholds>{\\"0.0001\\":\\"90.07\\",\\"0.001\\":\\"80.01\\",\\"0.01\\":\\"70.02\\"}</ConfidenceThresholds>\\r\\n <SimilarityScore>98.7913</SimilarityScore>\\r\\n </Data>\\r\\n <Success>true</Success>\\r\\n <Code>200</Code>\\r\\n</CompareFacesResponse>\\r\\n\\t\\t\\t\\t\\t\\t","errorExample":""}]', + 'title' => 'CompareFaces', + 'description' => 'Request Method: Only supports sending requests via HTTPS POST.'."\n" + ."\n" + .'Interface Description: Compares two face images and outputs the similarity score of the faces in the two images as the result.'."\n" + ."\n" + .'- At least one of the specified comparison images should be a face photo (FacePic).'."\n" + .'- If an image contains multiple faces, the algorithm will automatically select the largest face in the image.'."\n" + .'- If one of the two comparison images does not detect a face, the system will return an error message stating \'No face detected\'.'."\n" + ."\n" + .'When uploading images, you need to provide the HTTP address or base64 encoding of the image.'."\n" + ."\n" + .'- HTTP Address: A publicly accessible HTTP address. For example, `http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg`.'."\n" + .'- Base64 Encoding: An image encoded in base64, formatted as `base64://<base64 string of the image>`.'."\n" + ."\n" + .'Image Restrictions'."\n" + ."\n" + .'- Does not support relative or absolute paths for local images.'."\n" + .'- Please keep the size of a single image within 2MB to avoid timeout during retrieval by the algorithm.'."\n" + .'- The body of a single request has a size limit of 8MB; please calculate the total size of all images and other information in the request to ensure it does not exceed this limit.'."\n" + .'- When using base64 to transmit images, the request method must be changed to POST; the header description such as `data:image/png;base64,` should be removed from the base64 string of the image.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'translator' => 'machine', + ], + 'DetectFaceAttributes' => [ + 'summary' => 'Detect Validity Attributes in Face Photos', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59162', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth6RJHVQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'MaterialValue', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The photo to be detected, see the instructions for uploading image addresses for format description. A maximum of 5 faces can be detected in a single image.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Identifier for the business scenario using real-person authentication services.', + 'type' => 'string', + 'required' => false, + 'example' => 'RPBasicTest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'HTTP status code.', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Error code.', + 'type' => 'string', + 'example' => 'Error.InternalError', + ], + 'RequestId' => [ + 'description' => 'ID of this request.', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'Success' => [ + 'description' => 'Whether the response was successful.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'Returned data.', + 'type' => 'object', + 'properties' => [ + 'ImgHeight' => [ + 'description' => 'Original image height, in pixels.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1920', + ], + 'ImgWidth' => [ + 'description' => 'Original image width, in pixels.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1080', + ], + 'FaceInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FaceAttributesDetectInfo' => [ + 'description' => 'Face detection results.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FaceRect' => [ + 'description' => 'Position of the face in the original image.', + 'type' => 'object', + 'properties' => [ + 'Left' => [ + 'description' => 'Distance from the top-left corner of the face rectangle to the left edge of the original image, in pixels.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '354', + ], + 'Top' => [ + 'description' => 'Distance from the top-left corner of the face rectangle to the top edge of the original image, in pixels.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '453', + ], + 'Width' => [ + 'description' => 'Width of the face rectangle.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '473', + ], + 'Height' => [ + 'description' => 'Height of the face rectangle.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '473', + ], + ], + ], + 'FaceAttributes' => [ + 'description' => 'Face attributes.', + 'type' => 'object', + 'properties' => [ + 'Glasses' => [ + 'description' => 'Whether wearing glasses. Values:'."\n" + ."\n" + .'- **None**: Not wearing glasses'."\n" + .'- **Wear**: Wearing regular glasses'."\n" + .'- **Sunglass**: Wearing sunglasses', + 'type' => 'string', + 'example' => 'None', + ], + 'Facequal' => [ + 'description' => 'A score ranging from 0 to 100. The higher the score, the better the quality. It is recommended to consider a score of 50 or above as acceptable quality.', + 'type' => 'number', + 'format' => 'float', + 'example' => '60', + ], + 'Integrity' => [ + 'description' => 'A score ranging from 0 to 100. The higher the score, the more complete the face. It is recommended to consider a score of 70 or above as acceptable completeness.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '70', + ], + 'Facetype' => [ + 'description' => 'Whether it is a human face. Values:'."\n" + ."\n" + .'- **None**: Not a human face'."\n" + .'- **Face**: Human face'."\n" + .'- **Profile**: Profile (head turned left or right by more than 30°)'."\n" + ."\n" + .'> If no face is detected, the `faceInfos` in the response will be empty; here, `None` means that a face was detected but is considered to be a cartoon, pet, etc.', + 'type' => 'string', + 'example' => 'Face', + ], + 'Respirator' => [ + 'description' => 'Whether wearing a mask. Values:'."\n" + ."\n" + .'- Wear: Wearing a mask.'."\n" + .'- None: Not wearing a mask.'."\n" + ."\n", + 'type' => 'string', + 'example' => 'Wear', + ], + 'Blur' => [ + 'description' => 'Face blur level, with higher values indicating more blurriness. Typically, a value ≥2.0 is considered quite blurry. It is recommended to adjust based on actual business data testing.', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.1419367790222168', + ], + 'Smiling' => [ + 'description' => 'Whether smiling.', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => 'Smile score.', + 'type' => 'number', + 'format' => 'float', + 'example' => '97', + ], + 'Threshold' => [ + 'description' => 'Smile threshold.', + 'type' => 'number', + 'format' => 'float', + 'example' => '95', + ], + ], + ], + 'Headpose' => [ + 'description' => 'Face pose.', + 'type' => 'object', + 'properties' => [ + 'PitchAngle' => [ + 'description' => 'Pitch angle, in degrees.', + 'type' => 'number', + 'format' => 'float', + 'example' => '-1.5683923959732056', + ], + 'RollAngle' => [ + 'description' => 'Roll angle, in degrees.', + 'type' => 'number', + 'format' => 'float', + 'example' => '7.163370132446289', + ], + 'YawAngle' => [ + 'description' => 'Yaw angle, in degrees.', + 'type' => 'number', + 'format' => 'float', + 'example' => '-6.925303936004639', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Error.InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error', + ], + [ + 'errorCode' => 'InvalidParam.ParamsMissing', + 'errorMessage' => 'Please check if there is param empty in your imput', + ], + [ + 'errorCode' => 'Error.DetectFaceAttributesParamError', + 'errorMessage' => 'detectFaceAttributes param error', + ], + [ + 'errorCode' => 'Error.DetectFaceAttributesHttpError', + 'errorMessage' => 'detectFaceAttributes fail to get image from http', + ], + [ + 'errorCode' => 'Error.DetectFaceAttributesOssError', + 'errorMessage' => 'detectFaceAttributes fail to get image from oss', + ], + [ + 'errorCode' => 'Error.DetectFaceAttributesAlgServiceError', + 'errorMessage' => 'detectFaceAttributes algService error', + ], + [ + 'errorCode' => 'Error.DetectFaceAttributesAlgServieReturnError', + 'errorMessage' => 'detectFaceAttributes algService return error', + ], + [ + 'errorCode' => 'Error.DetectFaceAttributesBase64Error', + 'errorMessage' => 'detectFaceAttributes fail to get image from base64', + ], + ], + 403 => [ + [ + 'errorCode' => 'Error.NoPermissionAccess', + 'errorMessage' => 'No permission to access our service', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'RAM caller has no permission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Error.InternalError\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"ImgHeight\\": 1920,\\n \\"ImgWidth\\": 1080,\\n \\"FaceInfos\\": {\\n \\"FaceAttributesDetectInfo\\": [\\n {\\n \\"FaceRect\\": {\\n \\"Left\\": 354,\\n \\"Top\\": 453,\\n \\"Width\\": 473,\\n \\"Height\\": 473\\n },\\n \\"FaceAttributes\\": {\\n \\"Glasses\\": \\"None\\",\\n \\"Facequal\\": 60,\\n \\"Integrity\\": 70,\\n \\"Facetype\\": \\"Face\\",\\n \\"Respirator\\": \\"Wear\\",\\n \\"Blur\\": 0.1419367790222168,\\n \\"Smiling\\": {\\n \\"Value\\": 97,\\n \\"Threshold\\": 95\\n },\\n \\"Headpose\\": {\\n \\"PitchAngle\\": -1.5683923959732056,\\n \\"RollAngle\\": 7.163370132446289,\\n \\"YawAngle\\": -6.925303936004639\\n }\\n }\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DetectFaceAttributesResponse>\\n\\t<Code>200</Code>\\n\\t<Data>\\n\\t\\t<FaceInfos>\\n\\t\\t\\t<FaceAttributesDetectInfo>\\n\\t\\t\\t\\t<element>\\n\\t\\t\\t\\t\\t<FaceAttributes>\\n\\t\\t\\t\\t\\t\\t<Blur>0.14193678</Blur>\\n\\t\\t\\t\\t\\t\\t<Facetype>Face</Facetype>\\n\\t\\t\\t\\t\\t\\t<Glasses>None</Glasses>\\n\\t\\t\\t\\t\\t\\t<Headpose>\\n\\t\\t\\t\\t\\t\\t\\t<PitchAngle>-1.5683924</PitchAngle>\\n\\t\\t\\t\\t\\t\\t\\t<RollAngle>7.16337</RollAngle>\\n\\t\\t\\t\\t\\t\\t\\t<YawAngle>-6.925304</YawAngle>\\n\\t\\t\\t\\t\\t\\t</Headpose>\\n\\t\\t\\t\\t\\t\\t<Smiling></Smiling>\\n\\t\\t\\t\\t\\t</FaceAttributes>\\n\\t\\t\\t\\t\\t<FaceRect>\\n\\t\\t\\t\\t\\t\\t<Height>473</Height>\\n\\t\\t\\t\\t\\t\\t<Left>354</Left>\\n\\t\\t\\t\\t\\t\\t<Top>453</Top>\\n\\t\\t\\t\\t\\t\\t<Width>473</Width>\\n\\t\\t\\t\\t\\t</FaceRect>\\n\\t\\t\\t\\t</element>\\n\\t\\t\\t</FaceAttributesDetectInfo>\\n\\t\\t</FaceInfos>\\n\\t\\t<ImgHeight>1920</ImgHeight>\\n\\t\\t<ImgWidth>1080</ImgWidth>\\n\\t</Data>\\n\\t<Success>true</Success>\\n </DetectFaceAttributesResponse>","errorExample":""}]', + 'title' => 'Face Attributes Pure Server-side API', + 'description' => 'Request Method: Only supports sending requests via HTTPS POST.'."\n" + ."\n" + .'Interface Description: Detects the validity-related attributes of faces in the input photo, which helps the business side to determine whether the photo meets their own business retention or comparison requirements. The currently supported face validity-related attributes include: whether it is a face, whether it is blurry, whether glasses are worn, face pose, whether it is a smile, etc.'."\n" + ."\n" + .'Instructions for Uploading Image Addresses: When passing in images, you need to upload their corresponding HTTP, OSS addresses, or Base64 encoding.'."\n" + ."\n" + .'- HTTP Address: A publicly accessible HTTP address. For example, `http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg`.'."\n" + .'- Base64 Encoding: An image encoded through base64, with the format being `base64://<image base64 string>`.'."\n" + ."\n" + .'Image Limitations:'."\n" + ."\n" + .'- Does not support relative or absolute paths of local images.'."\n" + .'- Please keep the size of a single image within 2 MB to avoid algorithm timeout.'."\n" + .'- There is an 8 MB size limit for the Body of a single request; please calculate the total size of all images and other information in the request and do not exceed the limit.'."\n" + .'- When using Base64 to pass images, the request method needs to be changed to POST; the header description of the image Base64 string, such as `data:image/png;base64`, should be removed.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => "\n" + ."\n", + 'extraInfo' => ' ', + 'translator' => 'machine', + ], + 'DescribePageFaceVerifyData' => [ + 'summary' => 'Open API adds financial-grade data statistics API', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'abilityTreeCode' => '216157', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthLNAN1F', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'Required, start time, format is yyyy-MM-dd, default is yyyy-MM-dd 00:00:00, the query interval cannot exceed 90 days.', + 'type' => 'string', + 'required' => false, + 'example' => '2023-04-10', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'Required, end time, format is yyyy-MM-dd, default is yyyy-MM-dd 00:00:00, the query interval cannot exceed 90 days.', + 'type' => 'string', + 'required' => false, + 'example' => '2023-04-30', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scene ID.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '36**01'."\n", + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Product code.', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_PLUS'."\n", + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'Current page number, default is 1.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of items per page, default is 10.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'ID of this request.', + 'type' => 'string', + 'example' => '473469C7-A***B-A3DC0DE3C83E', + ], + 'Success' => [ + 'description' => 'Whether the response was successful.', + 'type' => 'string', + 'enumValueTitles' => [ + 'false' => 'false', + 'true' => 'true', + ], + 'example' => 'true', + ], + 'Code' => [ + 'description' => 'Return code', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'OK', + ], + 'TotalCount' => [ + 'description' => 'Total count.', + 'type' => 'string', + 'example' => '100', + ], + 'PageSize' => [ + 'description' => 'Number of items per page.', + 'type' => 'string', + 'example' => '10', + ], + 'TotalPage' => [ + 'description' => 'Total number of pages.', + 'type' => 'string', + 'example' => '5', + ], + 'CurrentPage' => [ + 'description' => 'Current page number.', + 'type' => 'string', + 'example' => '1', + ], + 'Items' => [ + 'description' => 'List of returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'List of returned data.', + 'type' => 'object', + 'properties' => [ + 'Date' => [ + 'description' => 'Date.', + 'type' => 'string', + 'example' => '2024-03-24T00:00:00.000Z', + ], + 'TotalCount' => [ + 'description' => 'Total count.', + 'type' => 'string', + 'example' => '19', + ], + 'SuccessCount' => [ + 'description' => 'Number of successful calls.', + 'type' => 'string', + 'example' => '1', + ], + 'SceneId' => [ + 'description' => 'Scene ID.', + 'type' => 'string', + 'example' => '20**40', + ], + 'SceneName' => [ + 'description' => 'Scene name.', + 'type' => 'string', + 'example' => '****实名认证', + ], + 'ProductCode' => [ + 'description' => 'Product scheme code, please refer to the financial-grade real-person help documentation.', + 'type' => 'string', + 'example' => 'ID_PLUS', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-A***B-A3DC0DE3C83E\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"OK\\",\\n \\"TotalCount\\": \\"100\\",\\n \\"PageSize\\": \\"10\\",\\n \\"TotalPage\\": \\"5\\",\\n \\"CurrentPage\\": \\"1\\",\\n \\"Items\\": [\\n {\\n \\"Date\\": \\"2024-03-24T00:00:00.000Z\\",\\n \\"TotalCount\\": \\"19\\",\\n \\"SuccessCount\\": \\"1\\",\\n \\"SceneId\\": \\"20**40\\",\\n \\"SceneName\\": \\"****实名认证\\",\\n \\"ProductCode\\": \\"ID_PLUS\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Financial-grade Data Statistics', + 'requestParamsDescription' => 'StartDate and EndDate are required parameters', + 'translator' => 'machine', + ], + 'CreateCloudauthstScene' => [ + 'summary' => 'Create Cloud Scene', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59099', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthV1ZO7W', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Product code.', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'SMART_VERIFY' => 'SMART_VERIFY', + 'SMART_CARD' => 'SMART_CARD', + 'SMART_COMPARE' => 'SMART_COMPARE', + 'SMART_FLASH' => 'SMART_FLASH', + 'SMART_DETECT' => 'SMART_DETECT', + ], + 'example' => 'SMART_COMPARE', + ], + ], + [ + 'name' => 'SceneName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scene name.', + 'type' => 'string', + 'required' => true, + 'example' => '测试场景', + ], + ], + [ + 'name' => 'StoreImage', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to deliver the files generated from the authentication to the customer\'s OSS:'."\n" + .'- **Y**: Enable'."\n" + .'- **N**: Disable', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ResultObject' => [ + 'description' => 'The result, indicating whether the operation was successful.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'ID of this request', + 'type' => 'string', + 'example' => '5A6229C0-E156-48E4-B6EC-0F528BDF60D2', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultObject\\": true,\\n \\"RequestId\\": \\"5A6229C0-E156-48E4-B6EC-0F528BDF60D2\\"\\n}","type":"json"}]', + 'title' => 'Create Cloud Scene', + 'description' => 'Request Method: Supports sending requests via HTTPS POST and GET methods.'."\n" + ."\n" + .'> The authorization key is valid for 30 minutes and cannot be reused. It is recommended to reacquire it before each activation.', + 'translator' => 'machine', + ], + 'DeleteCloudauthstScene' => [ + 'summary' => 'Delete Cloud Scene', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59107', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ID of the scene to be deleted.', + 'type' => 'string', + 'required' => true, + 'example' => '4275001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ResultObject' => [ + 'description' => 'Return result.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'ID of this request.', + 'type' => 'string', + 'example' => '969434DF-926B-4997-9881-4DE94E39F805', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultObject\\": true,\\n \\"RequestId\\": \\"969434DF-926B-4997-9881-4DE94E39F805\\"\\n}","type":"json"}]', + 'title' => 'Delete Cloud Scene', + 'description' => 'Request Method: Supports sending requests using HTTPS POST and GET methods.'."\n" + ."\n" + .'> The authorization key is valid for 30 minutes and cannot be reused. It is recommended to re-obtain it before each activation.', + 'translator' => 'machine', + ], + 'DescribeSmartStatisticsPageList' => [ + 'summary' => 'Enhanced Real Person Authentication Call Statistics Pagination Query Interface', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59134', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'Start time, using UTC format, in the form of yyyy-MM-ddTHH:mm:ssZ.', + 'type' => 'string', + 'required' => true, + 'example' => '2023-11-01 00:00:00 +0800', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'End time, using UTC format, in the form of yyyy-MM-ddTHH:mm:ssZ.', + 'type' => 'string', + 'required' => true, + 'example' => '2022-11-16 23:59:59 +0800', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scene ID.', + 'type' => 'string', + 'required' => true, + 'example' => '36**01', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'Current page number.', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of items per page.', + 'type' => 'string', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'ServiceCode for the real person cloud product, only value: **cloudauthst**.', + 'type' => 'string', + 'required' => false, + 'example' => 'cloudauthst', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => 'Current page number.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalPage' => [ + 'description' => 'Total number of pages.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'PageSize' => [ + 'description' => 'Number of items displayed per page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => 'ID of this request.', + 'type' => 'string', + 'example' => '96943***4E39F805', + ], + 'TotalCount' => [ + 'description' => 'Total count.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '29', + ], + 'Items' => [ + 'description' => 'Returned data list.', + 'type' => 'array', + 'items' => [ + 'description' => 'Returned data list.', + 'type' => 'object', + 'properties' => [ + 'Date' => [ + 'description' => 'Date. Format: <i>month/day</i>', + 'type' => 'string', + 'example' => '11/8', + ], + 'SceneId' => [ + 'description' => 'Scene ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20**40', + ], + 'SceneName' => [ + 'description' => 'Scene name.', + 'type' => 'string', + 'example' => '****实名认证', + ], + 'TotalCount' => [ + 'description' => 'Total count.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'SuccessCount' => [ + 'description' => 'Number of successful calls.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PassRate' => [ + 'description' => 'Pass rate.', + 'type' => 'string', + 'example' => '25', + ], + 'ProductCode' => [ + 'description' => 'Product solution Code, please refer to the Enhanced Real Person Help Documentation.', + 'type' => 'string', + 'example' => 'SMART_VERIFY', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"TotalPage\\": 3,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"96943***4E39F805\\",\\n \\"TotalCount\\": 29,\\n \\"Items\\": [\\n {\\n \\"Date\\": \\"11/8\\",\\n \\"SceneId\\": 0,\\n \\"SceneName\\": \\"****实名认证\\",\\n \\"TotalCount\\": 4,\\n \\"SuccessCount\\": 1,\\n \\"PassRate\\": \\"25\\",\\n \\"ProductCode\\": \\"SMART_VERIFY\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Enhanced Real Person Authentication Call Statistics Pagination Query Interface', + 'translator' => 'machine', + ], + 'CreateAntCloudAuthScene' => [ + 'summary' => 'Create a financial-grade authentication scenario', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59097', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'SceneName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scene name.', + 'type' => 'string', + 'required' => true, + 'example' => '测试场景', + ], + ], + [ + 'name' => 'StoreImage', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to deliver the files generated from the authentication to the customer\'s OSS:'."\n" + .'- **Y**: Yes'."\n" + .'- **N**: No', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + [ + 'name' => 'BindMiniProgram', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to enable binding of the mini program:'."\n" + .'- **Y**: Enable'."\n" + .'- **N (default)**: Not enabled', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + [ + 'name' => 'MiniProgramName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Mini program name.', + 'type' => 'string', + 'required' => false, + 'example' => '测试APP', + ], + ], + [ + 'name' => 'Platform', + 'in' => 'query', + 'schema' => [ + 'description' => 'Binding platform for the mini program:'."\n" + .'- **WECHAT**: WeChat'."\n" + .'- **ALIPAY**: Alipay'."\n" + .'- **TIKTOK**: TikTok', + 'type' => 'string', + 'required' => false, + 'example' => 'WECHAT', + ], + ], + [ + 'name' => 'CheckFileName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Name of the uploaded verification file.', + 'type' => 'string', + 'required' => false, + 'example' => '测试.txt', + ], + ], + [ + 'name' => 'CheckFileBody', + 'in' => 'query', + 'schema' => [ + 'description' => 'Content of the uploaded verification file.', + 'type' => 'string', + 'required' => false, + 'example' => '774c4aab45981ff4a86cde9255a11xxx', + ], + ], + [ + 'name' => 'ReturnPicCount', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + [ + 'name' => 'ReturnVideoLength', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + [ + 'name' => 'DeviceRiskPlus', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SceneId' => [ + 'description' => 'Instance ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000015112', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '01D3BDC6-64C0-58E2-8760-3F1B56AAE299', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SceneId\\": 1000015112,\\n \\"RequestId\\": \\"01D3BDC6-64C0-58E2-8760-3F1B56AAE299\\"\\n}","type":"json"}]', + 'title' => 'Create Cloud Scene', + 'description' => 'Request Method: Supports sending requests via HTTPS POST and GET methods.'."\n" + ."\n" + .'> The authorization key is valid for 30 minutes and cannot be reused. It is recommended to reacquire it before each activation.', + 'translator' => 'machine', + ], + 'UpdateAntCloudAuthScene' => [ + 'summary' => 'Update Ant Blockchain Transaction Scenario', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59169', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth0KJCLK', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1000013372', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'Currently meaningless, can be omitted.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'SceneName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario name.', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'StoreImage', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to enable delivering the authentication files generated during the authentication process to the user\'s OSS:'."\n" + .'- **Y**: Enable'."\n" + .'- **N (default)**: Disable', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + [ + 'name' => 'BindMiniProgram', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to enable binding to a mini program:'."\n" + .'- **Y**: Enable'."\n" + .'- **N (default)**: Do not enable'."\n" + .'><notice>If enabling the binding of a mini program, please ensure all parameters for the mini program are passed.></notice>'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + [ + 'name' => 'MiniProgramName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Mini program name.', + 'type' => 'string', + 'required' => false, + 'example' => '测试APP', + ], + ], + [ + 'name' => 'Platform', + 'in' => 'query', + 'schema' => [ + 'description' => 'Binding mini program platform:'."\n" + .'- **WECHAT**: WeChat'."\n" + .'- **ALIPAY**: Alipay'."\n" + .'- **TIKTOK**: TikTok', + 'type' => 'string', + 'required' => false, + 'example' => 'IOS', + ], + ], + [ + 'name' => 'CheckFileName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Name of the uploaded verification file.', + 'type' => 'string', + 'required' => false, + 'example' => '测试.txt', + ], + ], + [ + 'name' => 'CheckFileBody', + 'in' => 'query', + 'schema' => [ + 'description' => 'Content of the uploaded verification file.', + 'type' => 'string', + 'required' => false, + 'example' => '774c4aab45981ff4a86cde9255a11xxx', + ], + ], + [ + 'name' => 'ReturnPicCount', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + [ + 'name' => 'ReturnVideoLength', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + [ + 'name' => 'DeviceRiskPlus', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'ID of this request.', + 'type' => 'string', + 'example' => 'A07D5838-2BE0-5D2E-B864-D05ADAA5EDE3', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A07D5838-2BE0-5D2E-B864-D05ADAA5EDE3\\"\\n}","type":"json"}]', + 'title' => 'Update Financial-Level Authentication Scenario', + 'description' => 'Update the information of a financial-level authentication scenario based on the scenario ID.'."\n" + .'- Service address: cloudauth.aliyuncs.com.'."\n" + .'- Request method: HTTPS POST.', + 'translator' => 'machine', + ], + 'DeleteAntCloudAuthScene' => [ + 'summary' => 'Delete Watermark Scene', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59106', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ID of the scene to be deleted.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1000011589', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'ID of this request.', + 'type' => 'string', + 'example' => '80D1ACD4-1C7D-53CB-8C54-3758FF03C762', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"80D1ACD4-1C7D-53CB-8C54-3758FF03C762\\"\\n}","type":"json"}]', + 'title' => 'Delete Financial-Level Authentication Scene', + 'description' => '- Service Address: cloudauth.aliyuncs.com.'."\n" + .'- Request Method: HTTPS POST and GET.', + 'translator' => 'machine', + ], + 'RemoveWhiteListSetting' => [ + 'summary' => 'Delete Real Person Whitelist', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '243505', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'ServiceCode for the real person cloud product, only value: **antcloudauth**.', + 'type' => 'string', + 'required' => false, + 'example' => 'antcloudauth', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'IDs of the whitelist to be deleted in bulk.', + 'type' => 'array', + 'items' => [ + 'description' => 'List of auto-response rule IDs, as a JSON array.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2653', + ], + 'required' => 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' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'Code' => [ + 'description' => 'Return code: 200 for success, others for failure', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => 'Whether the response was successful.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ResultObject' => [ + 'description' => 'Returned result information.', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"ResultObject\\": true\\n}","type":"json"}]', + 'title' => 'Delete Real Person Whitelist', + 'translator' => 'machine', + ], + 'InsertWhiteListSetting' => [ + 'summary' => 'Add Real Person Whitelist', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '243504', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'ServiceCode for the real person cloud product, value: **antcloudauth**.', + 'type' => 'string', + 'required' => false, + 'example' => 'antcloudauth', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Authentication scene ID. This ID is automatically generated after creating an authentication scene in the console. For instructions on how to create an authentication scene, see Adding an Authentication Scene.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000xxxx', + ], + ], + [ + 'name' => 'CertifyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Unique identifier for real person authentication.', + 'type' => 'string', + 'required' => false, + 'example' => 'shsf57a4e0d9981c3bd66dc754f3d3cd', + ], + ], + [ + 'name' => 'CertNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'ID number.', + 'type' => 'string', + 'required' => false, + 'example' => '330103xxxxxxxxxxxx', + ], + ], + [ + 'name' => 'ValidDay', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whitelist validity period in days (only supports 3, 7, 30).', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => 'Remark, with a length less than 32 characters.', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response schema', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'Code' => [ + 'description' => 'Return code: 200 for success, others for failure.', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => 'Indicates whether the response was successful.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ResultObject' => [ + 'description' => 'Returned result', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"ResultObject\\": true\\n}","type":"json"}]', + 'title' => 'Add Real Person Whitelist', + 'translator' => 'machine', + ], + 'PageQueryWhiteListSetting' => [ + 'summary' => 'Paging Query for Real Person Whitelist Configuration', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '243501', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'ServiceCode of the real person cloud product, value: **antcloudauth**.', + 'type' => 'string', + 'required' => false, + 'example' => 'antcloudauth', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Authentication scene ID. This ID is automatically generated after creating an authentication scene in the console. For how to create an authentication scene, see Adding an Authentication Scene.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000000xxx', + ], + ], + [ + 'name' => 'CertifyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Unique identifier for real person authentication.', + 'type' => 'string', + 'required' => false, + 'example' => 'sha75b4e19a1ddda059b920757b0e12b', + ], + ], + [ + 'name' => 'CertNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'ID number.', + 'type' => 'string', + 'required' => false, + 'example' => '330103xxxxxxxxxxxx', + ], + ], + [ + 'name' => 'ValidStartDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'Start date of validity (timestamp in milliseconds)', + 'type' => 'string', + 'required' => false, + 'example' => '1725120000000', + ], + ], + [ + 'name' => 'ValidEndDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'End date of validity (timestamp in milliseconds)', + 'type' => 'string', + 'required' => false, + 'example' => '1725379200000', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'Status:'."\n" + ."\n" + .'- DELETE: Deleted'."\n" + .'- VALID: Not deleted and within the validity period, valid'."\n" + .'- INVALID: Not deleted but outside the validity period, invalid', + 'type' => 'string', + 'required' => false, + 'example' => 'VALID', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'Current page number, default is 1.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of items per page, default is 10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + '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' => '5A6229C0-E156-48E4-B6EC-0F528BDF60D2', + ], + 'Code' => [ + 'description' => 'Return code, **200** indicates a successful API response.', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => 'Whether the response was successful.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TotalItem' => [ + 'description' => 'Total number of items.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '28', + ], + 'TotalPage' => [ + 'description' => 'Total number of pages.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'CurrentPage' => [ + 'description' => 'Current page number.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'Number of items per page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ResultObject' => [ + 'description' => 'Request result', + 'type' => 'array', + 'items' => [ + 'description' => 'Returned result information.', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'Whitelist ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '234822', + ], + 'GmtCreate' => [ + 'description' => 'Creation time.', + 'type' => 'string', + 'example' => '2024-08-30 14:00:00', + ], + 'GmtModified' => [ + 'description' => 'Modification time.', + 'type' => 'string', + 'example' => '2024-08-30 14:00:00', + ], + 'ServiceCode' => [ + 'description' => 'ServiceCode of the real person cloud product', + 'type' => 'string', + 'example' => 'antcloudauth', + ], + 'CertifyId' => [ + 'description' => 'Unique identifier for real person authentication.', + 'type' => 'string', + 'example' => 'sha43d9cabd52d370d9f4cca9468f71e', + ], + 'CertNo' => [ + 'description' => 'ID number.', + 'type' => 'string', + 'example' => '330103xxxxxxxxxxxx'."\n", + ], + 'SceneId' => [ + 'description' => 'Authentication scene ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000000332', + ], + 'ValidStartDate' => [ + 'description' => 'Start date of validity', + 'type' => 'string', + 'example' => '2024-08-30 13:57:51', + ], + 'ValidEndDate' => [ + 'description' => 'End date of validity', + 'type' => 'string', + 'example' => '2024-09-02 13:57:51', + ], + 'Status' => [ + 'description' => 'Status:'."\n" + ."\n" + .'- DELETE: Deleted'."\n" + .'- VALID: Not deleted and within the validity period, valid'."\n" + .'- INVALID: Not deleted but outside the validity period, invalid', + 'type' => 'string', + 'example' => 'VALID', + ], + 'Remark' => [ + 'description' => 'Remark information.', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A6229C0-E156-48E4-B6EC-0F528BDF60D2\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"TotalItem\\": 28,\\n \\"TotalPage\\": 3,\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"ResultObject\\": [\\n {\\n \\"Id\\": 234822,\\n \\"GmtCreate\\": \\"2024-08-30 14:00:00\\",\\n \\"GmtModified\\": \\"2024-08-30 14:00:00\\",\\n \\"ServiceCode\\": \\"antcloudauth\\",\\n \\"CertifyId\\": \\"sha43d9cabd52d370d9f4cca9468f71e\\",\\n \\"CertNo\\": \\"330103xxxxxxxxxxxx\\\\n\\",\\n \\"SceneId\\": 1000000332,\\n \\"ValidStartDate\\": \\"2024-08-30 13:57:51\\",\\n \\"ValidEndDate\\": \\"2024-09-02 13:57:51\\",\\n \\"Status\\": \\"VALID\\",\\n \\"Remark\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Paging Query for Real Person Whitelist Configuration', + 'translator' => 'machine', + ], + 'CreateAuthKey' => [ + 'summary' => 'Call CreateAuthKey to get the authorization key, which is used for offline face recognition SDK activation.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59098', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Business type. No more than 64 characters. Can be used to note specific business, such as different face usage scenarios of the access party or the customer identifier to be delivered. It is recommended to pass this parameter.', + 'type' => 'string', + 'required' => false, + 'example' => 'FACE_TEST', + ], + ], + [ + 'name' => 'UserDeviceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'User device ID. No more than 64 characters. Can be used to identify a specific device, and it is suggested to use the physical number of the device. It is recommended to pass this parameter.', + 'type' => 'string', + 'required' => false, + 'example' => '3iJ1AY$oHcu7mC69', + ], + ], + [ + 'name' => 'Test', + 'in' => 'query', + 'schema' => [ + 'description' => 'Test flag. If true, it indicates using test authorization with a default duration of 30 days; if false, the authorization duration will be based on AuthYears.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AuthYears', + 'in' => 'query', + 'schema' => [ + 'description' => 'When the Test flag is false or empty, AuthYears is required, in years, with a range of [1,100]. A value of 100 indicates permanent authorization.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AuthKey' => [ + 'description' => 'The key that can be used for authorization activation. The authorization key is valid for 30 minutes and cannot be reused. It is recommended to re-obtain it before each activation.', + 'type' => 'string', + 'example' => 'auth.1KQMcnLd4m37LN2D0F0WCD-1qtQI$', + ], + 'RequestId' => [ + 'description' => 'The ID of this request.', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"AuthKey\\": \\"auth.1KQMcnLd4m37LN2D0F0WCD-1qtQI$\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\r\\n<CreateAuthKeyResponse>\\r\\n <Data>\\r\\n <AuthKey>auth.1KQMcnLd4m37LN2D0F0WCD-1qtQI$</AuthKey>\\r\\n </Data>\\r\\n <Success>true</Success>\\r\\n <Code>1</Code>\\r\\n</CreateAuthKeyResponse>","errorExample":""}]', + 'title' => 'CreateAuthKey', + 'description' => 'Request Method: Supports sending requests via HTTPS POST and GET methods.'."\n" + ."\n" + .'> The authorization key is valid for 30 minutes and cannot be reused. It is recommended to re-obtain it before each activation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'translator' => 'machine', + ], + 'DescribeOssUploadToken' => [ + 'summary' => 'Call DescribeOssUploadToken to get the Token required for uploading photos to OSS.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59122', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth6RJHVQ', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of this request.', + 'type' => 'string', + 'example' => '2FA2C773-47DB-4156-B1EE-5B047321A939', + ], + 'OssUploadToken' => [ + 'description' => 'Information about the OSS upload Token.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The Key required for file upload.', + 'type' => 'string', + 'example' => 'STS.NU8rUBj****', + ], + 'Token' => [ + 'description' => 'The Token required for file upload.', + 'type' => 'string', + 'example' => 'uWia500nTS5knZaDzq4/KqpvhcLnO****', + ], + 'Secret' => [ + 'description' => 'The Secret required for file upload.', + 'type' => 'string', + 'example' => 'FwmnyoqT8dHj7nJLuM67T****', + ], + 'Expired' => [ + 'description' => 'Expiration time.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1582636610000', + ], + 'Path' => [ + 'description' => 'File storage path.', + 'type' => 'string', + 'example' => 'prod/RdNLC@Ox2n-1s7NMt', + ], + 'EndPoint' => [ + 'description' => 'Access endpoint.', + 'type' => 'string', + 'example' => 'https://oss-cn-zhangjiakou.aliyuncs.com', + ], + 'Bucket' => [ + 'description' => 'OSS bucket for file storage.', + 'type' => 'string', + 'example' => 'cloudauth-zhangjiakou-external', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FA2C773-47DB-4156-B1EE-5B047321A939\\",\\n \\"OssUploadToken\\": {\\n \\"Key\\": \\"STS.NU8rUBj****\\",\\n \\"Token\\": \\"uWia500nTS5knZaDzq4/KqpvhcLnO****\\",\\n \\"Secret\\": \\"FwmnyoqT8dHj7nJLuM67T****\\",\\n \\"Expired\\": 1582636610000,\\n \\"Path\\": \\"prod/RdNLC@Ox2n-1s7NMt\\",\\n \\"EndPoint\\": \\"https://oss-cn-zhangjiakou.aliyuncs.com\\",\\n \\"Bucket\\": \\"cloudauth-zhangjiakou-external\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\"?>\\n<DescribeOssUploadTokenResponse>\\n <OssUploadToken class=\\"object\\">\\n <Bucket type=\\"string\\">cloudauth-zhangjiakou-external</Bucket>\\n <EndPoint type=\\"string\\">https://oss-cn-zhangjiakou.aliyuncs.com</EndPoint>\\n <Expired type=\\"number\\">1582636610000</Expired>\\n <Key type=\\"string\\">STS.NU8rUBj****</Key>\\n <Path type=\\"string\\">prod/RdNLC@Ox2n-1s7NMt</Path>\\n <Secret type=\\"string\\">FwmnyoqT8dHj7nJLuM67T****</Secret>\\n <Token type=\\"string\\">uWia500nTS5knZaDzq4/KqpvhcLnO****</Token>\\n </OssUploadToken>\\n <RequestId type=\\"string\\">46FF6F40-59F9-4108-BA2C-E6BA7E816F1F</RequestId>\\n</DescribeOssUploadTokenResponse>\\n","errorExample":""}]', + 'title' => 'DescribeOssUploadToken', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'translator' => 'machine', + ], + 'CreateVerifySetting' => [ + 'summary' => 'Call CreateVerifySetting to create a verification scenario configuration. This operation is equivalent to creating a new verification scenario on the console.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59103', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Verification scenario identifier, supporting English letters, numbers, and hyphens (-), with a maximum of 20 characters.', + 'type' => 'string', + 'required' => true, + 'example' => 'UserRegister', + ], + ], + [ + 'name' => 'BizName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Verification scenario name, supporting Chinese, English, numbers, and hyphens (-), with a maximum of 20 characters.', + 'type' => 'string', + 'required' => true, + 'example' => '用户注册', + ], + ], + [ + 'name' => 'Solution', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the authentication solution to use, such as **RPBasic**, **RPBioOnly**, etc. For all supported authentication solutions, see [Authentication Solutions](~~127521~~).', + 'type' => 'string', + 'required' => true, + 'example' => 'RPBasic', + ], + ], + [ + 'name' => 'GuideStep', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to use the system\'s default guide page.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'PrivacyStep', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to use the system\'s default authorization page.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ResultStep', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to use the system\'s default result page.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'BizName' => [ + 'description' => 'Verification scenario name.', + 'type' => 'string', + 'example' => '用户注册', + ], + 'RequestId' => [ + 'description' => 'ID of this request.', + 'type' => 'string', + 'example' => 'D6163397-15C5-419C-9ACC-B7C83E0B4C10', + ], + 'Solution' => [ + 'description' => 'Authentication solution name.', + 'type' => 'string', + 'example' => 'RPBasic', + ], + 'BizType' => [ + 'description' => 'Verification scenario identifier.', + 'type' => 'string', + 'example' => 'UserRegister', + ], + 'StepList' => [ + 'type' => 'array', + 'items' => [ + 'description' => 'Authentication steps, where GUIDE represents the guide page, PRIVACY represents the authorization page, FACE_LIVENESS represents the liveness detection step, TAKE_ID_PHOTO represents the ID photo taking step, and RESULT represents the result page.', + 'type' => 'string', + 'example' => '["GUIDE","PRIVACY","FACE_LIVENESS","TAKE_ID_PHOTO","RESULT"]', + ], + 'description' => 'Authentication steps', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BizName\\": \\"用户注册\\",\\n \\"RequestId\\": \\"D6163397-15C5-419C-9ACC-B7C83E0B4C10\\",\\n \\"Solution\\": \\"RPBasic\\",\\n \\"BizType\\": \\"UserRegister\\",\\n \\"StepList\\": [\\n \\"[\\\\\\"GUIDE\\\\\\",\\\\\\"PRIVACY\\\\\\",\\\\\\"FACE_LIVENESS\\\\\\",\\\\\\"TAKE_ID_PHOTO\\\\\\",\\\\\\"RESULT\\\\\\"]\\"\\n ]\\n}","type":"json"}]', + 'title' => 'CreateVerifySetting', + 'description' => 'Request Method: Only supports sending requests via HTTPS POST.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'translator' => 'machine', + ], + 'DescribeVerifySDK' => [ + 'summary' => 'Call DescribeVerifySDK to get the offline SDK download address.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59152', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthK16DVB', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The task ID for generating the SDK.', + 'type' => 'string', + 'required' => true, + 'example' => '1KQMcnLd4m37LN2D0F0WCD', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SdkUrl' => [ + 'description' => 'The SDK download URL. When not empty, it indicates that the generation is complete.', + 'type' => 'string', + 'example' => 'https://www.xxx.com', + ], + 'RequestId' => [ + 'description' => 'The ID of this request.', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"SdkUrl\\": \\"https://www.xxx.com\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\r\\n<DescribeVerifySDKResponse>\\r\\n <Data>\\r\\n <Url>https://www.xxx.com</Url>\\r\\n </Data>\\r\\n <Success>true</Success>\\r\\n</DescribeVerifySDKResponse>\\r\\n\\t\\t\\t\\t\\t\\t\\t\\t","errorExample":""}]', + 'title' => 'DescribeVerifySDK', + 'description' => 'Request Method: Supports sending requests via HTTPS POST and GET methods.'."\n" + ."\n" + .'Interface Description: Obtain the SDK generation result based on the task ID for generating an offline facial recognition SDK.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'translator' => 'machine', + ], + 'ModifyDeviceInfo' => [ + 'summary' => 'Call ModifyDeviceInfo to update device-related information, such as extending the device authorization validity period, updating the business party\'s custom business identifier, and device ID. Suitable for scenarios like renewing the device validity period.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59166', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthV1ZO7W', + ], + ], + 'parameters' => [ + [ + 'name' => 'DeviceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'A unique ID generated by the real-person authentication server for the connected device, which is only generated after the device is successfully activated. This ID can be obtained through the getLicenseExtraInfo function in the offline facial recognition SDK.', + 'type' => 'string', + 'required' => true, + 'example' => 'wd.6ziUffspAeW5FVYbaqmexR-1qwNjM', + ], + ], + [ + 'name' => 'UserDeviceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The updated user device ID. It should not exceed 64 characters and is defined by the connected party. It can be used to identify specific devices, and it is recommended to use the physical number of the device.', + 'type' => 'string', + 'required' => false, + 'example' => '3iJ1AY$oHcu7mC69', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The updated business type. It should not exceed 64 characters and is defined by the connected party. It can be used to annotate specific businesses, for example, different face usage scenarios or the customer identifiers to be delivered.', + 'type' => 'string', + 'required' => false, + 'example' => 'FACE_TEST', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended duration of the device expiration. Unit: years, with a range of [1,100]. A value of 100 indicates permanent use. One year is calculated as 365 days.', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ExpiredDay', + 'in' => 'query', + 'schema' => [ + 'description' => 'The current expiration time of the device. If the expiration date is incorrect (differing from the real-person authentication server\'s recorded expiration time by more than one week), an error will be reported.'."\n" + .'> The expiration time can be queried through the DescribeDeviceInfo interface. An incorrect expiration date will result in an error. This check ensures that the business party does not accidentally re-activate a device due to some misoperation, thus consuming the authorization unnecessarily.', + 'type' => 'string', + 'required' => false, + 'example' => '20190401', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of this request.', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'UserDeviceId' => [ + 'description' => 'Corresponds to the UserDeviceId in the request parameters.', + 'type' => 'string', + 'example' => '3iJ1AY$oHcu7mC69', + ], + 'DeviceId' => [ + 'description' => 'Corresponds to the DeviceId in the request parameters.', + 'type' => 'string', + 'example' => 'wd.6ziUffspAeW5FVYbaqmexR-1qwNjM', + ], + 'ExpiredDay' => [ + 'description' => 'If the Duration in the request parameters is not empty, this field represents the expiration time of the authorization after the device validity period has been extended. One year of Duration is calculated as 365 days. Example: 20180101.', + 'type' => 'string', + 'example' => '20200330', + ], + 'BeginDay' => [ + 'description' => 'If the Duration in the request parameters is not empty, this field represents the start time of the authorization after the device validity period has been extended. One year of Duration is calculated as 365 days. Example: 20180101.', + 'type' => 'string', + 'example' => '20190401', + ], + 'BizType' => [ + 'description' => 'Corresponds to the BizType in the request parameters.', + 'type' => 'string', + 'example' => 'FACE_TEST', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"UserDeviceId\\": \\"3iJ1AY$oHcu7mC69\\",\\n \\"DeviceId\\": \\"wd.6ziUffspAeW5FVYbaqmexR-1qwNjM\\",\\n \\"ExpiredDay\\": \\"20200330\\",\\n \\"BeginDay\\": \\"20190401\\",\\n \\"BizType\\": \\"FACE_TEST\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\r\\n<ModifyDeviceInfoResponse>\\r\\n <Data>\\r\\n <DeviceId>wd.6ziUffspAeW5FVYbaqmexR-1qwNjM</DeviceId>\\r\\n <UserDeviceId>3iJ1AY$oHcu7mC69</UserDeviceId>\\r\\n <BizType>FACE_TEST</BizType>\\r\\n <BeginDay>20190401</BeginDay>\\r\\n <ExpiredDay>20200330</ExpiredDay>\\r\\n </Data>\\r\\n <Success>true</Success>\\r\\n <Code>1</Code>\\r\\n</ModifyDeviceInfoResponse>\\t\\t\\t\\t","errorExample":""}]', + 'title' => 'Modify Device Info', + 'description' => 'Request Method: Supports sending requests using HTTPS POST and GET methods.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'translator' => 'machine', + ], + 'DescribeDeviceInfo' => [ + 'summary' => 'Call DescribeDeviceInfo to query device-related information, such as the validity period of authorization, business identifiers customized by the access party, and device ID, etc.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59114', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth0KJCLK', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of items per page in the query.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The current page number being queried.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'DeviceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'A unique ID generated by the real-person authentication server for the access party\'s device. This ID is only generated after the device has been successfully activated and can be obtained through the getLicenseExtraInfo function in the offline facial recognition SDK.', + 'type' => 'string', + 'required' => false, + 'example' => 'wd.6ziUffspAeW5FVYbaqmexR-1qwNjM', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Business type. No more than 64 characters.', + 'type' => 'string', + 'required' => false, + 'example' => 'FACE_TEST', + ], + ], + [ + 'name' => 'UserDeviceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'No more than 64 characters, defined by the access party, which can be used to identify a specific device.', + 'type' => 'string', + 'required' => false, + 'example' => '3iJ1AY$oHcu7mC69', + ], + ], + [ + 'name' => 'ExpiredStartDay', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time of the query, i.e., querying authorizations that will expire between ExpiredStartDay and ExpiredEndDay.', + 'type' => 'string', + 'required' => false, + 'example' => '20190401', + ], + ], + [ + 'name' => 'ExpiredEndDay', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end time of the query, i.e., querying authorizations that will expire between ExpiredStartDay and ExpiredEndDay.', + 'type' => 'string', + 'required' => false, + 'example' => '20200330', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => 'The current page number being queried.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of this request.', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'PageSize' => [ + 'description' => 'Number of items per page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => 'Total count.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DeviceInfoList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DeviceInfo' => [ + 'description' => 'Array of device information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ExpiredDay' => [ + 'description' => 'Authorization expiration date.', + 'type' => 'string', + 'example' => '20180101', + ], + 'UserDeviceId' => [ + 'description' => 'Corresponds to the UserDeviceId in the request.', + 'type' => 'string', + 'example' => '3iJ1AY$oHcu7mC69', + ], + 'DeviceId' => [ + 'description' => 'Corresponds to the DeviceId in the request.', + 'type' => 'string', + 'example' => 'wd.6ziUffspAeW5FVYbaqmexR-1qwNjM', + ], + 'BeginDay' => [ + 'description' => 'Authorization start date.', + 'type' => 'string', + 'example' => '20180101', + ], + 'BizType' => [ + 'description' => 'Corresponds to the BizType in the request.', + 'type' => 'string', + 'example' => 'FACE_TEST', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"DeviceInfoList\\": {\\n \\"DeviceInfo\\": [\\n {\\n \\"ExpiredDay\\": \\"20180101\\",\\n \\"UserDeviceId\\": \\"3iJ1AY$oHcu7mC69\\",\\n \\"DeviceId\\": \\"wd.6ziUffspAeW5FVYbaqmexR-1qwNjM\\",\\n \\"BeginDay\\": \\"20180101\\",\\n \\"BizType\\": \\"FACE_TEST\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\r\\n<DescribeDeviceInfoResponse>\\r\\n <Data>\\r\\n <PageSize>20</PageSize>\\r\\n <CurrentPage>1</CurrentPage>\\r\\n <TotalCount>1</TotalCount>\\r\\n <Devices>\\r\\n <DeviceId>wd.6ziUffspAeW5FVYbaqmexR-1qwNjM</DeviceId>\\r\\n <UserDeviceId>3iJ1AY$oHcu7mC69</UserDeviceId>\\r\\n <BizType>FACE_TEST</BizType>\\r\\n <BeginDay>20190101</BeginDay>\\r\\n <ExpiredDay>20200101</ExpiredDay>\\r\\n </Devices>\\r\\n </Data>\\r\\n <Success>true</Success>\\r\\n</DescribeDeviceInfoResponse>","errorExample":""}]', + 'title' => 'DescribeDeviceInfo', + 'description' => 'Request Method: Supports sending requests using HTTPS POST and GET methods.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'translator' => 'machine', + ], + 'DeleteWhitelistSetting' => [ + 'summary' => 'Delete Whitelist Configuration', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59109', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'Set the source IP address of the visitor. Supports IP addresses in CIDR and IPv4 formats. Example: 10.0.3.0/24.', + 'type' => 'string', + 'required' => false, + 'example' => '120.25.41.25', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specify the language of the user information to be deleted. Values: -**zh**: Chinese. -**en**: English.', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'ServiceCode for the real-person cloud product, only takes the value: **antcloudauth**.', + 'type' => 'string', + 'required' => true, + 'example' => 'antcloudauth', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'schema' => [ + 'description' => 'List of rule IDs to be deleted.', + 'type' => 'string', + 'required' => true, + 'example' => '[6222001]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ResultObject' => [ + 'description' => 'Return result.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'ID of this request.', + 'type' => 'string', + 'example' => 'D6163397-15C5-419C-9ACC-B7C83E0B4C10', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultObject\\": true,\\n \\"RequestId\\": \\"D6163397-15C5-419C-9ACC-B7C83E0B4C10\\"\\n}","type":"json"}]', + 'title' => 'Delete Whitelist Configuration', + 'description' => 'Request Method: Only supports sending requests via HTTPS POST method.', + 'translator' => 'machine', + ], + 'CreateWhitelistSetting' => [ + 'summary' => 'Create Whitelist', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59105', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'Visitor\'s source IP address. No need to fill in, the system will automatically obtain it.', + 'type' => 'string', + 'required' => false, + 'example' => '27.115.63.58', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'User language.', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Service type:'."\n" + .'- **antcloudauth**: Financial-grade real-person authentication.'."\n" + .'- **cloudauthst** (discontinued): Enhanced real-person authentication.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'antcloudauth', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scene ID.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000014526', + ], + ], + [ + 'name' => 'CertifyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Certificate ID, used for whitelisting this specific authenticated user.', + 'type' => 'string', + 'required' => false, + 'example' => 'sha6d0405f42926084e396e76a037d00', + ], + ], + [ + 'name' => 'CertNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'ID number to be whitelisted.', + 'type' => 'string', + 'required' => false, + 'example' => '44018219950810XXXX', + ], + ], + [ + 'name' => 'ValidDay', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of valid days after creating the whitelist.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '7', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'Whitelist remarks.', + 'type' => 'string', + 'required' => false, + 'example' => '测试白名单。', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ResultObject' => [ + 'description' => 'Return result, whether the creation was successful:'."\n" + .'- true: Success'."\n" + .'- false: Failure', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of this request.', + 'type' => 'string', + 'example' => 'CF4979D3-060F-5336-BD9F-0D46ECB66B22', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultObject\\": true,\\n \\"RequestId\\": \\"CF4979D3-060F-5336-BD9F-0D46ECB66B22\\"\\n}","type":"json"}]', + 'title' => 'Create Whitelist', + 'description' => 'Request Method: Only supports sending requests via HTTPS POST.', + 'translator' => 'machine', + ], + 'DescribeWhitelistSetting' => [ + 'summary' => 'Get Whitelist Collection Get Whitelist Collection', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59159', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth6RJHVQ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'Visitor\'s source IP address.', + 'type' => 'string', + 'required' => false, + 'example' => '113.140.85.74', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specify the language to query. Values:'."\n" + .'- **zh**: Chinese'."\n" + .'- **en**: English', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Service Code:'."\n" + .'- **Enhanced Financial Grade**: cloudauthst'."\n" + .'- **Financial Grade**: antcloudauth', + 'type' => 'string', + 'required' => true, + 'example' => 'antcloudauth', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scene ID.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000004530', + ], + ], + [ + 'name' => 'CertifyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Certification ID', + 'type' => 'string', + 'required' => false, + 'example' => 'shsf57a4e0d9981c3bd66dc754f3d3cd', + ], + ], + [ + 'name' => 'CertNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'ID Number', + 'type' => 'string', + 'required' => false, + 'example' => '320321XXXXXXXX701X', + ], + ], + [ + 'name' => 'ValidStartDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'Effective start time (in seconds timestamp).', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1759939200000', + ], + ], + [ + 'name' => 'ValidEndDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'Expiration date.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1730304000000', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whitelist status:'."\n" + .'- **VALID**: Valid'."\n" + .'- **INVALID**: Invalid'."\n" + .'- **DELETED**: Deleted', + 'type' => 'string', + 'required' => false, + 'example' => 'VALID', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of items per page for pagination.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'Pagination parameter: current page number, default value is 1.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => 'Pagination parameter: current page number, default value is 1.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'Number of items per page for pagination.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => 'ID of this request.', + 'type' => 'string', + 'example' => '0B8ACFD2-C5F0-5F9F-8DD4-E44F93E360E8', + ], + 'TotalCount' => [ + 'description' => 'Total count.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'Items' => [ + 'description' => 'List of certification details.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Whitelist status:'."\n" + .'- **VALID**: Valid.'."\n" + .'- **INVALID**: Invalid.'."\n" + .'- **DELETED**: Deleted.', + 'type' => 'string', + 'example' => 'VALID', + ], + 'GmtCreate' => [ + 'description' => 'Creation time.', + 'type' => 'string', + 'example' => '2025-10-16 17:28:03', + ], + 'CertifyId' => [ + 'description' => 'Certificate ID.', + 'type' => 'string', + 'example' => 'shad861465f2aaeeb805b519e1a93ab2', + ], + 'CertNo' => [ + 'description' => 'Certificate number.', + 'type' => 'string', + 'example' => '320321XXXXXXXX701X', + ], + 'ValidStartDate' => [ + 'description' => 'Effective start time.', + 'type' => 'string', + 'example' => '2025-10-16 17:28:03', + ], + 'SceneId' => [ + 'description' => 'Scene ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000000332', + ], + 'GmtModified' => [ + 'description' => 'Modification time.', + 'type' => 'string', + 'example' => '2025-10-16 17:28:03', + ], + 'ValidEndDate' => [ + 'description' => 'Effective end date.', + 'type' => 'string', + 'example' => '2025-10-16 17:28:03', + ], + 'Id' => [ + 'description' => 'Whitelist ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6372003', + ], + 'Remark' => [ + 'description' => 'Remark.', + 'type' => 'string', + 'example' => '测试白名单', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"0B8ACFD2-C5F0-5F9F-8DD4-E44F93E360E8\\",\\n \\"TotalCount\\": 4,\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"VALID\\",\\n \\"GmtCreate\\": \\"2025-10-16 17:28:03\\",\\n \\"CertifyId\\": \\"shad861465f2aaeeb805b519e1a93ab2\\",\\n \\"CertNo\\": \\"320321XXXXXXXX701X\\",\\n \\"ValidStartDate\\": \\"2025-10-16 17:28:03\\",\\n \\"SceneId\\": 1000000332,\\n \\"GmtModified\\": \\"2025-10-16 17:28:03\\",\\n \\"ValidEndDate\\": \\"2025-10-16 17:28:03\\",\\n \\"Id\\": 6372003,\\n \\"Remark\\": \\"测试白名单\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Get Whitelist Collection', + 'description' => 'Request Method: Only supports sending requests via HTTPS POST method.', + 'translator' => 'machine', + ], + 'DescribeAntAndCloudAuthUserStatus' => [ + 'summary' => 'Query the User Status of Ant Blockchain', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59110', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AntcloudauthEnabled' => [ + 'description' => 'Indicates whether financial-grade real-person authentication is activated. Values:'."\n" + .'- **true**: Activated'."\n" + .'- **false**: Not activated', + 'type' => 'boolean', + 'example' => 'true', + ], + 'CloudauthstEnabled' => [ + 'description' => 'Indicates whether the enhanced version of real-person authentication is activated. Values:'."\n" + .'- **true**: Activated'."\n" + .'- **false**: Not activated', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of this request.', + 'type' => 'string', + 'example' => '3FE07CCE-DF47-51C2-9D32-CD70ED62C91B', + ], + 'CloudauthEnabled' => [ + 'description' => 'Indicates whether real-person authentication is activated. Values:'."\n" + .'- **true**: Activated'."\n" + .'- **false**: Not activated', + 'type' => 'boolean', + 'example' => 'false', + ], + 'InforverifyEnabled' => [ + 'description' => 'Indicates whether information verification is activated. Values:'."\n" + .'- **true**: Activated'."\n" + .'- **false**: Not activated', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AntcloudauthEnabled\\": true,\\n \\"CloudauthstEnabled\\": true,\\n \\"RequestId\\": \\"3FE07CCE-DF47-51C2-9D32-CD70ED62C91B\\",\\n \\"CloudauthEnabled\\": false,\\n \\"InforverifyEnabled\\": false\\n}","type":"json"}]', + 'title' => 'Query the Activation Status of Different Real-person Authentication Product Solutions', + 'description' => 'Request Method: Supports sending requests via HTTPS POST and GET methods.'."\n" + ."\n" + .'> The authorization key is valid for 30 minutes and cannot be reused. It is recommended to re-obtain it before each activation.', + 'translator' => 'machine', + ], + 'DescribeCloudauthstSceneList' => [ + 'summary' => 'Query Dashboard Data', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59113', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthV1ZO7W', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Product Code', + 'type' => 'string', + 'required' => false, + 'example' => 'SMART_CARD', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of this request.', + 'type' => 'string', + 'example' => 'CEC88747-2F3E-539E-91A6-84E321CAA12B', + ], + 'Items' => [ + 'description' => 'Scene list', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProductName' => [ + 'description' => 'Product name', + 'type' => 'string', + 'example' => '-', + ], + 'GmtCreate' => [ + 'description' => 'Creation time.', + 'type' => 'string', + 'example' => '2023-01-04 19:56:04', + ], + 'SceneId' => [ + 'description' => 'Scene ID.', + 'type' => 'string', + 'example' => '20**40', + ], + 'SceneName' => [ + 'description' => 'Scene name.', + 'type' => 'string', + 'example' => '测试场景', + ], + 'GmtModified' => [ + 'description' => 'Modification time.', + 'type' => 'string', + 'example' => '2023-01-04 19:56:04', + ], + 'ProductCode' => [ + 'description' => 'Cloud marketplace product code.', + 'type' => 'string', + 'example' => 'SMART_VERIFY', + ], + 'StoreImage' => [ + 'description' => 'Whether to deliver the files generated by the authentication to the customer\'s OSS:'."\n" + .'- **Y**: Enabled'."\n" + .'- **N**: Disabled', + 'type' => 'string', + 'example' => 'N', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEC88747-2F3E-539E-91A6-84E321CAA12B\\",\\n \\"Items\\": [\\n {\\n \\"ProductName\\": \\"-\\",\\n \\"GmtCreate\\": \\"2023-01-04 19:56:04\\",\\n \\"SceneId\\": \\"20**40\\",\\n \\"SceneName\\": \\"测试场景\\",\\n \\"GmtModified\\": \\"2023-01-04 19:56:04\\",\\n \\"ProductCode\\": \\"SMART_VERIFY\\",\\n \\"StoreImage\\": \\"N\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query Enhanced Real Person Authentication Scene List', + 'description' => 'Request Method: Supports sending requests via HTTPS POST and GET methods.'."\n" + ."\n" + .'> The authorization key is valid for 30 minutes and cannot be reused. It is recommended to reacquire it before each activation.', + 'translator' => 'machine', + ], + 'DescribeListAntCloudAuthScenes' => [ + 'summary' => 'Query the cloud scenario authentication records of a specific region', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59118', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'ID of this request.', + 'type' => 'string', + 'example' => 'CC1AB3F5-22A2-589F-ABDD-B766694AA671', + ], + 'Scenes' => [ + 'description' => 'List of scenarios.', + 'type' => 'array', + 'items' => [ + 'description' => 'List of authorized scenarios.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Whether it is enabled, with 1 indicating yes.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Modifier' => [ + 'description' => 'Modifier.', + 'type' => 'string', + 'example' => '189884094677xxxx', + ], + 'UpdateTime' => [ + 'description' => 'The last update time of the instance.', + 'type' => 'string', + 'example' => '1260051251634779', + ], + 'AppId' => [ + 'description' => 'Application ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2a3a13b6-ee85-457e-bd15-b48115cb396e', + ], + 'CreateTime' => [ + 'description' => 'Creation time.', + 'type' => 'string', + 'example' => '1260051251634779', + ], + 'SceneId' => [ + 'description' => 'Scenario ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100001xxxx', + ], + 'SceneName' => [ + 'description' => 'Scenario name.', + 'type' => 'string', + 'example' => '测试场景', + ], + 'Creator' => [ + 'description' => 'Creator.', + 'type' => 'string', + 'example' => '189884094677xxxx', + ], + 'StoreImage' => [ + 'description' => 'Whether to deliver the files generated by the authentication to the customer\'s OSS:'."\n" + .'- **Y**: Enabled'."\n" + .'- **N**: Disabled', + 'type' => 'string', + 'example' => 'Y', + ], + 'BindMiniProgram' => [ + 'description' => 'Whether to enable binding to a mini program:'."\n" + .'- **Y**: Enabled'."\n" + .'- **N (default)**: Not enabled', + 'type' => 'string', + 'example' => 'Y', + ], + 'Platform' => [ + 'description' => 'Platform for binding the mini program:'."\n" + .'- **WECHAT**: WeChat'."\n" + .'- **ALIPAY**: Alipay'."\n" + .'- **TIKTOK**: TikTok', + 'type' => 'string', + 'example' => 'WECHAT', + ], + 'MiniProgramName' => [ + 'description' => 'Mini program name.', + 'type' => 'string', + 'example' => '测试APP', + ], + 'Domain' => [ + 'description' => 'Bound domain.', + 'type' => 'string', + 'example' => 'www.ddos.com', + ], + 'ReturnPicCount' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'ReturnVideoLength' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'DeviceRiskPlus' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CC1AB3F5-22A2-589F-ABDD-B766694AA671\\",\\n \\"Scenes\\": [\\n {\\n \\"Status\\": 1,\\n \\"Modifier\\": \\"189884094677xxxx\\",\\n \\"UpdateTime\\": \\"1260051251634779\\",\\n \\"AppId\\": 0,\\n \\"CreateTime\\": \\"1260051251634779\\",\\n \\"SceneId\\": 0,\\n \\"SceneName\\": \\"测试场景\\",\\n \\"Creator\\": \\"189884094677xxxx\\",\\n \\"StoreImage\\": \\"Y\\",\\n \\"BindMiniProgram\\": \\"Y\\",\\n \\"Platform\\": \\"WECHAT\\",\\n \\"MiniProgramName\\": \\"测试APP\\",\\n \\"Domain\\": \\"www.ddos.com\\",\\n \\"ReturnPicCount\\": 0,\\n \\"ReturnVideoLength\\": 0,\\n \\"DeviceRiskPlus\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'List of Financial-grade Authentication Scenarios', + 'description' => 'Request Method: Supports sending requests via HTTPS POST and GET methods.'."\n" + ."\n" + .'> The authorization key is valid for 30 minutes and cannot be reused. It is recommended to re-obtain it before each activation.', + 'translator' => 'machine', + ], + 'DescribeListFaceVerifyData' => [ + 'summary' => 'Query Face Verification Data', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59119', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth6RJHVQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'GmtStart', + 'in' => 'query', + 'schema' => [ + 'description' => 'Start time of the query.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1760025600000', + ], + ], + [ + 'name' => 'GmtEnd', + 'in' => 'query', + 'schema' => [ + 'description' => 'End time of the query.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1760630399999', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scene ID.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000000339', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'Product Code, currently deprecated.', + 'type' => 'string', + 'required' => false, + 'example' => 'Liveness', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'ID of this request.', + 'type' => 'string', + 'example' => 'EBD373EA-07FC-50BC-906F-B8950B6ED462', + ], + 'MonitorData' => [ + 'description' => 'Returned data.', + 'type' => 'object', + 'properties' => [ + 'FaceVerifyData' => [ + 'description' => 'Face verification data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCnt' => [ + 'description' => 'Total number of verifications.', + 'type' => 'string', + 'example' => '18', + ], + 'FailCnt' => [ + 'description' => 'Number of failed verifications.', + 'type' => 'string', + 'example' => '6', + ], + 'SuccCnt' => [ + 'description' => 'Number of successful verifications.', + 'type' => 'string', + 'example' => '12', + ], + 'SceneId' => [ + 'description' => 'Scene ID.', + 'type' => 'string', + 'example' => '1000011644', + ], + 'Name' => [ + 'description' => 'Verification scheme.', + 'type' => 'string', + 'example' => 'Liveness', + ], + 'ConDate' => [ + 'description' => 'Verification statistics time.', + 'type' => 'string', + 'example' => '2025-10-16T00:00:00.000Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EBD373EA-07FC-50BC-906F-B8950B6ED462\\",\\n \\"MonitorData\\": {\\n \\"FaceVerifyData\\": [\\n {\\n \\"TotalCnt\\": \\"18\\",\\n \\"FailCnt\\": \\"6\\",\\n \\"SuccCnt\\": \\"12\\",\\n \\"SceneId\\": \\"1000011644\\",\\n \\"Name\\": \\"Liveness\\",\\n \\"ConDate\\": \\"2025-10-16T00:00:00.000Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query Face Verification Data', + 'description' => '- Service Address: cloudauth.aliyuncs.com.'."\n" + .'- Request Method: HTTPS POST and GET.', + 'translator' => 'machine', + ], + 'DescribeListFaceVerifyInfos' => [ + 'summary' => 'Get Face Verification Information', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59120', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth0KJCLK', + ], + ], + 'parameters' => [ + [ + 'name' => 'GmtStart', + 'in' => 'query', + 'schema' => [ + 'description' => 'Query the start time of the verification.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1760112000000', + ], + ], + [ + 'name' => 'GmtEnd', + 'in' => 'query', + 'schema' => [ + 'description' => 'Query the end time of the verification.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1760716800000', + ], + ], + [ + 'name' => 'CertifyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Verification ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'shs414a8b392a3a338abe0504c75c056', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of items per page for paginated queries. Maximum value: 100, default value: 10.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Pagination parameter: current page number.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'Verification status:'."\n" + .'- **1**: Verification passed.'."\n" + .'- **2**: Verification failed.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scene ID.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000009699', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalPages' => [ + 'description' => 'Total number of pages.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ItemsPerPage' => [ + 'description' => 'Number of items per page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'PageNumber' => [ + 'description' => 'Pagination parameter: current page number.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'ID of the current request.', + 'type' => 'string', + 'example' => '1CC27D8E-24BF-5056-B14E-9F26719C9A8D', + ], + 'TotalCount' => [ + 'description' => 'Total number of verifications.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'FaceVerifyInfos' => [ + 'description' => 'List of face verification records.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Verification status:'."\n" + .'- **1**: Verification passed.'."\n" + .'- **2**: Verification failed.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'BizCode' => [ + 'description' => 'Business code.', + 'type' => 'string', + 'example' => 'CLOUD_FACE', + ], + 'CreateTime' => [ + 'description' => 'Creation time of the face recognition record.', + 'type' => 'string', + 'example' => '2022-10-02T11:16:06Z', + ], + 'CertName' => [ + 'description' => 'Name.', + 'type' => 'string', + 'example' => '赵四', + ], + 'CertNo' => [ + 'description' => 'ID number.', + 'type' => 'string', + 'example' => '500382199805086199', + ], + 'CertifyId' => [ + 'description' => 'ID of the certificate.', + 'type' => 'string', + 'example' => 'sha8ff58e964152c4c4d21005fb98ecb', + ], + 'SceneId' => [ + 'description' => 'Scene ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000010145', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalPages\\": 3,\\n \\"ItemsPerPage\\": 20,\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"1CC27D8E-24BF-5056-B14E-9F26719C9A8D\\",\\n \\"TotalCount\\": 0,\\n \\"FaceVerifyInfos\\": [\\n {\\n \\"Status\\": 2,\\n \\"BizCode\\": \\"CLOUD_FACE\\",\\n \\"CreateTime\\": \\"2022-10-02T11:16:06Z\\",\\n \\"CertName\\": \\"赵四\\",\\n \\"CertNo\\": \\"500382199805086199\\",\\n \\"CertifyId\\": \\"sha8ff58e964152c4c4d21005fb98ecb\\",\\n \\"SceneId\\": 1000010145\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Get Face Verification Information', + 'description' => '- Service address: cloudauth.aliyuncs.com.'."\n" + .'- Request method: HTTPS POST and GET.', + 'translator' => 'machine', + ], + 'DescribeOssStatus' => [ + 'summary' => 'Query OSS status', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59121', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthV1ZO7W', + ], + ], + 'parameters' => [ + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Service code:'."\n" + .'- antcloudauth: Financial-grade real-person authentication'."\n" + .'- cloudauthst (discontinued): Enhanced real-person authentication', + 'type' => 'string', + 'required' => false, + 'example' => 'antcloudauth', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of this request.', + 'type' => 'string', + 'example' => 'F2DB870B-EEB7-51BD-9F0A-B5D8D3C79308', + ], + 'Data' => [ + 'description' => 'Returned data.', + 'type' => 'object', + 'properties' => [ + 'UserStatus' => [ + 'description' => 'User activation status, SUCCESS indicates activated.', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'BucketName' => [ + 'description' => 'The name of the OSS bucket for delivering authentication information.', + 'type' => 'string', + 'example' => 'cn-hangzhou-aliyun-cloudauth-20250516xxxxxx', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2DB870B-EEB7-51BD-9F0A-B5D8D3C79308\\",\\n \\"Data\\": {\\n \\"UserStatus\\": \\"SUCCESS\\",\\n \\"BucketName\\": \\"cn-hangzhou-aliyun-cloudauth-20250516xxxxxx\\"\\n }\\n}","type":"json"}]', + 'title' => 'Query User OSS Status', + 'description' => '- Request Method: Supports sending requests via HTTPS POST and GET methods.'."\n" + .'- Service Address: cloudauth.aliyuncs.com.'."\n", + 'translator' => 'machine', + ], + 'DescribePageSetting' => [ + 'summary' => 'Query Page Settings', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59123', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth0KJCLK', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'FailReasons' => [ + 'description' => 'Failure reasons.', + 'type' => 'string', + 'example' => '{'."\n" + .' "11": "认证不通过，可能原因：1、公安网照片缺失；2、公安网照片格式错误；3、公安网照片找不到人脸等可能",'."\n" + .' "1": "认证通过",'."\n" + .' "12": "认证不通过，可能原因：公安网系统异常，无法比对等可能",'."\n" + .' "2": "认证不通过，原因：实名校验不通过",'."\n" + .' "3": "认证不通过，可能原因：1、身份证照片模糊、光线问题造成字体无法识别；2、身份证照片信息与需认证的身份证姓名不一致；3、提交的照片为非身份证照片等可能",'."\n" + .' "4": "认证不通过，可能原因：1、身份证照片模糊、光线问题造成字体无法识别；2、身份证照片信息与需认证的身份证号码不一致；3、提交的照片为非身份证照片等可能",'."\n" + .' "5": "认证不通过，可能原因：身份证照片有效期已过期（或即将过期）等可能",'."\n" + .' "6": "认证不通过，可能原因：人脸与身份证头像不一致等可能",'."\n" + .' "7": "认证不通过，可能原因：人脸与公安网照片不一致等可能",'."\n" + .' "8": "认证不通过，可能原因：1、提交的身份证照片非身份证原照片；2、未提交有效身份证照片等可能",'."\n" + .' "9": "认证不通过，可能原因：非账号本人操作等可能",'."\n" + .' "10": "认证不通过，可能原因：非同人操作等可能"'."\n" + .' }', + ], + 'RequestId' => [ + 'description' => 'The ID of this request.', + 'type' => 'string', + 'example' => 'C58A8581-6A5B-55F1-B2EF-1CEAC97DA181', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FailReasons\\": \\"{\\\\n \\\\\\"11\\\\\\": \\\\\\"认证不通过，可能原因：1、公安网照片缺失；2、公安网照片格式错误；3、公安网照片找不到人脸等可能\\\\\\",\\\\n \\\\\\"1\\\\\\": \\\\\\"认证通过\\\\\\",\\\\n \\\\\\"12\\\\\\": \\\\\\"认证不通过，可能原因：公安网系统异常，无法比对等可能\\\\\\",\\\\n \\\\\\"2\\\\\\": \\\\\\"认证不通过，原因：实名校验不通过\\\\\\",\\\\n \\\\\\"3\\\\\\": \\\\\\"认证不通过，可能原因：1、身份证照片模糊、光线问题造成字体无法识别；2、身份证照片信息与需认证的身份证姓名不一致；3、提交的照片为非身份证照片等可能\\\\\\",\\\\n \\\\\\"4\\\\\\": \\\\\\"认证不通过，可能原因：1、身份证照片模糊、光线问题造成字体无法识别；2、身份证照片信息与需认证的身份证号码不一致；3、提交的照片为非身份证照片等可能\\\\\\",\\\\n \\\\\\"5\\\\\\": \\\\\\"认证不通过，可能原因：身份证照片有效期已过期（或即将过期）等可能\\\\\\",\\\\n \\\\\\"6\\\\\\": \\\\\\"认证不通过，可能原因：人脸与身份证头像不一致等可能\\\\\\",\\\\n \\\\\\"7\\\\\\": \\\\\\"认证不通过，可能原因：人脸与公安网照片不一致等可能\\\\\\",\\\\n \\\\\\"8\\\\\\": \\\\\\"认证不通过，可能原因：1、提交的身份证照片非身份证原照片；2、未提交有效身份证照片等可能\\\\\\",\\\\n \\\\\\"9\\\\\\": \\\\\\"认证不通过，可能原因：非账号本人操作等可能\\\\\\",\\\\n \\\\\\"10\\\\\\": \\\\\\"认证不通过，可能原因：非同人操作等可能\\\\\\"\\\\n }\\",\\n \\"RequestId\\": \\"C58A8581-6A5B-55F1-B2EF-1CEAC97DA181\\"\\n}","type":"json"}]', + 'title' => 'Query Page Settings', + 'description' => 'Request Method: Only supports sending requests via HTTPS POST method.', + 'translator' => 'machine', + ], + 'DescribeProductCode' => [ + 'summary' => 'Get Product Code', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59124', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthV1ZO7W', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => 'Current query page number.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalPage' => [ + 'description' => 'Total number of pages.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'PageSize' => [ + 'description' => 'Number of products per page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => 'ID of this request.', + 'type' => 'string', + 'example' => '7FBBADA3-9A66-5759-8AF8-2F99F5BE13F7', + ], + 'TotalCount' => [ + 'description' => 'Total number of returned results.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'description' => 'List of product code information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProductName' => [ + 'description' => 'Name corresponding to the product code.', + 'type' => 'string', + 'example' => 'APP认证', + ], + 'ProductCode' => [ + 'description' => 'Product code.', + 'type' => 'string', + 'example' => 'ID_PRO', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"TotalPage\\": 3,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"7FBBADA3-9A66-5759-8AF8-2F99F5BE13F7\\",\\n \\"TotalCount\\": 1,\\n \\"Items\\": [\\n {\\n \\"ProductName\\": \\"APP认证\\",\\n \\"ProductCode\\": \\"ID_PRO\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Get Financial-grade Real-person Product Code', + 'description' => 'Request Method: Supports sending requests via HTTPS GET/POST methods.', + 'translator' => 'machine', + ], + 'DescribeVerifyDeviceRiskStatistics' => [ + 'summary' => 'Get Verification Device Statistics', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59141', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Cloud product code.', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_PRO', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'Start time of the query, in Unix timestamp format, in milliseconds.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1746720000000', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'End time.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1748624399999', + ], + ], + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Service type:'."\n" + .'- **antcloudauth**: Financial-grade real-person authentication.'."\n" + .'- **cloudauthst** (discontinued): Enhanced real-person authentication.'."\n" + .'- **cloudauth** (discontinued): Real-person authentication.', + 'type' => 'string', + 'required' => true, + 'example' => 'antcloudauth', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scene ID.', + 'type' => 'string', + 'required' => false, + 'example' => '100000xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'ID of this request.', + 'type' => 'string', + 'example' => 'B3193814-AE54-50C5-9070-68B69C07287D', + ], + 'ResultObject' => [ + 'description' => 'Authentication result.', + 'type' => 'object', + 'properties' => [ + 'RootRate' => [ + 'description' => 'Root percentage: total number of root / total number of risks.', + 'type' => 'string', + 'example' => '0', + ], + 'VirtualVideoRate' => [ + 'description' => 'Virtual video percentage: total number of virtual videos / total number of risks.', + 'type' => 'string', + 'example' => '23.2', + ], + 'RiskCount' => [ + 'description' => 'Number of risks.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'IdFakeRate' => [ + 'description' => 'Total number of suspected fake identities.', + 'type' => 'string', + 'example' => '0', + ], + 'FaceAttackRate' => [ + 'description' => 'Suspected fake face percentage: total number of suspected fake faces / total number of risks.', + 'type' => 'string', + 'example' => '0', + ], + 'SimulatorRate' => [ + 'description' => 'Simulator percentage: total number of simulators / total number of risks.', + 'type' => 'string', + 'example' => '0', + ], + 'Items' => [ + 'description' => 'Data items in the response.', + 'type' => 'array', + 'items' => [ + 'description' => 'Data items in the response.', + 'type' => 'object', + 'properties' => [ + 'Date' => [ + 'description' => 'Date.', + 'type' => 'string', + 'example' => '2025-10-10', + ], + 'DailyCallCount' => [ + 'description' => 'Daily call count.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11', + ], + 'DeviceRiskRate' => [ + 'description' => 'Abnormal device risk ratio.', + 'type' => 'string', + 'example' => '0', + ], + 'IdentityRiskRate' => [ + 'description' => 'Abnormal identity risk ratio.', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B3193814-AE54-50C5-9070-68B69C07287D\\",\\n \\"ResultObject\\": {\\n \\"RootRate\\": \\"0\\",\\n \\"VirtualVideoRate\\": \\"23.2\\",\\n \\"RiskCount\\": 2,\\n \\"IdFakeRate\\": \\"0\\",\\n \\"FaceAttackRate\\": \\"0\\",\\n \\"SimulatorRate\\": \\"0\\",\\n \\"Items\\": [\\n {\\n \\"Date\\": \\"2025-10-10\\",\\n \\"DailyCallCount\\": 11,\\n \\"DeviceRiskRate\\": \\"0\\",\\n \\"IdentityRiskRate\\": \\"0\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Get Verification Device Statistics', + 'description' => '- Service address: cloudauth.aliyuncs.com.'."\n" + .'- Request method: HTTPS POST and GET.', + 'translator' => 'machine', + ], + 'DescribeVerifyFailStatistics' => [ + 'summary' => 'Overview of authentication request statistics', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59142', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Product code.', + 'type' => 'string', + 'required' => true, + 'example' => 'ID_PRO', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'Start time of the query.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1760025600000', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'End time of the query.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1760630399999', + ], + ], + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Service type:'."\n" + .'- **antcloudauth**: Financial-grade real-person authentication.'."\n" + .'- **cloudauthst** (discontinued): Enhanced real-person authentication.'."\n" + .'- **cloudauth** (discontinued): Real-person authentication.', + 'type' => 'string', + 'required' => true, + 'example' => 'cloudauthst', + ], + ], + [ + 'name' => 'DeviceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Device type.'."\n" + .'- ios'."\n" + .'- android'."\n" + .'- websdk', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'android' => 'android', + 'websdk' => 'websdk', + 'ios' => 'ios', + ], + 'example' => 'ios', + ], + ], + [ + 'name' => 'Api', + 'in' => 'query', + 'schema' => [ + 'description' => 'API code:'."\n" + .'- **INIT_SERVICE**: Server-side initialization failure'."\n" + .'- **INIT_DEVICE**: Client-side failure'."\n" + .'- **VERIFY_DEVICE**: Authentication failed', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'VERIFY_DEVICE' => 'VERIFY_DEVICE', + 'INIT_SERVICE' => 'INIT_SERVICE', + 'INIT_DEVICE' => 'INIT_DEVICE', + ], + 'example' => 'INIT_SERVICE', + ], + ], + [ + 'name' => 'AgeGt', + 'in' => 'query', + 'schema' => [ + 'description' => 'Age greater than 14 years old:'."\n" + .'- **T**: Greater than'."\n" + .'- **F**: Less than', + 'type' => 'string', + 'required' => false, + 'example' => 'T', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'ID of this request.', + 'type' => 'string', + 'example' => 'C2C596D1-B14B-5D79-9672-61D7686912B2', + ], + 'ResultObject' => [ + 'description' => 'Authentication result.', + 'type' => 'object', + 'properties' => [ + 'Column' => [ + 'description' => 'Line chart of failure reasons.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'Total count.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Items' => [ + 'description' => 'Column information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'Error code.', + 'type' => 'string', + 'example' => '404', + ], + 'Rate' => [ + 'description' => 'Date: Date', + 'type' => 'string', + 'example' => '2025-10-16', + ], + 'Count' => [ + 'description' => 'Failure count.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + 'Line' => [ + 'description' => 'Bar chart of failure reasons.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'Total count.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Items' => [ + 'description' => 'Column information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'Error code.', + 'type' => 'string', + 'example' => '404', + ], + 'Data' => [ + 'description' => 'Returned quantity data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Date' => [ + 'description' => 'Date.', + 'type' => 'string', + 'example' => '2025-10-16', + ], + 'Code' => [ + 'description' => 'Error code.', + 'type' => 'string', + 'example' => '404', + ], + 'Count' => [ + 'description' => 'Count.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C2C596D1-B14B-5D79-9672-61D7686912B2\\",\\n \\"ResultObject\\": {\\n \\"Column\\": {\\n \\"TotalCount\\": 2,\\n \\"Items\\": [\\n {\\n \\"Code\\": \\"404\\",\\n \\"Rate\\": \\"2025-10-16\\",\\n \\"Count\\": 1\\n }\\n ]\\n },\\n \\"Line\\": {\\n \\"TotalCount\\": 0,\\n \\"Items\\": [\\n {\\n \\"Code\\": \\"404\\",\\n \\"Data\\": [\\n {\\n \\"Date\\": \\"2025-10-16\\",\\n \\"Code\\": \\"404\\",\\n \\"Count\\": 9\\n }\\n ]\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Query Authentication Request Failure Statistics', + 'description' => '- Service address: cloudauth.aliyuncs.com.'."\n" + .'- Request method: HTTPS POST and GET.', + 'translator' => 'machine', + ], + 'DescribeVerifyPersonasDeviceModelStatistics' => [ + 'summary' => 'Query Statistics on Device Face Comparison', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59145', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth0KJCLK', + ], + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scene ID.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000015316', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Product Code.', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_PRO', + ], + ], + [ + 'name' => 'TimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => 'Time range for the query, indicating how many days back.', + 'type' => 'string', + 'required' => true, + 'example' => '30', + ], + ], + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Service type:'."\n" + .'- **antcloudauth**: Financial-grade real-person authentication.'."\n" + .'- **cloudauthst** (discontinued): Enhanced real-person authentication.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'antcloudauth', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'ID of this request.', + 'type' => 'string', + 'example' => '026828A3-CC7E-5D85-85B6-08DF245C5A53', + ], + 'ResultObject' => [ + 'description' => 'Query result.', + 'type' => 'object', + 'properties' => [ + 'AllDeviceCnt' => [ + 'description' => 'Total number of devices.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '31', + ], + 'Items' => [ + 'description' => 'List of data for different phone models.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceModel' => [ + 'description' => 'Device model', + 'type' => 'string', + 'example' => 'iPhone15,2', + ], + 'DeviceCnt' => [ + 'description' => 'Number of devices.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'DeviceRate' => [ + 'description' => 'The ratio of this device model to the total number of devices.', + 'type' => 'string', + 'example' => '16.13', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"026828A3-CC7E-5D85-85B6-08DF245C5A53\\",\\n \\"ResultObject\\": {\\n \\"AllDeviceCnt\\": 31,\\n \\"Items\\": [\\n {\\n \\"DeviceModel\\": \\"iPhone15,2\\",\\n \\"DeviceCnt\\": 5,\\n \\"DeviceRate\\": \\"16.13\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query Distribution Data of Certified Users\' Phone Models', + 'description' => '- Service Address: cloudauth.aliyuncs.com.'."\n" + .'- Request Method: HTTPS POST and GET.', + 'translator' => 'machine', + ], + 'DescribeVerifyPersonasOsStatistics' => [ + 'summary' => 'Query Authentication Personnel Statistics', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59146', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthV1ZO7W', + ], + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scene ID.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000002995', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Product code.', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_PRO', + ], + ], + [ + 'name' => 'TimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => 'Time range for the query, indicating how many days ago.', + 'type' => 'string', + 'required' => true, + 'example' => '7', + ], + ], + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Service type:'."\n" + .'- **antcloudauth**: Financial-grade real-person authentication.'."\n" + .'- **cloudauthst** (discontinued): Enhanced real-person authentication.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'antcloudauth', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'ID of this request.', + 'type' => 'string', + 'example' => '123906BE-752B-51E3-A8FF-52F53B659CE6', + ], + 'ResultObject' => [ + 'description' => 'Processing result.', + 'type' => 'object', + 'properties' => [ + 'DeviceIosCnt' => [ + 'description' => 'Number of authenticated iOS devices.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'AllDeviceCnt' => [ + 'description' => 'Total number of authenticated devices.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '24', + ], + 'DeviceAndroidRate' => [ + 'description' => 'Proportion of Android devices.', + 'type' => 'string', + 'example' => '58.33', + ], + 'DeviceIosRate' => [ + 'description' => 'Proportion of iOS devices.', + 'type' => 'string', + 'example' => '41.67', + ], + 'DeviceAndroidCnt' => [ + 'description' => 'Number of authenticated Android devices.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"123906BE-752B-51E3-A8FF-52F53B659CE6\\",\\n \\"ResultObject\\": {\\n \\"DeviceIosCnt\\": 10,\\n \\"AllDeviceCnt\\": 24,\\n \\"DeviceAndroidRate\\": \\"58.33\\",\\n \\"DeviceIosRate\\": \\"41.67\\",\\n \\"DeviceAndroidCnt\\": 14\\n }\\n}","type":"json"}]', + 'title' => 'Query Authentication Device Distribution Data', + 'description' => '- Service address: cloudauth.aliyuncs.com.'."\n" + .'- Request method: HTTPS POST and GET.', + 'translator' => 'machine', + ], + 'DescribeVerifyPersonasProvinceStatistics' => [ + 'summary' => 'Obtain statistical information on the location of authenticated individuals', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59147', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth0KJCLK', + ], + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scene ID.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000004071', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Cloud product code.', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_PRO', + ], + ], + [ + 'name' => 'TimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => 'Time range, search range is for the previous N days, TimeRange of 1 indicates the previous 1 day.', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Service type:'."\n" + .'- **antcloudauth**: Financial-grade real-person authentication.'."\n" + .'- **cloudauthst** (discontinued): Enhanced real-person authentication.', + 'type' => 'string', + 'required' => true, + 'example' => 'antcloudauth', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'ID of this request.', + 'type' => 'string', + 'example' => 'D9821F95-CC18-5439-BB1C-21A0FF0C2003', + ], + 'ResultObject' => [ + 'description' => 'Query result.', + 'type' => 'object', + 'properties' => [ + 'AllUserCnt' => [ + 'description' => 'Total number of devices.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'Items' => [ + 'description' => 'Data items.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProvinceName' => [ + 'description' => 'Province name.', + 'type' => 'string', + 'example' => '浙江', + ], + 'ProvinceCnt' => [ + 'description' => 'Total number of devices in the province.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'ProvinceRate' => [ + 'description' => 'Percentage of the total for this province.', + 'type' => 'string', + 'example' => '35.71', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D9821F95-CC18-5439-BB1C-21A0FF0C2003\\",\\n \\"ResultObject\\": {\\n \\"AllUserCnt\\": 30,\\n \\"Items\\": [\\n {\\n \\"ProvinceName\\": \\"浙江\\",\\n \\"ProvinceCnt\\": 5,\\n \\"ProvinceRate\\": \\"35.71\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Statistics of Authentication Information by Individual\'s Province', + 'description' => '- Service Address: cloudauth.aliyuncs.com.'."\n" + .'- Request Method: HTTPS POST and GET.', + 'translator' => 'machine', + ], + 'DescribeVerifyPersonasSexStatistics' => [ + 'summary' => 'Query gender statistics of authentication', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scene ID.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000002996', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Product Code.', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_PRO', + ], + ], + [ + 'name' => 'TimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => 'Time range, the search range is for the previous N days, TimeRange of 1 indicates the previous 1 day.', + 'type' => 'string', + 'required' => true, + 'example' => '7', + ], + ], + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Service type:'."\n" + .'- **antcloudauth**: Financial-grade real-person authentication.'."\n" + .'- **cloudauthst** (discontinued): Enhanced real-person authentication.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'antcloudauth', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'ID of this request.', + 'type' => 'string', + 'example' => '013DA6E1-3F37-5579-B979-2F12B7E92450', + ], + 'ResultObject' => [ + 'description' => 'Returned data.', + 'type' => 'object', + 'properties' => [ + 'Age0To14Rate' => [ + 'description' => 'Proportion of users under 14 years old.', + 'type' => 'string', + 'example' => '0', + ], + 'Age14To18Cnt' => [ + 'description' => 'Number of users between 14 and 18 years old.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'FemaleCnt' => [ + 'description' => 'Number of female users.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'AllUserCnt' => [ + 'description' => 'Total number of authenticated users.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14', + ], + 'Age14To18Rate' => [ + 'description' => 'Proportion of users between 14 and 18 years old.', + 'type' => 'string', + 'example' => '0', + ], + 'Age0To14Cnt' => [ + 'description' => 'Number of users under 14 years old.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'MaleCnt' => [ + 'description' => 'Number of male users.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'Age50To999Rate' => [ + 'description' => 'Proportion of authenticated users over 50 years old.', + 'type' => 'string', + 'example' => '0', + ], + 'Age35To50Rate' => [ + 'description' => 'Proportion of users between 35 and 50 years old.', + 'type' => 'string', + 'example' => '35.71', + ], + 'FemaleRate' => [ + 'description' => 'Proportion of female authenticated users.', + 'type' => 'string', + 'example' => '28.57', + ], + 'Age18To35Rate' => [ + 'description' => 'Proportion of authenticated users between 18 and 35 years old.', + 'type' => 'string', + 'example' => '64.29', + ], + 'Age18To35Cnt' => [ + 'description' => 'Number of authenticated users between 18 and 35 years old.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'Age35To50Cnt' => [ + 'description' => 'Number of authenticated users between 35 and 50 years old.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'Age50To999Cnt' => [ + 'description' => 'Number of authenticated users over 50 years old.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'MaleRate' => [ + 'description' => 'Proportion of male users.', + 'type' => 'string', + 'example' => '71.43', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"013DA6E1-3F37-5579-B979-2F12B7E92450\\",\\n \\"ResultObject\\": {\\n \\"Age0To14Rate\\": \\"0\\",\\n \\"Age14To18Cnt\\": 0,\\n \\"FemaleCnt\\": 4,\\n \\"AllUserCnt\\": 14,\\n \\"Age14To18Rate\\": \\"0\\",\\n \\"Age0To14Cnt\\": 0,\\n \\"MaleCnt\\": 10,\\n \\"Age50To999Rate\\": \\"0\\",\\n \\"Age35To50Rate\\": \\"35.71\\",\\n \\"FemaleRate\\": \\"28.57\\",\\n \\"Age18To35Rate\\": \\"64.29\\",\\n \\"Age18To35Cnt\\": 9,\\n \\"Age35To50Cnt\\": 5,\\n \\"Age50To999Cnt\\": 0,\\n \\"MaleRate\\": \\"71.43\\"\\n }\\n}","type":"json"}]', + 'title' => 'Statistics of Authentication Information by Gender', + 'description' => '- Service address: cloudauth.aliyuncs.com.'."\n" + .'- Request method: HTTPS POST and GET.', + 'translator' => 'machine', + ], + 'DescribeVerifySearchPageList' => [ + 'summary' => 'Query the list of authentication schemes', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59153', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth0KJCLK', + ], + ], + 'parameters' => [ + [ + 'name' => 'CertifyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Authentication ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'shadbdd3dbacd001cfa892a5e2b98dxx', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scene ID.', + 'type' => 'string', + 'required' => false, + 'example' => '10000072xx', + ], + ], + [ + 'name' => 'OuterOrderNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'Unique identifier for the customer request.', + 'type' => 'string', + 'required' => false, + 'example' => 'e0c34a77f5ac40a5aa5e6ed20c353888', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Product code.', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_PRO', + ], + ], + [ + 'name' => 'CertNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'ID number.', + 'type' => 'string', + 'required' => false, + 'example' => '3203212000XXXX701X', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'Start date of the query.', + 'type' => 'string', + 'required' => false, + 'example' => '2025-10-10 00:00:00 +0800', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'End date of the query. The format is a Unix timestamp, in milliseconds.', + 'type' => 'string', + 'required' => false, + 'example' => '2025-10-16 23:59:59 +0800', + ], + ], + [ + 'name' => 'SubCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Result Code. For detailed values, please refer to: [SubCode Explanation](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/error-code-person-verify?spm=a2c4g.11186623.0.0.6015566ebArcFw#d88910e172fgg).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '201', + ], + ], + [ + 'name' => 'SubCodes', + 'in' => 'query', + 'schema' => [ + 'description' => 'Comma-separated Result Codes. For detailed values, please refer to: [SubCode Explanation](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/error-code-person-verify?spm=a2c4g.11186623.0.0.6015566ebArcFw#d88910e172fgg).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '201,202', + ], + ], + [ + 'name' => 'HasDeviceRisk', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether there is device risk (pass true if root = 1 or simulator = 1 or virtual_video = 1).', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Passed', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether the authentication passed:'."\n" + .'- **T**: Passed'."\n" + .'- **F**: Not passed', + 'type' => 'string', + 'required' => false, + 'example' => 'F', + ], + ], + [ + 'name' => 'Model', + 'in' => 'query', + 'schema' => [ + 'description' => 'Liveness detection model.', + 'type' => 'string', + 'required' => false, + 'example' => 'LIVENESS', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'Current page number.', + 'type' => 'string', + 'required' => true, + 'example' => '3', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of items per page.', + 'type' => 'string', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'Root', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether it is rooted (pass 1 if selected, otherwise do not pass; corresponds to identity label risk type).', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Simulator', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether it is a simulator (pass 1 if selected, otherwise do not pass; corresponds to device label risk type).', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'VirtualVideo', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether it is a virtual adaptation (pass 1 if selected, otherwise do not pass; corresponds to behavior label risk type).', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RiskDevice', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'RiskDeviceToken', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'RiskGeneric', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'RiskBizScenario', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'RiskModelMining', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => 'Current page number.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalPage' => [ + 'description' => 'Total number of pages.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'PageSize' => [ + 'description' => 'Number of items per page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => 'ID of this request.', + 'type' => 'string', + 'example' => '47D87BC1-D956-573A-8A15-A9007A76F56C', + ], + 'TotalCount' => [ + 'description' => 'Total number of pages.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '53', + ], + 'Items' => [ + 'description' => 'Paged list data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GmtVerify' => [ + 'description' => 'Verification time of this authentication.', + 'type' => 'string', + 'example' => '2025-10-14 15:40:13', + ], + 'Simulator' => [ + 'description' => 'Whether it is a simulator (pass 1 if selected, otherwise do not pass; corresponds to device label risk type).', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'UserId' => [ + 'description' => 'User ID.', + 'type' => 'string', + 'example' => '198123xxxxxx', + ], + 'CertifyId' => [ + 'description' => 'Certification ID.', + 'type' => 'string', + 'example' => 'shad861465f2aaeeb805b519e1a93ab2', + ], + 'Model' => [ + 'description' => 'Liveness detection scheme.', + 'type' => 'string', + 'example' => 'MULTI_ACTION', + ], + 'OuterOrderNo' => [ + 'description' => 'Unique identifier for the customer request.', + 'type' => 'string', + 'example' => 'e0c34a77f5ac40a5aa5e6ed20c353888', + ], + 'CertNo' => [ + 'description' => 'Desensitized ID number.', + 'type' => 'string', + 'example' => '3****************2', + ], + 'SubCode' => [ + 'description' => 'System returned error code.', + 'type' => 'string', + 'example' => '207', + ], + 'SceneId' => [ + 'description' => 'Scene ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000015352', + ], + 'Root' => [ + 'description' => 'Whether it is root (pass 1 if selected, otherwise do not pass; corresponds to identity label risk type).', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Passed' => [ + 'description' => 'Whether the certification passed. Values:'."\n" + .'- **T**: Passed.'."\n" + .'- **F**: Not passed.', + 'type' => 'string', + 'example' => 'T', + ], + 'VirtualVideo' => [ + 'description' => 'Whether it is a virtual adaptation (pass 1 if selected, otherwise do not pass; corresponds to behavior label risk type).', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ProductCode' => [ + 'description' => 'Product code.', + 'type' => 'string', + 'example' => 'ID_PRO', + ], + 'ExtInfo' => [ + 'description' => 'Extended information.', + 'type' => 'object', + 'properties' => [ + 'OssIdNationalEmblemObjectName' => [ + 'description' => 'OCR ID card national emblem file name.', + 'type' => 'string', + 'example' => '-', + ], + 'QualityScore' => [ + 'description' => 'Liveness face quality score.', + 'type' => 'number', + 'format' => 'float', + 'example' => '1.0', + ], + 'FaceAttackScore' => [ + 'description' => 'Face attack score, with a range of 0~1. A value closer to 1 indicates a higher likelihood of an attack.', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0000445161', + ], + 'CertName' => [ + 'description' => 'Desensitized name.', + 'type' => 'string', + 'example' => '何*', + ], + 'FaceAttack' => [ + 'description' => 'Whether it is a face attack:'."\n" + .'- **T**: Yes'."\n" + .'- **F**: No', + 'type' => 'string', + 'example' => 'T', + ], + 'IdCardVerifyScore' => [ + 'description' => 'Face-to-ID card comparison score.', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9', + ], + 'OssIdFaceObjectName' => [ + 'description' => 'OCR ID card face file name.', + 'type' => 'string', + 'example' => '-', + ], + 'FaceOcclusion' => [ + 'description' => 'Whether the face is occluded, T if yes, F otherwise.', + 'type' => 'string', + 'example' => 'T', + ], + 'VerifyScore' => [ + 'description' => 'Face comparison score.', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'OssBucketName' => [ + 'description' => 'The OSS bucket for the photo.', + 'type' => 'string', + 'example' => 'cn-shanghai-aliyun-cloudauth-XXX', + ], + 'OssObjectName' => [ + 'description' => 'The name of the stored object.', + 'type' => 'string', + 'example' => 'verify/XXXXX1251634779/sha6a0a0cab01288c7aa8ac3f45220eb_0_normal.jpeg', + ], + 'asrTexts' => [ + 'description' => 'List of ASR texts.', + 'type' => 'array', + 'items' => [ + 'description' => 'ASR text', + 'type' => 'string', + 'example' => '请朗读：3 5 8 1', + ], + ], + 'voiceObjectNames' => [ + 'description' => 'List of OSS file names for audio files.', + 'type' => 'array', + 'items' => [ + 'description' => 'OSS file name for an audio file.', + 'type' => 'string', + 'example' => 'XXXXXc3f45220eb_0.mp4'."\n", + ], + 'example' => '-', + ], + 'screenVideoObjectNames' => [ + 'description' => 'List of OSS file names for screen recording files.', + 'type' => 'array', + 'items' => [ + 'description' => 'OSS file name for a screen recording file.', + 'type' => 'string', + 'example' => 'XXXXXc3f45220eb_0.mp4', + ], + 'example' => '-', + ], + 'DeviceRisk' => [ + 'description' => 'Face guard label.', + 'type' => 'string', + 'example' => '-', + ], + ], + ], + 'RiskDevice' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RiskDeviceToken' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RiskGeneric' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RiskBizScenario' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RiskModelMining' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"TotalPage\\": 4,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"47D87BC1-D956-573A-8A15-A9007A76F56C\\",\\n \\"TotalCount\\": 53,\\n \\"Items\\": [\\n {\\n \\"GmtVerify\\": \\"2025-10-14 15:40:13\\",\\n \\"Simulator\\": 1,\\n \\"UserId\\": \\"198123xxxxxx\\",\\n \\"CertifyId\\": \\"shad861465f2aaeeb805b519e1a93ab2\\",\\n \\"Model\\": \\"MULTI_ACTION\\",\\n \\"OuterOrderNo\\": \\"e0c34a77f5ac40a5aa5e6ed20c353888\\",\\n \\"CertNo\\": \\"3****************2\\",\\n \\"SubCode\\": \\"207\\",\\n \\"SceneId\\": 1000015352,\\n \\"Root\\": 1,\\n \\"Passed\\": \\"T\\",\\n \\"VirtualVideo\\": 1,\\n \\"ProductCode\\": \\"ID_PRO\\",\\n \\"ExtInfo\\": {\\n \\"OssIdNationalEmblemObjectName\\": \\"-\\",\\n \\"QualityScore\\": 1,\\n \\"FaceAttackScore\\": 0.0000445161,\\n \\"CertName\\": \\"何*\\",\\n \\"FaceAttack\\": \\"T\\",\\n \\"IdCardVerifyScore\\": 0.9,\\n \\"OssIdFaceObjectName\\": \\"-\\",\\n \\"FaceOcclusion\\": \\"T\\",\\n \\"VerifyScore\\": 0,\\n \\"OssBucketName\\": \\"cn-shanghai-aliyun-cloudauth-XXX\\",\\n \\"OssObjectName\\": \\"verify/XXXXX1251634779/sha6a0a0cab01288c7aa8ac3f45220eb_0_normal.jpeg\\",\\n \\"asrTexts\\": [\\n \\"请朗读：3 5 8 1\\"\\n ],\\n \\"voiceObjectNames\\": [\\n \\"XXXXXc3f45220eb_0.mp4\\\\n\\"\\n ],\\n \\"screenVideoObjectNames\\": [\\n \\"XXXXXc3f45220eb_0.mp4\\"\\n ],\\n \\"DeviceRisk\\": \\"-\\"\\n },\\n \\"RiskDevice\\": 0,\\n \\"RiskDeviceToken\\": 0,\\n \\"RiskGeneric\\": 0,\\n \\"RiskBizScenario\\": 0,\\n \\"RiskModelMining\\": 0\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Paged Query for Authentication List', + 'description' => '- Service Address: cloudauth.aliyuncs.com.'."\n" + .'- Request Method: HTTPS POST and GET.', + 'translator' => 'machine', + ], + 'DescribeVerifyStatistics' => [ + 'summary' => 'Query Authentication Statistics', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59155', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth0KJCLK', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Product Code.', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_PRO', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'Start date of the query.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1760025600000', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'End date of the query.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1760630399999', + ], + ], + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Service type:'."\n" + .'- **antcloudauth**: Financial-grade real-person authentication.'."\n" + .'- **cloudauthst** (discontinued): Enhanced real-person authentication.'."\n" + .'- **cloudauth** (discontinued): Real-person authentication.', + 'type' => 'string', + 'required' => true, + 'example' => 'antcloudauth', + ], + ], + [ + 'name' => 'AgeGt', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether the age is over 14 years old:'."\n" + .'- **T**: Over'."\n" + .'- **F**: Under', + 'type' => 'string', + 'required' => false, + 'example' => 'T', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'ID of this request.', + 'type' => 'string', + 'example' => '4E27D502-1287-526A-910C-881A3F023914', + ], + 'ResultObject' => [ + 'description' => 'Statistical results', + 'type' => 'object', + 'properties' => [ + 'InitServiceId' => [ + 'description' => 'Total number of identity deduplication server initialization requests.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'InitServiceIdSuccess' => [ + 'description' => 'Number of successful identity deduplication server initializations.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'InitDeviceIdSuccess' => [ + 'description' => 'Number of successful identity deduplication client initializations.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'InitDeviceId' => [ + 'description' => 'Number of identity deduplication client initializations.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'InitDeviceSuccess' => [ + 'description' => 'Number of client initialization calls.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '73', + ], + 'VerifyDeviceIdSuccessPassed' => [ + 'description' => 'Number of successful identity deduplication client authentications.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'VerifyDeviceSuccessPassed' => [ + 'description' => 'Number of successful client authentications.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + 'VerifyDeviceId' => [ + 'description' => 'Number of identity deduplication client authentications.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'VerifyDeviceSuccess' => [ + 'description' => 'Number of successful client authentications.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + 'InitDevice' => [ + 'description' => 'Number of client initializations.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '73', + ], + 'VerifyDeviceIdSuccess' => [ + 'description' => 'Number of successful identity deduplication client verifications.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + 'InitServiceSuccess' => [ + 'description' => 'Number of successful service-side initialization authentications.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '134', + ], + 'InitService' => [ + 'description' => 'Number of service-side initializations.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '73', + ], + 'VerifyDevice' => [ + 'description' => 'Number of client verifications.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + 'Items' => [ + 'description' => 'Daily pass/conversion rate (PV).', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InitDevicePassRate' => [ + 'description' => 'Client initialization pass rate.', + 'type' => 'string', + 'example' => '60', + ], + 'InitServicePassRate' => [ + 'description' => 'Server initialization pass rate.', + 'type' => 'string', + 'example' => '20', + ], + 'Date' => [ + 'description' => 'Date.', + 'type' => 'string', + 'example' => '2025-10-11', + ], + 'InitServiceConversionRate' => [ + 'description' => 'Server initialization conversion rate.', + 'type' => 'string', + 'example' => '26.67', + ], + 'PassRate' => [ + 'description' => 'Pass rate.', + 'type' => 'string', + 'example' => '75', + ], + 'InitService' => [ + 'description' => 'Number of server initializations.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E27D502-1287-526A-910C-881A3F023914\\",\\n \\"ResultObject\\": {\\n \\"InitServiceId\\": 9,\\n \\"InitServiceIdSuccess\\": 9,\\n \\"InitDeviceIdSuccess\\": 9,\\n \\"InitDeviceId\\": 9,\\n \\"InitDeviceSuccess\\": 73,\\n \\"VerifyDeviceIdSuccessPassed\\": 3,\\n \\"VerifyDeviceSuccessPassed\\": 6,\\n \\"VerifyDeviceId\\": 9,\\n \\"VerifyDeviceSuccess\\": 15,\\n \\"InitDevice\\": 73,\\n \\"VerifyDeviceIdSuccess\\": 6,\\n \\"InitServiceSuccess\\": 134,\\n \\"InitService\\": 73,\\n \\"VerifyDevice\\": 15,\\n \\"Items\\": [\\n {\\n \\"InitDevicePassRate\\": \\"60\\",\\n \\"InitServicePassRate\\": \\"20\\",\\n \\"Date\\": \\"2025-10-11\\",\\n \\"InitServiceConversionRate\\": \\"26.67\\",\\n \\"PassRate\\": \\"75\\",\\n \\"InitService\\": 15\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query Authentication Statistics', + 'description' => '- Request Method: Supports sending requests using HTTPS POST and GET methods.'."\n" + .'- Service Address: cloudauth.aliyuncs.com.'."\n", + 'translator' => 'machine', + ], + 'DescribeMetaSearchPageList' => [ + 'summary' => 'Query Page Metadata', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '103364', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthNOQ41U', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Api', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ID_CARD_2_META', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1760198400000', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1739926800000', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'SubCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '205', + ], + ], + [ + 'name' => 'ReqId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'B012DB99-6C10-5740-81E0-B3A8C1C1B9C1', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '522132197411184XXX', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'VehicleNum', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '19127612221', + ], + ], + [ + 'name' => 'BankCard', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '610*************1181', + ], + ], + [ + 'name' => 'IspName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'CTCC', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalPage' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '5176EB42-6EE7-510B-9388-35018DF3175B', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Items' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'IdentifyNum' => [ + 'description' => '', + 'type' => 'string', + 'example' => '4****************X', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'B0102BEF-4411-57C3-860D-CFE7DE0A64C0', + ], + 'Api' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ID_CARD_2_META', + ], + 'BizCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Date' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-10-17 10:00:11', + ], + 'SubCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '207', + ], + 'UserName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ApiName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Request' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'VehicleNum' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'VehicleType' => [ + 'description' => '', + 'type' => 'string', + 'example' => '52', + ], + 'VehicleTypeName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + 'Response' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2', + ], + 'Vin' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'LDC643T44G3667219', + ], + 'ModelNum' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'HQ7002BEV67', + ], + 'EngineNum' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'N7YJ113PA', + ], + 'Type' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Color' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'UseProperty' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'RegistrationDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2015-08-24 00:00:00', + ], + 'InspectionDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2026-07-31 00:00:00', + ], + 'RetirementDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2099-12-31 00:00:00', + ], + 'VehicleState' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'EngineType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CA6GV30TD', + ], + 'FuelType' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Displacement' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'Power' => [ + 'description' => '', + 'type' => 'string', + 'example' => '120', + ], + 'AxleCount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2', + ], + 'WheelBase' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2750', + ], + 'FrontWheelDistance' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1630', + ], + 'BackWheelDistance' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1630', + ], + 'TotalMass' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2350', + ], + 'UnladenMass' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1900', + ], + 'ApprovedLoad' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'ApprovedCount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '5', + ], + 'ReleaseDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-08-13 00:00:00', + ], + 'Brand' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'BankCard' => [ + 'description' => '', + 'type' => 'string', + 'example' => '622848001714440xxxx', + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + 'VehicleNum' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RequestJson' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ResponseJson' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Mobile' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1500000xxxx', + ], + 'BankCard' => [ + 'description' => '', + 'type' => 'string', + 'example' => '6214837145546986', + ], + 'IspName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CUCC', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"TotalPage\\": 0,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"5176EB42-6EE7-510B-9388-35018DF3175B\\",\\n \\"TotalCount\\": 0,\\n \\"Items\\": [\\n {\\n \\"IdentifyNum\\": \\"4****************X\\",\\n \\"RequestId\\": \\"B0102BEF-4411-57C3-860D-CFE7DE0A64C0\\",\\n \\"Api\\": \\"ID_CARD_2_META\\",\\n \\"BizCode\\": \\"1\\",\\n \\"Date\\": \\"2025-10-17 10:00:11\\",\\n \\"SubCode\\": \\"207\\",\\n \\"UserName\\": \\"**豪\\",\\n \\"ApiName\\": \\"身份证二要素\\",\\n \\"Request\\": {\\n \\"VehicleNum\\": \\"浙J3H91H\\",\\n \\"VehicleType\\": \\"52\\",\\n \\"VehicleTypeName\\": \\"新能源小型车\\"\\n },\\n \\"Response\\": {\\n \\"Data\\": {\\n \\"BizCode\\": \\"2\\",\\n \\"Vin\\": \\"LDC643T44G3667219\\",\\n \\"ModelNum\\": \\"HQ7002BEV67\\",\\n \\"EngineNum\\": \\"N7YJ113PA\\",\\n \\"Type\\": \\"小型轿车\\",\\n \\"Color\\": \\"白\\",\\n \\"UseProperty\\": \\"0\\",\\n \\"RegistrationDate\\": \\"2015-08-24 00:00:00\\",\\n \\"InspectionDate\\": \\"2026-07-31 00:00:00\\",\\n \\"RetirementDate\\": \\"2099-12-31 00:00:00\\",\\n \\"VehicleState\\": \\"正常\\",\\n \\"EngineType\\": \\"CA6GV30TD\\",\\n \\"FuelType\\": \\"电\\",\\n \\"Displacement\\": \\"0\\",\\n \\"Power\\": \\"120\\",\\n \\"AxleCount\\": \\"2\\",\\n \\"WheelBase\\": \\"2750\\",\\n \\"FrontWheelDistance\\": \\"1630\\",\\n \\"BackWheelDistance\\": \\"1630\\",\\n \\"TotalMass\\": \\"2350\\",\\n \\"UnladenMass\\": \\"1900\\",\\n \\"ApprovedLoad\\": \\"0\\",\\n \\"ApprovedCount\\": \\"5\\",\\n \\"ReleaseDate\\": \\"2022-08-13 00:00:00\\",\\n \\"Brand\\": \\"奔驰\\",\\n \\"BankCard\\": \\"622848001714440xxxx\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\"\\n },\\n \\"VehicleNum\\": \\"浙J3H91H\\",\\n \\"RequestJson\\": \\"{\\\\\\\\\\\\\\"productCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cloudauth_infoverify_public_cn\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"identifyNum\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"4****************X\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"userName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"**豪\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"userId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"12600512516xxxxx\\\\\\\\\\\\\\"}\\",\\n \\"ResponseJson\\": \\"{\\\\\\\\\\\\\\"code\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"200\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"data\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"bizCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ispName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"CMCC\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"subCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"101\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"message\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"调用成功\\\\\\\\\\\\\\"}\\",\\n \\"Mobile\\": \\"1500000xxxx\\",\\n \\"BankCard\\": \\"6214837145546986\\",\\n \\"IspName\\": \\"CUCC\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Paginated Query for Information Verification Details.', + 'translator' => 'machine', + ], + 'DescribeMetaStatisticsList' => [ + 'summary' => 'Query Authentication Statistics', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '103365', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthNOQ41U', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Api', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'MOBILE_ONLINE_LENGTH', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1760112000000', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1750694399999', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3F860B3F-76B7-5555-A907-2F4433BF8868', + ], + 'Items' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SuccessRate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '100', + ], + 'Api' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'MOBILE_ONLINE_LENGTH', + ], + 'BillRate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'Date' => [ + 'description' => '', + 'type' => 'string', + 'example' => '11/8', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'SuccessCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'NoRecordCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'BillCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'UnpassedCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'PassedRate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '20', + ], + 'ApiName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'PassedCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'IspName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CUCC', + ], + 'ChargeCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F860B3F-76B7-5555-A907-2F4433BF8868\\",\\n \\"Items\\": [\\n {\\n \\"SuccessRate\\": \\"100\\",\\n \\"Api\\": \\"MOBILE_ONLINE_LENGTH\\",\\n \\"BillRate\\": \\"0\\",\\n \\"Date\\": \\"11/8\\",\\n \\"TotalCount\\": 4,\\n \\"SuccessCount\\": 1,\\n \\"NoRecordCount\\": 0,\\n \\"BillCount\\": 0,\\n \\"UnpassedCount\\": 2,\\n \\"PassedRate\\": \\"20\\",\\n \\"ApiName\\": \\"身份证二要素\\",\\n \\"PassedCount\\": 9,\\n \\"IspName\\": \\"CUCC\\",\\n \\"ChargeCount\\": 0\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query Information Verification and Authentication Statistics', + 'translator' => 'machine', + ], + 'DescribeMetaStatisticsPageList' => [ + 'summary' => 'Query Authentication Statistics Page', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '103367', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthNOQ41U', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Api', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ID_PERIOD', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1760112000000', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1737561599999', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '3', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'TotalPage' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'C379C9E4-4DA0-5D0B-821B-25E2B8693D48', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'Items' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SuccessRate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '100', + ], + 'Api' => [ + 'description' => 'Api。', + 'type' => 'string', + 'example' => 'ID_PERIOD', + ], + 'BillRate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '80', + ], + 'Date' => [ + 'description' => '', + 'type' => 'string', + 'example' => '11/8', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'SuccessCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'NoRecordCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'BillCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'UnpassedCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'PassedRate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '80', + ], + 'ApiName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'PassedCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21', + ], + 'IspName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CMCC', + ], + 'ChargeCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 3,\\n \\"TotalPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"C379C9E4-4DA0-5D0B-821B-25E2B8693D48\\",\\n \\"TotalCount\\": 7,\\n \\"Items\\": [\\n {\\n \\"SuccessRate\\": \\"100\\",\\n \\"Api\\": \\"ID_PERIOD\\",\\n \\"BillRate\\": \\"80\\",\\n \\"Date\\": \\"11/8\\",\\n \\"TotalCount\\": 4,\\n \\"SuccessCount\\": 1,\\n \\"NoRecordCount\\": 12,\\n \\"BillCount\\": 10,\\n \\"UnpassedCount\\": 2,\\n \\"PassedRate\\": \\"80\\",\\n \\"ApiName\\": \\"车辆要素核验增强版\\",\\n \\"PassedCount\\": 21,\\n \\"IspName\\": \\"CMCC\\",\\n \\"ChargeCount\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Paged Query for Information Verification Data', + 'translator' => 'machine', + ], + 'QuerySceneConfigs' => [ + 'summary' => 'Query Scene Configuration', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '138609', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'type', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scene type.', + 'type' => 'string', + 'required' => true, + 'example' => 'VOLUNTARY', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListRespDTO<SceneConfigDTO>', + 'description' => 'ListRespDTO<SceneConfigDTO>', + 'type' => 'object', + 'properties' => [ + 'sceneConfigs' => [ + 'description' => 'Willingness configuration list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => 'Configuration ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '607', + ], + 'gmtCreate' => [ + 'description' => 'Creation time.', + 'type' => 'string', + 'example' => '1760782820000', + ], + 'gmtModified' => [ + 'description' => 'Modification time.', + 'type' => 'string', + 'example' => '1760782820000', + ], + 'type' => [ + 'description' => 'Configuration type.', + 'type' => 'string', + 'example' => 'VOLUNTARY', + ], + 'sceneId' => [ + 'description' => 'Scene ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000009045', + ], + 'version' => [ + 'description' => 'Scene configuration version number.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'config' => [ + 'description' => 'Specific configuration content, in JSON string format.', + 'type' => 'string', + 'example' => '{\\"faceCompareMode\\":\\"CUSTOM\\",\\"certConfigs\\":[{\\"index\\":0,\\"openVoiceCompare\\":false,\\"openCustomizedContent\\":true,\\"model\\":\\"QA\\"}],\\"screenEvidence\\":true}', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'ID of this request.', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"sceneConfigs\\": [\\n {\\n \\"id\\": 607,\\n \\"gmtCreate\\": \\"1760782820000\\",\\n \\"gmtModified\\": \\"1760782820000\\",\\n \\"type\\": \\"VOLUNTARY\\",\\n \\"sceneId\\": 1000009045,\\n \\"version\\": 1,\\n \\"config\\": \\"{\\\\\\\\\\\\\\"faceCompareMode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"CUSTOM\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"certConfigs\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"index\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"openVoiceCompare\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"openCustomizedContent\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"model\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"QA\\\\\\\\\\\\\\"}],\\\\\\\\\\\\\\"screenEvidence\\\\\\\\\\\\\\":true}\\"\\n }\\n ],\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]', + 'title' => 'Query Willingness Authentication Settings', + 'description' => '- Service address: cloudauth.aliyuncs.com.'."\n" + .'- Request method: HTTPS POST and GET.', + 'translator' => 'machine', + ], + 'CreateSceneConfig' => [ + 'summary' => 'Create Scene Configuration', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '138594', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthV1ZO7W', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'type', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Configuration type.', + 'type' => 'string', + 'required' => true, + 'example' => 'VOLUNTARY', + ], + ], + [ + 'name' => 'sceneId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Scene ID.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1000014084', + ], + ], + [ + 'name' => 'config', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Intention authentication configuration, as a JSON string.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{\\"faceCompareMode\\":\\"AUTHORITY\\",\\"certConfigs\\":[{\\"index\\":0,\\"openVoiceCompare\\":true,\\"openCustomizedContent\\":true,\\"model\\":\\"FOLLOW\\"}],\\"screenEvidence\\":false}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RespDTO<SceneConfigDTO>', + 'description' => 'RespDTO<SceneConfigDTO>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'ID of this request.', + 'type' => 'string', + 'example' => 'B506328A-D84B-4750-82C7-6A207C585CF1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B506328A-D84B-4750-82C7-6A207C585CF1\\"\\n}","type":"json"}]', + 'title' => 'Create Intention Authentication Configuration for Scene.', + 'description' => 'Request Method: Supports sending requests via HTTPS POST.'."\n" + .'Request Address: cloudauth.aliyuncs.com.'."\n" + ."\n" + .'> The authorization key is valid for 30 minutes and cannot be reused. It is recommended to reacquire it before each activation.', + 'translator' => 'machine', + ], + 'UpdateSceneConfig' => [ + 'summary' => 'Update Scene Configuration', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '138608', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth6RJHVQ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'id', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Willingness configuration ID.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '607', + ], + ], + [ + 'name' => 'sceneId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Selected authentication scene.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1000012918', + ], + ], + [ + 'name' => 'config', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Scene configuration information, in JSON format. For the specific structure definition, please refer to more information about the configuration.', + 'type' => 'string', + 'required' => true, + 'example' => '{\\"faceCompareMode\\":\\"AUTHORITY\\",\\"certConfigs\\":[{\\"index\\":0,\\"model\\":\\"ENROLL\\"}],\\"screenEvidence\\":false}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RespDTO<Boolean>', + 'description' => 'RespDTO<Boolean>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of this request.', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]', + 'title' => 'Update Willingness Scene Configuration', + 'description' => '- Request Method: Supports sending requests via HTTPS POST.'."\n" + .'- Request URL: cloudauth.aliyuncs.com.', + 'translator' => 'machine', + ], + 'DeleteSceneConfig' => [ + 'summary' => 'Delete Scene Configuration', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '138610', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth6RJHVQ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'sceneConfigId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'ID of the intent authentication configuration.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '559', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RespDTO<Boolean>', + 'description' => 'RespDTO<Boolean>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'ID of this request.', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', + 'title' => 'Delete Scene Configuration', + 'description' => '- Request Method: Supports sending requests via HTTPS POST and GET methods.'."\n" + .'- Request URL: cloudauth.aliyuncs.com.'."\n" + ."\n" + .'> The authorization key is valid for 30 minutes and cannot be reused. It is recommended to re-obtain it before each activation.', + 'translator' => 'machine', + ], + 'QueryVerifyDownloadTask' => [ + 'summary' => 'Query Real-Person Download Task', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '165842', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth6RJHVQ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DownloadTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Download task ID.', + 'type' => 'string', + 'required' => false, + 'example' => '202411194002618', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + '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' => '5A6229C0-E156-48E4-B6EC-0F528BDF60D2', + ], + 'Finish' => [ + 'description' => 'Whether the download task is completed:'."\n" + .'- **true**: Completed'."\n" + .'- **false**: Not completed', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Url' => [ + 'description' => 'Download URL.', + 'type' => 'string', + 'example' => 'http://xxx/xxx.csv', + ], + 'Status' => [ + 'description' => 'Task status:'."\n" + .'- **1**: File generation in progress'."\n" + .'- **2**: File generation completed'."\n" + .'- **3**: File generation failed'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ErrorCode' => [ + 'description' => 'Error code.', + 'type' => 'string', + 'example' => '-', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A6229C0-E156-48E4-B6EC-0F528BDF60D2\\",\\n \\"Finish\\": true,\\n \\"Url\\": \\"http://xxx/xxx.csv\\",\\n \\"Status\\": 2,\\n \\"ErrorCode\\": \\"-\\"\\n}","type":"json"}]', + 'title' => 'Query Download Authentication Data Task Details', + 'description' => 'Obtain the download link for statistical call data files under the product plan based on query conditions.'."\n" + .'- Method: HTTPS POST'."\n" + .'- Service Address: cloudauth.aliyuncs.com'."\n" + ."\n" + .'> The real-person authentication product uses CertifyId to count the number of calls. For ease of reconciliation, please retain the CertifyId field in your system.'."\n", + 'translator' => 'machine', + ], + 'DownloadVerifyRecords' => [ + 'summary' => 'Real-person Authentication Record Download', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '165265', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Product type:'."\n" + .'- **FINANCE_VERIFY**: Financial-level real-person authentication'."\n" + .'- **SMART_VERIFY**: Enhanced real-person authentication (discontinued)'."\n" + .'- **FACE_VERIFY**: Real-person authentication (discontinued)'."\n" + .'- **INFO_CHECK_STATISTICS**: Information verification', + 'type' => 'string', + 'required' => false, + 'example' => 'FINANCE_VERIFY', + ], + ], + [ + 'name' => 'BizParam', + 'in' => 'query', + 'schema' => [ + 'description' => 'Query condition in JSON string format, specifically including fields:'."\n" + .'- **DownloadMode (String)**: Download mode,'."\n" + .' - Example value: sync'."\n" + .'- **InvokeType (String)**: Product plan, corresponding to **ProductType**'."\n" + .'- **SceneIdList (List<Long>)**: List of scene IDs'."\n" + .'- **StatisticsType (String)**: Statistics type'."\n" + .' - day'."\n" + .' - month'."\n" + .'- **StartDate (String)**: Start date of the query'."\n" + .' - Example value: 2025-09-17 00:00:00 +0800'."\n" + .'- **EndDate (String)**: End date of the query'."\n" + .' - Example value: 2025-10-16 23:59:59 +0800'."\n" + .'- **ProductProgramList**: List of product codes under the queried product plan'."\n" + .' - Example value: ["FINANCE_FACE_VERIFY","MFVC"]'."\n" + .'- **Code (Information Verification API)**:'."\n" + .' - **ID_CARD_2_META**: ID card two-factor verification'."\n" + .' - **ID_PERIOD**: Validity period of ID card verification'."\n" + .' - **MOBILE_ONLINE_LENGTH**: Mobile online duration'."\n" + .' - **MOBILE_ONLINE_STATUS**: Mobile online status'."\n" + .' - **MOBILE_3_META_SIMPLE**: Simplified mobile three-factor verification'."\n" + .' - **MOBILE_3_META**: Detailed mobile three-factor verification'."\n" + .' - **MOBILE_2_META**: Mobile two-factor verification'."\n" + .' - **BANK_CARD_N_META**: Detailed bank card verification'."\n" + .' - **MOBILE_DETECT**: Number detection '."\n" + .' - **VEHICLE_N_META**: Enhanced vehicle factor verification'."\n" + .' - **VEHICLE_PENTA_INFO**: Vehicle five-item information recognition'."\n" + .' - **VEHICLE_LICENSE_INFO**: Vehicle information recognition'."\n" + .' - **VEHICLE_INSURE_DATE**: Vehicle insurance date inquiry'."\n" + .' - **VEHICLE_CHECK**: Vehicle factor verification'."\n" + .'- **ProductCode** (Information Verification): Same as Code', + 'type' => 'string', + 'required' => false, + 'example' => '{"ProductType":"INVOKE_STATISTICS","BizParam":{"DownloadMode":"sync","InvokeType":"FINANCE_VERIFY","SceneIdList":"[]","ProductProgramList":"[\\"FINANCE_FACE_VERIFY\\",\\"MFVC\\",\\"PV_FV\\",\\"CLOUD_FACE_CAPTURE\\",\\"FACE_GUARD\\",\\"PV_FC\\"]","StatisticsType":"day","StartDate":"2025-09-17 00:00:00 +0800","EndDate":"2025-10-16 23:59:59 +0800"}}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + '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' => 'D6163397-15C5-419C-9ACC-B7C83E0B4C10', + ], + 'ResultObject' => [ + 'description' => 'OSS link for file download.', + 'type' => 'string', + 'example' => 'https://cn-shanghai-aliyun-cloudauth.oss-cn-shanghai.aliyuncs.com/invoke_download/0E30CD55-DCD4-5363-AA98-XXXXXXX', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6163397-15C5-419C-9ACC-B7C83E0B4C10\\",\\n \\"ResultObject\\": \\"https://cn-shanghai-aliyun-cloudauth.oss-cn-shanghai.aliyuncs.com/invoke_download/0E30CD55-DCD4-5363-AA98-XXXXXXX\\"\\n}","type":"json"}]', + 'title' => 'Get Downloadable Authentication Call Volume Data', + 'description' => 'Obtain the download link for statistical call data files under the product plan based on query conditions.'."\n" + .'- Method: HTTPS POST'."\n" + .'- Service Address: cloudauth.aliyuncs.com'."\n" + ."\n" + .'> Real-person authentication products use CertifyId to count call volumes. For ease of reconciliation, please retain the CertifyId field in your system.'."\n", + 'translator' => 'machine', + ], + 'QueryVerifyFlowPackage' => [ + 'summary' => 'Query Flow Package', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '168774', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthV1ZO7W', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Product type:'."\n" + .'- **FINANCE_VERIFY**: Financial Grade Real Person Verification'."\n" + .'- **SMART_VERIFY**: Enhanced Real Person Verification (discontinued)'."\n" + .'- **FACE_VERIFY**: Real Person Verification (discontinued)', + 'type' => 'string', + 'required' => true, + 'example' => 'FINANCE_VERIFY', + ], + ], + ], + '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' => '969434DF-926B-4997-9881-4DE94E39F805', + ], + 'Success' => [ + 'description' => 'Indicates whether the response was successful.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => 'Return code', + 'type' => 'string', + 'example' => '200', + ], + 'TotalCount' => [ + 'description' => 'Total count.', + 'type' => 'string', + 'example' => '1', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP status code.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Items' => [ + 'description' => 'List of returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'List of returned data.', + 'type' => 'object', + 'properties' => [ + 'CommodityName' => [ + 'description' => 'Name of the resource package.', + 'type' => 'string', + 'example' => '实人认证流量包', + ], + 'CurrCapacity' => [ + 'description' => 'Current available capacity.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'CurrProportion' => [ + 'description' => 'Proportion of current remaining capacity to total capacity.', + 'type' => 'string', + 'example' => '0%', + ], + 'TotalCapacity' => [ + 'description' => 'Total quota.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'UsedCapacity' => [ + 'description' => 'Used capacity.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'FlowDetails' => [ + 'description' => 'Details of the flow package.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Capacity' => [ + 'description' => 'Total amount.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CommodityName' => [ + 'description' => 'Name of the flow package.', + 'type' => 'string', + 'example' => '实人认证流量包', + ], + 'CurrCapacity' => [ + 'description' => 'Remaining amount.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'CurrProportion' => [ + 'description' => 'Proportion of remaining amount.', + 'type' => 'string', + 'example' => '100%', + ], + 'ExpireDate' => [ + 'description' => 'Expiration date.', + 'type' => 'string', + 'example' => '-', + ], + 'InstanceName' => [ + 'description' => 'Instance name', + 'type' => 'string', + 'example' => 'tf-testacccn-hangzhouapigate84369', + ], + 'Status' => [ + 'description' => 'Status.', + 'type' => 'string', + 'example' => '-', + ], + 'TakeEffectDate' => [ + 'description' => 'Effective date.', + 'type' => 'string', + 'example' => '-', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"969434DF-926B-4997-9881-4DE94E39F805\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"TotalCount\\": \\"1\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Items\\": [\\n {\\n \\"CommodityName\\": \\"实人认证流量包\\",\\n \\"CurrCapacity\\": 0,\\n \\"CurrProportion\\": \\"0%\\",\\n \\"TotalCapacity\\": 0,\\n \\"UsedCapacity\\": 0,\\n \\"FlowDetails\\": [\\n {\\n \\"Capacity\\": 0,\\n \\"CommodityName\\": \\"实人认证流量包\\",\\n \\"CurrCapacity\\": 0,\\n \\"CurrProportion\\": \\"100%\\",\\n \\"ExpireDate\\": \\"-\\",\\n \\"InstanceName\\": \\"tf-testacccn-hangzhouapigate84369\\",\\n \\"Status\\": \\"-\\",\\n \\"TakeEffectDate\\": \\"-\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query Flow Package', + 'description' => '- Service address: cloudauth.aliyuncs.com'."\n" + .'- Request method: HTTPS POST and GET.'."\n" + .'- This interface uses different parameters for different product solutions. For details, please refer to the [official documentation](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/product-overview/introduction/?spm=a2c4g.11186623.help-menu-2401581.d_0_0.13f644ecRzFHfm&scm=20140722.H_99169._.OR_help-T_cn~zh-V_1).', + 'translator' => 'machine', + ], + 'QueryVerifyInvokeSatistic' => [ + 'summary' => 'Call Volume Statistics', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '170459', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthV1ZO7W', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'StatisticsType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Statistics dimension:'."\n" + .'- **day**: daily'."\n" + .'- **month**: monthly'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'day', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'Start date of the query.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1743436800000', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'End date of the query.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1761926399999', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Product type:'."\n" + .'- **FINANCE_VERIFY**: Financial-grade real-person verification'."\n" + .'- **SMART_VERIFY**: Enhanced real-person verification (discontinued)'."\n" + .'- **FACE_VERIFY**: Real-person verification (discontinued)', + 'type' => 'string', + 'required' => false, + 'example' => 'FINANCE_VERIFY', + ], + ], + [ + 'name' => 'SceneIdList', + 'in' => 'query', + 'schema' => [ + 'description' => 'List of application scenarios.', + 'type' => 'string', + 'required' => false, + 'example' => '[]', + ], + ], + [ + 'name' => 'ProductProgramList', + 'in' => 'query', + 'schema' => [ + 'description' => 'List of product codes to query. Please refer to the productCode under the corresponding ProductType.', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_PRO', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of items per page.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'Current page number.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + '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' => '2FA2C773-47DB-4156-B1EE-5B047321A939', + ], + 'Code' => [ + 'description' => 'Response code, **200** indicates a successful response.', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Whether the response was successful.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TotalCount' => [ + 'description' => 'Total count.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'Number of items per page.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'TotalPage' => [ + 'description' => 'Total number of pages.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'CurrentPage' => [ + 'description' => 'Current page number.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Items' => [ + 'description' => 'List of returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'List of returned data.', + 'type' => 'object', + 'properties' => [ + 'StatisticsDate' => [ + 'description' => 'Statistics date.', + 'type' => 'string', + 'example' => '2025-10-16', + ], + 'Data' => [ + 'description' => 'List of statistical data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StatisticsCount' => [ + 'description' => 'Number of occurrences of the statistic.', + 'type' => 'string', + 'example' => '3', + ], + 'StatisticsType' => [ + 'description' => 'ProductCode。', + 'type' => 'string', + 'example' => 'ID_PRO', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FA2C773-47DB-4156-B1EE-5B047321A939\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalPage\\": 3,\\n \\"CurrentPage\\": 1,\\n \\"Items\\": [\\n {\\n \\"StatisticsDate\\": \\"2025-10-16\\",\\n \\"Data\\": [\\n {\\n \\"StatisticsCount\\": \\"3\\",\\n \\"StatisticsType\\": \\"ID_PRO\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Authentication Call Volume Statistics', + 'description' => '- Request URL: cloudauth.aliyuncs.com'."\n" + .'- Request Method: HTTPS POST and GET.'."\n" + ."\n" + .'> Real-person authentication products use CertifyId to count call volume. For ease of reconciliation, please retain the CertifyId field in your system.', + 'translator' => 'machine', + ], + 'QueryCustomizeFlowStrategy' => [ + 'summary' => 'Query Custom Flow Control Strategy', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '207520', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + 'FEATUREcloudauth883TGF', + 'FEATUREcloudauthPZCZ2I', + 'FEATUREcloudauthXA9M4C', + 'FEATUREcloudauthA9Y5H0', + 'FEATUREcloudauthDSU9LB', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'title' => '用户ID', + 'description' => 'User ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '126005125163xxxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'regionId', + 'description' => 'regionId', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Product type, currently only supports **ANT_CLOUD_AUTH** (Financial-grade Real Person), all others have been phased out.', + 'type' => 'string', + 'required' => false, + 'example' => 'ANT_CLOUD_AUTH', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SingleDataResponse<CustomizeFlowStrategyDTO>', + 'description' => 'SingleDataResponse<CustomizeFlowStrategyDTO>', + 'type' => 'object', + 'properties' => [ + 'ResultObject' => [ + 'description' => 'Processing result.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'Rule ID.', + 'type' => 'string', + 'example' => '234822', + ], + 'UserId' => [ + 'description' => 'User ID.', + 'type' => 'string', + 'example' => '126005125163xxxx', + ], + 'ApiName' => [ + 'description' => 'API name, same as **ProductCode**.', + 'type' => 'string', + 'example' => 'ID_PRO', + ], + 'AccumulateWindow' => [ + 'description' => 'Flow control statistical window, unit: **minutes**.', + 'type' => 'string', + 'example' => '60', + ], + 'AccumulateKey' => [ + 'description' => 'AccumulateKey', + 'type' => 'string', + 'example' => '-', + ], + 'Threshold' => [ + 'description' => 'Threshold.', + 'type' => 'string', + 'example' => '10', + ], + 'Operation' => [ + 'description' => 'Operation.', + 'type' => 'string', + 'example' => 'match', + ], + 'Status' => [ + 'description' => 'Status:'."\n" + .'- **disabled**: Disabled'."\n" + .'- **normal**: Enabled', + 'type' => 'string', + 'example' => 'disabled', + ], + 'FlowType' => [ + 'description' => 'Flow type:'."\n" + .'- **ACCUMULATE**: ID card reappears'."\n" + .'- **PASSED_RATE**: Pass rate less than'."\n" + .'- **SUB_CODE_205**: Authentication failed and liveness attack 205 ratio greater than'."\n" + .'- **SUB_CODE_206**: Authentication failed and liveness attack 206 ratio greater than', + 'type' => 'string', + 'example' => 'ACCUMULATE', + ], + ], + ], + ], + 'Success' => [ + 'description' => 'Whether the response was successful.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => 'Return code: 200 for success, others for failure.', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => 'success', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'ID of this request.', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultObject\\": [\\n {\\n \\"Id\\": \\"234822\\",\\n \\"UserId\\": \\"126005125163xxxx\\",\\n \\"ApiName\\": \\"ID_PRO\\",\\n \\"AccumulateWindow\\": \\"60\\",\\n \\"AccumulateKey\\": \\"-\\",\\n \\"Threshold\\": \\"10\\",\\n \\"Operation\\": \\"match\\",\\n \\"Status\\": \\"disabled\\",\\n \\"FlowType\\": \\"ACCUMULATE\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', + 'title' => 'Query Security Rules', + 'description' => '- Service Address: cloudauth.aliyuncs.com'."\n" + .'- Request Method: HTTPS POST and GET.'."\n" + .'- Security Rules: These are rules to ensure system security, such as monitoring for API abuse, account theft, etc. When a threshold is triggered, the system supports alerting.', + 'translator' => 'machine', + ], + 'DeleteCustomizeFlowStrategy' => [ + 'summary' => 'Delete Customized Flow Control Strategy', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '207420', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthNOQ41U', + 'FEATUREcloudauthGEV2SZ', + 'FEATUREcloudauthKKY1LP', + 'FEATUREcloudauthFO5MJB', + 'FEATUREcloudauthIT1PW0', + 'FEATUREcloudauth434P23', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => 'id', + 'description' => 'Policy ID.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '38', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'title' => '用户ID', + 'description' => 'User ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '126005125163xxxx', + ], + ], + [ + 'name' => 'ApiName', + 'in' => 'query', + 'schema' => [ + 'title' => '接口编号', + 'description' => 'API name, same as **ProductCode**.', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_PRO', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'regionId', + 'description' => 'regionId', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Product type, currently only supports **ANT_CLOUD_AUTH** (Financial-grade Real Person), all others have been phased out.', + 'type' => 'string', + 'required' => false, + 'example' => 'ANT_CLOUD_AUTH', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SingleDataResponse<Integer>', + 'description' => 'SingleDataResponse<Integer>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'Returned data.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '-', + ], + 'Success' => [ + 'description' => 'Whether the response was successful.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => 'HTTP status code.', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success'."\n", + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'ID of this request.', + 'type' => 'string', + 'example' => '5A6229C0-E156-48E4-B6EC-0F528BDF60D2', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 0,\\n \\"Success\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\\\n\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"5A6229C0-E156-48E4-B6EC-0F528BDF60D2\\"\\n}","type":"json"}]', + 'title' => 'Delete Custom Flow Control Strategy', + 'description' => 'Request Method: Supports sending requests using HTTPS POST and GET methods.'."\n" + ."\n" + .'> The authorization key is valid for 30 minutes and cannot be reused. It is recommended to reacquire it before each activation.', + 'translator' => 'machine', + ], + 'DeleteAllCustomizeFlowStrategy' => [ + 'summary' => 'Delete All Custom Flow Control Strategies', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '207521', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + 'FEATUREcloudauth883TGF', + 'FEATUREcloudauthPZCZ2I', + 'FEATUREcloudauthXA9M4C', + 'FEATUREcloudauthA9Y5H0', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'title' => '用户ID', + 'description' => 'User ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '126005125163xxxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'regionId', + 'description' => 'Region ID', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SingleDataResponse<Integer>', + 'description' => 'SingleDataResponse<Integer>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'Returned data.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Success' => [ + 'description' => 'Indicates whether the response was successful.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => 'Return code: 200 indicates success, others indicate failure.', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => 'ID of this request.', + 'type' => 'string', + 'example' => '8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 1,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260\\"\\n}","type":"json"}]', + 'title' => 'Delete All Custom Flow Control Strategies', + 'description' => 'Request Method: Supports sending requests via HTTPS POST and GET methods.'."\n" + ."\n" + .'> The authorization key is valid for 30 minutes and cannot be reused. It is recommended to reacquire it before each activation.', + 'translator' => 'machine', + ], + 'ModifyCustomizeFlowStrategyList' => [ + 'summary' => 'Information Verification Security Management', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '209313', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + 'FEATUREcloudauth883TGF', + 'FEATUREcloudauthPZCZ2I', + 'FEATUREcloudauthXA9M4C', + 'FEATUREcloudauthA9Y5H0', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'StrategyObject', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Strategy list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'Rule ID.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '38', + ], + 'UserId' => [ + 'description' => 'User ID.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '126005125163xxxx', + ], + 'ApiName' => [ + 'description' => 'API name, same as **ProductCode**.', + 'type' => 'string', + 'required' => true, + 'example' => 'ID_PRO', + ], + 'AccumulateWindow' => [ + 'description' => 'Flow control statistical window size, in minutes.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '60', + ], + 'Threshold' => [ + 'description' => 'Flow control threshold.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + 'Operation' => [ + 'description' => 'Operation.', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + 'Status' => [ + 'description' => 'Status:'."\n" + .'- **disabled**: Disabled'."\n" + .'- **normal**: Enabled', + 'type' => 'string', + 'required' => true, + 'example' => 'disabled', + ], + 'AccumulateKey' => [ + 'description' => 'AccumulateKey', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + 'FlowType' => [ + 'description' => 'Flow type:'."\n" + .'- **ACCUMULATE**: Repeated appearance of ID card'."\n" + .'- **PASSED_RATE**: Pass rate less than'."\n" + .'- **SUB_CODE_205**: Authentication failed and liveness attack 205 ratio greater than'."\n" + .'- **SUB_CODE_206**: Authentication failed and liveness attack 206 ratio greater than'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ACCUMULATE', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Product type, currently only supports **ANT_CLOUD_AUTH** (Financial-grade real person), all others have been phased out.', + 'type' => 'string', + 'required' => false, + 'example' => 'ANT_CLOUD_AUTH', + ], + ], + ], + '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' => '8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260', + ], + 'Data' => [ + 'description' => 'Result data.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Success' => [ + 'description' => 'Whether the response was successful.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => 'Return code, **200** indicates the interface responded successfully.', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260\\",\\n \\"Data\\": 1,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'Adjust Custom Flow Control Strategy List', + 'description' => '- Request Method: Supports sending requests via HTTPS POST and GET methods.'."\n" + .'- Service Address: cloudauth.aliyuncs.com.'."\n", + 'translator' => 'machine', + ], + 'ModifyControlStrategy' => [ + 'summary' => 'Modify Security Control Strategy', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215262', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + 'FEATUREcloudauth883TGF', + 'FEATUREcloudauthPZCZ2I', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ControlStrategyList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'List of security alarm rules.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'Rule ID.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '38', + ], + 'ApiName' => [ + 'description' => 'API name, same as **ProductCode**.', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_PRO', + ], + 'BizType' => [ + 'description' => 'Rule configuration type:'."\n" + .'- **QPS**: QPS greater than'."\n" + .'- **SUCCESS_RATE_5_MIN**: Success rate in the last 5 minutes less than'."\n" + .'- **RESP_TIME_5_MIN**: Average response time in the last 5 minutes greater than'."\n" + .'- **AMOUNT_RISE**: Call volume growth ratio greater than'."\n" + .'- **AMOUNT_FALL**: Call volume decline ratio less than'."\n" + .'- **PASSED_RATE_1_HOUR**: Verification consistency rate in the last hour less than'."\n" + .'- **PARAM_ERROR_RATE_1_HOUR**: Parameter error rate in the last hour greater than', + 'type' => 'string', + 'required' => false, + 'example' => 'SUCCESS_RATE_5_MIN', + ], + 'Threshold' => [ + 'description' => 'Alarm threshold for the rule.', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '0.9', + ], + 'Status' => [ + 'description' => 'Status:'."\n" + .'- **disabled**: Disabled'."\n" + .'- **normal**: Enabled'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Region ID of the intelligent access gateway instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Product type, currently only supports **ANT_CLOUD_AUTH** (Financial-grade Real Person), all others are phased out.'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ANT_CLOUD_AUTH', + ], + ], + ], + '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' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'Message' => [ + 'description' => 'Information returned by the API call.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => 'Return code', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Whether the response was successful.', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Adjust Stability Alarm Rules', + 'description' => '- Request Method: Supports sending requests via HTTPS POST method.'."\n" + .'- Request Address: cloudauth.aliyuncs.com.', + 'translator' => 'machine', + ], + 'QueryControlStrategy' => [ + 'summary' => 'Query Security Control Strategy', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215261', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + 'FEATUREcloudauth883TGF', + 'FEATUREcloudauthPZCZ2I', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Region ID', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Product type, currently only supports ANT_CLOUD_AUTH (financial-grade real person), all others have been phased out.', + 'type' => 'string', + 'required' => false, + 'example' => 'ANT_CLOUD_AUTH', + ], + ], + ], + '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' => 'B506328A-D84B-4750-82C7-6A207C585CF1', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => 'Return code: 200 for success, others for failure.', + 'type' => 'string', + 'example' => 'Success', + ], + 'ResultObject' => [ + 'description' => 'Processing result.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'Rule ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '234822', + ], + 'UserId' => [ + 'description' => 'User ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '126005125163xxxx', + ], + 'ApiName' => [ + 'description' => 'API name, same as the **ProductCode** of the authentication interface.', + 'type' => 'string', + 'example' => 'ID_PRO', + ], + 'BizType' => [ + 'description' => 'Rule configuration type:'."\n" + .'- **QPS**: QPS greater than'."\n" + .'- **SUCCESS_RATE_5_MIN**: Success rate in the last 5 minutes less than'."\n" + .'- **RESP_TIME_5_MIN**: Average response time in the last 5 minutes greater than'."\n" + .'- **AMOUNT_RISE**: Call volume growth ratio greater than'."\n" + .'- **AMOUNT_FALL**: Call volume decline ratio less than'."\n" + .'- **PASSED_RATE_1_HOUR**: Verification consistency rate in the last hour less than'."\n" + .'- **PARAM_ERROR_RATE_1_HOUR**: Parameter error rate in the last hour greater than', + 'type' => 'string', + 'example' => 'SUCCESS_RATE_5_MIN', + ], + 'Threshold' => [ + 'description' => 'Alarm threshold for rule configuration.', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.9', + ], + 'Status' => [ + 'description' => 'Status:'."\n" + .'- **disabled**: Disabled'."\n" + .'- **normal**: Enabled', + 'type' => 'string', + 'example' => 'normal', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B506328A-D84B-4750-82C7-6A207C585CF1\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": \\"Success\\",\\n \\"ResultObject\\": [\\n {\\n \\"Id\\": 234822,\\n \\"UserId\\": 0,\\n \\"ApiName\\": \\"ID_PRO\\",\\n \\"BizType\\": \\"SUCCESS_RATE_5_MIN\\",\\n \\"Threshold\\": 0.9,\\n \\"Status\\": \\"normal\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query Stability Alarm Rules', + 'description' => '- Request Method: Supports sending requests via HTTPS POST and GET methods.'."\n" + .'- Request Address: cloudauth.aliyuncs.com.'."\n", + 'translator' => 'machine', + ], + 'DeleteControlStrategy' => [ + 'summary' => 'Delete Security Control Strategy', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215260', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + 'FEATUREcloudauth883TGF', + 'FEATUREcloudauthPZCZ2I', + 'FEATUREcloudauthA9Y5H0', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Region ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'Security rule ID.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '38', + ], + ], + [ + 'name' => 'ApiName', + 'in' => 'query', + 'schema' => [ + 'description' => 'API name, same as **ProductCode**.', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_PRO', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Product type, currently only supports **ANT_CLOUD_AUTH** (Financial-grade Real Person), all others have been phased out.', + 'type' => 'string', + 'required' => false, + 'example' => 'ANT_CLOUD_AUTH', + ], + ], + ], + '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' => 'D6C1237B-D34B-5126-93AC-36A4B9E819C6', + ], + 'Code' => [ + 'description' => 'Return code, **200** indicates successful API response.', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => 'Whether the response was successful.', + 'type' => 'boolean', + 'example' => 'True', + ], + 'Data' => [ + 'description' => 'Returned data.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6C1237B-D34B-5126-93AC-36A4B9E819C6\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": 1\\n}","type":"json"}]', + 'title' => 'Delete Stability Alarm Rule', + 'description' => 'Request Method: Supports sending requests via HTTPS POST.'."\n" + .'Request URL: cloudauth.aliyuncs.com.', + 'translator' => 'machine', + ], + 'ModifyBlackListStrategy' => [ + 'summary' => 'Modify Black and White List Policy', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214006', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + 'FEATUREcloudauth883TGF', + 'FEATUREcloudauthPZCZ2I', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Region ID', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'BlackListStrategy', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Blacklist rule.', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'Rule ID:'."\n" + .'- **Empty**: Add a new rule'."\n" + .'- **Non-empty**: Modify an existing rule', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '38', + ], + 'ProductName' => [ + 'description' => 'Product Name:'."\n" + .'- **id2meta**: ID card two-factor verification'."\n" + .'- **mobile3Meta**: Mobile number factor verification'."\n" + .'- **bankcardMeta**: Bank card factor verification'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'id2meta', + ], + 'BizKey' => [ + 'description' => 'List Type:'."\n" + .'- **mobile**: Mobile number blacklist'."\n" + .'- **ip**: IP blacklist'."\n" + .'- **identifyNum**: ID number blacklist'."\n" + .'- **bankCard**: Bank card blacklist'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ip', + ], + 'BizContent' => [ + 'description' => 'Blacklist string, with each blacklist entry separated by commas.', + 'type' => 'string', + 'required' => false, + 'example' => '127.0.0.1,127.0.0.2', + ], + 'Status' => [ + 'description' => 'Verification Status:'."\n" + .'- **1**: Verification passed'."\n" + .'- **2**: Verification failed', + 'type' => 'string', + 'required' => false, + 'example' => '3', + ], + ], + 'required' => false, + ], + ], + ], + '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' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Code' => [ + 'description' => 'Return code: 200 for success, others for failure.', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Whether the response was successful.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'Returned data.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '{\'StatusCode\': -1}', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Data\\": 0\\n}","type":"json"}]', + 'title' => 'Add or Modify Blacklist Rule', + 'description' => '- Service Address: cloudauth.aliyuncs.com.'."\n" + .'- Request Method: HTTPS POST and GET.'."\n" + .'- Interface Description: Add or modify blacklist rule.'."\n", + 'translator' => 'machine', + ], + 'QueryBlackListStrategy' => [ + 'summary' => 'Query Blacklist and Whitelist Policies', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214008', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + 'FEATUREcloudauth883TGF', + 'FEATUREcloudauthPZCZ2I', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Region ID', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + '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' => '8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260', + ], + 'Code' => [ + 'description' => 'Return code, **200** indicates successful API response.', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => 'Returned result information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'Rule ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '234822', + ], + 'UserId' => [ + 'description' => 'User ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12600512xxxxxxxx', + ], + 'ProductName' => [ + 'description' => 'Product name:'."\n" + .'- id2meta: ID number two-factor verification'."\n" + .'- mobile3Meta: Phone number factor verification'."\n" + .'- bankcardMeta: Bank card factor verification', + 'type' => 'string', + 'example' => 'id2meta', + ], + 'BizKey' => [ + 'description' => 'List type:'."\n" + .'- mobile: Phone number blacklist'."\n" + .'- ip: IP blacklist'."\n" + .'- identifyNum: ID number blacklist'."\n" + .'- bankCard: Bank card blacklist'."\n", + 'type' => 'string', + 'example' => 'identifyNum', + ], + 'BizContent' => [ + 'description' => 'Blacklist string, separated by **commas**.', + 'type' => 'string', + 'example' => '127.0.0.1,127.0.0.2', + ], + 'Status' => [ + 'description' => 'Status:'."\n" + .'- **disabled**: Disabled'."\n" + .'- **normal**: Enabled', + 'type' => 'string', + 'example' => 'disabled', + ], + 'GmtModified' => [ + 'description' => 'Modification time.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1711533786000', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": [\\n {\\n \\"Id\\": 234822,\\n \\"UserId\\": 0,\\n \\"ProductName\\": \\"id2meta\\",\\n \\"BizKey\\": \\"identifyNum\\",\\n \\"BizContent\\": \\"127.0.0.1,127.0.0.2\\",\\n \\"Status\\": \\"disabled\\",\\n \\"GmtModified\\": 1711533786000\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query Blacklist Rules', + 'description' => '- Request URL: cloudauth.aliyuncs.com'."\n" + .'- Request Method: HTTPS POST and GET.'."\n" + ."\n" + .'> Supports setting blacklists for IP, ID number, phone number, bank card number, etc. When a blacklist is hit, the system rejects the request and returns a fixed error code.'."\n" + .'Supports setting blacklists for IP, ID number, phone number, bank card number, etc. When a blacklist is hit, the system rejects the request and returns a fixed error code.'."\n", + 'translator' => 'machine', + ], + 'DeleteBlackListStrategy' => [ + 'summary' => 'Delete Black and White List Policy', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214004', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + 'FEATUREcloudauth883TGF', + 'FEATUREcloudauthPZCZ2I', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Region ID', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'Rule ID.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '38', + ], + ], + [ + 'name' => 'ProductName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Product Name:'."\n" + .'- **id2meta**: ID card two-factor verification'."\n" + .'- **mobile3Meta**: Mobile phone number factor verification'."\n" + .'- **bankcardMeta**: Bank card factor verification'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'id2meta', + ], + ], + ], + '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' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Code' => [ + 'description' => 'HTTP status code.', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => 'Whether the response was successful.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'Returned data.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": 1\\n}","type":"json"}]', + 'title' => 'Delete Blacklist Rule', + 'description' => 'Request Method: Only supports sending requests via HTTPS POST method.', + 'translator' => 'machine', + ], + 'DescribeInfoCheckExportRecord' => [ + 'summary' => 'Query export task records', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '205575', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthGDLZVA', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_CARD_2_META', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2025-10-11 21:24:48', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2025-10-11 21:24:48', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + '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' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalPage' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'CurrentPage' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DownloadTaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '202510189017278', + ], + 'Status' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Url' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://cn-shanghai-aliyun-cloudauth.oss-cn-shanghai.aliyuncs.com/console/xxxxxxxx.xlsx', + ], + 'DownloadDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1758250979000', + ], + 'ErrorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '-', + ], + 'ProductType' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'FileType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CSV', + ], + 'FileName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalPage\\": 3,\\n \\"CurrentPage\\": 1,\\n \\"Items\\": [\\n {\\n \\"DownloadTaskId\\": \\"202510189017278\\",\\n \\"Status\\": 1,\\n \\"Url\\": \\"https://cn-shanghai-aliyun-cloudauth.oss-cn-shanghai.aliyuncs.com/console/xxxxxxxx.xlsx\\",\\n \\"DownloadDate\\": \\"1758250979000\\",\\n \\"ErrorCode\\": \\"-\\",\\n \\"ProductType\\": \\"身份证二要素\\",\\n \\"FileType\\": \\"CSV\\",\\n \\"FileName\\": \\"手机号二要素统计202509013975081.csv\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Information Verification Export Task', + 'translator' => 'machine', + ], + 'DescribeOssStatusV2' => [ + 'summary' => 'Get OSS Activation Status', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthCPTLY3', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'ServiceCode for Real Person Cloud products:'."\n" + .'- **antcloudauth**: Financial-grade real person authentication'."\n" + .'- **cloudauthst (discontinued)**: Enhanced real person authentication', + 'type' => 'string', + 'required' => false, + 'example' => 'antcloudauth', + ], + ], + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'Visitor\'s source IP address.', + 'type' => 'string', + 'required' => false, + 'example' => '120.25.41.25', + ], + ], + ], + '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' => 'B506328A-D84B-4750-82C7-6A207C585CF1', + ], + 'ResultObject' => [ + 'description' => 'Returned result information.', + 'type' => 'object', + 'properties' => [ + 'UserStatus' => [ + 'description' => 'User activation status, **SUCCESS** indicates activated.', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'BucketName' => [ + 'description' => 'Bucket name.', + 'type' => 'string', + 'example' => 'cn-hangzhou-aliyun-cloudauth-20250516xxxxxx', + ], + 'Region' => [ + 'description' => 'Region.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + 'Code' => [ + 'description' => 'Return code', + 'type' => 'string', + 'example' => '200', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP status code.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => 'Whether the response was successful.', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B506328A-D84B-4750-82C7-6A207C585CF1\\",\\n \\"ResultObject\\": {\\n \\"UserStatus\\": \\"SUCCESS\\",\\n \\"BucketName\\": \\"cn-hangzhou-aliyun-cloudauth-20250516xxxxxx\\",\\n \\"Region\\": \\"cn-hangzhou\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Query User OSS Status V2', + 'description' => '- Request Method: Supports sending requests via HTTPS POST and GET methods.'."\n" + .'- Service Address: cloudauth.aliyuncs.com.'."\n", + 'translator' => 'machine', + ], + 'DescribeAuthVerify' => [ + 'summary' => '获取结果', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthCW0JNH', + ], + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => ' '."\n" + .'100000****', + ], + ], + [ + 'name' => 'CertifyId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'shsf57a4e0d9981c3bd66dc754f3d3cd', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'Result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SubCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'MaterialInfo' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'SpoofInfo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'spoofRiskResult：Y'."\n" + .'spoofType：SCREEN_REMARK', + ], + 'SpoofBackInfo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'spoofRiskResult：Y'."\n" + .'spoofType：SCREEN_REMARK', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Result\\": {\\n \\"SubCode\\": \\"200\\",\\n \\"MaterialInfo\\": \\"\\\\\\"ocrIdCardInfo\\\\\\": {\\\\n \\\\\\"certName\\\\\\": \\\\\\"张先生\\\\\\",\\\\n \\\\\\"sex\\\\\\": \\\\\\"男\\\\\\",\\\\n \\\\\\"nationality\\\\\\": \\\\\\"汉\\\\\\",\\\\n \\\\\\"birth\\\\\\": \\\\\\"20010213\\\\\\",\\\\n \\\\\\"address\\\\\\": \\\\\\"XXX省XX市XXX区XX街道X号\\\\\\",\\\\n \\\\\\"certNo\\\\\\": \\\\\\"4****************X\\\\\\",\\\\n \\\\\\"authority\\\\\\": \\\\\\"XXX公安局XXX分局\\\\\\",\\\\n \\\\\\"startDate\\\\\\": \\\\\\"20250523\\\\\\",\\\\n \\\\\\"endDate\\\\\\": \\\\\\"20450523\\\\\\"\\\\n },\\\\n\\\\\\"ocrIdEditInfo\\\\\\": {\\\\n \\\\\\"certName\\\\\\": \\\\\\"张先生\\\\\\",\\\\n \\\\\\"sex\\\\\\": \\\\\\"男\\\\\\",\\\\n \\\\\\"nationality\\\\\\": \\\\\\"汉\\\\\\",\\\\n \\\\\\"birth\\\\\\": \\\\\\"20010213\\\\\\",\\\\n \\\\\\"address\\\\\\": \\\\\\"XXX省XX市XXX区XX街道X号\\\\\\",\\\\n \\\\\\"certNo\\\\\\": \\\\\\"4****************X\\\\\\",\\\\n \\\\\\"authority\\\\\\": \\\\\\"XXX公安局XXX分局\\\\\\",\\\\n \\\\\\"startDate\\\\\\": \\\\\\"20250523\\\\\\",\\\\n \\\\\\"endDate\\\\\\": \\\\\\"20450523\\\\\\"\\\\n },\\\\n \\\\\\"ocrPictureFront\\\\\\": {\\\\n \\\\\\"ossBucketName\\\\\\": \\\\\\"cn-shanghai-aliyun-cloudauth-12********\\\\\\",\\\\n \\\\\\"ossIdFaceObjectName\\\\\\": \\\\\\"verify/1234567890/f7ed1ef80ad1234fdsd95c********cd_ocridface_b749.jpeg\\\\\\",\\\\n \\\\\\"ossIdFaceUrl\\\\\\": \\\\\\"http://cn-shanghai-aliyun-cloudauth-1234567890.oss-cn-shanghai.aliyuncs.com/verify/1234567890/f7ed1ef80ad1234fdsd95c66d83340cd_ocridface_b749.jpeg?security-token=CAISjdfgeJ1q6F...\\\\\\",\\\\n \\\\\\"ossIdNationalEmblemObjectName\\\\\\": \\\\\\"verify/1234567890/f7ed1ef80ad1234fdsd95c********cd_ocridnationalemblem_a3hf.jpeg\\\\\\",\\\\n \\\\\\"ossIdNationalEmblemUrl\\\\\\": \\\\\\"http://cn-shanghai-aliyun-cloudauth-1234567890.oss-cn-shanghai.aliyuncs.com/verify/1234567890/f7ed1ef80ad1234fdsd95c66d83340cd_ocridnationalemblem_a3hf.jpeg?security-token=CAISjgJ1q6...\\\\\\"\\\\n }\\",\\n \\"SpoofInfo\\": \\"spoofRiskResult：Y\\\\nspoofType：SCREEN_REMARK\\",\\n \\"SpoofBackInfo\\": \\"spoofRiskResult：Y\\\\nspoofType：SCREEN_REMARK\\"\\n }\\n}","type":"json"}]', + ], + 'InitAuthVerify' => [ + 'summary' => '服务端初始化', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthCW0JNH', + ], + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1000002996', + ], + ], + [ + 'name' => 'OuterOrderNo', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'e0c34a77f5ac40a5aa5e6ed20c******', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ID_OCR', + ], + ], + [ + 'name' => 'MetaInfo', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '{'."\n" + .' "zimVer": "3.0.0",'."\n" + .' "appVersion": "1",'."\n" + .' "bioMetaInfo": "4.1.0:1150****,0",'."\n" + .' "appName": "com.aliyun.antcloudauth",'."\n" + .' "deviceType": "ios",'."\n" + .' "osVersion": "iOS 10.3.2",'."\n" + .' "apdidToken": "",'."\n" + .' "deviceModel": "iPhone9,1"'."\n" + .'}', + ], + ], + [ + 'name' => 'CardType', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'IDENTITY_CARD', + ], + ], + [ + 'name' => 'IdSpoof', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + [ + 'name' => 'CallbackUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.aliyun.com?callbackToken=100000****&certifyId=shaxxxx&subCode=200', + ], + ], + [ + 'name' => 'CallbackToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'NMjvQanQgplBSaEI0sL86WnQplB', + ], + ], + [ + 'name' => 'CardPageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'DocScanMode', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'shoot', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'B506328A-D84B-4750-82C7-6A207C585CF1', + ], + 'Result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CertifyId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'shif9d1a185b8dde7cd07bf0943a448b', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"B506328A-D84B-4750-82C7-6A207C585CF1\\",\\n \\"Result\\": {\\n \\"CertifyId\\": \\"shif9d1a185b8dde7cd07bf0943a448b\\"\\n }\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'cloudauth.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'cloudauth.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + ], +]; |