'1.0', 'info' => ['style' => 'RPC', 'product' => 'Cloudauth-intl', 'version' => '2022-08-09'], 'directories' => [ [ 'children' => ['Id2MetaVerifyIntl', 'Id2MetaPeriodVerifyIntl', 'BankMetaVerifyIntl', 'Mobile2MetaVerifyIntl', 'Mobile3MetaVerifyIntl'], 'type' => 'directory', 'title' => 'Information verification', ], [ 'children' => ['CredentialRecognitionIntl', 'CredentialSubmitIntl', 'CredentialGetResultIntl', 'CredentialVerifyIntl'], 'type' => 'directory', 'title' => 'Credential detection', ], [ 'children' => ['AddressVerifyV2Intl', 'AddressCompareIntl'], 'type' => 'directory', 'title' => 'Address verification', ], [ 'children' => ['KeepaliveIntl', 'DeleteVerifyResult', 'CheckVerifyLog'], 'type' => 'directory', 'title' => 'Auxiliary operations', ], [ 'children' => ['AddFaceRecord', 'DownloadVerifyRecordIntl', 'QueryFaceGroup', 'ModifyFaceGroup', 'DeleteFaceGroup', 'QueryFaceRecord', 'ModifyFaceRecord', 'DeleteFaceRecord', 'TempOssUrlIntl', 'TempAccessTokenIntl'], 'type' => 'directory', 'title' => 'Console', ], [ 'children' => ['CardOcr', 'FraudResultCallBack', 'AddressVerifyIntl'], 'type' => 'directory', 'title' => 'Deprecated', ], [ 'children' => [ 'DocOcrV2', 'CheckResult', 'DeepfakeDetectIntl', 'DeepfakeDetectIntlStream', 'DeleteFaceRecordV2', 'DocOcr', 'DocOcrMax', 'DocOcrMaxV2', 'EkycVerify', 'EkycVerifyV2', 'FaceCompare', 'FaceCompareV2', 'FaceCrossCompareIntl', 'FaceDuplicationCheckIntl', 'FaceGuardRisk', 'FaceLiveness', 'FaceLivenessV2', 'FaceVerifyIntl', 'IdnAuthorityVerifyIntl', 'Initialize', 'InitializeV2', ], 'type' => 'directory', 'title' => 'Others', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'AddFaceRecord' => [ 'summary' => 'Adds a face image to a specified face library.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcloudauthHJ4WQV'], ], 'parameters' => [ [ 'name' => 'FaceGroupCode', 'in' => 'formData', 'schema' => ['description' => 'The face library code.', 'type' => 'string', 'required' => true, 'example' => 'sgl****7uc', 'title' => ''], ], [ 'name' => 'ProductCode', 'in' => 'formData', 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => true, 'example' => 'FACE_ENROLL', 'title' => ''], ], [ 'name' => 'MerchantUserId', 'in' => 'formData', 'schema' => ['description' => 'The custom unique user ID. The value cannot exceed 32 characters.'."\n" .'- If this parameter is specified, the system registers the user with the specified MerchantUserId.'."\n" .'- If this parameter is not specified, the image name is used by default.', 'type' => 'string', 'required' => false, 'example' => '130A2C10B9EE4D8488E35384FF03hst', 'title' => ''], ], [ 'name' => 'FacePicture', 'in' => 'formData', 'schema' => ['description' => 'The Base64-encoded face image to register.', 'type' => 'string', 'required' => false, 'example' => 'base64', 'title' => ''], ], [ 'name' => 'FacePictureUrl', 'in' => 'formData', 'schema' => ['description' => 'The URL of the face image to register.', 'type' => 'string', 'required' => false, 'example' => 'https://www.xxxxx.com/test.jpg', 'title' => ''], ], [ 'name' => 'FacePictureFile', 'in' => 'formData', 'schema' => ['description' => 'The file stream of the face image to register.', 'type' => 'string', 'isFileTransferUrl' => true, 'required' => false, 'example' => 'InputStream', 'title' => ''], ], [ 'name' => 'FaceQualityCheck', 'in' => 'formData', 'schema' => ['description' => 'Specifies whether to check the quality of the face image. Valid values:'."\n" .'- Y: enabled.'."\n" .'- N: disabled (default).', 'type' => 'string', 'required' => false, 'example' => 'N', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '7A0D192A-CC0C-5DE5-A3B6-A14CF45508F2'], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The return message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'Passed' => ['description' => 'Indicates whether the verification is passed. Valid values:'."\n" ."\n" .'- Y: Passed.'."\n" .'- N: Not passed.', 'type' => 'string', 'example' => 'Y', 'title' => ''], 'ExtFaceInfo' => ['description' => 'The face result information.', 'type' => 'string', 'example' => '{'."\n" .'"faceQuality": "HIGH"'."\n" .'}'."\n" ."\n", 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Add a face record', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:AddFaceRecord', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7A0D192A-CC0C-5DE5-A3B6-A14CF45508F2\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"Passed\\": \\"Y\\",\\n \\"ExtFaceInfo\\": \\"{\\\\n\\\\\\"faceQuality\\\\\\": \\\\\\"HIGH\\\\\\"\\\\n}\\\\n\\\\n\\"\\n }\\n}","type":"json"}]', ], 'AddressCompareIntl' => [ 'summary' => 'Compares the similarity of two addresses.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREcloudauthNOQ41U'], ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => ['description' => 'ADD_VERIFY.', 'type' => 'string', 'required' => true, 'example' => '固定值：ADD_VERIFY', 'title' => ''], ], [ 'name' => 'Text1', 'in' => 'query', 'schema' => ['description' => 'Address 1.', 'type' => 'string', 'required' => true, 'example' => '杭州市阿里巴巴西溪园区', 'title' => ''], ], [ 'name' => 'Text2', 'in' => 'query', 'schema' => ['description' => 'Address 2.', 'type' => 'string', 'required' => true, 'example' => '杭州市文一西路969号1号楼', 'title' => ''], ], [ 'name' => 'DefaultCountry', 'in' => 'query', 'schema' => ['description' => 'The country name. Valid values:'."\n" .'- China.', 'type' => 'string', 'required' => true, 'example' => '固定值：中国', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '86C40EC3-5940-5F47-995C-BFE90B70E540'."\n"], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The return message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'The sameLevel parameter has the following valid values:'."\n" .'- all: completely identical'."\n" .'- prov: province level '."\n" .'- city: city level'."\n" .'- district: district level'."\n" .'- town: street level'."\n" .'- road: road level'."\n" .'- roadno: road number level'."\n" .'- poi: community/neighborhood level'."\n" .'- roomno: room number level.', 'type' => 'string', 'example' => '{'."\n" .' sameLevel: "city", '."\n" .' distance: 5997.34m, -- 地址相差距离'."\n" .' same_info: { -- 相同信息'."\n" .' prov: "浙江省",'."\n" .' city: "杭州市",'."\n" .' district: "西湖区"'."\n" .' } '."\n" .'}', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Compare address similarity', 'description' => 'Compares two addresses for consistency by using address standardization.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:AddressCompareIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86C40EC3-5940-5F47-995C-BFE90B70E540\\\\n\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"Data\\": \\"{\\\\n sameLevel: \\\\\\"city\\\\\\", \\\\n distance: 5997.34m, -- 地址相差距离\\\\n same_info: { -- 相同信息\\\\n prov: \\\\\\"浙江省\\\\\\",\\\\n city: \\\\\\"杭州市\\\\\\",\\\\n district: \\\\\\"西湖区\\\\\\"\\\\n } \\\\n}\\"\\n }\\n}","type":"json"}]', ], 'AddressVerifyIntl' => [ 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREcloudauthZN5W38'], ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => ['description' => 'Fixed value: ADD_VERIFY_PRO.', 'type' => 'string', 'required' => true, 'example' => 'ADD_VERIFY_PRO', 'title' => ''], ], [ 'name' => 'VerifyType', 'in' => 'query', 'schema' => ['description' => 'The address verification method. Valid values:'."\n" .'- HOME: home address verification'."\n" .'- WORK: work address verification.', 'type' => 'string', 'required' => true, 'example' => 'HOME', 'title' => ''], ], [ 'name' => 'Mobile', 'in' => 'query', 'schema' => ['description' => 'Chinese mainland phone numbers are supported.', 'type' => 'string', 'required' => true, 'example' => '1872334****', 'title' => ''], ], [ 'name' => 'DefaultCountry', 'in' => 'query', 'schema' => ['description' => 'The country name. Currently, only China is supported.', 'type' => 'string', 'required' => true, 'example' => '中国', 'title' => ''], ], [ 'name' => 'AddressType', 'in' => 'query', 'schema' => ['description' => 'The type of the address to verify. Valid values:'."\n" .'- "0": text address'."\n" .'- "1": coordinates (longitude and latitude).', 'type' => 'string', 'required' => true, 'example' => '“0”', 'title' => ''], ], [ 'name' => 'Longitude', 'in' => 'query', 'schema' => ['description' => 'The longitude.', 'type' => 'string', 'required' => false, 'example' => '“121.4737”', 'title' => ''], ], [ 'name' => 'Latitude', 'in' => 'query', 'schema' => ['description' => 'The latitude.', 'type' => 'string', 'required' => false, 'example' => '“31.2304”', 'title' => ''], ], [ 'name' => 'Text', 'in' => 'query', 'schema' => ['description' => 'The detailed address in text format.', 'type' => 'string', 'required' => false, 'example' => '阿里巴巴西溪园区', 'title' => ''], ], [ 'name' => 'DefaultProvince', 'in' => 'query', 'schema' => ['description' => 'The default province.', 'type' => 'string', 'required' => false, 'example' => '浙江省', 'title' => ''], ], [ 'name' => 'DefaultCity', 'in' => 'query', 'schema' => ['description' => 'The default city.', 'type' => 'string', 'required' => false, 'example' => '杭州市', 'title' => ''], ], [ 'name' => 'DefaultDistrict', 'in' => 'query', 'schema' => ['description' => 'The default district.', 'type' => 'string', 'required' => false, 'example' => '余杭区', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '86C40EC3-5940-5F47-995C-BFE90B70E540'], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The return message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'ResultObject' => [ 'description' => 'The result information.', 'type' => 'object', 'properties' => [ 'TransactionId' => ['description' => 'The unique identifier of the verification request.', 'type' => 'string', 'example' => 'hksb7ba1b28130d24e015d69********', 'title' => ''], 'Passed' => ['description' => 'The verification result. Valid values:'."\n" .'- Y: The verified address is within 10 km of the residential address.'."\n" .'- N: The verified address is more than 10 km from the residential address.', 'type' => 'string', 'example' => 'Y', 'title' => ''], 'SubCode' => ['description' => 'The description of the verification result.', 'type' => 'string', 'example' => '200', 'title' => ''], 'AddressInfo' => ['description' => 'The address verification details.', 'type' => 'string', 'example' => '0-3000', 'title' => ''], 'IspName' => ['description' => 'The telecommunications service provider name. Valid values:'."\n" .'- CMCC: China Mobile'."\n" .'- CTCC: China Telecom'."\n" .'- CUCC: China Unicom.', 'type' => 'string', 'example' => 'CMCC', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => [ 'substitutions' => ['Cloudauth-intl::2022-08-09::AddressVerifyV2Intl'], 'returnType' => 'synchronous', ], 'title' => 'Address verification', 'summary' => 'Verifies whether a specified address belongs to a user\'s residential address based on telecommunications service provider capabilities, using a phone number and an address (or coordinates).', 'description' => 'Verifies whether a specified address belongs to a user\'s residential address based on telecommunications service provider capabilities, using a phone number and an address (or coordinates).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddressVerifyIntl'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:AddressVerifyIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86C40EC3-5940-5F47-995C-BFE90B70E540\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"TransactionId\\": \\"hksb7ba1b28130d24e015d69********\\",\\n \\"Passed\\": \\"Y\\",\\n \\"SubCode\\": \\"200\\",\\n \\"AddressInfo\\": \\"0-3000\\",\\n \\"IspName\\": \\"CMCC\\"\\n }\\n}","type":"json"}]', ], 'AddressVerifyV2Intl' => [ 'summary' => 'Verifies an address.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREcloudauthZN5W38'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => ['description' => 'The product code. Set this parameter to ADD_VERIFY_PRO.', 'type' => 'string', 'required' => true, 'example' => 'ADD_VERIFY_PRO', 'title' => ''], ], [ 'name' => 'VerifyType', 'in' => 'query', 'schema' => ['description' => 'The address verification method. Valid values:'."\n" ."\n" .'- HOME: home address verification.'."\n" .'- WORK: work address verification.', 'type' => 'string', 'required' => false, 'example' => 'HOME', 'title' => ''], ], [ 'name' => 'Mobile', 'in' => 'query', 'schema' => ['description' => 'The China mobile phone number.', 'type' => 'string', 'required' => false, 'example' => '1872334****', 'title' => ''], ], [ 'name' => 'RegCountry', 'in' => 'query', 'schema' => ['description' => 'The list of prohibited countries.', 'type' => 'string', 'required' => true, 'example' => '目前仅支持：USA', 'title' => ''], ], [ 'name' => 'Text', 'in' => 'query', 'schema' => ['description' => 'The detailed address text.', 'type' => 'string', 'required' => false, 'example' => '江苏省常州市*******小区', 'title' => ''], ], [ 'name' => 'DeviceToken', 'in' => 'query', 'schema' => ['description' => 'The device token, which is used for risk identification.', 'type' => 'string', 'required' => true, 'example' => 'Tk9SSUQuMS*****************ZDNmNWY5NzQxOW1o', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '7F971622-38C0-5F56-B2EC-315367979B4F'], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'The verification result.', 'type' => 'object', 'properties' => [ 'TransactionId' => ['description' => 'The authentication ID.', 'type' => 'string', 'example' => 'hksb7ba1b28130d24e015d69********', 'title' => ''], 'BizCode' => ['description' => 'The verification result. Valid values:'."\n" .'- 1: Passed.'."\n" .'- 2: Failed (the device is in a prohibited region). '."\n" .'- 3: Unable to determine.', 'type' => 'string', 'example' => '1', 'title' => ''], 'Detail' => ['description' => 'The verification details, which include:'."\n" ."\n" .'- distanceRange: the location range. '."\n" .'- ispName: the ISP name. '."\n" .'- phoneStatus: the phone status. A value of 0 indicates abnormal. A value of 1 indicates Normal. Otherwise, the status is unknown.', 'type' => 'string', 'example' => '{'."\n" .' "distanceRange": "0-3000",'."\n" .' "ispName": "CTCC",'."\n" .' "phoneStatus": "1"'."\n" .'}', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Address verification', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:AddressVerifyV2Intl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7F971622-38C0-5F56-B2EC-315367979B4F\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"hksb7ba1b28130d24e015d69********\\",\\n \\"BizCode\\": \\"1\\",\\n \\"Detail\\": \\"{\\\\n \\\\\\"distanceRange\\\\\\": \\\\\\"0-3000\\\\\\",\\\\n \\\\\\"ispName\\\\\\": \\\\\\"CTCC\\\\\\",\\\\n \\\\\\"phoneStatus\\\\\\": \\\\\\"1\\\\\\"\\\\n}\\"\\n }\\n}","type":"json"}]', ], 'BankMetaVerifyIntl' => [ 'summary' => 'Provides bank card element verification (two-element, three-element, and four-element) API operations.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREcloudauth883TGF'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => ['description' => 'Fixed value: BANK_CARD_N_META.', 'type' => 'string', 'required' => true, 'example' => 'BANK_CARD_N_META'."\n", 'title' => ''], ], [ 'name' => 'ParamType', 'in' => 'query', 'schema' => ['description' => 'The encryption method. Valid values:'."\n" .'- normal: no encryption'."\n" .'- md5: MD5 encryption'."\n" ."\n" .'Important:'."\n" ."\n" .'- All encrypted parameter values must be 32-character lowercase MD5 strings.'."\n" .'- Different MD5 tools may produce different ciphertext. If the API call succeeds before encryption but fails after encryption, try a different MD5 tool.', 'type' => 'string', 'required' => true, 'example' => 'normal', 'title' => ''], ], [ 'name' => 'VerifyMode', 'in' => 'query', 'schema' => ['description' => 'VERIFY_BANK_CARD: bank card authentication mode. Indicates whether the provided bank card number matches the user\'s real name, ID card number, and phone number.', 'type' => 'string', 'required' => true, 'example' => 'VERIFY_BANK_CARD', 'title' => ''], ], [ 'name' => 'ProductType', 'in' => 'query', 'schema' => ['description' => 'The product type to call. Valid values:'."\n" ."\n" .'- BANK_CARD_2_META: Bank card number + name verification.'."\n" .'- BANK_CARD_3_META: Bank card number + name + ID card number verification.'."\n" .'- BANK_CARD_4_META: Bank card number + name + ID card number + phone number verification.', 'type' => 'string', 'required' => true, 'example' => 'BANK_CARD_4_META', 'title' => ''], ], [ 'name' => 'BankCard', 'in' => 'query', 'schema' => ['description' => 'The bank card number.'."\n" ."\n" .'- If paramType is set to normal, enter the bank card number in plaintext.'."\n" .'- If paramType is set to md5, provide the plaintext of all digits except the last 6 digits + the MD5 value (32-character lowercase) of the last 6 digits.', 'type' => 'string', 'required' => true, 'example' => '● 明文：12345678******'."\n" .'● 密文：'."\n" .'12345678f8ee21920e37807b43e7e912ab829b6e', 'title' => ''], ], [ 'name' => 'UserName', 'in' => 'query', 'schema' => ['description' => 'The name.'."\n" ."\n" .'- If paramType is set to normal, enter the name in plaintext.'."\n" .'- If paramType is set to md5, provide the MD5-encrypted first character of the name (32-character lowercase MD5) + the plaintext of the remaining characters.', 'type' => 'string', 'required' => true, 'example' => '张*'."\n", 'title' => ''], ], [ 'name' => 'IdentityType', 'in' => 'query', 'schema' => ['description' => 'The ID document type. If left empty, the default value is ID card. For other document types, refer to the table below.', 'type' => 'string', 'required' => false, 'example' => '01', 'title' => ''], ], [ 'name' => 'IdentifyNum', 'in' => 'query', 'schema' => ['description' => 'The ID document number.'."\n" .'- If paramType is set to normal, enter the ID document number in plaintext.'."\n" .'- If paramType is set to md5:'."\n" .' - For ID cards: the first 6 digits (plaintext) + date of birth (ciphertext) + the last 4 digits (plaintext).'."\n" .' - For other documents: the last 2 characters are MD5-encrypted.'."\n" ."\n" .'Important:'."\n" .'This parameter is required when ProductType is set to one of the following values:'."\n" .'- BANK_CARD_3_META'."\n" .'- BANK_CARD_4_META.', 'type' => 'string', 'required' => false, 'example' => '● 明文：429001********8211'."\n" .'● 密文：'."\n" .'42900132fa7bcd874161bea8ec8fd98f390ec98211', 'title' => ''], ], [ 'name' => 'Mobile', 'in' => 'query', 'schema' => ['description' => 'The phone number.'."\n" .'- If paramType is set to normal, enter the phone number in plaintext.'."\n" .'- If paramType is set to md5, enter the phone number in ciphertext.'."\n" ."\n" .'Important:'."\n" ."\n" .'- This parameter is required when ProductType is set to BANK_CARD_4_META.', 'type' => 'string', 'required' => false, 'example' => '● 明文：186****2055'."\n" .'● 密文：'."\n" .'849169cd3b20621c1c78bd61a11a4fc2', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4EB35****87EBA1'], 'Code' => ['description' => 'The response code. A value of 200 indicates success. Other values indicate failure.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'ResultObject' => [ 'description' => 'The result information.', 'type' => 'object', 'properties' => [ 'BizCode' => ['description' => 'The verification result code. Valid values:'."\n" .'- 1: Verification consistent (billable).'."\n" .'- 2: Verification inconsistent (billable).'."\n" .'- 3: No record found (not billable).', 'type' => 'string', 'example' => '1', 'title' => ''], 'SubCode' => ['description' => 'The verification details. Valid values:'."\n" ."\n" .'- **101**: Verification passed.'."\n" .'- **201**: Authentication information inconsistent. The cardholder information is incorrect.'."\n" .'- **202**: Authentication information inconsistent. The bank card has not enabled authenticated payment.'."\n" .'- **203**: Authentication information inconsistent. The bank card has expired.'."\n" .'- **204**: Authentication information inconsistent. The bank card is restricted.'."\n" .'- **205**: Authentication information inconsistent. The card has been confiscated.'."\n" .'- **206**: Authentication information inconsistent. The bank card is invalid.'."\n" .'- **207**: Authentication information inconsistent. No issuing bank found for this card.'."\n" .'- **208**: Authentication information inconsistent. The card is not initialized or is a dormant card.'."\n" .'- **209**: Authentication information inconsistent. The card is a fraudulent or retained card.'."\n" .'- **210**: Authentication information inconsistent. The card has been reported lost.'."\n" .'- **211**: Authentication information inconsistent. The number of incorrect password attempts has exceeded the limit.'."\n" .'- **212**: Authentication information inconsistent. The issuing bank does not support this transaction.'."\n" .'- **213**: Authentication information inconsistent. The card status is abnormal or the card is invalid.'."\n" .'- **214**: Authentication information inconsistent. No phone number is registered with the card.'."\n" .'- **215**: Authentication information inconsistent. The password, expiration date, or CVN2 is incorrect.'."\n" .'- **216**: Authentication information inconsistent. Other card exceptions.'."\n" .'- **301**: Verification unavailable. The bank card does not support this service.'."\n" .'- **302**: Verification unavailable. Verification failed or the bank rejected the verification. Contact the issuing bank.'."\n" .'- **303**: Verification unavailable. The bank card does not currently support phone number verification.'."\n" .'- **304**: Verification unavailable. The bank card number is incorrect.'."\n" .'- **305**: Verification unavailable. Other reasons.'."\n" .'- **306**: Verification unavailable. The number of verification attempts has exceeded the limit.', 'type' => 'string', 'example' => '101', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"SubCode\\": \\"101\\"\\n }\\n}","type":"json"}]', 'title' => 'Bank card element verification', 'description' => 'Verifies bank card elements, including two-element verification (name + bank card number), three-element verification (name + ID card number + bank card number), and four-element verification (name + ID card number + phone number + bank card number) for consistency.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BankMetaVerifyIntl'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:BankMetaVerifyIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'CardOcr' => [ 'summary' => 'Provides server-side ID card and certificate OCR capabilities.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '178782', 'abilityTreeNodes' => ['FEATUREcloudauthCW0JNH', 'FEATUREcloudauthHOSIED', 'FEATUREcloudauthWSJE4H'], ], 'parameters' => [ [ 'name' => 'MerchantBizId', 'in' => 'query', 'schema' => ['description' => 'The merchant-defined unique business ID used for subsequent troubleshooting. The value can be a combination of letters and digits with a maximum length of 32 characters. Ensure that the value is unique.', 'type' => 'string', 'required' => false, 'example' => 'dso9322***dsjsd22', 'title' => ''], ], [ 'name' => 'MerchantUserId', 'in' => 'query', 'schema' => ['description' => 'The merchant user ID or another identifier that can be used to identify a specific user, such as a phone number or email address. We strongly recommend that you pre-desensitize the value of the userId field, for example, by hashing the value.', 'type' => 'string', 'required' => false, 'example' => '123456789', 'title' => ''], ], [ 'name' => 'IdOcrPictureBase64', 'in' => 'formData', 'schema' => ['description' => 'The Base64-encoded image of the front side of the ID document. The value is a Base64 encoding of the image.', 'type' => 'string', 'required' => false, 'example' => 'base64', 'title' => ''], ], [ 'name' => 'IdOcrPictureUrl', 'in' => 'query', 'schema' => ['description' => 'The URL of the front-side image of the ID document.', 'type' => 'string', 'required' => false, 'example' => 'https://digital-cardocr-prod8.oss-cn-hangzhou.aliyuncs.com/1669520556530-expo/default/face/20221127114236530_w3kx2e6t.jpg'."\n", 'title' => ''], ], [ 'name' => 'DocType', 'in' => 'query', 'schema' => ['description' => 'The document type.', 'type' => 'string', 'required' => false, 'example' => '00000006', 'title' => ''], ], [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => false, 'example' => 'ID_OCR_MIN', 'title' => ''], ], [ 'name' => 'Ocr', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to perform OCR on the ID document. Valid values:'."\n" .'- T: Perform OCR on the ID document. This is the default value.'."\n" .'- F: Do not perform OCR.', 'type' => 'string', 'required' => false, 'example' => 'T', 'title' => ''], ], [ 'name' => 'IdFaceQuality', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to perform face quality detection on the ID document. Valid values:'."\n" .'- T: Perform face quality detection.'."\n" .'- F: Do not perform face quality detection. This is the default value.', 'type' => 'string', 'required' => false, 'example' => 'F', 'title' => ''], ], [ 'name' => 'Spoof', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable anti-spoofing detection. Valid values:'."\n" .'- T: Enable anti-spoofing detection.'."\n" .'- F: Disable anti-spoofing detection. This is the default value.', 'type' => 'string', 'required' => false, 'example' => 'F', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '4EB356FE-BB6A-5DCC-B4C5-E8051787EBA1'], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'TransactionId' => ['description' => 'The unique ID of the authentication request.', 'type' => 'string', 'example' => '08573be80f944d95ac812e019e3655a8', 'title' => ''], 'Passed' => ['description' => 'Indicates whether the authentication is passed. Valid values:'."\n" ."\n" .'- Y: Passed.'."\n" .'- N: Not passed.', 'type' => 'string', 'example' => 'Y', 'title' => ''], 'SubCode' => ['description' => 'The sub-result code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'ExtIdInfo' => ['description' => 'The additional result information.', 'type' => 'string', 'example' => '**', 'title' => ''], 'ExtCardInfo' => ['description' => 'The ID card and certificate recognition result.', 'type' => 'string', 'example' => '{'."\n" .' "idFaceQualityScore": 98.90,'."\n" .' "ocrIdInfo": {'."\n" .' "expiryDate": "2024-04-20",'."\n" .' "placeOfIssue": "广东",'."\n" .' "englishName": "ZHENGJIAN,YANGBEN",'."\n" .' "originOfIssue": "公安部出入境管理局",'."\n" .' "sex": "女",'."\n" .' "name": "证件样本",'."\n" .' "idNumber": "C00000000",'."\n" .' "issueDate": "2014-04-21",'."\n" .' "birthDate": "1981-08-03"'."\n" .' },'."\n" .' "spoofInfo": {'."\n" .' "spoofResult": "N",'."\n" .' "spoofType": ['."\n" .' "SCREEN_REMARK"'."\n" .' ]'."\n" .' }'."\n" .'}', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => [ 'substitutions' => ['Cloudauth-intl::2022-08-09::DocOcr'], 'returnType' => 'synchronous', ], 'title' => 'ID card and certificate OCR server-side API', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CardOcr'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:CardOcr', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB356FE-BB6A-5DCC-B4C5-E8051787EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"08573be80f944d95ac812e019e3655a8\\",\\n \\"Passed\\": \\"Y\\",\\n \\"SubCode\\": \\"200\\",\\n \\"ExtIdInfo\\": \\"**\\",\\n \\"ExtCardInfo\\": \\"{\\\\n \\\\\\"idFaceQualityScore\\\\\\": 98.90,\\\\n \\\\\\"ocrIdInfo\\\\\\": {\\\\n \\\\\\"expiryDate\\\\\\": \\\\\\"2024-04-20\\\\\\",\\\\n \\\\\\"placeOfIssue\\\\\\": \\\\\\"广东\\\\\\",\\\\n \\\\\\"englishName\\\\\\": \\\\\\"ZHENGJIAN,YANGBEN\\\\\\",\\\\n \\\\\\"originOfIssue\\\\\\": \\\\\\"公安部出入境管理局\\\\\\",\\\\n \\\\\\"sex\\\\\\": \\\\\\"女\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"证件样本\\\\\\",\\\\n \\\\\\"idNumber\\\\\\": \\\\\\"C00000000\\\\\\",\\\\n \\\\\\"issueDate\\\\\\": \\\\\\"2014-04-21\\\\\\",\\\\n \\\\\\"birthDate\\\\\\": \\\\\\"1981-08-03\\\\\\"\\\\n },\\\\n \\\\\\"spoofInfo\\\\\\": {\\\\n \\\\\\"spoofResult\\\\\\": \\\\\\"N\\\\\\",\\\\n \\\\\\"spoofType\\\\\\": [\\\\n \\\\\\"SCREEN_REMARK\\\\\\"\\\\n ]\\\\n }\\\\n}\\"\\n }\\n}","type":"json"}]', ], 'CheckResult' => [ 'summary' => 'Queries the verification result.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '149753', 'abilityTreeNodes' => ['FEATUREcloudauthCS0SDG'], ], 'parameters' => [ [ 'name' => 'MerchantBizId', 'in' => 'query', 'schema' => ['description' => 'The merchant-defined unique business ID used for subsequent troubleshooting. The value can be a combination of letters and digits with a maximum length of 32 characters. Ensure that the value is unique.', 'type' => 'string', 'required' => false, 'example' => 'djs20d***9-dsskc', 'title' => ''], ], [ 'name' => 'TransactionId', 'in' => 'query', 'schema' => ['description' => 'The verification ID.', 'type' => 'string', 'required' => false, 'example' => '4ab0b***cbde97', 'title' => ''], ], [ 'name' => 'IsReturnImage', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to return images. Valid values:'."\n" .'- Y: Return images.'."\n" .'- N: Do not return images.', 'type' => 'string', 'required' => false, 'example' => 'N', 'title' => ''], ], [ 'name' => 'ExtraImageControlList', 'in' => 'query', 'schema' => ['description' => 'The additional information to return.', 'type' => 'string', 'required' => false, 'example' => '***', 'title' => ''], ], [ 'name' => 'ReturnFiveCategorySpoofResult', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to return the anti-spoofing detection result.', 'type' => 'string', 'required' => false, 'example' => 'Y', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '4EB35****87EBA1'], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The return message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'EkycResult' => ['description' => 'The verification result.', 'type' => 'string', 'example' => '**', 'title' => ''], 'ExtBasicInfo' => ['description' => 'The extended basic information.', 'type' => 'string', 'example' => '**', 'title' => ''], 'ExtFaceInfo' => ['description' => 'The face information.', 'type' => 'string', 'example' => '**', 'title' => ''], 'ExtIdInfo' => ['description' => 'The ID information.', 'type' => 'string', 'example' => '**', 'title' => ''], 'ExtRiskInfo' => ['description' => 'The risk information.', 'type' => 'string', 'example' => '**', 'title' => ''], 'Passed' => ['description' => 'Indicates whether the verification is passed. Valid values:'."\n" ."\n" .'- Y: Passed.'."\n" .'- N: Not passed.', 'type' => 'string', 'example' => 'Y', 'title' => ''], 'SubCode' => ['description' => 'The sub-result code.', 'type' => 'string', 'example' => '***', 'title' => ''], 'ExtInfo' => ['description' => 'The extended information, in JSON string format.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'ExtSourceInfo' => ['description' => 'The data source verification details are described as follows (using the Indonesian data source as an example):'."\n" .'- **govId, fullName, dob**: A comparison score equal to 1.0 indicates a complete match with the official data source. A score lower than 1.0 indicates a mismatch. '."\n" .'- **selfiePhoto**: A comparison score greater than 0.8 indicates a match with the official data source. A score equal to or lower than 0.8 indicates a mismatch. '."\n" .'- **liveness**: A score higher than 0.95 indicates a liveness detection risk. '."\n" .'- **imgManipulationScore**: A score higher than 0.95 indicates an image tampering risk.', 'type' => 'string', 'example' => '{'."\n" .' "govId": 1.0,'."\n" .' "fullName": 1.0,'."\n" .' "dob": 0.9,'."\n" .' "selfiePhoto": 0.8777,'."\n" .' "liveness": 0.1152,'."\n" .' "imgManipulationScore": 0.2253'."\n" .'}', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"EkycResult\\": \\"**\\",\\n \\"ExtBasicInfo\\": \\"**\\",\\n \\"ExtFaceInfo\\": \\"**\\",\\n \\"ExtIdInfo\\": \\"**\\",\\n \\"ExtRiskInfo\\": \\"**\\",\\n \\"Passed\\": \\"Y\\",\\n \\"SubCode\\": \\"***\\",\\n \\"ExtInfo\\": \\"{}\\",\\n \\"ExtSourceInfo\\": \\"{\\\\n \\\\\\"govId\\\\\\": 1.0,\\\\n \\\\\\"fullName\\\\\\": 1.0,\\\\n \\\\\\"dob\\\\\\": 0.9,\\\\n \\\\\\"selfiePhoto\\\\\\": 0.8777,\\\\n \\\\\\"liveness\\\\\\": 0.1152,\\\\n \\\\\\"imgManipulationScore\\\\\\": 0.2253\\\\n}\\"\\n }\\n}","type":"json"}]', 'title' => 'Query verification result', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckResult'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'antcloudauth:CheckResult', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'CheckVerifyLog' => [ 'summary' => 'Authentication log query.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '266432', 'abilityTreeNodes' => ['FEATUREcloudauthCS0SDG'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'MerchantBizId', 'in' => 'formData', 'schema' => ['description' => 'The merchant-side custom business unique identifier, used for subsequent troubleshooting. The value supports a combination of letters and numbers with a maximum length of 32 characters. Ensure that the value is unique.', 'type' => 'string', 'required' => false, 'example' => 'e0c34a***353888', 'title' => ''], ], [ 'name' => 'TransactionId', 'in' => 'formData', 'schema' => ['description' => 'The unique identifier of the entire authentication process. Obtain this value by calling the Initialize operation.', 'type' => 'string', 'required' => false, 'example' => 'hksb7ba1b*********015d694361bee4', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '4EB35****87EBA1'], 'Code' => ['description' => 'The backend error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'Passed' => ['description' => 'Indicates whether the authentication is passed. Valid values:'."\n" ."\n" .'- Y: Passed.'."\n" .'- N: Not passed.', 'type' => 'string', 'example' => 'Y', 'title' => ''], 'SubCode' => ['description' => 'The sub-result code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'VerifyStatus' => ['description' => 'The authentication status. Valid values:'."\n" ."\n" .'- 0: finished. The authentication is complete.'."\n" .'- 1: unfinished. The authentication is interrupted.'."\n" .'- 2: notstart. The authentication has not started.', 'type' => 'string', 'example' => '1', 'title' => ''], 'InterruptPage' => ['description' => 'The last page where the authentication was interrupted. Valid values:'."\n" ."\n" .'- Page not started'."\n" .'- OCR guide page'."\n" .'- OCR camera authorization'."\n" .'- OCR document capture page'."\n" .'- OCR recognition loading'."\n" .'- OCR recognition result editing page'."\n" .'- OCR recognition result editing loading'."\n" .'- Liveness detection guide page'."\n" .'- Liveness detection camera authorization page'."\n" .'- Liveness detection page'."\n" .'- Liveness detection downgrade page'."\n" .'- Liveness detection retry'."\n" .'- Liveness detection loading.', 'type' => 'string', 'example' => 'OCR拍摄证件页面', 'title' => ''], 'VerifyErrorCode' => ['description' => 'The error code for authentication interruption. Valid values:'."\n" ."\n" .'- 1000: The user completed the face verification process, and the authentication result is passed.'."\n" .'- 1001: The user completed the face verification process, and the authentication result is not passed.'."\n" .'- 1002: System error.'."\n" .'- 1003: SDK initialization failed. Check whether the client time is correct.'."\n" .'- 1004: Camera permission error.'."\n" .'- 1005: Network error.'."\n" .'- 1006: The user exited.'."\n" .'- 1007: Invalid TransactionId.'."\n" .'- 1009: Client timestamp error.'."\n" .'- 1011: Incorrect document type submitted.'."\n" .'- 1012: Key information of the recognized document is missing or format validation failed.'."\n" .'- 1013: Poor image quality.'."\n" .'- 1014: The number of errors exceeded the upper limit.'."\n" .'- 1015: The Android system version is too low.'."\n" .'- 1016: Camera permission not obtained.'."\n" .'- 9999: The authentication process is suspected to be interrupted.', 'type' => 'string', 'example' => '1001', 'title' => ''], 'LogInfo' => [ 'description' => 'The SDK runtime log details.', 'type' => 'array', 'items' => ['description' => 'The runtime log.', 'type' => 'string', 'example' => '['."\n" .' "2025-03-21 10:31:25 Loading阶段结束",'."\n" .' "2025-03-21 10:31:25 用户进入OCR页面",'."\n" .' "2025-03-21 10:31:39 OCR认证阶段点击相册选择按钮",'."\n" .' "2025-03-21 10:31:39 OCR认证阶段点击OCR提交按钮",'."\n" .' "2025-03-21 10:31:42 OCR认证阶段中断弹窗弹出",'."\n" .' "2025-03-21 10:31:43 OCR认证阶段中断重试",'."\n" .' "2025-03-21 10:31:43 OCR认证阶段中断弹窗关闭",'."\n" .' "2025-03-21 10:31:59 OCR认证阶段点击相册选择按钮",'."\n" .' "2025-03-21 10:31:59 OCR认证阶段点击OCR提交按钮",'."\n" .' "2025-03-21 10:32:02 OCR认证阶段结束",'."\n" .' "2025-03-21 10:32:02 用户进入OCR编辑页面",'."\n" .' "2025-03-21 10:32:03 OCR编辑阶段点击OCR结果确认无误按钮",'."\n" .' "2025-03-21 10:32:04 OCR编辑阶段结束",'."\n" .' "2025-03-21 10:32:04 用户进入活体页面",'."\n" .' "2025-03-21 10:32:12 活体检测阶段结束"'."\n" .' ]', 'title' => ''], 'title' => '', 'example' => '', ], 'ExtInfo' => ['description' => 'The extended information.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'LogStatisticsInfo' => ['description' => 'The SDK runtime log statistics details.', 'type' => 'string', 'example' => '{'."\n" .' "faceOverTimes": 0,'."\n" .' "hasFaceOverTimes": false,'."\n" .' "hasFacePermissionRefuse": false,'."\n" .' "hasOcrEdit": true,'."\n" .' "hasOcrEditOverTimes": false,'."\n" .' "hasOcrOverTimes": true,'."\n" .' "hasOcrPermissionRefuse": false,'."\n" .' "ocrEditOverTimes": 0,'."\n" .' "ocrEditTimes": 1,'."\n" .' "ocrOverTimes": 1,'."\n" .' "pageStayTimeInfo": {'."\n" .' "LOADING": "1615",'."\n" .' "OCR_SCAN": "37446",'."\n" .' "OCR_RESULT": "1338",'."\n" .' "FACE": "8707"'."\n" .' }'."\n" .' }', 'title' => ''], 'LogInfoEn' => [ 'description' => 'The SDK runtime trace log details in English. The format of this field is the same as **LogInfo**.', 'type' => 'array', 'items' => ['description' => 'The runtime log.', 'type' => 'string', 'example' => '['."\n" .' "2025-03-21 10:31:25 LOADING_ENTER",'."\n" .' "2025-03-21 10:31:25 LOADING_EXIT",'."\n" .' "2025-03-21 10:31:39 GUIDE_PAGE_SHOW",'."\n" .' "2025-03-21 10:31:39 GUIDE_PAGE_LEAVE",'."\n" .' "2025-03-21 10:31:42 FACE_ENTER",'."\n" .' "2025-03-21 10:31:43 FACE_EXIT"'."\n" .']', 'title' => ''], 'title' => '', 'example' => '', ], 'InterruptPageEn' => ['description' => 'The last page where the authentication was interrupted, in English. Valid values:'."\n" ."\n" .'- LOADING'."\n" ."\n" .'- GUIDE'."\n" ."\n" .'- FACE'."\n" ."\n" .'- OCR_SCAN'."\n" ."\n" .'- OCR_RESULT'."\n" ."\n" .'- NFC_INPUT'."\n" ."\n" .'- NFC_READ.', 'type' => 'string', 'example' => 'LOADING', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"Passed\\": \\"Y\\",\\n \\"SubCode\\": \\"200\\",\\n \\"VerifyStatus\\": \\"1\\",\\n \\"InterruptPage\\": \\"OCR拍摄证件页面\\",\\n \\"VerifyErrorCode\\": \\"1001\\",\\n \\"LogInfo\\": [\\n \\"[\\\\n \\\\\\"2025-03-21 10:31:25 Loading阶段结束\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:25 用户进入OCR页面\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:39 OCR认证阶段点击相册选择按钮\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:39 OCR认证阶段点击OCR提交按钮\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:42 OCR认证阶段中断弹窗弹出\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:43 OCR认证阶段中断重试\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:43 OCR认证阶段中断弹窗关闭\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:59 OCR认证阶段点击相册选择按钮\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:59 OCR认证阶段点击OCR提交按钮\\\\\\",\\\\n \\\\\\"2025-03-21 10:32:02 OCR认证阶段结束\\\\\\",\\\\n \\\\\\"2025-03-21 10:32:02 用户进入OCR编辑页面\\\\\\",\\\\n \\\\\\"2025-03-21 10:32:03 OCR编辑阶段点击OCR结果确认无误按钮\\\\\\",\\\\n \\\\\\"2025-03-21 10:32:04 OCR编辑阶段结束\\\\\\",\\\\n \\\\\\"2025-03-21 10:32:04 用户进入活体页面\\\\\\",\\\\n \\\\\\"2025-03-21 10:32:12 活体检测阶段结束\\\\\\"\\\\n ]\\"\\n ],\\n \\"ExtInfo\\": \\"{}\\",\\n \\"LogStatisticsInfo\\": \\"{\\\\n \\\\\\"faceOverTimes\\\\\\": 0,\\\\n \\\\\\"hasFaceOverTimes\\\\\\": false,\\\\n \\\\\\"hasFacePermissionRefuse\\\\\\": false,\\\\n \\\\\\"hasOcrEdit\\\\\\": true,\\\\n \\\\\\"hasOcrEditOverTimes\\\\\\": false,\\\\n \\\\\\"hasOcrOverTimes\\\\\\": true,\\\\n \\\\\\"hasOcrPermissionRefuse\\\\\\": false,\\\\n \\\\\\"ocrEditOverTimes\\\\\\": 0,\\\\n \\\\\\"ocrEditTimes\\\\\\": 1,\\\\n \\\\\\"ocrOverTimes\\\\\\": 1,\\\\n \\\\\\"pageStayTimeInfo\\\\\\": {\\\\n \\\\\\"LOADING\\\\\\": \\\\\\"1615\\\\\\",\\\\n \\\\\\"OCR_SCAN\\\\\\": \\\\\\"37446\\\\\\",\\\\n \\\\\\"OCR_RESULT\\\\\\": \\\\\\"1338\\\\\\",\\\\n \\\\\\"FACE\\\\\\": \\\\\\"8707\\\\\\"\\\\n }\\\\n }\\",\\n \\"LogInfoEn\\": [\\n \\"[\\\\n \\\\\\"2025-03-21 10:31:25 LOADING_ENTER\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:25 LOADING_EXIT\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:39 GUIDE_PAGE_SHOW\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:39 GUIDE_PAGE_LEAVE\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:42 FACE_ENTER\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:43 FACE_EXIT\\\\\\"\\\\n]\\"\\n ],\\n \\"InterruptPageEn\\": \\"LOADING\\"\\n }\\n}","type":"json"}]', 'title' => 'Authentication log query', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckVerifyLog'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:CheckVerifyLog', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'CredentialGetResultIntl' => [ 'summary' => 'Queries the credential recognition result.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcloudauthS6WIN6'], ], 'parameters' => [ [ 'name' => 'TransactionId', 'in' => 'query', 'schema' => ['description' => 'The unique identifier of the authentication request.', 'type' => 'string', 'required' => true, 'example' => '4ab0b***abde97', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5E63B760-0ECB-5C07-8503-A65C27876968'], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The return message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The task status. Valid values:'."\n" .'- PROCESSING: Processing. Continue polling.'."\n" .'- SUCCESS: Succeeded.'."\n" .'- FAILED: Failed.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], 'SubCode' => ['description' => 'The description of the authentication result. For more information, refer to the ResultObject.SubCode error code description.', 'type' => 'string', 'example' => '200', 'title' => ''], 'ExtIdInfo' => ['description' => 'The key information identified, in JSON format.', 'type' => 'string', 'example' => '{'."\n" .' "address": "",'."\n" .' "name":""'."\n" .'}', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query credential recognition result (asynchronous)', 'description' => 'After you obtain the TransactionId, you can call this operation on the server side to retrieve the corresponding authentication result.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:CredentialGetResultIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5E63B760-0ECB-5C07-8503-A65C27876968\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"SubCode\\": \\"200\\",\\n \\"ExtIdInfo\\": \\"{\\\\n \\\\\\"address\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"name\\\\\\":\\\\\\"\\\\\\"\\\\n}\\"\\n }\\n}","type":"json"}]', ], 'CredentialRecognitionIntl' => [ 'summary' => 'An API operation that uploads a credential image, such as a utility bill or credit card statement, and uses Qwen-VL to intelligently fetch the billing address and name from the credential.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREcloudauthNYJI62'], ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => ['description' => 'The product solution to use. Set this to CREDENTIAL_RECOGNITION.', 'type' => 'string', 'required' => true, 'example' => 'CREDENTIAL_RECOGNITION', 'title' => ''], ], [ 'name' => 'CredentialOcrPictureBase64', 'in' => 'formData', 'schema' => ['description' => 'The Base64-encoded image. If you choose to pass in the image by using IdOcrPictureBase64 (Base64-encoded photo), check the photo size and do not pass in an excessively large photo.', 'type' => 'string', 'required' => false, 'example' => 'base64', 'title' => ''], ], [ 'name' => 'CredentialOcrPictureUrl', 'in' => 'formData', 'schema' => ['description' => 'The URL of the image. The URL must be a publicly accessible HTTP or HTTPS link.', 'type' => 'string', 'required' => false, 'example' => 'https://***', 'title' => ''], ], [ 'name' => 'DocType', 'in' => 'query', 'schema' => ['description' => 'The credential type. Valid values:'."\n" .'- 01: transaction credential (including electronic bill images for water, electricity, gas, credit cards, and other types).', 'type' => 'string', 'required' => true, 'example' => '01', 'title' => ''], ], [ 'name' => 'OcrArea', 'in' => 'query', 'schema' => ['description' => 'The extraction type. Valid values:'."\n" .'- 0101: electronic bill address and name module (extracts the address and name module through intelligent analysis).', 'type' => 'string', 'required' => true, 'example' => '0101', 'title' => ''], ], [ 'name' => 'FraudCheck', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable tampering detection. Valid values:'."\n" .'- true: Enabled.'."\n" .'- false: Disabled.', 'type' => 'string', 'required' => true, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4EB35****87EBA1'], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'Success' => ['description' => 'The extraction result. Valid values:'."\n" .'- S: Succeeded.'."\n" .'- F: Failed.', 'type' => 'string', 'example' => 'S', 'title' => ''], 'SubCode' => ['description' => 'The description of the authentication result.', 'type' => 'string', 'example' => '200', 'title' => ''], 'ExtIdInfo' => ['description' => 'The key information extracted from the credential, in JSON format.', 'type' => 'string', 'example' => '{'."\n" .' "address": "",'."\n" .' "name":""'."\n" .'}', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Credential recognition', 'description' => 'Uses AI technology to detect whether a credential (such as a water, electricity, gas, or credit card electronic bill) has been forged, and extracts key information from the credential.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:CredentialRecognitionIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"Success\\": \\"S\\",\\n \\"SubCode\\": \\"200\\",\\n \\"ExtIdInfo\\": \\"{\\\\n \\\\\\"address\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"name\\\\\\":\\\\\\"\\\\\\"\\\\n}\\"\\n }\\n}","type":"json"}]', ], 'CredentialSubmitIntl' => [ 'summary' => 'Submits credential recognition information.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREcloudauthS6WIN6'], ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => ['description' => 'The product solution to use. Set this parameter to CREDENTIAL_RECOGNITION.', 'type' => 'string', 'required' => true, 'example' => 'CREDENTIAL_RECOGNITION', 'title' => ''], ], [ 'name' => 'SceneCode', 'in' => 'query', 'schema' => ['description' => 'The custom authentication scenario ID. You can use this scenario ID to query related records in the console. The value can be a combination of letters, digits, or underscores with a maximum length of 10 characters.', 'type' => 'string', 'required' => true, 'example' => '123****123', 'title' => ''], ], [ 'name' => 'MerchantBizId', 'in' => 'query', 'schema' => ['description' => 'The merchant-side custom business unique identifier, used for subsequent troubleshooting. The value can be a combination of letters and digits with a maximum length of 32 characters. Ensure that the value is unique.', 'type' => 'string', 'required' => true, 'example' => 'e0c34a***353888', 'title' => ''], ], [ 'name' => 'CredentialOcrPictureBase64', 'in' => 'formData', 'schema' => ['description' => 'The Base64-encoded image. If you use this method to submit a photo, check the photo size and do not submit an excessively large photo.', 'type' => 'string', 'required' => false, 'example' => 'base64', 'title' => ''], ], [ 'name' => 'CredentialOcrPictureUrl', 'in' => 'formData', 'schema' => ['description' => 'The URL of the image. The URL must be a publicly accessible HTTP or HTTPS link.', 'type' => 'string', 'required' => false, 'example' => 'https://***', 'title' => ''], ], [ 'name' => 'DocType', 'in' => 'query', 'schema' => ['description' => 'The credential type. Valid values:'."\n" .'- 02: vehicle registration certificate.', 'type' => 'string', 'required' => true, 'example' => '02', 'title' => ''], ], [ 'name' => 'OcrArea', 'in' => 'query', 'schema' => ['description' => 'The extraction type. Valid values:'."\n" ."\n" .'- 0201: Thailand vehicle registration certificate.', 'type' => 'string', 'required' => true, 'example' => '0201', 'title' => ''], ], [ 'name' => 'FraudCheck', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable tampering detection. Valid values:'."\n" .'- true: Enable.'."\n" .'- false: Disable.', 'type' => 'string', 'required' => true, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5E63B760-0ECB-5C07-8503-A65C27876968'], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'TransactionId' => ['description' => 'The unique identifier of the authentication request.', 'type' => 'string', 'example' => '4ab0b***cbde97', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Submit credential recognition task (asynchronous)', 'description' => 'Initializes the credential recognition OCR operation and retrieves a transactionId.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:CredentialSubmitIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5E63B760-0ECB-5C07-8503-A65C27876968\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"4ab0b***cbde97\\"\\n }\\n}","type":"json"}]', ], 'CredentialVerifyIntl' => [ 'summary' => 'Provides the API operation for the credential verification service. This operation uses a large language model to detect image tampering, forgery, and image quality issues in submitted credential images.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREcloudauthNYJI62'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'CredType', 'in' => 'query', 'schema' => ['description' => 'The credential type. Valid values:'."\n" ."\n" .'- 03: enterprise qualification'."\n" .'- 04: transaction voucher.', 'type' => 'string', 'required' => true, 'example' => '03', 'title' => ''], ], [ 'name' => 'CredName', 'in' => 'query', 'schema' => ['description' => 'The credential name (specified as a numeric code). Valid values:'."\n" ."\n" .'- Codes starting with 03: enterprise qualification'."\n" .' - 0301: business license issued in the Chinese mainland'."\n" .'- Codes starting with 04: transaction voucher'."\n" .' - 0401: bank statement'."\n" .' - 0402: payslip'."\n" .' - 0403: utility bill'."\n" .' - 0405: credit card statement'."\n" .' - 0499: other.', 'type' => 'string', 'required' => true, 'example' => '0301', 'title' => ''], ], [ 'name' => 'ImageUrl', 'in' => 'query', 'schema' => ['description' => 'The URL of the image.'."\n" .'> Specify either ImageUrl or ImageFile.', 'type' => 'string', 'required' => false, 'example' => 'https://oss-bj01.avic.com/eavic-prod-commodity/pic/commodity/94677ee6-1067-4287-8ff4-6e030ef3a5a8.jpg', 'title' => ''], ], [ 'name' => 'ImageFile', 'in' => 'formData', 'schema' => ['description' => 'The image input stream.'."\n" .'> Specify either ImageUrl or ImageFile.', 'type' => 'string', 'isFileTransferUrl' => true, 'required' => false, 'example' => '无', 'title' => ''], ], [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => ['description' => 'The call mode. Valid values:'."\n" .'- ANTI_FAKE_CHECK: image quality and tampering detection.', 'type' => 'string', 'required' => true, 'example' => '取值：ANTI_FAKE_CHECK', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '130A2C10-B9EE-4D84-88E3-5384FF039795'], 'Code' => ['description' => 'The return code. A value of 200 indicates success. Other values indicate failure.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The return message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'ResultObject' => [ 'description' => 'The result information.', 'type' => 'object', 'properties' => [ 'Result' => ['description' => 'The risk result. Valid values:'."\n" ."\n" .'- **0**: Low risk.'."\n" .'- **1**: High risk.'."\n" .'- **2**: Suspicious.', 'type' => 'string', 'example' => '1', 'title' => ''], 'RiskTag' => ['description' => 'The risk tags, separated by commas (,). Valid values:'."\n" ."\n" .'- PS: Image has been edited with photo editing software.'."\n" .'- SCREEN_PHOTO: Photo taken from a screen.'."\n" .'- SCREENSHOT: Screenshot.'."\n" .'- ORIGINAL_PHOTO: Non-original image.', 'type' => 'string', 'example' => 'PS', 'title' => ''], 'RiskScore' => [ 'description' => 'The risk score map.', 'type' => 'object', 'additionalProperties' => ['description' => '风险分值', 'type' => 'string', 'example' => '{'."\n" .'"PS": "0.0211",'."\n" .'"SCREEN_PHOTO": "0.0101",'."\n" .'"SCREENSHOT": "0.0521"'."\n" .'}', 'title' => ''], 'title' => '', 'example' => '', ], 'MaterialInfo' => ['description' => 'The 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" .'}', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"130A2C10-B9EE-4D84-88E3-5384FF039795\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"Result\\": \\"1\\",\\n \\"RiskTag\\": \\"PS\\",\\n \\"RiskScore\\": {\\n \\"key\\": \\"{\\\\n\\\\\\"PS\\\\\\": \\\\\\"0.0211\\\\\\",\\\\n\\\\\\"SCREEN_PHOTO\\\\\\": \\\\\\"0.0101\\\\\\",\\\\n\\\\\\"SCREENSHOT\\\\\\": \\\\\\"0.0521\\\\\\"\\\\n}\\"\\n },\\n \\"MaterialInfo\\": \\"{\\\\n \\\\\\"sameBackgroundDetail\\\\\\": {\\\\n // 相似背景对于的原始图请求RequestId\\\\n \\\\\\"originalRequestId\\\\\\": \\\\\\"130A2C10-B9EE-4D84-88E3-5384FF03****\\\\\\";\\\\n // 相似背景对于的原始图请求商户ID \\\\n \\\\\\"originalMerchantId\\\\\\": \\\\\\"xxxxxxxx\\\\\\" \\\\n }\\\\n}\\"\\n }\\n}","type":"json"}]', 'title' => 'Credential tampering detection', 'description' => 'Submits credential image information, performs image quality, tampering, and forgery detection, and returns the detection results.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CredentialVerifyIntl'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:CredentialVerifyIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DeepfakeDetectIntl' => [ 'summary' => 'Detects deepfake risks in facial images.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREcloudauthNYJI62'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => ['description' => 'The product solution to use. Set the value to **FACE_DEEPFAKE**.', 'type' => 'string', 'required' => true, 'example' => 'FACE_DEEPFAKE', 'title' => ''], ], [ 'name' => 'SceneCode', 'in' => 'query', 'schema' => ['description' => 'The custom scene ID for authentication. You can use this scene ID to query related records in the console. The value can be up to 10 characters long and can contain letters, digits, and underscores.', 'type' => 'string', 'required' => false, 'example' => '1234567890', 'title' => ''], ], [ 'name' => 'MerchantBizId', 'in' => 'query', 'schema' => ['description' => 'The unique identifier of the merchant request. The value is a 32-character combination of letters and digits. The first few characters are a custom merchant abbreviation, the middle part can contain a timestamp, and the last part can be a random or incremental sequence.', 'type' => 'string', 'required' => true, 'example' => 'e0c34a77f5ac40a5aa5e6ed20c******', 'title' => ''], ], [ 'name' => 'FaceInputType', 'in' => 'query', 'schema' => ['description' => 'Set the value to **IMAGE** to specify a facial image.', 'type' => 'string', 'required' => false, 'example' => 'IMAGE', 'title' => ''], ], [ 'name' => 'FaceUrl', 'in' => 'query', 'schema' => ['description' => 'The URL of the facial image.'."\n" .'> Specify either FaceUrl or FaceBase64.', 'type' => 'string', 'required' => false, 'example' => 'https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg', 'title' => ''], ], [ 'name' => 'FaceBase64', 'in' => 'formData', 'schema' => ['description' => 'The Base64-encoded content of the facial image.'."\n" .'> Specify either FaceUrl or FaceBase64.', 'type' => 'string', 'required' => false, 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260'], 'Code' => ['description' => 'The return code. A value of 200 indicates success. Other values indicate failure.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'ResultObject' => [ 'description' => 'The result information.', 'type' => 'object', 'properties' => [ 'Result' => ['description' => 'The risk result. Valid values:'."\n" ."\n" .'- **0**: Low risk.'."\n" .'- **1**: High risk.'."\n" .'- **2**: Suspicious.', 'type' => 'string', 'example' => '1', 'title' => ''], 'RiskTag' => ['description' => 'The risk labels. Multiple labels are separated by commas (,). Valid values:'."\n" ."\n" .'- **SuspectDeepForgery**: suspected depth forgery '."\n" .'- **SuspectPSFace**: suspected synthetic attack '."\n" .'- **SuspectWarterMark**: suspected watermark '."\n" .'- **SuspectTemple**: suspected template attack '."\n" .'- **SuspectAIGCFace**: suspected AIGC-generated face '."\n" .'- **SuspectRemake**: suspected recaptured face.', 'type' => 'string', 'example' => 'SuspectDeepForgery,SuspectWarterMark', 'title' => ''], 'RiskScore' => [ 'description' => 'The risk score map.', 'type' => 'object', 'additionalProperties' => ['description' => '后端接收参数名。', 'type' => 'string', 'example' => '{'."\n" .' "SuspectPSFace": "0.9796",'."\n" .' "SuspectRemake": "0.0000",'."\n" .' "SuspectDeepForgery": "0.9500",'."\n" .' "SuspectAIGCFace": "0.0001",'."\n" .' "SuspectWaterMark": "0.0000"'."\n" .' }', 'title' => ''], 'title' => '', 'example' => '', ], 'TransactionId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Face deepfake detection', 'description' => 'Submits a facial image and uses algorithms to detect potential deepfake risks. This operation covers risk scenarios such as AIGC-generated faces, deep forgery face swaps, template faces, and recaptured faces. It returns risk labels and confidence scores.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeepfakeDetectIntl'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:DeepfakeDetectIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"Result\\": \\"1\\",\\n \\"RiskTag\\": \\"SuspectDeepForgery,SuspectWarterMark\\",\\n \\"RiskScore\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"SuspectPSFace\\\\\\": \\\\\\"0.9796\\\\\\",\\\\n \\\\\\"SuspectRemake\\\\\\": \\\\\\"0.0000\\\\\\",\\\\n \\\\\\"SuspectDeepForgery\\\\\\": \\\\\\"0.9500\\\\\\",\\\\n \\\\\\"SuspectAIGCFace\\\\\\": \\\\\\"0.0001\\\\\\",\\\\n \\\\\\"SuspectWaterMark\\\\\\": \\\\\\"0.0000\\\\\\"\\\\n }\\"\\n },\\n \\"TransactionId\\": \\"\\"\\n }\\n}","type":"json"}]', ], 'DeepfakeDetectIntlStream' => [ 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREcloudauthNYJI62'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'formData', 'schema' => ['description' => 'The product solution to integrate.'."\n" .'Valid value: FACE_DEEPFAKE', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'FACE_DEEPFAKE', 'title' => ''], ], [ 'name' => 'SceneCode', 'in' => 'formData', 'schema' => ['description' => 'A custom verification scenario ID that you define. This ID is used to query related records in the console.'."\n" ."\n" .'The value is a combination of letters, digits, or underscores (_) with a maximum length of 10 characters.', 'type' => 'string', 'required' => false, 'example' => '123****123', 'title' => ''], ], [ 'name' => 'MerchantBizId', 'in' => 'formData', 'schema' => ['description' => 'The unique identifier of the merchant request. The value is an alphanumeric string with a length of 32 characters.'."\n" ."\n" .'The first few characters consist of a custom abbreviation defined by the merchant, the middle part can contain a timestamp, and the last part can use a random or incremental sequence.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'e0c34a***353888', 'title' => ''], ], [ 'name' => 'FaceInputType', 'in' => 'formData', 'schema' => [ 'description' => 'The type of facial material input:'."\n" ."\n" .'- IMAGE (default): Face image'."\n" .'- VIDEO: Face video'."\n" ."\n" .'Note'."\n" .'Video processing takes a long time. We recommend that you set the timeout period to more than 3 seconds.', 'enumValueTitles' => ['IMAGE' => 'IMAGE', 'VIDEO' => 'VIDEO'], 'type' => 'string', 'required' => false, 'example' => 'IMAGE', 'title' => '', ], ], [ 'name' => 'FaceUrl', 'in' => 'formData', 'schema' => ['description' => 'The URL of the face image.', 'type' => 'string', 'required' => false, 'example' => 'https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg', 'title' => ''], ], [ 'name' => 'FaceBase64', 'in' => 'formData', 'schema' => ['description' => 'The Base64-encoded face image. For videos, we recommend that you use the stream method for transmission.', 'type' => 'string', 'required' => false, 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx', 'title' => ''], ], [ 'name' => 'FaceFile', 'in' => 'formData', 'schema' => ['description' => 'The image input stream.', 'type' => 'string', 'isFileTransferUrl' => true, 'required' => false, 'example' => '-', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4EB35****87EBA1'], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'ResultObject' => [ 'description' => 'The returned result information.', 'type' => 'object', 'properties' => [ 'Result' => ['description' => 'The risk result:'."\n" ."\n" .'- **0**: Low risk'."\n" .'- **1**: High risk'."\n" .'- **2**: Suspicious', 'type' => 'string', 'example' => '1', 'title' => ''], 'RiskTag' => ['description' => 'The risk labels. Multiple labels are separated by commas (,), including:'."\n" ."\n" .'- SuspectDeepForgery: Suspected deep forgery'."\n" .'- SuspectPSFace: Suspected face synthesis attack'."\n" .'- SuspectTemple: Suspected template attack'."\n" .'- SuspectRemake: Suspected presentation attack', 'type' => 'string', 'example' => 'SuspectDeepForgery', 'title' => ''], 'RiskScore' => [ 'description' => 'The risk score map.', 'type' => 'object', 'additionalProperties' => ['description' => 'The score for each corresponding risk label when a risk is detected.', 'type' => 'string', 'example' => '{'."\n" .' "SuspectPSFace": "0.9796",'."\n" .' "SuspectRemake": "0.0000",'."\n" .' "SuspectDeepForgery": "0.9500",'."\n" .' "SuspectAIGCFace": "0.0001"'."\n" .' }', 'title' => ''], 'title' => '', 'example' => '', ], 'TransactionId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Face Deepfake Detection (File Stream)', 'summary' => 'ID Verification provides face deepfake detection capabilities, which can be integrated independently through API calls.', 'description' => 'Submit a face image to detect deepfake risks through algorithms. This covers risk scenarios such as AIGC-generated faces, deep forgery face swaps, template faces, and re-captured faces, and outputs risk labels and confidence scores.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:DeepfakeDetectIntlStream', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"Result\\": \\"1\\",\\n \\"RiskTag\\": \\"SuspectDeepForgery\\",\\n \\"RiskScore\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"SuspectPSFace\\\\\\": \\\\\\"0.9796\\\\\\",\\\\n \\\\\\"SuspectRemake\\\\\\": \\\\\\"0.0000\\\\\\",\\\\n \\\\\\"SuspectDeepForgery\\\\\\": \\\\\\"0.9500\\\\\\",\\\\n \\\\\\"SuspectAIGCFace\\\\\\": \\\\\\"0.0001\\\\\\"\\\\n }\\"\\n },\\n \\"TransactionId\\": \\"\\"\\n }\\n}","type":"json"}]', ], 'DeleteFaceGroup' => [ 'summary' => 'Deletes a face library.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcloudauthHJ4WQV'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'formData', 'schema' => ['description' => 'The primary key ID.', 'type' => 'string', 'required' => true, 'example' => '16681', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '595E387B-3F0E-5C52-BD02-8EFE63D41FD5'], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Data' => ['description' => 'The response result.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Delete a face library', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'yundun-cloudauth:DeleteFaceGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"595E387B-3F0E-5C52-BD02-8EFE63D41FD5\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": 1\\n}","type":"json"}]', ], 'DeleteFaceRecord' => [ 'summary' => 'Deletes a face record.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcloudauthHJ4WQV'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'formData', 'schema' => ['description' => 'The primary key ID.', 'type' => 'string', 'required' => false, 'example' => '344537', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '4EB35****87EBA1'], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Data' => ['description' => 'The response data.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Delete a face record', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'yundun-cloudauth:DeleteFaceRecord', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": 1\\n}","type":"json"}]', ], 'DeleteFaceRecordV2' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcloudauthCS0SDG'], ], 'parameters' => [ [ 'name' => 'MerchantUserId', 'in' => 'query', 'schema' => ['description' => 'The unique user identifier, which must be consistent with the one used when calling AddFaceRecord. If this parameter was not specified during registration, you can use the default image name.', 'type' => 'string', 'required' => true, 'example' => '1231****', 'title' => ''], ], [ 'name' => 'FaceGroupCode', 'in' => 'query', 'schema' => ['description' => 'The face group code. If this parameter is not specified, the face data of the user is deleted from all face groups.', 'type' => 'string', 'required' => false, 'example' => 'sgl****7uc', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5E63B760-0ECB-5C07-8503-A65C27876968'], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'The response result.', 'type' => 'object', 'properties' => [ 'Deleted' => ['description' => 'The deletion result. Valid values:'."\n" .'- Y: Succeeded.'."\n" .'- N: Failed.', 'type' => 'string', 'example' => 'Y', 'title' => ''], 'DeletedGroupCodes' => ['description' => 'The list of face group codes from which the face data was actually deleted (comma-separated). This parameter is returned with all deleted group codes when FaceGroupCode is not specified.', 'type' => 'string', 'example' => 'wqe***,dsa***', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Delete a face record', 'summary' => 'Deletes a face record.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5E63B760-0ECB-5C07-8503-A65C27876968\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"Deleted\\": \\"Y\\",\\n \\"DeletedGroupCodes\\": \\"wqe***,dsa***\\"\\n }\\n}","type":"json"}]', ], 'DeleteVerifyResult' => [ 'summary' => 'Deletes data related to a user authentication record.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcloudauthHJ4WQV'], ], 'parameters' => [ [ 'name' => 'TransactionId', 'in' => 'query', 'schema' => ['description' => 'The unique identifier of the authentication request.', 'type' => 'string', 'required' => false, 'example' => '4ab0b***cbde97', 'title' => ''], ], [ 'name' => 'DeleteAfterQuery', 'in' => 'query', 'schema' => ['description' => 'Specifies whether the deletion depends on the query operation.', 'type' => 'string', 'required' => false, 'example' => 'Y / N', 'title' => ''], ], [ 'name' => 'DeleteType', 'in' => 'query', 'schema' => ['description' => 'The type of data to delete.', 'type' => 'string', 'required' => false, 'example' => 'Img / Text / All', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4EB35****87EBA1'], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The return message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'TransactionId' => ['description' => 'The unique identifier of the authentication request.', 'type' => 'string', 'example' => '4ab0b***cbde97', 'title' => ''], 'DeleteResult' => ['description' => 'The deletion result. Valid values:'."\n" .'- Y: The deletion was successful.'."\n" .'- N: The deletion failed.', 'type' => 'string', 'example' => 'Y/N', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"4ab0b***cbde97\\",\\n \\"DeleteResult\\": \\"Y/N\\"\\n }\\n}","type":"json"}]', 'title' => 'Delete an authentication record', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteVerifyResult'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:DeleteVerifyResult', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DocOcr' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '181950', 'abilityTreeNodes' => ['FEATUREcloudauthCW0JNH'], ], 'parameters' => [ [ 'name' => 'MerchantBizId', 'in' => 'query', 'schema' => ['description' => 'The custom business unique identifier on the merchant side, used for subsequent issue tracking and troubleshooting. The value can be a combination of letters and digits with a maximum length of 32 characters. Ensure that the value is unique.', 'type' => 'string', 'required' => false, 'example' => 'dso9322***dsjsd22', 'title' => ''], ], [ 'name' => 'MerchantUserId', 'in' => 'query', 'schema' => ['description' => 'The custom user ID in the business. Ensure that the value is unique.', 'type' => 'string', 'required' => false, 'example' => '123456789', 'title' => ''], ], [ 'name' => 'IdOcrPictureBase64', 'in' => 'formData', 'schema' => ['description' => 'The Base64-encoded card or certificate image.'."\n" ."\n" .'If you use IdOcrPictureBase64 (Base64-encoded photo) to submit the certificate photo, check the photo size and do not submit an excessively large photo.', 'type' => 'string', 'required' => false, 'example' => 'base64', 'title' => ''], ], [ 'name' => 'IdOcrPictureUrl', 'in' => 'query', 'schema' => ['description' => 'The URL of the front side of the certificate image.', 'type' => 'string', 'required' => false, 'example' => 'https://digital-cardocr-prod8.oss-cn-hangzhou.aliyuncs.com/1669520556530-expo/default/face/20221127114236530_w3kx2e6t.jpg'."\n", 'title' => ''], ], [ 'name' => 'DocType', 'in' => 'query', 'schema' => ['description' => 'The certificate type.', 'type' => 'string', 'required' => false, 'example' => '00000006', 'title' => ''], ], [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => false, 'example' => '产品方案类型ID_OCR_MIN', 'title' => ''], ], [ 'name' => 'Ocr', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to perform certificate OCR. Valid values:'."\n" .'- T: OCR is required.'."\n" .'- F: OCR is not required.', 'type' => 'string', 'required' => false, 'example' => 'T', 'title' => ''], ], [ 'name' => 'IdFaceQuality', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to perform certificate face quality detection. Valid values:'."\n" .'- T: Detection is required.'."\n" .'- F: Detection is not required. (Default value: F).', 'type' => 'string', 'required' => false, 'example' => 'F', 'title' => ''], ], [ 'name' => 'Spoof', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable anti-spoofing detection. Valid values:'."\n" .'- T: Anti-spoofing is enabled.'."\n" .'- F: Anti-spoofing is disabled.', 'type' => 'string', 'required' => false, 'example' => 'F', 'title' => ''], ], [ 'name' => 'IdThreshold', 'in' => 'query', 'schema' => ['description' => 'The custom OCR quality detection threshold mode. Valid values:'."\n" ."\n" .'- 0: system default'."\n" .'- 1: strict mode'."\n" .'- 2: loose mode'."\n" .'- 3 (default): quality detection disabled.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'CardSide', 'in' => 'query', 'schema' => ['description' => 'Specifies the side of the certificate to distinguish between the national emblem side and the portrait side. If this parameter is not specified, the portrait side is used by default. Valid values:'."\n" ."\n" .'- OCR_ID_FACE (default): portrait side'."\n" ."\n" .'- OCR_ID_NATIONAL_EMBLEM: national emblem side.', 'type' => 'string', 'required' => false, 'example' => 'OCR_ID_FACE', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '86C40EC3-5940-5F47-995C-BFE90B70E540'], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The return message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'TransactionId' => ['description' => 'The unique identifier of the authentication request.', 'type' => 'string', 'example' => '08573be80f944d95ac812e019e3655a8', 'title' => ''], 'Passed' => ['description' => 'Indicates whether the authentication is passed. Valid values:'."\n" ."\n" .'- Y: Passed.'."\n" .'- N: Not passed.', 'type' => 'string', 'example' => 'Y', 'title' => ''], 'SubCode' => ['description' => 'The sub-result code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'ExtIdInfo' => ['description' => 'The card and certificate recognition result. This parameter is returned only when the API response is successful.', 'type' => 'string', 'example' => '{'."\n" .' "idFaceQualityScore": 98.0'."\n" .' "ocrIdInfo": {'."\n" .' "expiryDate": "",'."\n" .' "originOfIssue": "公安部出入境管理局",'."\n" .' "englishName": "LI SI",'."\n" .' "sex": "男",'."\n" .' "name": "李四",'."\n" .' "idNumber": "H11111112",'."\n" .' "issueDate": "2013-01-02",'."\n" .' "birthDate": "1990-02-21"'."\n" .' },'."\n" .' "spoofInfo": {'."\n" .' "spoofResult": "Y",'."\n" .' "spoofType": ['."\n" .' "SCREEN_REMARK"'."\n" .' ]'."\n" .' }'."\n" .'}', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'China card and certificate OCR recognition (ID_OCR_MIN)', 'summary' => 'Provides server-side card and certificate OCR capabilities.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DocOcr'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:DocOcr', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86C40EC3-5940-5F47-995C-BFE90B70E540\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"08573be80f944d95ac812e019e3655a8\\",\\n \\"Passed\\": \\"Y\\",\\n \\"SubCode\\": \\"200\\",\\n \\"ExtIdInfo\\": \\"{\\\\n \\\\\\"idFaceQualityScore\\\\\\": 98.0\\\\n \\\\\\"ocrIdInfo\\\\\\": {\\\\n \\\\\\"expiryDate\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"originOfIssue\\\\\\": \\\\\\"公安部出入境管理局\\\\\\",\\\\n \\\\\\"englishName\\\\\\": \\\\\\"LI SI\\\\\\",\\\\n \\\\\\"sex\\\\\\": \\\\\\"男\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"李四\\\\\\",\\\\n \\\\\\"idNumber\\\\\\": \\\\\\"H11111112\\\\\\",\\\\n \\\\\\"issueDate\\\\\\": \\\\\\"2013-01-02\\\\\\",\\\\n \\\\\\"birthDate\\\\\\": \\\\\\"1990-02-21\\\\\\"\\\\n },\\\\n \\\\\\"spoofInfo\\\\\\": {\\\\n \\\\\\"spoofResult\\\\\\": \\\\\\"Y\\\\\\",\\\\n \\\\\\"spoofType\\\\\\": [\\\\n \\\\\\"SCREEN_REMARK\\\\\\"\\\\n ]\\\\n }\\\\n}\\"\\n }\\n}","type":"json"}]', ], 'DocOcrMax' => [ 'summary' => 'Recognizes global identity documents through OCR.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREcloudauthCW0JNH', 'FEATUREcloudauthHOSIED', 'FEATUREcloudauthWSJE4H'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'formData', 'schema' => ['description' => 'The product solution to use.'."\n" ."\n" .'Set this parameter to ID_OCR_MAX.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'ID_OCR_MAX', 'title' => ''], ], [ 'name' => 'SceneCode', 'in' => 'formData', 'schema' => ['description' => 'The custom authentication scenario ID. You can use this scenario ID to query related records in the console.'."\n" ."\n" .'The value can contain up to 10 characters, including letters, digits, and underscores.', 'type' => 'string', 'required' => false, 'example' => '1234567890', 'title' => ''], ], [ 'name' => 'MerchantBizId', 'in' => 'formData', 'schema' => ['description' => 'The custom unique business identifier, which is used for subsequent troubleshooting.'."\n" ."\n" .'The value can contain up to 32 characters, including letters and digits. Make sure the value is unique.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'e0c34a77f5ac40a5aa5e6ed20c******', 'title' => ''], ], [ 'name' => 'MerchantUserId', 'in' => 'formData', 'schema' => ['description' => 'The custom user ID or another identifier that can identify a specific user, such as a phone number or email address.'."\n" ."\n" .'We strongly recommend that you desensitize the value of this field in advance, for example, by hashing the value.', 'type' => 'string', 'required' => false, 'example' => '123456789', 'title' => ''], ], [ 'name' => 'IdOcrPictureBase64', 'in' => 'formData', 'schema' => ['description' => 'The Base64-encoded image of the card or certificate.'."\n" ."\n" .'If you use IdOcrPictureBase64 to pass in the document image, check the image size and do not pass in an excessively large image.', 'type' => 'string', 'required' => false, 'example' => 'base64', 'title' => ''], ], [ 'name' => 'IdOcrPictureUrl', 'in' => 'formData', 'schema' => ['description' => 'The URL of the card or certificate image. The URL must be a publicly accessible HTTP or HTTPS link.', 'type' => 'string', 'required' => false, 'example' => 'https://***********.oss-cn-hangzhou.aliyuncs.com/1669520556530-expo/default/face/20221127114236530_w3kx2e6t.jpg'."\n", 'title' => ''], ], [ 'name' => 'OcrModel', 'in' => 'formData', 'schema' => ['description' => 'The OCR recognition mode. Valid values:'."\n" ."\n" .'- 0: general document recognition mode (default).'."\n" ."\n" .'- 1: automatic document classification mode.'."\n" ."\n" .'- 2: automatic document classification + general recognition mode.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'DocType', 'in' => 'formData', 'schema' => ['description' => 'The document type.'."\n" .'- Format: country code + document type abbreviation + page (optional).'."\n" ."\n" .'Note:'."\n" .'- OcrModel = 0: DocType is required. Specify the document type. The existing logic remains unchanged.'."\n" .'- OcrModel = 1 or 2: DocType must be left empty.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'CNSSC01', 'title' => ''], ], [ 'name' => 'Prompt', 'in' => 'formData', 'schema' => ['description' => '>This field is deprecated..', 'type' => 'string', 'required' => false, 'example' => '已废弃', 'title' => ''], ], [ 'name' => 'Spoof', 'in' => 'formData', 'schema' => ['description' => 'This field is deprecated..', 'type' => 'string', 'required' => false, 'example' => '已废弃', 'title' => ''], ], [ 'name' => 'IdThreshold', 'in' => 'formData', 'schema' => ['description' => 'The custom OCR quality detection threshold mode. Valid values:'."\n" ."\n" .'- 0: system default.'."\n" .'- 1: strict mode.'."\n" .'- 2: loose mode.'."\n" .'- 3 (default): quality detection disabled.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'IdSpoof', 'in' => 'formData', 'schema' => ['description' => 'Specifies whether to enable the document anti-forgery feature. Valid values:'."\n" ."\n" .'- T: enabled.'."\n" ."\n" .'- F (default): disabled.', 'type' => 'string', 'required' => false, 'example' => 'F', 'title' => ''], ], [ 'name' => 'DocPage', 'in' => 'formData', 'schema' => ['description' => 'The expected page to recognize. Valid values:'."\n" ."\n" .'- 01 (default): the portrait side of the document.'."\n" ."\n" .'- 02: the back side of the document.', 'type' => 'string', 'required' => false, 'example' => '01', 'title' => ''], ], [ 'name' => 'OcrValueStandard', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies whether to enable OCR key field standardization. Valid values:'."\n" .'- 0: no (default). '."\n" .'- 1: yes.', 'type' => 'string', 'example' => '0', 'default' => '0', 'required' => false], ], [ 'name' => 'Authorize', 'in' => 'formData', 'schema' => ['description' => 'Specifies whether to enable authoritative data source verification to enhance document anti-forgery capabilities.'."\n" ."\n" .'- **T**: enabled.'."\n" ."\n" .'- **F**: disabled (default).'."\n" ."\n" .'> '."\n" .'> - **Applicable document types**: China resident identity card (CHN01001) and Chinese mainland driver\'s license (CHN02001).'."\n" .'> - **Data transmission statement**: Enabling this parameter indicates your consent to transmit the user\'s name and document number to an authoritative data source in the Chinese mainland for consistency verification.'."\n" .'> - **Performance impact**: After this feature is enabled, the API response time increases by approximately 1 to 2 seconds. Adjust the timeout settings accordingly.', 'type' => 'string', 'required' => false, 'example' => 'T'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '4EB35****87EBA1'], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'Passed' => ['description' => 'Indicates whether the authentication is passed. Valid values:'."\n" ."\n" .'- Y: passed.'."\n" .'- N: not passed.', 'type' => 'string', 'example' => 'Y', 'title' => ''], 'SubCode' => ['description' => 'The sub-result code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'ExtIdInfo' => ['description' => 'The card and certificate recognition result. This parameter is returned only when the API response is successful.', 'type' => 'string', 'example' => '{'."\n" .' "docType": "PPTW01",'."\n" .' "ocrIdInfo": {'."\n" .' "passportNo": "36*******",'."\n" .' "expiryDate": "2032/02/10",'."\n" .' "placeOfBirth": "TAIWAN",'."\n" .' "surname": "CHEN",'."\n" .' "givenname": "LIN-CHUN",'."\n" .' "countryCode": "TWN",'."\n" .' "sex": "F",'."\n" .' "personalNo": "S22********",'."\n" .' "issueDate": "2022/02/10",'."\n" .' "birthDate": "1988/10/04"'."\n" .' }'."\n" .'}', 'title' => ''], 'TransactionId' => ['description' => 'The authentication ID.', 'type' => 'string', 'example' => 'hk573be80f944d95ac812e0*******a8', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"Passed\\": \\"Y\\",\\n \\"SubCode\\": \\"200\\",\\n \\"ExtIdInfo\\": \\"{\\\\n \\\\\\"docType\\\\\\": \\\\\\"PPTW01\\\\\\",\\\\n \\\\\\"ocrIdInfo\\\\\\": {\\\\n \\\\\\"passportNo\\\\\\": \\\\\\"36*******\\\\\\",\\\\n \\\\\\"expiryDate\\\\\\": \\\\\\"2032/02/10\\\\\\",\\\\n \\\\\\"placeOfBirth\\\\\\": \\\\\\"TAIWAN\\\\\\",\\\\n \\\\\\"surname\\\\\\": \\\\\\"CHEN\\\\\\",\\\\n \\\\\\"givenname\\\\\\": \\\\\\"LIN-CHUN\\\\\\",\\\\n \\\\\\"countryCode\\\\\\": \\\\\\"TWN\\\\\\",\\\\n \\\\\\"sex\\\\\\": \\\\\\"F\\\\\\",\\\\n \\\\\\"personalNo\\\\\\": \\\\\\"S22********\\\\\\",\\\\n \\\\\\"issueDate\\\\\\": \\\\\\"2022/02/10\\\\\\",\\\\n \\\\\\"birthDate\\\\\\": \\\\\\"1988/10/04\\\\\\"\\\\n }\\\\n}\\",\\n \\"TransactionId\\": \\"hk573be80f944d95ac812e0*******a8\\"\\n }\\n}","type":"json"}]', 'title' => 'Global card and certificate OCR recognition', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DocOcrMax'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:DocOcrMax', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DocOcrMaxV2' => [ 'summary' => 'Recognizes identity documents worldwide through OCR.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREcloudauthCW0JNH', 'FEATUREcloudauthHOSIED', 'FEATUREcloudauthWSJE4H'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'formData', 'schema' => ['description' => 'The product solution to use.'."\n" ."\n" .'Set this parameter to ID_OCR_MAX.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'ID_OCR_MAX', 'title' => ''], ], [ 'name' => 'SceneCode', 'in' => 'formData', 'schema' => ['description' => 'The custom verification scenario ID. You can use this scenario ID to query related records in the console.'."\n" ."\n" .'The value can contain letters, digits, and underscores, with a maximum length of 10 characters.', 'type' => 'string', 'required' => false, 'example' => '1234567890', 'title' => ''], ], [ 'name' => 'MerchantBizId', 'in' => 'formData', 'schema' => ['description' => 'The merchant-defined unique business identifier, used for subsequent troubleshooting. The value can contain letters and digits, with a maximum length of 32 characters. Make sure the value is unique.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'e0c34a77f5ac40a5aa5e6ed20c353888'."\n", 'title' => ''], ], [ 'name' => 'MerchantUserId', 'in' => 'formData', 'schema' => ['description' => 'The custom user ID, or another identifier that can identify a specific user, such as a phone number or email address.'."\n" ."\n" .'Hash or otherwise desensitize this field value before passing it in.', 'type' => 'string', 'required' => false, 'example' => '123456789', 'title' => ''], ], [ 'name' => 'IdOcrPictureBase64', 'in' => 'formData', 'schema' => ['description' => 'The Base64-encoded image of the identity document.'."\n" ."\n" .'If you use IdOcrPictureBase64 to pass in the document image, check the image size and do not pass in an excessively large image.', 'type' => 'string', 'required' => false, 'example' => 'base64'."\n", 'title' => ''], ], [ 'name' => 'IdOcrPictureUrl', 'in' => 'formData', 'schema' => ['description' => 'The URL of the identity document image. The URL must be a publicly accessible HTTP or HTTPS link.', 'type' => 'string', 'required' => false, 'example' => 'https://***********.oss-cn-hangzhou.aliyuncs.com/1669520556530-expo/default/face/20221127114236530_w3kx2e6t.jpg'."\n", 'title' => ''], ], [ 'name' => 'OcrModel', 'in' => 'formData', 'schema' => ['description' => 'The OCR recognition mode. Valid values:'."\n" ."\n" .'- 0: general document recognition mode (default).'."\n" ."\n" .'- 1: automatic document classification mode.'."\n" ."\n" .'- 2: automatic document classification and general recognition mode.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'DocType', 'in' => 'formData', 'schema' => ['description' => 'The document type.'."\n" .'- Format: country code + document type abbreviation + page (optional).'."\n" ."\n" .'Note:'."\n" .'- OcrModel = 0: DocType is required. Specify the document type. The existing logic remains unchanged.'."\n" .'- OcrModel = 1 or 2: DocType must be left empty.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'CHN01001', 'title' => ''], ], [ 'name' => 'IdThreshold', 'in' => 'formData', 'schema' => ['description' => 'The custom OCR quality detection threshold mode. Valid values:'."\n" ."\n" .'- 0: system default.'."\n" .'- 1: strict mode.'."\n" .'- 2: loose mode.'."\n" .'- 3 (default): quality detection disabled.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'IdSpoof', 'in' => 'formData', 'schema' => ['description' => 'Specifies whether to enable the document anti-forgery feature. Valid values:'."\n" ."\n" .'- T: enabled.'."\n" ."\n" .'- F (default): disabled.', 'type' => 'string', 'required' => false, 'example' => 'F', 'title' => ''], ], [ 'name' => 'DocPage', 'in' => 'formData', 'schema' => ['description' => 'The expected page to recognize. Valid values:'."\n" ."\n" .'- 01 (default): the portrait side of the document.'."\n" ."\n" .'- 02: the back side of the document.', 'type' => 'string', 'required' => false, 'example' => '01', 'title' => ''], ], [ 'name' => 'OcrValueStandard', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies whether to enable OCR key field standardization. Valid values:'."\n" ."\n" .'- 0 (default): disabled.'."\n" .'- 1: enabled.', 'type' => 'string', 'example' => '0', 'default' => '0', 'required' => false], ], [ 'name' => 'Authorize', 'in' => 'formData', 'schema' => ['description' => 'Specifies whether to enable authoritative data source verification to enhance document anti-forgery capabilities. Valid values:'."\n" ."\n" .'- **T**: enabled.'."\n" ."\n" .'- **F** (default): disabled.'."\n" ."\n" .'> '."\n" .'> - **Applicable document types**: China resident identity card (CHN01001) and China mainland driver\'s license (CHN02001).'."\n" .'> - **Data transmission statement**: Enabling this parameter indicates consent to transmit the user\'s name and document number to an authoritative data source in the Chinese mainland for consistency verification.'."\n" .'> - **Performance impact**: Enabling this parameter increases the API response time by approximately 1 to 2 seconds. Adjust the timeout settings accordingly.', 'type' => 'string', 'required' => false, 'example' => 'T'."\n", 'title' => ''], ], [ 'name' => 'IdOcrPictureFile', 'in' => 'formData', 'schema' => ['description' => 'The file stream of the document image.', 'type' => 'string', 'isFileTransferUrl' => true, 'required' => false, 'example' => 'InputStream', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5E63B760-0ECB-5C07-8503-A65C27876968'], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'Passed' => ['description' => 'Indicates whether the verification passed. Valid values:'."\n" ."\n" .'- Y: passed.'."\n" .'- N: not passed.', 'type' => 'string', 'example' => 'Y', 'title' => ''], 'SubCode' => ['description' => 'The sub-result code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'ExtIdInfo' => ['description' => 'The card and certificate recognition result. This parameter is returned only when the API response is successful.', 'type' => 'string', 'example' => '{'."\n" .' "ocrIdInfo": {'."\n" .' "id_number": "*****719******",'."\n" .' "address": "xxxxxx,'."\n" .' "ethnicity": "汉",'."\n" .' "date_of_birth": "1990年06月02日",'."\n" .' "sex": "女",'."\n" .' "name": "何**"'."\n" .' },'."\n" .' "ocrStandardData": {'."\n" .' "given_name_s": "**",'."\n" .' "surname_s": "HE",'."\n" .' "date_of_birth_s": "1990-06-02",'."\n" .' "sex_s": "F"'."\n" .' }'."\n" .'}', 'title' => ''], 'TransactionId' => ['description' => 'The unique identifier of the verification request.', 'type' => 'string', 'example' => '08573be80f944d95ac812e019e3655a8', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Global card and certificate OCR recognition', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5E63B760-0ECB-5C07-8503-A65C27876968\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"Passed\\": \\"Y\\",\\n \\"SubCode\\": \\"200\\",\\n \\"ExtIdInfo\\": \\"{\\\\n \\\\\\"ocrIdInfo\\\\\\": {\\\\n \\\\\\"id_number\\\\\\": \\\\\\"*****719******\\\\\\",\\\\n \\\\\\"address\\\\\\": \\\\\\"xxxxxx,\\\\n \\\\\\"ethnicity\\\\\\": \\\\\\"汉\\\\\\",\\\\n \\\\\\"date_of_birth\\\\\\": \\\\\\"1990年06月02日\\\\\\",\\\\n \\\\\\"sex\\\\\\": \\\\\\"女\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"何**\\\\\\"\\\\n },\\\\n \\\\\\"ocrStandardData\\\\\\": {\\\\n \\\\\\"given_name_s\\\\\\": \\\\\\"**\\\\\\",\\\\n \\\\\\"surname_s\\\\\\": \\\\\\"HE\\\\\\",\\\\n \\\\\\"date_of_birth_s\\\\\\": \\\\\\"1990-06-02\\\\\\",\\\\n \\\\\\"sex_s\\\\\\": \\\\\\"F\\\\\\"\\\\n }\\\\n}\\",\\n \\"TransactionId\\": \\"08573be80f944d95ac812e019e3655a8\\"\\n }\\n}","type":"json"}]', ], 'DocOcrV2' => [ 'summary' => 'Provides server-side card and certificate OCR capabilities.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '181950', 'abilityTreeNodes' => ['FEATUREcloudauthCW0JNH'], ], 'parameters' => [ [ 'name' => 'MerchantBizId', 'in' => 'query', 'schema' => ['description' => 'The merchant-defined unique business ID used for subsequent troubleshooting. The value can contain letters and digits with a maximum length of 32 characters. Ensure that the value is unique.', 'type' => 'string', 'required' => false, 'example' => 'dso9322***dsjsd22'."\n", 'title' => ''], ], [ 'name' => 'MerchantUserId', 'in' => 'query', 'schema' => ['description' => 'The custom user ID defined in your business. Ensure that the value is unique.', 'type' => 'string', 'required' => false, 'example' => '123456789', 'title' => ''], ], [ 'name' => 'IdOcrPictureBase64', 'in' => 'formData', 'schema' => ['description' => 'The Base64-encoded card or certificate image.'."\n" ."\n" .'If you use IdOcrPictureBase64 to pass in the certificate image, check the image size and do not pass in an excessively large image.', 'type' => 'string', 'required' => false, 'example' => 'base64'."\n", 'title' => ''], ], [ 'name' => 'IdOcrPictureUrl', 'in' => 'query', 'schema' => ['description' => 'The URL of the front side of the certificate image.', 'type' => 'string', 'required' => false, 'example' => 'https://digital-cardocr-prod8.oss-cn-hangzhou.aliyuncs.com/1669520556530-expo/default/face/20221127114236530_w3kx2e6t.jpg', 'title' => ''], ], [ 'name' => 'IdOcrPictureFile', 'in' => 'formData', 'schema' => ['description' => 'The file stream of the front side of the certificate image.', 'type' => 'string', 'isFileTransferUrl' => true, 'required' => false, 'example' => 'InputStream', 'title' => ''], ], [ 'name' => 'DocType', 'in' => 'query', 'schema' => ['description' => 'The certificate type.', 'type' => 'string', 'required' => false, 'example' => '00000006'."\n", 'title' => ''], ], [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => false, 'example' => '产品方案类型ID_OCR_MIN'."\n", 'title' => ''], ], [ 'name' => 'Ocr', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to perform certificate OCR.'."\n" ."\n" .'- T: OCR is required.'."\n" .'- F: OCR is not required.', 'type' => 'string', 'required' => false, 'example' => 'T'."\n", 'title' => ''], ], [ 'name' => 'IdFaceQuality', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to perform face quality detection on the certificate.'."\n" ."\n" .'- T: Detection is required.'."\n" .'- F: Detection is not required. (Default: F).', 'type' => 'string', 'required' => false, 'example' => 'F', 'title' => ''], ], [ 'name' => 'Spoof', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable anti-spoofing detection.'."\n" ."\n" .'- T: Anti-spoofing is enabled.'."\n" .'- F: Anti-spoofing is disabled.', 'type' => 'string', 'required' => false, 'example' => 'F', 'title' => ''], ], [ 'name' => 'IdThreshold', 'in' => 'query', 'schema' => ['description' => 'The custom OCR quality detection threshold mode. Valid values:'."\n" ."\n" .'- 0: system default'."\n" .'- 1: strict mode'."\n" .'- 2: loose mode'."\n" .'- 3 (default): quality detection is disabled.', 'type' => 'string', 'required' => false, 'example' => '0'."\n", 'title' => ''], ], [ 'name' => 'CardSide', 'in' => 'query', 'schema' => ['description' => 'Specifies the side of the certificate. If this parameter is not specified, the portrait side is used by default.'."\n" ."\n" .'- OCR_ID_FACE (default): the portrait side'."\n" ."\n" .'- OCR_ID_NATIONAL_EMBLEM: the national emblem side.', 'type' => 'string', 'required' => false, 'example' => 'OCR_ID_FACE'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '86C40EC3-5940-5F47-995C-BFE90B70E540'."\n"], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => 'Success'."\n", 'title' => ''], 'Message' => ['description' => 'The return message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'TransactionId' => ['description' => 'The unique ID of the authentication request.', 'type' => 'string', 'example' => '08573be80f944d95ac812e019e3655a8'."\n", 'title' => ''], 'Passed' => ['description' => 'Indicates whether the authentication is passed. Valid values:'."\n" ."\n" .'- Y: Passed.'."\n" .'- N: Not passed.', 'type' => 'string', 'example' => 'Y'."\n", 'title' => ''], 'SubCode' => ['description' => 'The sub-result code.', 'type' => 'string', 'example' => '200'."\n", 'title' => ''], 'ExtIdInfo' => ['description' => 'The card and certificate recognition result. This parameter is returned only when the API response is successful.', 'type' => 'string', 'example' => '{'."\n" .' "idFaceQualityScore": 98.0'."\n" .' "ocrIdInfo": {'."\n" .' "expiryDate": "",'."\n" .' "originOfIssue": "公安部出入境管理局",'."\n" .' "englishName": "LI SI",'."\n" .' "sex": "男",'."\n" .' "name": "李四",'."\n" .' "idNumber": "H11111112",'."\n" .' "issueDate": "2013-01-02",'."\n" .' "birthDate": "1990-02-21"'."\n" .' },'."\n" .' "spoofInfo": {'."\n" .' "spoofResult": "Y",'."\n" .' "spoofType": ['."\n" .' "SCREEN_REMARK"'."\n" .' ]'."\n" .' }'."\n" .'}', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'China card and certificate OCR recognition (ID_OCR_MIN)', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86C40EC3-5940-5F47-995C-BFE90B70E540\\\\n\\",\\n \\"Code\\": \\"Success\\\\n\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"08573be80f944d95ac812e019e3655a8\\\\n\\",\\n \\"Passed\\": \\"Y\\\\n\\",\\n \\"SubCode\\": \\"200\\\\n\\",\\n \\"ExtIdInfo\\": \\"{\\\\n \\\\\\"idFaceQualityScore\\\\\\": 98.0\\\\n \\\\\\"ocrIdInfo\\\\\\": {\\\\n \\\\\\"expiryDate\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"originOfIssue\\\\\\": \\\\\\"公安部出入境管理局\\\\\\",\\\\n \\\\\\"englishName\\\\\\": \\\\\\"LI SI\\\\\\",\\\\n \\\\\\"sex\\\\\\": \\\\\\"男\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"李四\\\\\\",\\\\n \\\\\\"idNumber\\\\\\": \\\\\\"H11111112\\\\\\",\\\\n \\\\\\"issueDate\\\\\\": \\\\\\"2013-01-02\\\\\\",\\\\n \\\\\\"birthDate\\\\\\": \\\\\\"1990-02-21\\\\\\"\\\\n },\\\\n \\\\\\"spoofInfo\\\\\\": {\\\\n \\\\\\"spoofResult\\\\\\": \\\\\\"Y\\\\\\",\\\\n \\\\\\"spoofType\\\\\\": [\\\\n \\\\\\"SCREEN_REMARK\\\\\\"\\\\n ]\\\\n }\\\\n}\\"\\n }\\n}","type":"json"}]', ], 'DownloadVerifyRecordIntl' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '225500', 'abilityTreeNodes' => ['FEATUREcloudauth6RJHVQ'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'Code', 'in' => 'query', 'schema' => ['description' => 'The query code.', 'type' => 'string', 'required' => false, 'example' => 'vrf_intl_verify_record_real_id_idv_invoke_statistics_query', 'title' => ''], ], [ 'name' => 'Param', 'in' => 'query', 'schema' => ['description' => 'The parameters for the export and download query task.', 'type' => 'string', 'required' => false, 'example' => '{\\"productCode\\":\\"FACE_LIVENESS\\",\\"startDs\\":\\"20251121\\",\\"endDs\\":\\"20251128\\",\\"language\\":\\"en\\"}', 'title' => ''], ], [ 'name' => 'ProductType', 'in' => 'query', 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => false, 'example' => 'KYC', 'title' => ''], ], [ 'name' => 'DownloadMode', 'in' => 'query', 'schema' => ['description' => 'The download mode. Valid values:'."\n" ."\n" .'- **async**: asynchronous'."\n" .'- **sync**: synchronous.', 'type' => 'string', 'required' => false, 'example' => 'async', 'title' => ''], ], [ 'name' => 'BizType', 'in' => 'query', 'schema' => ['description' => 'The business type. Valid values:'."\n" .'- INVOKE_STATISTICS'."\n" .'- INVOKE_RECORD.', 'type' => 'string', 'required' => false, 'example' => 'INVOKE_RECORD', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '86C40EC3-5940-5F47-995C-BFE90B70E540'."\n"], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The return message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'DownloadTaskId' => ['description' => 'The task ID. This parameter is returned in asynchronous mode. Use QueryDownloadTaskIntl to download the exported file.', 'type' => 'string', 'example' => '202511284106866', 'title' => ''], 'Url' => ['description' => 'The download URL of the exported file.', 'type' => 'string', 'example' => 'https://cn-shanghai-aliyun-cloudauth.oss-cn-shanghai.aliyuncs.com/console/xxxxxx/KYC_INVOKE_STATISTICS.xlxs', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Download authentication records', 'summary' => 'Downloads verification task records.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:DownloadVerifyRecordIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86C40EC3-5940-5F47-995C-BFE90B70E540\\\\n\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"DownloadTaskId\\": \\"202511284106866\\",\\n \\"Url\\": \\"https://cn-shanghai-aliyun-cloudauth.oss-cn-shanghai.aliyuncs.com/console/xxxxxx/KYC_INVOKE_STATISTICS.xlxs\\"\\n }\\n}","type":"json"}]', ], 'EkycVerify' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '190721', 'abilityTreeNodes' => ['FEATUREcloudauthHJ4WQV'], ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => false, 'example' => 'eKYC_MIN', 'title' => ''], ], [ 'name' => 'MerchantBizId', 'in' => 'query', 'schema' => ['description' => 'The merchant-defined unique business identifier, used for subsequent troubleshooting. The value is a combination of letters and digits up to 32 characters in length. Ensure that the value is unique.', 'type' => 'string', 'required' => false, 'example' => 'e0c34a77f5ac40a5aa5e6ed20c353888', 'title' => ''], ], [ 'name' => 'MerchantUserId', 'in' => 'query', 'schema' => ['description' => 'The custom user ID or other identifier that can identify a specific user, such as a phone number or email address. We strongly recommend that you mask the value of this field in advance, for example, by hashing the value.', 'type' => 'string', 'required' => false, 'example' => '123456', 'title' => ''], ], [ 'name' => 'DocType', 'in' => 'query', 'schema' => ['description' => 'The document type.', 'type' => 'string', 'required' => false, 'example' => '00000001', 'title' => ''], ], [ 'name' => 'DocName', 'in' => 'query', 'schema' => ['description' => 'The real name of the user. If Authorize is set to T and the document type is a Chinese mainland ID card, you must provide at least one of the following: the key document information (DocName and DocNo) or the document image (IdOcrPictureBase64 or IdOcrPictureURL).'."\n" .'Note: The value must contain at least one Chinese character and cannot contain special characters, except for the middle dot (·) used in ethnic minority names.', 'type' => 'string', 'required' => false, 'example' => '张**', 'title' => ''], ], [ 'name' => 'DocNo', 'in' => 'query', 'schema' => ['description' => 'The document number of the user. If Authorize is set to T and the document type is a Chinese mainland ID card, you must provide at least one of the following: the key document information (DocName and DocNo) or the document image (IdOcrPictureBase64 or IdOcrPictureURL).'."\n" .'Note: The value is a combination of letters and digits up to 18 characters in length.', 'type' => 'string', 'required' => false, 'example' => '410***************', 'title' => ''], ], [ 'name' => 'IdOcrPictureUrl', 'in' => 'query', 'schema' => ['description' => 'The URL of the front side of the document image.', 'type' => 'string', 'required' => false, 'example' => 'https://digital-cardocr-prod8.oss-cn-hangzhou.aliyuncs.com/1669520556530-expo/default/face/20221127114236530_w3kx2e6t.jpg'."\n", 'title' => ''], ], [ 'name' => 'IdOcrPictureBase64', 'in' => 'formData', 'schema' => ['description' => 'The Base64-encoded document image.'."\n" .'Note:'."\n" .'- If you use this method to pass the document image, check the image size and do not pass an excessively large image.'."\n" .'- Specify either IdOcrPictureBase64 or IdOcrPictureUrl.', 'type' => 'string', 'required' => false, 'example' => 'base64', 'title' => ''], ], [ 'name' => 'FacePictureUrl', 'in' => 'query', 'schema' => ['description' => 'The URL of the face photo.', 'type' => 'string', 'required' => false, 'example' => 'https://digital-face-prod8.oss-cn-hangzhou.aliyuncs.com/1669520556530-expo/default/face/20221127114236530_w3kx2e6t.jpg', 'title' => ''], ], [ 'name' => 'FacePictureBase64', 'in' => 'formData', 'schema' => ['description' => 'The Base64-encoded face image.'."\n" ."\n" .'Note:'."\n" .'- If you use this method to pass the face image, check the image size and do not pass an excessively large image.'."\n" .'- Specify either FacePictureBase64 or FacePictureUrl.', 'type' => 'string', 'required' => false, 'example' => 'Base64', 'title' => ''], ], [ 'name' => 'Crop', 'in' => 'query', 'schema' => ['description' => 'Specifies whether cropping is allowed. By default, cropping is not allowed. Valid values:'."\n" ."\n" .'- T: Cropping is required.'."\n" .'- F: Cropping is not required. This is the default value.', 'type' => 'string', 'required' => false, 'example' => 'F', 'title' => ''], ], [ 'name' => 'Authorize', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable authoritative identity verification. This feature currently applies only to second-generation ID cards issued in the Chinese mainland.', 'type' => 'string', 'required' => false, 'example' => 'T', 'title' => ''], ], [ 'name' => 'IdThreshold', 'in' => 'query', 'schema' => ['description' => 'The custom OCR quality detection threshold mode. Valid values:'."\n" ."\n" .'- 0: system default'."\n" .'- 1: strict mode'."\n" .'- 2: loose mode'."\n" .'- 3 (default): quality detection disabled.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'FaceQualityCheck', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '4EB356FE-BB6A-5DCC-B4C5-E8051787EBA1'], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'TransactionId' => ['description' => 'The unique identifier of the verification request.', 'type' => 'string', 'example' => '4ab0b***cbde97', 'title' => ''], 'SubCode' => ['description' => 'The sub-result code.', 'type' => 'string', 'example' => '205', 'title' => ''], 'Passed' => ['description' => 'Indicates whether the verification is passed. Valid values: T (passed) and F (not passed).', 'type' => 'string', 'example' => 'Y', 'title' => ''], 'ExtFaceInfo' => ['description' => 'The face verification result.', 'type' => 'string', 'example' => '{'."\n" .'"faceAttack": "N",'."\n" .'"faceComparisonScore": 52.57,'."\n" .'"facePassed": "N",'."\n" .'"authorityComparisonScore": 80.39'."\n" .'}'."\n" ."\n", 'title' => ''], 'ExtIdInfo' => ['description' => 'The document recognition result. This field is returned only when the API response is successful.', 'type' => 'string', 'example' => '{'."\n" .' "ocrIdInfo": {'."\n" .' "firstName": "**龙",'."\n" .' "lastName": "**",'."\n" .' "countryCode": "CHN",'."\n" .' "docType": "01560001",'."\n" .' "dateOfBirth": "2002-08-04",'."\n" .' "idNumber": "410************19"'."\n" .' },'."\n" .' "ocrIdPassed": "N",'."\n" .' "spoofInfo": {'."\n" .' "spoofResult": "Y",'."\n" .' }'."\n" .'}'."\n" ."\n", 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Server-side-only identity verification (eKYC_MIN)', 'summary' => 'Provides a server-side-only API for the eKYC solution.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EkycVerify'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:EkycVerify', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB356FE-BB6A-5DCC-B4C5-E8051787EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"4ab0b***cbde97\\",\\n \\"SubCode\\": \\"205\\",\\n \\"Passed\\": \\"Y\\",\\n \\"ExtFaceInfo\\": \\"{\\\\n\\\\\\"faceAttack\\\\\\": \\\\\\"N\\\\\\",\\\\n\\\\\\"faceComparisonScore\\\\\\": 52.57,\\\\n\\\\\\"facePassed\\\\\\": \\\\\\"N\\\\\\",\\\\n\\\\\\"authorityComparisonScore\\\\\\": 80.39\\\\n}\\\\n\\\\n\\",\\n \\"ExtIdInfo\\": \\"{\\\\n \\\\\\"ocrIdInfo\\\\\\": {\\\\n \\\\\\"firstName\\\\\\": \\\\\\"**龙\\\\\\",\\\\n \\\\\\"lastName\\\\\\": \\\\\\"**\\\\\\",\\\\n \\\\\\"countryCode\\\\\\": \\\\\\"CHN\\\\\\",\\\\n \\\\\\"docType\\\\\\": \\\\\\"01560001\\\\\\",\\\\n \\\\\\"dateOfBirth\\\\\\": \\\\\\"2002-08-04\\\\\\",\\\\n \\\\\\"idNumber\\\\\\": \\\\\\"410************19\\\\\\"\\\\n },\\\\n \\\\\\"ocrIdPassed\\\\\\": \\\\\\"N\\\\\\",\\\\n \\\\\\"spoofInfo\\\\\\": {\\\\n \\\\\\"spoofResult\\\\\\": \\\\\\"Y\\\\\\",\\\\n }\\\\n}\\\\n\\\\n\\"\\n }\\n}","type":"json"}]', ], 'EkycVerifyV2' => [ 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '190721', 'abilityTreeNodes' => ['FEATUREcloudauthHJ4WQV'], ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => false, 'example' => 'eKYC_MIN'."\n", 'title' => ''], ], [ 'name' => 'MerchantBizId', 'in' => 'query', 'schema' => ['description' => 'A unique business identifier customized by the merchant, used for subsequent troubleshooting. Supports a combination of letters and digits with a length of 32 characters. Ensure that the value is unique.', 'type' => 'string', 'required' => false, 'example' => 'e0c34a77f5ac40a5aa5e6ed20c353888'."\n", 'title' => ''], ], [ 'name' => 'MerchantUserId', 'in' => 'query', 'schema' => ['description' => 'A custom user ID or other identifier that can identify a specific user, such as a phone number or email address. We strongly recommend that you desensitize the value of this field in advance, for example, by hashing the value.', 'type' => 'string', 'required' => false, 'example' => '123456'."\n", 'title' => ''], ], [ 'name' => 'DocType', 'in' => 'query', 'schema' => ['description' => 'The document type.', 'type' => 'string', 'required' => false, 'example' => '00000001'."\n", 'title' => ''], ], [ 'name' => 'DocName', 'in' => 'query', 'schema' => ['description' => 'The real name of the user. When Authorize=\'T\' and the document type is a mainland China ID card, at least one of the following groups must be provided: document key information (DocName, DocNo) or document image (IdOcrPictureBase64/URL). Note: Supports combinations of Chinese characters with a length of at least 1 character. Special characters are not supported, except for the middle dot (·) used in ethnic minority names.', 'type' => 'string', 'required' => false, 'example' => '张**', 'title' => ''], ], [ 'name' => 'DocNo', 'in' => 'query', 'schema' => ['description' => 'The document number of the user. When Authorize=\'T\' and the document type is a mainland China ID card, at least one of the following groups must be provided: document key information (DocName, DocNo) or document image (IdOcrPictureBase64/URL). Note: Supports a combination of letters and digits with a length of 18 characters.', 'type' => 'string', 'required' => false, 'example' => '410***************'."\n", 'title' => ''], ], [ 'name' => 'IdOcrPictureUrl', 'in' => 'query', 'schema' => ['description' => 'The URL of the front side of the document image.', 'type' => 'string', 'required' => false, 'example' => 'https://digital-cardocr-prod8.oss-cn-hangzhou.aliyuncs.com/1669520556530-expo/default/face/20221127114236530_w3kx2e6t.jpg'."\n", 'title' => ''], ], [ 'name' => 'IdOcrPictureBase64', 'in' => 'formData', 'schema' => ['description' => 'The Base64-encoded document image. Note:'."\n" ."\n" .'- If you use this method to pass the document image, check the photo size and do not pass an overly large photo.'."\n" .'- You can only specify one of IdOcrPictureBase64, IdOcrPictureUrl, and IdOcrPictureFile.', 'type' => 'string', 'required' => false, 'example' => 'base64'."\n", 'title' => ''], ], [ 'name' => 'IdOcrPictureFile', 'in' => 'formData', 'schema' => ['description' => 'The file stream of the front side of the document image.', 'type' => 'string', 'isFileTransferUrl' => true, 'required' => false, 'example' => 'InputStream', 'title' => ''], ], [ 'name' => 'FacePictureUrl', 'in' => 'query', 'schema' => ['description' => 'The URL of the face photo.', 'type' => 'string', 'required' => false, 'example' => 'https://digital-face-prod8.oss-cn-hangzhou.aliyuncs.com/1669520556530-expo/default/face/20221127114236530_w3kx2e6t.jpg', 'title' => ''], ], [ 'name' => 'FacePictureBase64', 'in' => 'formData', 'schema' => ['description' => 'The Base64-encoded face image.'."\n" ."\n" .'Note:'."\n" ."\n" .'- If you use this method to pass the face image, check the photo size and do not pass an overly large photo.'."\n" .'- You can only specify one of FacePictureBase64, FacePictureUrl, and FacePictureFile.', 'type' => 'string', 'required' => false, 'example' => 'Base64'."\n", 'title' => ''], ], [ 'name' => 'FacePictureFile', 'in' => 'formData', 'schema' => ['description' => 'The file stream of the face photo.', 'type' => 'string', 'isFileTransferUrl' => true, 'required' => false, 'example' => 'InputStream', 'title' => ''], ], [ 'name' => 'Crop', 'in' => 'query', 'schema' => ['description' => 'Specifies whether cropping is allowed. Not allowed by default. Valid values: T and F.'."\n" ."\n" .'- T: Cropping is allowed.'."\n" .'- F: Cropping is not allowed. (Default: F)', 'type' => 'string', 'required' => false, 'example' => 'F'."\n", 'title' => ''], ], [ 'name' => 'Authorize', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable authoritative identity verification. Currently, this feature is applicable only to second-generation ID cards of mainland China.', 'type' => 'string', 'required' => false, 'example' => 'T'."\n", 'title' => ''], ], [ 'name' => 'IdThreshold', 'in' => 'query', 'schema' => ['description' => 'The custom OCR quality detection threshold mode:'."\n" ."\n" .'- 0: System default.'."\n" .'- 1: Strict mode.'."\n" .'- 2: Lenient mode.'."\n" .'- 3 (Default): Quality detection is disabled.', 'type' => 'string', 'required' => false, 'example' => '0'."\n", 'title' => ''], ], [ 'name' => 'FaceQualityCheck', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '4EB356FE-BB6A-5DCC-B4C5-E8051787EBA1'."\n"], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => ' '."\n" .'Success'."\n", 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success'."\n", 'title' => ''], 'Result' => [ 'description' => 'The response result.', 'type' => 'object', 'properties' => [ 'TransactionId' => ['description' => 'The unique identifier of the authentication request.', 'type' => 'string', 'example' => '4ab0b***cbde97'."\n", 'title' => ''], 'SubCode' => ['description' => 'The sub-result code.', 'type' => 'string', 'example' => ' '."\n" .'205'."\n", 'title' => ''], 'Passed' => ['description' => 'Indicates whether the verification is passed. Valid values: Y (passed) and N (not passed).', 'type' => 'string', 'example' => 'Y', 'title' => ''], 'ExtFaceInfo' => ['description' => 'The face verification result information.', 'type' => 'string', 'example' => '{'."\n" .'"faceAttack": "N",'."\n" .'"faceComparisonScore": 52.57,'."\n" .'"facePassed": "N",'."\n" .'"authorityComparisonScore": 80.39'."\n" .'}', 'title' => ''], 'ExtIdInfo' => ['description' => 'The document recognition result. This parameter is returned only when the API response is successful.', 'type' => 'string', 'example' => '{'."\n" .' "ocrIdInfo": {'."\n" .' "firstName": "**龙",'."\n" .' "lastName": "**",'."\n" .' "countryCode": "CHN",'."\n" .' "docType": "01560001",'."\n" .' "dateOfBirth": "2002-08-04",'."\n" .' "idNumber": "410************19"'."\n" .' },'."\n" .' "ocrIdPassed": "N",'."\n" .' "spoofInfo": {'."\n" .' "spoofResult": "Y",'."\n" .' }'."\n" .'}', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Server-Side Real Person Authentication (eKYC_MIN)', 'summary' => 'The eKYC solution server-side API.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB356FE-BB6A-5DCC-B4C5-E8051787EBA1\\\\n\\",\\n \\"Code\\": \\"\\\\t\\\\nSuccess\\\\n\\",\\n \\"Message\\": \\"success\\\\n\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"4ab0b***cbde97\\\\n\\",\\n \\"SubCode\\": \\"\\\\t\\\\n205\\\\n\\",\\n \\"Passed\\": \\"Y\\",\\n \\"ExtFaceInfo\\": \\"{\\\\n\\\\\\"faceAttack\\\\\\": \\\\\\"N\\\\\\",\\\\n\\\\\\"faceComparisonScore\\\\\\": 52.57,\\\\n\\\\\\"facePassed\\\\\\": \\\\\\"N\\\\\\",\\\\n\\\\\\"authorityComparisonScore\\\\\\": 80.39\\\\n}\\",\\n \\"ExtIdInfo\\": \\"{\\\\n \\\\\\"ocrIdInfo\\\\\\": {\\\\n \\\\\\"firstName\\\\\\": \\\\\\"**龙\\\\\\",\\\\n \\\\\\"lastName\\\\\\": \\\\\\"**\\\\\\",\\\\n \\\\\\"countryCode\\\\\\": \\\\\\"CHN\\\\\\",\\\\n \\\\\\"docType\\\\\\": \\\\\\"01560001\\\\\\",\\\\n \\\\\\"dateOfBirth\\\\\\": \\\\\\"2002-08-04\\\\\\",\\\\n \\\\\\"idNumber\\\\\\": \\\\\\"410************19\\\\\\"\\\\n },\\\\n \\\\\\"ocrIdPassed\\\\\\": \\\\\\"N\\\\\\",\\\\n \\\\\\"spoofInfo\\\\\\": {\\\\n \\\\\\"spoofResult\\\\\\": \\\\\\"Y\\\\\\",\\\\n }\\\\n}\\"\\n }\\n}","type":"json"}]', ], 'FaceCompare' => [ 'summary' => 'Uses facial recognition technology to compare and verify two input face images, returning the face comparison result and similarity score.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '165986', 'abilityTreeNodes' => ['FEATUREcloudauth0KJCLK'], ], 'parameters' => [ [ 'name' => 'MerchantBizId', 'in' => 'query', 'schema' => ['description' => 'A unique business identifier customized by the merchant, used for subsequent troubleshooting. Supports a combination of letters and numbers with a maximum length of 32 characters. Ensure it is unique.', 'type' => 'string', 'required' => false, 'example' => 'e0c34a77f5ac40a5aa5e6ed20c353888', 'title' => ''], ], [ 'name' => 'SourceFacePicture', 'in' => 'formData', 'schema' => ['description' => 'Base64-encoded face photo.'."\n" ."\n" .'Note'."\n" .'- If you choose this method to pass in the photo, check the photo size and do not pass in an oversized photo.'."\n" .'- Either SourceFacePicture or SourceFacePictureUrl must be specified.', 'type' => 'string', 'required' => false, 'example' => 'base64', 'title' => ''], ], [ 'name' => 'SourceFacePictureUrl', 'in' => 'query', 'schema' => ['description' => 'The HTTPS or HTTP URL of the face image.', 'type' => 'string', 'required' => false, 'example' => 'https://***face1.jpeg', 'title' => ''], ], [ 'name' => 'TargetFacePicture', 'in' => 'formData', 'schema' => ['description' => 'Base64-encoded reference photo.'."\n" ."\n" .'Note'."\n" .'- If you choose this method to pass in the photo, check the photo size and do not pass in an oversized photo.'."\n" .'- Either TargetFacePicture or TargetFacePictureUrl must be specified.', 'type' => 'string', 'required' => false, 'example' => 'base64', 'title' => ''], ], [ 'name' => 'TargetFacePictureUrl', 'in' => 'query', 'schema' => ['description' => 'The HTTPS or HTTP URL of the reference face image.', 'type' => 'string', 'required' => false, 'example' => 'https://***face2.jpeg', 'title' => ''], ], [ 'name' => 'FacePictureQualityCheck', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Whether to enable quality detection for the input face image>Deprecated>', 'type' => 'string', 'example' => 'N', 'required' => false], ], [ 'name' => 'FaceQualityCheck', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Face quality check', 'type' => 'string', 'example' => 'Y', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '4EB356FE-BB6A-5DCC-B4C5-E8051787EBA1'], 'Code' => ['description' => 'Response code.'."\n" ."\n" .'200: Success.'."\n" .'Other: Error code. For error code details, see Error Codes.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'Response result.', 'type' => 'object', 'properties' => [ 'TransactionId' => ['description' => 'The unique identifier of the authentication request.', 'type' => 'string', 'example' => '08573be80f944d95ac812e019e3655a8', 'title' => ''], 'Passed' => ['description' => 'Whether the authentication passed.'."\n" ."\n" .'- Y: Passed.'."\n" .'- N: Not passed.', 'type' => 'string', 'example' => 'Y', 'title' => ''], 'FaceComparisonScore' => ['description' => 'The comparison score between the submitted face photo and the reference face image during the authentication process. Value range: **0** to **100**.', 'type' => 'number', 'format' => 'double', 'example' => '98', 'title' => ''], 'ExtFaceInfo' => [ 'title' => '', 'description' => 'Related result information', 'type' => 'object', 'properties' => [ 'FaceQualityScore' => ['title' => '', 'description' => 'Overall quality score', 'type' => 'number', 'format' => 'double', 'example' => '39.04'], 'OcclusionScore' => ['title' => '', 'description' => 'Occlusion score', 'type' => 'number', 'format' => 'double', 'example' => '50.26'], 'KaOcclusionScore' => ['title' => '', 'description' => 'Key area occlusion score', 'type' => 'number', 'format' => 'double', 'example' => '20'], 'IlluminationScore' => ['title' => '', 'description' => 'Illumination score', 'type' => 'number', 'format' => 'double', 'example' => '0.02'], 'SharpnessScore' => ['title' => '', 'description' => 'Sharpness score', 'type' => 'number', 'format' => 'double', 'example' => '86.47'], 'TargetFaceQualityScore' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], 'TargetOcclusionScore' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], 'TargetSharpnessScore' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], 'TargetKaOcclusionScore' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], 'TargetIlluminationScore' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'FaceCompare', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FaceCompare'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:FaceCompare', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB356FE-BB6A-5DCC-B4C5-E8051787EBA1\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"08573be80f944d95ac812e019e3655a8\\",\\n \\"Passed\\": \\"Y\\",\\n \\"FaceComparisonScore\\": 98,\\n \\"ExtFaceInfo\\": {\\n \\"FaceQualityScore\\": 39.04,\\n \\"OcclusionScore\\": 50.26,\\n \\"KaOcclusionScore\\": 20,\\n \\"IlluminationScore\\": 0.02,\\n \\"SharpnessScore\\": 86.47,\\n \\"TargetFaceQualityScore\\": 0,\\n \\"TargetOcclusionScore\\": 0,\\n \\"TargetSharpnessScore\\": 0,\\n \\"TargetKaOcclusionScore\\": 0,\\n \\"TargetIlluminationScore\\": 0\\n }\\n }\\n}","type":"json"}]', ], 'FaceCompareV2' => [ 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '165986', 'abilityTreeNodes' => ['FEATUREcloudauth0KJCLK'], ], 'parameters' => [ [ 'name' => 'MerchantBizId', 'in' => 'query', 'schema' => ['description' => 'The merchant-defined unique business ID used for subsequent troubleshooting. The value can be a combination of letters and numbers with a maximum length of 32 characters. Ensure that the value is unique.', 'type' => 'string', 'required' => false, 'example' => 'e0c34a77f5ac40a5aa5e6ed20c353888'."\n", 'title' => ''], ], [ 'name' => 'SourceFacePicture', 'in' => 'formData', 'schema' => ['description' => 'The Base64-encoded source face image.'."\n" ."\n" .'> **Note**'."\n" ."\n" .'- If you use this method to pass in the image, check the image size and do not pass in an excessively large image.'."\n" .'- Specify one of the following parameters: SourceFacePicture, SourceFacePictureUrl, or SourceFacePictureFile.', 'type' => 'string', 'required' => false, 'example' => ' '."\n" .'base64'."\n", 'title' => ''], ], [ 'name' => 'SourceFacePictureUrl', 'in' => 'query', 'schema' => ['description' => 'The HTTPS or HTTP URL of the source face image.', 'type' => 'string', 'required' => false, 'example' => 'https://***face1.jpeg'."\n", 'title' => ''], ], [ 'name' => 'SourceFacePictureFile', 'in' => 'formData', 'schema' => ['description' => 'The file stream of the source face image.', 'type' => 'string', 'isFileTransferUrl' => true, 'required' => false, 'example' => 'InputStream', 'title' => ''], ], [ 'name' => 'TargetFacePicture', 'in' => 'formData', 'schema' => ['description' => 'The Base64-encoded reference face image.'."\n" ."\n" .'> **Note**'."\n" ."\n" .'- If you use this method to pass in the image, check the image size and do not pass in an excessively large image.'."\n" .'- Specify one of the following parameters: TargetFacePicture, TargetFacePictureUrl, or TargetFacePictureFile.', 'type' => 'string', 'required' => false, 'example' => 'base64', 'title' => ''], ], [ 'name' => 'TargetFacePictureUrl', 'in' => 'query', 'schema' => ['description' => 'The HTTPS or HTTP URL of the reference face image.', 'type' => 'string', 'required' => false, 'example' => 'https://***face2.jpeg'."\n", 'title' => ''], ], [ 'name' => 'TargetFacePictureFile', 'in' => 'formData', 'schema' => ['description' => 'The file stream of the reference face image.', 'type' => 'string', 'isFileTransferUrl' => true, 'required' => false, 'example' => 'InputStream', 'title' => ''], ], [ 'name' => 'FacePictureQualityCheck', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies whether to enable quality check for the input face images.'."\n" .'>Deprecated..', 'type' => 'string', 'example' => 'N', 'required' => false], ], [ 'name' => 'FaceQualityCheck', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies whether to enable face quality check.', 'type' => 'string', 'example' => 'Y', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '4EB356FE-BB6A-5DCC-B4C5-E8051787EBA1'], 'Code' => ['description' => 'The response code.'."\n" ."\n" .'200: success. Other values: error codes. For more information, see error codes.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'TransactionId' => ['description' => 'The unique ID of the verification request.', 'type' => 'string', 'example' => '08573be80f944d95ac812e019e3655a8'."\n", 'title' => ''], 'Passed' => ['description' => 'Indicates whether the verification is passed. Valid values:'."\n" ."\n" .'- Y: Passed.'."\n" .'- N: Not passed.', 'type' => 'string', 'example' => 'Y', 'title' => ''], 'FaceComparisonScore' => ['description' => 'The comparison score between the submitted face image and the reference face image during the verification process. Valid values: 0 to 100.', 'type' => 'number', 'format' => 'double', 'example' => '98', 'title' => ''], 'ExtFaceInfo' => [ 'title' => '', 'description' => 'The additional result information.', 'type' => 'object', 'properties' => [ 'FaceQualityScore' => ['title' => '', 'description' => 'The overall quality score.', 'type' => 'number', 'format' => 'double', 'example' => '39.04'], 'OcclusionScore' => ['title' => '', 'description' => 'The occlusion score.', 'type' => 'number', 'format' => 'double', 'example' => '50.26'], 'KaOcclusionScore' => ['title' => '', 'description' => 'The key area occlusion score.', 'type' => 'number', 'format' => 'double', 'example' => '20'], 'IlluminationScore' => ['title' => '', 'description' => 'The illumination score.', 'type' => 'number', 'format' => 'double', 'example' => '0.02'], 'SharpnessScore' => ['title' => '', 'description' => 'The sharpness score.', 'type' => 'number', 'format' => 'double', 'example' => '86.47'], 'TargetFaceQualityScore' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], 'TargetOcclusionScore' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], 'TargetSharpnessScore' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], 'TargetKaOcclusionScore' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], 'TargetIlluminationScore' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Face comparison', 'summary' => 'Compares two face images by using face recognition technology and returns the comparison result and a similarity score.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB356FE-BB6A-5DCC-B4C5-E8051787EBA1\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"08573be80f944d95ac812e019e3655a8\\\\n\\",\\n \\"Passed\\": \\"Y\\",\\n \\"FaceComparisonScore\\": 98,\\n \\"ExtFaceInfo\\": {\\n \\"FaceQualityScore\\": 39.04,\\n \\"OcclusionScore\\": 50.26,\\n \\"KaOcclusionScore\\": 20,\\n \\"IlluminationScore\\": 0.02,\\n \\"SharpnessScore\\": 86.47,\\n \\"TargetFaceQualityScore\\": 0,\\n \\"TargetOcclusionScore\\": 0,\\n \\"TargetSharpnessScore\\": 0,\\n \\"TargetKaOcclusionScore\\": 0,\\n \\"TargetIlluminationScore\\": 0\\n }\\n }\\n}","type":"json"}]', ], 'FaceCrossCompareIntl' => [ 'summary' => 'Performs cross-comparison of faces.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREcloudauthHJ4WQV'], ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => ['description' => 'The product solution to use. Valid values:'."\n" .'FACE_CROSS_COMPARE.', 'type' => 'string', 'required' => true, 'example' => ' FACE_CROSS_COMPARE', 'title' => ''], ], [ 'name' => 'SceneCode', 'in' => 'query', 'schema' => ['description' => 'The custom business scenario ID.', 'type' => 'string', 'required' => false, 'example' => '1234567890', 'title' => ''], ], [ 'name' => 'MerchantBizId', 'in' => 'query', 'schema' => ['description' => 'The custom unique business identifier, used for subsequent troubleshooting. The value is a combination of letters and digits with a length of 32 characters. Ensure that the value is unique.', 'type' => 'string', 'required' => true, 'example' => 'e0c34a77f5ac40a5aa5e6ed20c35****', 'title' => ''], ], [ 'name' => 'CompareModel', 'in' => 'query', 'schema' => ['description' => 'The comparison mode. Valid values:'."\n" .'- 0: chain comparison (default). A:B and B:C.'."\n" .'- 1: circular comparison. A:B, B:C, and C:A.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'SourceAFacePicture', 'in' => 'formData', 'schema' => ['description' => 'The Base64-encoded face photo.', 'type' => 'string', 'required' => false, 'example' => 'base64', 'title' => ''], ], [ 'name' => 'SourceAFacePictureUrl', 'in' => 'query', 'schema' => ['description' => 'The URL of the face photo. The URL must be a publicly accessible HTTP or HTTPS link.', 'type' => 'string', 'required' => false, 'example' => 'https://www.xxx.com/1.jpg', 'title' => ''], ], [ 'name' => 'SourceBFacePicture', 'in' => 'formData', 'schema' => ['description' => 'The Base64-encoded face photo.', 'type' => 'string', 'required' => false, 'example' => 'base64'."\n", 'title' => ''], ], [ 'name' => 'SourceBFacePictureUrl', 'in' => 'query', 'schema' => ['description' => 'The URL of the face photo. The URL must be a publicly accessible HTTP or HTTPS link.', 'type' => 'string', 'required' => false, 'example' => 'https://www.xxx.com/1.jpg', 'title' => ''], ], [ 'name' => 'SourceCFacePicture', 'in' => 'formData', 'schema' => ['description' => 'The Base64-encoded face photo.', 'type' => 'string', 'required' => false, 'example' => 'base64'."\n", 'title' => ''], ], [ 'name' => 'SourceCFacePictureUrl', 'in' => 'query', 'schema' => ['description' => 'The URL of the face photo. The URL must be a publicly accessible HTTP or HTTPS link.', 'type' => 'string', 'required' => false, 'example' => 'https://www.xxx.com/1.jpg', 'title' => ''], ], [ 'name' => 'FaceVerifyThreshold', 'in' => 'query', 'schema' => ['description' => 'The face matching threshold. This parameter is reserved by the system and does not support custom values.', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '130A2C10-B9EE-4D84-88E3-5384FF039795'], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The return message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'FacePassed' => ['description' => 'The final verification result. Valid values:'."\n" .'- Y: Passed.'."\n" .'- N: Not passed.', 'type' => 'string', 'example' => 'Y', 'title' => ''], 'FaceComparisonScoreA2B' => ['description' => 'The comparison score between A and B. Value range: 0 to 1.', 'type' => 'number', 'format' => 'double', 'example' => '0.9999999999999999', 'title' => ''], 'FaceComparisonScoreB2C' => ['description' => 'The comparison score between B and C. Value range: 0 to 1.', 'type' => 'number', 'format' => 'double', 'example' => '0.9999999999999999', 'title' => ''], 'FaceComparisonScoreC2A' => ['description' => 'The comparison score between C and A. Value range: 0 to 1.', 'type' => 'number', 'format' => 'double', 'example' => '0.9999999999999999', 'title' => ''], 'TransactionId' => ['description' => 'The unique identifier of the verification request.', 'type' => 'string', 'example' => '4ab0b***cbde97', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Cross-compare faces', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:FaceCrossCompareIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"130A2C10-B9EE-4D84-88E3-5384FF039795\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"FacePassed\\": \\"Y\\",\\n \\"FaceComparisonScoreA2B\\": 0.9999999999999999,\\n \\"FaceComparisonScoreB2C\\": 0.9999999999999999,\\n \\"FaceComparisonScoreC2A\\": 0.9999999999999999,\\n \\"TransactionId\\": \\"4ab0b***cbde97\\"\\n }\\n}","type":"json"}]', ], 'FaceDuplicationCheckIntl' => [ 'summary' => 'Performs face duplication check (FaceDuplicationCheckIntl) for scenarios where SDK integration is not feasible. Submits face images through the API to verify whether a user is a real person, compare the face against a stored face image for identity verification, search a face library to determine whether the face already exists, and automatically register the face in a specified face library after successful verification.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREcloudauthHJ4WQV'], ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => true, 'example' => 'FACE_IDU_MIN', 'title' => ''], ], [ 'name' => 'SceneCode', 'in' => 'formData', 'schema' => ['description' => 'The custom verification scenario ID.', 'type' => 'string', 'required' => false, 'example' => '1234567890', 'title' => ''], ], [ 'name' => 'MerchantBizId', 'in' => 'formData', 'schema' => ['description' => 'The custom unique business identifier used for subsequent troubleshooting. The value is a combination of letters and digits up to 32 characters in length. Ensure that the value is unique.', 'type' => 'string', 'required' => true, 'example' => 'e0c34a77f5ac40a5aa5e6ed20c35****', 'title' => ''], ], [ 'name' => 'MerchantUserId', 'in' => 'formData', 'schema' => ['description' => 'The custom user ID or another identifier that can identify a specific user, such as a phone number or email address. We strongly recommend that you desensitize this field value in advance, for example, by hashing the value.', 'type' => 'string', 'required' => true, 'example' => '1234567890', 'title' => ''], ], [ 'name' => 'VerifyModel', 'in' => 'formData', 'schema' => ['description' => 'The verification type. Valid values:'."\n" .'- 0: retrieve pattern'."\n" .'> - Feature: Submits a face library and a user face image (sourceFacePicture). The system automatically retrieves the face library to determine whether the specified face image (sourceFacePicture) already exists. Passive liveness detection can be enabled for the face image (sourceFacePicture).'."\n" .'> - Recommended scenario: Real-person create an account where duplicate registration is not allowed.'."\n" ."\n" .'- 1 (default): authenticate pattern'."\n" .'> - Feature: Submits a specified face image (sourceFacePicture) and a stored face image (TargetFacePicture). The system automatically authenticates whether the two faces match. Passive liveness detection can be enabled for the specified face image (sourceFacePicture).'."\n" .'> - Recommended scenario: Authenticating the identity of the operator when modifying logon credentials or account information.'."\n" ."\n" .'- 2: comprehensive pattern'."\n" .'> - Feature: Submits a face library, a specified face image (sourceFacePicture), and a stored face image (TargetFacePicture). The system automatically retrieves the face library to determine whether the specified face image (sourceFacePicture) exists, authenticates whether it matches the stored face, and supports passive liveness detection for the specified face image (sourceFacePicture).'."\n" .'> - Recommended scenario: Verifying that the user is new and the operation is performed by the user in person.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'Liveness', 'in' => 'formData', 'schema' => ['description' => 'Specifies whether to enable passive liveness detection. Valid values:'."\n" .'- 0: disabled'."\n" .'- 1: enabled', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'FaceGroupCodes', 'in' => 'formData', 'schema' => ['description' => 'The face library codes created through the console. A maximum of 10 face libraries can be queried at the same time. Separate multiple face library codes with commas (,).', 'type' => 'string', 'required' => false, 'example' => '1232344，23444', 'title' => ''], ], [ 'name' => 'SourceFacePicture', 'in' => 'formData', 'schema' => ['description' => 'The Base64-encoded face image.', 'type' => 'string', 'required' => false, 'example' => 'base64', 'title' => ''], ], [ 'name' => 'SourceFacePictureUrl', 'in' => 'formData', 'schema' => ['description' => 'The URL of the face image. The URL must be a publicly accessible HTTP or HTTPS link.', 'type' => 'string', 'required' => false, 'example' => 'https://***face1.jpeg', 'title' => ''], ], [ 'name' => 'TargetFacePicture', 'in' => 'formData', 'schema' => ['description' => 'The Base64-encoded face image.', 'type' => 'string', 'required' => false, 'example' => 'base64', 'title' => ''], ], [ 'name' => 'TargetFacePictureUrl', 'in' => 'formData', 'schema' => ['description' => 'The URL of the face image. The URL must be a publicly accessible HTTP or HTTPS link.', 'type' => 'string', 'required' => false, 'example' => 'https://***face2.jpeg', 'title' => ''], ], [ 'name' => 'AutoRegistration', 'in' => 'formData', 'schema' => ['description' => 'Specifies whether to automatically register the face in the specified face library when no duplicate face is found during the search. Valid values:'."\n" .'- 0: automatic registration'."\n" .'- 1: no registration (default)', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'FaceRegisterGroupCode', 'in' => 'formData', 'schema' => ['description' => 'The face library for registration.', 'type' => 'string', 'required' => false, 'example' => '0e0c34a77f', 'title' => ''], ], [ 'name' => 'SaveFacePicture', 'in' => 'formData', 'schema' => ['description' => 'The type of face data to save. Valid values:'."\n" .'- 0: face image (default)'."\n" .'- 1: feature'."\n" .'>This is a reserved field and is not currently enabled.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'FaceVerifyThreshold', 'in' => 'formData', 'schema' => ['description' => 'The face matching threshold. >This is a reserved field and is not currently enabled.', 'type' => 'string', 'required' => false, 'example' => '0.5', 'title' => ''], ], [ 'name' => 'ReturnFaces', 'in' => 'formData', 'schema' => ['description' => 'The number of faces to return when multiple faces above the matching threshold are found. You can use this parameter to customize the number of returned faces.'."\n" .'- Default value: 1.'."\n" .'- Maximum value: 5.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'FaceQualityCheck', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The face quality check.', 'type' => 'string', 'example' => 'Y', 'required' => false], ], [ 'name' => 'FaceAttributeCheck', 'in' => 'formData', 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5E63B760-0ECB-5C07-8503-A65C27876968'], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'FacePassed' => ['description' => 'The final verification result. Valid values:'."\n" .'- Y: Passed.'."\n" .'- N: Not passed.', 'type' => 'string', 'example' => 'Y', 'title' => ''], 'FaceComparisonScore' => ['description' => 'The 1:1 face comparison score returned when the verification mode is 1 or 2. The value ranges from 0 to 100.', 'type' => 'string', 'example' => '98', 'title' => ''], 'DuplicateFace' => ['description' => 'The face ID and UserID retrieved from the face library when a duplicate face is detected.', 'type' => 'string', 'example' => '['."\n" .' {'."\n" .' "faceGroupCode": "sg7****uzt",'."\n" .' "faceId": "f5a921*******9e792ec84c8f0ca592a",'."\n" .' "merchantUserId": "fa****01"'."\n" .' }'."\n" .']', 'title' => ''], 'FaceRegistrationResult' => ['description' => 'The face registration result. Valid values: '."\n" .'- 0: Failed. '."\n" .'- 1: Succeeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'FaceRegistrationId' => ['description' => 'The FACEID returned only when automatic registration is enabled and the face is successfully registered.', 'type' => 'string', 'example' => '9e792ec84c8f0ca592a', 'title' => ''], 'FaceAttack' => ['description' => 'Indicates whether the captured face involves a liveness attack. Valid values:'."\n" .'- Y: Attack detected.'."\n" .'- N: No attack detected.'."\n" ."\n" .'This field is returned only when passive liveness detection is enabled.', 'type' => 'string', 'example' => 'N', 'title' => ''], 'FaceAttackScore' => ['description' => 'The probability of a passive liveness detection attack on the face. The value ranges from 0 to 100. This field is returned only when passive liveness detection is enabled.', 'type' => 'string', 'example' => '99', 'title' => ''], 'FaceAge' => ['description' => 'The estimated age of the face. This value may not be returned if the prediction fails.', 'type' => 'string', 'example' => '30', 'title' => ''], 'FaceGender' => ['description' => 'The predicted gender of the face. This value may not be returned if the prediction fails. Valid values:'."\n" .'- M: male'."\n" .'- F: female', 'type' => 'string', 'example' => 'M', 'title' => ''], 'SubCode' => ['description' => 'The verification result description. For more information, see the ResultObject.SubCode error code description.', 'type' => 'string', 'example' => '200', 'title' => ''], 'TransactionId' => ['description' => 'The unique identifier of the verification request.', 'type' => 'string', 'example' => '4ab0b***cbde97', 'title' => ''], 'ExtFaceInfo' => [ 'title' => '', 'description' => 'The related result information.', 'type' => 'object', 'properties' => [ 'FaceQualityScore' => ['title' => '', 'description' => 'The overall quality score.', 'type' => 'number', 'format' => 'double', 'example' => '39.04'], 'OcclusionScore' => ['title' => '', 'description' => 'The occlusion score.', 'type' => 'number', 'format' => 'double', 'example' => '50.26'], 'KaOcclusionScore' => ['title' => '', 'description' => 'The key area occlusion score.', 'type' => 'number', 'format' => 'double', 'example' => '20'], 'IlluminationScore' => ['title' => '', 'description' => 'The illumination score.', 'type' => 'number', 'format' => 'double', 'example' => '0.02'], 'SharpnessScore' => ['title' => '', 'description' => 'The sharpness score.', 'type' => 'number', 'format' => 'double', 'example' => '86.47'], 'TargetFaceQualityScore' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], 'TargetOcclusionScore' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], 'TargetKaOcclusionScore' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], 'TargetIlluminationScore' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], 'TargetSharpnessScore' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], 'FaceAttributeInfo' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Server-side liveness and face duplication check (FACE_IDU_MIN)', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:FaceDuplicationCheckIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5E63B760-0ECB-5C07-8503-A65C27876968\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"FacePassed\\": \\"Y\\",\\n \\"FaceComparisonScore\\": \\"98\\",\\n \\"DuplicateFace\\": \\"[\\\\n {\\\\n \\\\\\"faceGroupCode\\\\\\": \\\\\\"sg7****uzt\\\\\\",\\\\n \\\\\\"faceId\\\\\\": \\\\\\"f5a921*******9e792ec84c8f0ca592a\\\\\\",\\\\n \\\\\\"merchantUserId\\\\\\": \\\\\\"fa****01\\\\\\"\\\\n }\\\\n]\\",\\n \\"FaceRegistrationResult\\": 0,\\n \\"FaceRegistrationId\\": \\"9e792ec84c8f0ca592a\\",\\n \\"FaceAttack\\": \\"N\\",\\n \\"FaceAttackScore\\": \\"99\\",\\n \\"FaceAge\\": \\"30\\",\\n \\"FaceGender\\": \\"M\\",\\n \\"SubCode\\": \\"200\\",\\n \\"TransactionId\\": \\"4ab0b***cbde97\\",\\n \\"ExtFaceInfo\\": {\\n \\"FaceQualityScore\\": 39.04,\\n \\"OcclusionScore\\": 50.26,\\n \\"KaOcclusionScore\\": 20,\\n \\"IlluminationScore\\": 0.02,\\n \\"SharpnessScore\\": 86.47,\\n \\"TargetFaceQualityScore\\": 0,\\n \\"TargetOcclusionScore\\": 0,\\n \\"TargetKaOcclusionScore\\": 0,\\n \\"TargetIlluminationScore\\": 0,\\n \\"TargetSharpnessScore\\": 0,\\n \\"FaceAttributeInfo\\": \\"\\"\\n }\\n }\\n}","type":"json"}]', ], 'FaceGuardRisk' => [ 'summary' => 'Server-side API for the international Face Guard service.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '253422', 'abilityTreeNodes' => ['FEATUREcloudauthCS0SDG'], ], 'parameters' => [ [ 'name' => 'DeviceToken', 'in' => 'query', 'schema' => ['description' => 'The device token obtained from the Face Guard SDK.', 'type' => 'string', 'required' => false, 'example' => 'Tk9SSUQuMS*****************ZDNmNWY5NzQxOW1o', 'title' => ''], ], [ 'name' => 'MerchantBizId', 'in' => 'query', 'schema' => ['description' => 'The merchant-defined unique business identifier, used for subsequent troubleshooting. The value can contain letters and digits with a maximum length of 32 characters. Make sure the value is unique.', 'type' => 'string', 'required' => false, 'example' => '0c83ce0101d34eff886b1f7d1cdef67f', 'title' => ''], ], [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => ['description' => 'The product code. Set the value to FACE_GUARD.', 'type' => 'string', 'required' => false, 'example' => 'FACE_GUARD', 'title' => ''], ], [ 'name' => 'BizId', 'in' => 'query', 'schema' => ['description' => 'The customer business ID.', 'type' => 'string', 'required' => false, 'example' => 'LMALL20******001', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '595E387B-3F0E-5C52-BD02-8EFE63D41FD5'], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The return message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'RiskTags' => ['description' => 'The device risk tags.'."\n" ."\n" .'- Multiple device risk tags are separated by commas (,), such as "ROOT,VPN,HOOK".'."\n" ."\n" .'- For more information about device risk tags and their meanings, refer to the Face Guard tag description in the official documentation.', 'type' => 'string', 'example' => 'ROOT,VPN,HOOK', 'title' => ''], 'RiskExtends' => ['description' => 'The extended information in JSON format. The response is customized based on tenant requirements.', 'type' => 'string', 'example' => '默认为空', 'title' => ''], 'TransactionId' => ['description' => 'The unique identifier of the authentication request.', 'type' => 'string', 'example' => 'hk573be80f944d95ac812e019e3655a8', 'title' => ''], 'GuardRiskScore' => ['description' => 'The device risk probability predicted by the Face Guard algorithm. A higher score indicates a higher device risk.'."\n" ."\n" .'Value range: 0 to 100.', 'type' => 'number', 'format' => 'double', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Device assistant', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FaceGuardRisk'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:FaceGuardRisk', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"595E387B-3F0E-5C52-BD02-8EFE63D41FD5\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"RiskTags\\": \\"ROOT,VPN,HOOK\\",\\n \\"RiskExtends\\": \\"默认为空\\",\\n \\"TransactionId\\": \\"hk573be80f944d95ac812e019e3655a8\\",\\n \\"GuardRiskScore\\": 0\\n }\\n}","type":"json"}]', ], 'FaceLiveness' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '175619', 'abilityTreeNodes' => ['FEATUREcloudauthHJ4WQV'], ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => false, 'example' => 'FACE_LIVENESS_MIN', 'title' => ''], ], [ 'name' => 'MerchantBizId', 'in' => 'query', 'schema' => ['description' => 'The merchant-defined unique business ID used for subsequent troubleshooting. The value can contain letters and digits with a maximum length of 32 characters. Ensure that the value is unique.', 'type' => 'string', 'required' => false, 'example' => 'e0c34a77f5ac40a5aa5e6ed20c353888', 'title' => ''], ], [ 'name' => 'MerchantUserId', 'in' => 'query', 'schema' => ['description' => 'The merchant user ID or another identifier that can be used to identify a specific user, such as a phone number or email address. We strongly recommend that you desensitize the value of the userId field before passing it in, for example, by hashing the value.', 'type' => 'string', 'required' => false, 'example' => '123456789', 'title' => ''], ], [ 'name' => 'FacePictureUrl', 'in' => 'query', 'schema' => ['description' => 'The URL of the face photo.', 'type' => 'string', 'required' => false, 'example' => 'https://digital-face-prod8.oss-cn-hangzhou.aliyuncs.com/1669520556530-expo/default/face/20221127114236530_w3kx2e6t.jpg', 'title' => ''], ], [ 'name' => 'FacePictureBase64', 'in' => 'formData', 'schema' => ['description' => 'The Base64-encoded face photo.'."\n" ."\n" .'Note:'."\n" .'- If you use FacePictureBase64 (Base64-encoded photo) to pass in the face photo, check the photo size and do not pass in an excessively large photo.', 'type' => 'string', 'required' => false, 'example' => 'Base64', 'title' => ''], ], [ 'name' => 'FaceQuality', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to output the face quality score. Default value: F. Valid values:'."\n" .'- T: enabled.'."\n" .'- F: disabled. (Default)', 'type' => 'string', 'required' => false, 'example' => 'T', 'title' => ''], ], [ 'name' => 'Crop', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to allow cropping. Default value: F. Valid values:'."\n" ."\n" .'- T: enabled.'."\n" .'- F: disabled. (Default)', 'type' => 'string', 'required' => false, 'example' => 'T', 'title' => ''], ], [ 'name' => 'Occlusion', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to perform occlusion detection. Default value: F. Valid values:'."\n" ."\n" .'- T: enabled.'."\n" .'- F: disabled. (Default)', 'type' => 'string', 'required' => false, 'example' => 'T', 'title' => ''], ], [ 'name' => 'FaceQualityCheck', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The face quality check.', 'type' => 'string', 'example' => 'Y', 'required' => false], ], [ 'name' => 'FaceAttributeCheck', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The unique ID that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => '42EA58CA-5DF4-55D5-82C4-5E7A40DA62BA'], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The description of the return result.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'TransactionId' => ['description' => 'The unique ID of the authentication request.', 'type' => 'string', 'example' => '08573be80f944d95ac812e019e3655a8', 'title' => ''], 'Passed' => ['description' => 'Indicates whether the authentication passed. Valid values:'."\n" ."\n" .'- Y: passed.'."\n" .'- N: not passed.', 'type' => 'string', 'example' => 'N', 'title' => ''], 'SubCode' => ['description' => 'The sub-result code.', 'type' => 'string', 'example' => '205', 'title' => ''], 'ExtFaceInfo' => [ 'description' => 'The face result information.', 'type' => 'object', 'properties' => [ 'FaceQualityScore' => ['description' => 'The face quality score (0 to 100). This value is returned only when the face quality score switch is enabled in the request parameters.', 'type' => 'number', 'format' => 'double', 'example' => '87.19', 'title' => ''], 'OcclusionResult' => ['description' => 'The occlusion detection result. Valid values: Y (occluded) and N (not occluded). This value is returned only when the occlusion detection switch is enabled in the request parameters.', 'type' => 'string', 'example' => 'Y', 'title' => ''], 'FaceAttack' => ['description' => 'The liveness detection result. Valid values: Y (attack detected) and N (normal).', 'type' => 'string', 'example' => 'Y', 'title' => ''], 'FaceGender' => ['description' => 'The predicted gender based on the face image. The prediction may fail, in which case no value is returned. Valid values:'."\n" ."\n" .'- M: male.'."\n" .'- F: female.', 'type' => 'string', 'example' => 'M', 'title' => ''], 'FaceAge' => ['description' => 'The predicted reference age based on the face image. The prediction may fail, in which case no value is returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '18', 'title' => ''], 'OcclusionScore' => ['title' => '', 'description' => 'The occlusion score.', 'type' => 'number', 'format' => 'double', 'example' => '50.26'], 'KaOcclusionScore' => ['title' => '', 'description' => 'The key area occlusion score.', 'type' => 'number', 'format' => 'double', 'example' => '20'], 'IlluminationScore' => ['title' => '', 'description' => 'The illumination score.', 'type' => 'number', 'format' => 'double', 'example' => '0.02'], 'SharpnessScore' => ['title' => '', 'description' => 'The sharpness score.', 'type' => 'number', 'format' => 'double', 'example' => '86.47'], 'FaceAttributeInfo' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Passive liveness detection (FACE_LIVENESS_MIN)', 'summary' => 'Provides the server-side API for passive liveness detection.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FaceLiveness'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:FaceLiveness', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42EA58CA-5DF4-55D5-82C4-5E7A40DA62BA\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"08573be80f944d95ac812e019e3655a8\\",\\n \\"Passed\\": \\"N\\",\\n \\"SubCode\\": \\"205\\",\\n \\"ExtFaceInfo\\": {\\n \\"FaceQualityScore\\": 87.19,\\n \\"OcclusionResult\\": \\"Y\\",\\n \\"FaceAttack\\": \\"Y\\",\\n \\"FaceGender\\": \\"M\\",\\n \\"FaceAge\\": 18,\\n \\"OcclusionScore\\": 50.26,\\n \\"KaOcclusionScore\\": 20,\\n \\"IlluminationScore\\": 0.02,\\n \\"SharpnessScore\\": 86.47,\\n \\"FaceAttributeInfo\\": \\"\\"\\n }\\n }\\n}","type":"json"}]', ], 'FaceLivenessV2' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREcloudauthHJ4WQV'], ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => [ 'description' => 'The product plan to use. Valid values: FACE_LIVENESS_MIN_PRO and FACE_LIVENESS_MIN.', 'enumValueTitles' => ['FACE_LIVENESS_MIN' => 'FACE_LIVENESS_MIN', 'FACE_LIVENESS_MIN_PRO' => 'FACE_LIVENESS_MIN_PRO'], 'type' => 'string', 'required' => true, 'example' => 'FACE_LIVENESS_MIN_PRO', 'title' => '', ], ], [ 'name' => 'MerchantBizId', 'in' => 'query', 'schema' => ['description' => 'The merchant-defined unique business ID for subsequent troubleshooting. The value can be a combination of letters and digits with a maximum length of 32 characters. Make sure the value is unique.', 'type' => 'string', 'required' => false, 'example' => 'e0c34a***353888', 'title' => ''], ], [ 'name' => 'MerchantUserId', 'in' => 'query', 'schema' => ['description' => 'The custom user ID or another identifier that can identify a specific user, such as a phone number or email address. We strongly recommend that you desensitize the value of this field in advance, for example, by hashing the value.', 'type' => 'string', 'required' => false, 'example' => '123456789', 'title' => ''], ], [ 'name' => 'FacePictureBase64', 'in' => 'formData', 'schema' => ['description' => 'The Base64-encoded face image.'."\n" ."\n" .'> **Note**'."\n" ."\n" .'- If you use this method to pass in the image, check the image size and do not pass in an excessively large image.'."\n" .'- Specify one of the following parameters: FacePictureBase64, FacePictureUrl, or FacePictureFile.', 'type' => 'string', 'required' => false, 'example' => 'Base64', 'title' => ''], ], [ 'name' => 'FacePictureUrl', 'in' => 'query', 'schema' => ['description' => 'The URL of the face image. The URL must be a publicly accessible HTTPS URL.', 'type' => 'string', 'required' => false, 'example' => 'https://***', 'title' => ''], ], [ 'name' => 'FacePictureFile', 'in' => 'query', 'schema' => ['description' => 'The file stream of the face image.', 'type' => 'string', 'isFileTransferUrl' => true, 'required' => false, 'example' => 'InputStream', 'title' => ''], ], [ 'name' => 'FaceQualityCheck', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to check the quality of the face image. Valid values:'."\n" .'- Y: enabled.'."\n" .'- N: disabled. This is the default value.', 'type' => 'string', 'required' => false, 'example' => 'Y', 'title' => ''], ], [ 'name' => 'FaceAttributeCheck', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5E63B760-0ECB-5C07-8503-A65C27876968'], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'TransactionId' => ['description' => 'The unique ID of the authentication request.', 'type' => 'string', 'example' => 'hksb7ba1b28130d24e015d694361****', 'title' => ''], 'Passed' => ['description' => 'Indicates whether the authentication is passed. Valid values:'."\n" ."\n" .'- Y: Passed.'."\n" .'- N: Not passed.', 'type' => 'string', 'example' => 'Y', 'title' => ''], 'SubCode' => ['description' => 'The sub-result code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'ExtFaceInfo' => [ 'description' => 'The face result information.', 'type' => 'object', 'properties' => [ 'FaceQualityScore' => ['description' => 'The quality score of the liveness face. Valid values: 0 to 100. A higher value indicates better quality.', 'type' => 'number', 'format' => 'double', 'example' => '79.04', 'title' => ''], 'OcclusionResult' => ['description' => 'Indicates whether facial occlusion is detected. A value of Y indicates occlusion is detected. A value of N indicates no occlusion is detected.', 'type' => 'string', 'example' => 'Y', 'title' => ''], 'FaceAttack' => ['description' => 'The liveness detection result. Valid values: Y (attack detected) and N (Normal).', 'type' => 'string', 'example' => 'Y', 'title' => ''], 'FaceGender' => ['description' => 'The predicted gender of the face image. The prediction may fail and return no value. Valid values:'."\n" ."\n" .'- M: male.'."\n" .'- F: female.', 'type' => 'string', 'example' => 'M', 'title' => ''], 'FaceAge' => ['description' => 'The predicted reference age of the face. The prediction may fail and return no value.', 'type' => 'integer', 'format' => 'int64', 'example' => '18', 'title' => ''], 'OcclusionScore' => ['description' => 'The algorithm score for occlusion, which is a sub-dimension of quality assessment. Valid values: 0 to 100. A higher value indicates better quality.', 'type' => 'number', 'format' => 'double', 'example' => '50.26', 'title' => ''], 'KaOcclusionScore' => ['description' => 'The algorithm score for key area occlusion, which is a sub-dimension of quality assessment. Valid values: 0 to 100. A higher value indicates better quality.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], 'IlluminationScore' => ['description' => 'The algorithm score for illumination, which is a sub-dimension of quality assessment. Valid values: 0 to 100. A higher value indicates better quality.', 'type' => 'number', 'format' => 'double', 'example' => '97.43', 'title' => ''], 'SharpnessScore' => ['description' => 'The image sharpness score, which is a sub-dimension of quality assessment. Valid values: 0 to 100. A higher value indicates better quality.', 'type' => 'number', 'format' => 'double', 'example' => '60.78', 'title' => ''], 'FaceAttributeInfo' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Face liveness detection', 'summary' => 'Detects whether a face in an image is from a real person by using the API operation. This service combines the Qwen-VL large model for in-depth forgery risk detection to determine face liveness.', 'description' => 'Calls the FaceLivenessV2 operation to perform liveness detection on a face image.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5E63B760-0ECB-5C07-8503-A65C27876968\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"hksb7ba1b28130d24e015d694361****\\",\\n \\"Passed\\": \\"Y\\",\\n \\"SubCode\\": \\"200\\",\\n \\"ExtFaceInfo\\": {\\n \\"FaceQualityScore\\": 79.04,\\n \\"OcclusionResult\\": \\"Y\\",\\n \\"FaceAttack\\": \\"Y\\",\\n \\"FaceGender\\": \\"M\\",\\n \\"FaceAge\\": 18,\\n \\"OcclusionScore\\": 50.26,\\n \\"KaOcclusionScore\\": 100,\\n \\"IlluminationScore\\": 97.43,\\n \\"SharpnessScore\\": 60.78,\\n \\"FaceAttributeInfo\\": \\"\\"\\n }\\n }\\n}","type":"json"}]', ], 'FaceVerifyIntl' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREcloudauthHJ4WQV'], ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => [ 'description' => 'The product code. Valid values: FACE_VERIFY_MIN and FACE_IDU_MIN.', 'enumValueTitles' => ['FACE_IDU_MIN' => 'FACE_IDU_MIN', 'FACE_VERIFY_MIN' => 'FACE_VERIFY_MIN'], 'type' => 'string', 'required' => true, 'example' => 'FACE_VERIFY_MIN', 'title' => '', ], ], [ 'name' => 'MerchantUserId', 'in' => 'query', 'schema' => ['description' => 'A custom user ID or other identifier that can identify a specific user, such as a phone number or email address. We strongly recommend that you desensitize the value of this field in advance, such as by hashing the value.', 'type' => 'string', 'required' => false, 'example' => '123456789', 'title' => ''], ], [ 'name' => 'MerchantBizId', 'in' => 'query', 'schema' => ['description' => 'A custom unique business identifier used for subsequent troubleshooting. The value supports a combination of letters and digits up to 32 characters in length. Make sure the value is unique.', 'type' => 'string', 'required' => false, 'example' => 'e0c34a77f5ac40a5aa5e6ed20c35****', 'title' => ''], ], [ 'name' => 'FaceQualityCheck', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to check the quality of the face image. Valid values:'."\n" .'- Y: Enabled.'."\n" .'- N: Disabled. This is the default value.', 'type' => 'string', 'required' => false, 'example' => 'Y', 'title' => ''], ], [ 'name' => 'TargetFacePicture', 'in' => 'formData', 'schema' => ['description' => 'The Base64-encoded reference face image.'."\n" ."\n" .'> **Note**'."\n" .'>'."\n" .'> - If you use this method to pass in the image, check the image size and do not pass in an excessively large image.'."\n" .'> - Specify one of the following parameters: TargetFacePicture, TargetFacePictureUrl, or TargetFacePictureFile.', 'type' => 'string', 'required' => false, 'example' => 'base64', 'title' => ''], ], [ 'name' => 'TargetFacePictureUrl', 'in' => 'query', 'schema' => ['description' => 'The HTTPS URL of the reference face image.', 'type' => 'string', 'required' => false, 'example' => 'https://***face2.jpeg', 'title' => ''], ], [ 'name' => 'TargetFacePictureFile', 'in' => 'query', 'schema' => ['description' => 'The file stream of the reference face image.', 'type' => 'string', 'isFileTransferUrl' => true, 'required' => false, 'example' => 'InputStream', 'title' => ''], ], [ 'name' => 'SourceFacePicture', 'in' => 'formData', 'schema' => ['description' => 'The Base64-encoded portrait image.'."\n" ."\n" .'> **Note**'."\n" .'>'."\n" .'> - If you use this method to pass in the image, check the image size and do not pass in an excessively large image.'."\n" .'> - Specify one of the following parameters: SourceFacePicture, SourceFacePictureUrl, or SourceFacePictureFile.', 'type' => 'string', 'required' => false, 'example' => ' '."\n" .'base64'."\n", 'title' => ''], ], [ 'name' => 'SourceFacePictureUrl', 'in' => 'query', 'schema' => ['description' => 'The publicly accessible HTTPS URL of the portrait image.', 'type' => 'string', 'required' => false, 'example' => 'https://***face1.jpeg', 'title' => ''], ], [ 'name' => 'SourceFacePictureFile', 'in' => 'query', 'schema' => ['description' => 'The file stream of the face image.', 'type' => 'string', 'isFileTransferUrl' => true, 'required' => false, 'example' => 'InputStream', 'title' => ''], ], [ 'name' => 'VerifyModel', 'in' => 'query', 'schema' => ['description' => 'Required when ProductCode is set to FACE_IDU_MIN. The verification type. Valid values:'."\n" ."\n" .'- 0: retrieve pattern'."\n" .'> - Feature: Pass in a face library and a user face image (sourceFacePicture). The system automatically retrieves the face library to check whether the specified face image (sourceFacePicture) already exists. Passive liveness detection can be enabled for the face image (sourceFacePicture).'."\n" .'> - Recommended scenario: Real-person create an account where duplicate registration is not allowed.'."\n" ."\n" .'- 1 (default): authenticate pattern'."\n" .'> - Feature: Pass in a specified face image (sourceFacePicture) and a reference face image (TargetFacePicture). The system automatically authenticates whether the faces match. Passive liveness detection can be enabled for the specified face image (sourceFacePicture).'."\n" .'> - Recommended scenario: Authenticating the identity of the user when modifying logon credentials or account information.'."\n" ."\n" .'- 2: comprehensive pattern'."\n" .'> - Feature: Pass in a face library, a specified face image (sourceFacePicture), and a reference face image (TargetFacePicture). The system automatically retrieves the face library to check whether the specified face image (sourceFacePicture) exists, authenticates whether it matches the reference face, and supports enabling passive liveness detection for the specified face image (sourceFacePicture).'."\n" .'> - Recommended scenario: Authenticating that the user is a new user and the operation is performed by the user in person.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'FaceGroupCodes', 'in' => 'query', 'schema' => ['description' => 'Required when ProductCode is set to FACE_IDU_MIN.'."\n" ."\n" .'The face library codes created by the customer through the console. A maximum of 10 face libraries can be queried at the same time. Separate multiple face library codes with commas (,).', 'type' => 'string', 'required' => false, 'example' => '1232344，23444', 'title' => ''], ], [ 'name' => 'AutoRegistration', 'in' => 'query', 'schema' => ['description' => 'Required when ProductCode is set to FACE_IDU_MIN.'."\n" ."\n" .'Specifies whether to automatically register the face to the specified face library when no duplicate face is found during retrieval. Valid values:'."\n" .'- 0: Automatic registration.'."\n" .'- 1: No registration. This is the default value.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'FaceRegisterGroupCode', 'in' => 'query', 'schema' => ['description' => 'Required when ProductCode is set to FACE_IDU_MIN.'."\n" ."\n" .'The code of the face library for registration.', 'type' => 'string', 'required' => false, 'example' => '0e0c34a77f', 'title' => ''], ], [ 'name' => 'ReturnFaces', 'in' => 'query', 'schema' => ['description' => 'Required when ProductCode is set to FACE_IDU_MIN.'."\n" ."\n" .'Specifies the number of faces to return when multiple faces exist above the matching threshold. Default value: 1. Maximum value: 5.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'FaceAttributeCheck', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5E63B760-0ECB-5C07-8503-A65C27876968'], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The return message.', 'type' => 'string', 'example' => 'success'."\n", 'title' => ''], 'Result' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'TransactionId' => ['description' => 'The unique identifier of the verification request.', 'type' => 'string', 'example' => '4ab0b***cbde97', 'title' => ''], 'SubCode' => ['description' => 'The sub-result code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'FacePassed' => ['description' => 'The final verification result. Valid values:'."\n" .'- Y: Passed.'."\n" .'- N: Not passed.', 'type' => 'string', 'example' => 'Y', 'title' => ''], 'FaceComparisonScore' => ['description' => 'The comparison score between the face image submitted during verification and the reference face image. Value range: 0 to 100.', 'type' => 'number', 'format' => 'double', 'example' => '95.0', 'title' => ''], 'DuplicateFace' => ['description' => 'The face ID, user ID, and comparison score of the corresponding face in the face library when a duplicate face is found during retrieval.', 'type' => 'string', 'example' => '['."\n" .' {'."\n" .' "faceGroupCode": "sg7****uzt",'."\n" .' "faceId": "f5a921*******9e792ec84c8f0ca592a",'."\n" .' "merchantUserId": "fa****01"'."\n" .' }'."\n" .']', 'title' => ''], 'FaceRegistrationResult' => ['description' => 'The face registration result. Valid values: '."\n" .'- 0: Failed. '."\n" .'- 1: Succeeded.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'FaceRegistrationId' => ['description' => 'The face ID returned only when the customer has enabled automatic registration and the face is registered successfully.', 'type' => 'string', 'example' => '9e792ec84c8f0ca592a', 'title' => ''], 'FaceAttack' => ['description' => 'Indicates whether the captured face involves a liveness attack. Valid values:'."\n" .'- Y: Attack detected.'."\n" .'- N: No attack detected.'."\n" ."\n" .'This field is returned only when passive liveness detection is enabled.', 'type' => 'string', 'example' => 'N', 'title' => ''], 'FaceAttackScore' => ['description' => 'The probability of a passive liveness detection attack on the face. Value range: 0 to 100. This field is returned only when passive liveness detection is enabled.', 'type' => 'number', 'format' => 'double', 'example' => '99', 'title' => ''], 'FaceAge' => ['description' => 'The estimated age of the face. This value may not be returned if the prediction fails.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], 'FaceGender' => ['description' => 'The predicted gender of the face image. This value may not be returned if the prediction fails. Valid values:'."\n" .'- M: Male.'."\n" .'- F: Female.', 'type' => 'string', 'example' => 'M', 'title' => ''], 'ExtFaceInfo' => [ 'description' => 'The additional face result information.', 'type' => 'object', 'properties' => [ 'FaceQualityScore' => ['description' => 'The liveness face quality score. Value range: 0 to 100. A higher value indicates better quality.', 'type' => 'number', 'format' => 'double', 'example' => '39.04', 'title' => ''], 'OcclusionScore' => ['description' => 'The algorithm score for occlusion, a sub-dimension of quality assessment. Value range: 0 to 100. A higher value indicates better quality.', 'type' => 'number', 'format' => 'double', 'example' => '50.26', 'title' => ''], 'KaOcclusionScore' => ['description' => 'The algorithm score for key area occlusion, a sub-dimension of quality assessment. Value range: 0 to 100. A higher value indicates better quality.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], 'IlluminationScore' => ['description' => 'The algorithm score for illumination, a sub-dimension of quality assessment. Value range: 0 to 100. A higher value indicates better quality.', 'type' => 'number', 'format' => 'double', 'example' => '97.43', 'title' => ''], 'SharpnessScore' => ['description' => 'The image sharpness score, a sub-dimension of quality assessment. Value range: 0 to 100. A higher value indicates better quality.', 'type' => 'number', 'format' => 'double', 'example' => '86.47', 'title' => ''], 'TargetFaceQualityScore' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], 'TargetOcclusionScore' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], 'TargetKaOcclusionScore' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], 'TargetIlluminationScore' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], 'TargetSharpnessScore' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], 'FaceAttributeInfo' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Face verification', 'summary' => 'Performs real face detection by using face images obtained in advance through an API operation. The algorithm identifies whether a face is a screen recapture or printed photo to detect basic presentation liveness attacks that render such attack types, and supports comparison with another face image to authenticate whether they belong to the same person.', 'description' => 'Calls the FaceVerifyIntl operation to perform liveness detection on face images.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:FaceVerifyIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5E63B760-0ECB-5C07-8503-A65C27876968\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\\\n\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"4ab0b***cbde97\\",\\n \\"SubCode\\": \\"200\\",\\n \\"FacePassed\\": \\"Y\\",\\n \\"FaceComparisonScore\\": 95,\\n \\"DuplicateFace\\": \\"[\\\\n {\\\\n \\\\\\"faceGroupCode\\\\\\": \\\\\\"sg7****uzt\\\\\\",\\\\n \\\\\\"faceId\\\\\\": \\\\\\"f5a921*******9e792ec84c8f0ca592a\\\\\\",\\\\n \\\\\\"merchantUserId\\\\\\": \\\\\\"fa****01\\\\\\"\\\\n }\\\\n]\\",\\n \\"FaceRegistrationResult\\": 0,\\n \\"FaceRegistrationId\\": \\"9e792ec84c8f0ca592a\\",\\n \\"FaceAttack\\": \\"N\\",\\n \\"FaceAttackScore\\": 99,\\n \\"FaceAge\\": 30,\\n \\"FaceGender\\": \\"M\\",\\n \\"ExtFaceInfo\\": {\\n \\"FaceQualityScore\\": 39.04,\\n \\"OcclusionScore\\": 50.26,\\n \\"KaOcclusionScore\\": 100,\\n \\"IlluminationScore\\": 97.43,\\n \\"SharpnessScore\\": 86.47,\\n \\"TargetFaceQualityScore\\": 0,\\n \\"TargetOcclusionScore\\": 0,\\n \\"TargetKaOcclusionScore\\": 0,\\n \\"TargetIlluminationScore\\": 0,\\n \\"TargetSharpnessScore\\": 0,\\n \\"FaceAttributeInfo\\": \\"\\"\\n }\\n }\\n}","type":"json"}]', ], 'FraudResultCallBack' => [ 'summary' => 'Calls the eKYC global anti-spoofing callback operation.', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '184671', 'abilityTreeNodes' => ['FEATUREcloudauthCW0JNH', 'FEATUREcloudauthHOSIED', 'FEATUREcloudauthWSJE4H'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'CertifyId', 'in' => 'query', 'schema' => ['description' => 'The unique identifier for identity verification, which corresponds to the verifyId of Ant.', 'type' => 'string', 'required' => false, 'example' => 'shs2b27333914876c01de4cb22f5841f', 'title' => ''], ], [ 'name' => 'ResultCode', 'in' => 'query', 'schema' => ['description' => 'Indicates whether the anti-spoofing check is passed. Valid values:'."\n" .'- PASS: Passed.'."\n" .'- REJECT: Not passed.', 'type' => 'string', 'required' => false, 'example' => 'PASS', 'title' => ''], ], [ 'name' => 'VerifyDeployEnv', 'in' => 'query', 'schema' => ['description' => 'The environment routing parameter. Valid values:'."\n" .'- staging: staging environment'."\n" .'- production: production environment.', 'type' => 'string', 'required' => false, 'example' => 'production', 'title' => ''], ], [ 'name' => 'ExtParams', 'in' => 'query', 'schema' => ['description' => 'The extended parameters, in JSON string format.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4EB35****87EBA1'], 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n" .'- **true**: The call is successful.'."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The return message.', 'type' => 'string', 'example' => 'success', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', 'returnType' => 'synchronous'], 'title' => 'Anti-spoofing callback', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FraudResultCallBack'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'antcloudauth:FraudResultCallBack', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', ], 'Id2MetaPeriodVerifyIntl' => [ 'summary' => 'Verifies the validity period of an identity document as a two-factor authentication element.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '261144', 'abilityTreeNodes' => ['FEATUREcloudauthZN5W38'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'formData', 'schema' => ['description' => 'The product solution to use.'."\n" ."\n" .'Set the value to eKYC_Date_MIN.', 'type' => 'string', 'required' => true, 'example' => 'eKYC_Date_MIN', 'title' => ''], ], [ 'name' => 'SceneCode', 'in' => 'formData', 'schema' => ['description' => 'The custom authentication scenario ID. You can use this scenario ID to query related records in the console. The value can be up to 10 characters in length and can contain letters, digits, and underscores.', 'type' => 'string', 'required' => false, 'example' => '1234567890', 'title' => ''], ], [ 'name' => 'MerchantBizId', 'in' => 'formData', 'schema' => ['description' => 'The custom unique business identifier, which is used for subsequent troubleshooting. The value can be up to 32 characters in length and can contain letters and digits. Make sure the value is unique.', 'type' => 'string', 'required' => true, 'example' => 'e0c34a77f5ac40a5aa5e6ed20c35****', 'title' => ''], ], [ 'name' => 'MerchantUserId', 'in' => 'formData', 'schema' => ['description' => 'The custom user ID or another identifier that can identify a specific user, such as a phone number or email address. We strongly recommend that you desensitize the value of this field in advance, for example, by hashing the value.', 'type' => 'string', 'required' => false, 'example' => '1234567890', 'title' => ''], ], [ 'name' => 'DocType', 'in' => 'formData', 'schema' => ['description' => 'The document type, which is uniquely identified by an 8-digit number. For more information, see the document type list.'."\n" ."\n" .'Currently, only the second-generation resident identity card of the Chinese mainland is supported. Set this parameter to 00000001.', 'type' => 'string', 'required' => true, 'example' => '​00000001'."\n" ."\n", 'title' => ''], ], [ 'name' => 'DocName', 'in' => 'formData', 'schema' => ['description' => 'The name of the user.', 'type' => 'string', 'required' => true, 'example' => '张三', 'title' => ''], ], [ 'name' => 'DocNo', 'in' => 'formData', 'schema' => ['description' => 'The document number of the user.', 'type' => 'string', 'required' => true, 'example' => '411xxxxxxxxxxx0001', 'title' => ''], ], [ 'name' => 'ValidityStartDate', 'in' => 'formData', 'schema' => ['description' => 'The start date of the validity period, in the format YYYYMMDD. Example: 20201001.', 'type' => 'string', 'required' => true, 'example' => '20201001', 'title' => ''], ], [ 'name' => 'ValidityEndDate', 'in' => 'formData', 'schema' => ['description' => 'The expiration date of the ID card validity period, in the format YYYYMMDD. Example: 20301001.', 'type' => 'string', 'required' => true, 'example' => '20301001', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7B97D932-7FF5-517D-BF39-7CA1BEE3CDD9'], 'Code' => ['description' => 'The response code. For more information about response codes, see the description of response codes and messages.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Message' => ['description' => 'The response message of the request.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'Passed' => ['description' => 'The final authentication result. Valid values:'."\n" ."\n" .'* Y: Passed.'."\n" ."\n" .'* N: Not passed.', 'type' => 'string', 'example' => 'Y', 'title' => ''], 'SubCode' => ['description' => 'The description of the authentication result. For more information, see the ResultObject.SubCode error code description.', 'type' => 'string', 'example' => '200', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B97D932-7FF5-517D-BF39-7CA1BEE3CDD9\\",\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"Passed\\": \\"Y\\",\\n \\"SubCode\\": \\"200\\"\\n }\\n}","type":"json"}]', 'title' => 'Verify ID card validity period', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Id2MetaPeriodVerifyIntl'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:Id2MetaPeriodVerifyIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'Id2MetaVerifyIntl' => [ 'summary' => 'Verifies the authenticity and consistency of a name and ID card number against an authoritative data source.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '199203', 'abilityTreeNodes' => ['FEATUREcloudauthZN5W38'], ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => ['description' => 'The product solution code. Set this parameter to ID_2META.', 'type' => 'string', 'required' => false, 'example' => 'ID_2META', 'title' => ''], ], [ 'name' => 'ParamType', 'in' => 'query', 'schema' => ['description' => 'The parameter type. Valid values:'."\n" ."\n" .'- normal: original value (plaintext).'."\n" .'- Note: Due to authoritative data source restrictions, two-factor identity verification does not support MD5 encryption.', 'type' => 'string', 'required' => false, 'example' => 'normal', 'title' => ''], ], [ 'name' => 'IdentifyNum', 'in' => 'query', 'schema' => ['description' => 'The ID card number (in plaintext).', 'type' => 'string', 'required' => false, 'example' => '429001********8211'."\n", 'title' => ''], ], [ 'name' => 'UserName', 'in' => 'query', 'schema' => ['description' => 'The name (in plaintext).', 'type' => 'string', 'required' => false, 'example' => '张*', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EFA11401-C961-5E89-A2D3-BF9883E5CC3D'], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The return message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'The verification result.', 'type' => 'object', 'properties' => [ 'BizCode' => ['description' => 'The verification result code. Valid values:'."\n" .'- 1: Consistent.'."\n" .'- 2: Inconsistent.'."\n" .'- 3: No record found.', 'type' => 'string', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EFA11401-C961-5E89-A2D3-BF9883E5CC3D\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"BizCode\\": \\"1\\"\\n }\\n}","type":"json"}]', 'title' => 'Two-factor identity verification', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Id2MetaVerifyIntl'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:Id2MetaVerifyIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'IdnAuthorityVerifyIntl' => [ 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREcloudauth6RJHVQ'], ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => [ 'description' => 'The product solution to use. Set the value to IDN_META.', 'enumValueTitles' => [], 'type' => 'string', 'required' => true, 'example' => 'IDN_META', 'title' => '', ], ], [ 'name' => 'SceneCode', 'in' => 'query', 'schema' => ['description' => 'The custom authentication scenario ID. You can use this scenario ID to query related records in the console. The value can be a combination of letters, digits, or underscores with a maximum length of 10 characters.', 'type' => 'string', 'required' => false, 'example' => '1234567890', 'title' => ''], ], [ 'name' => 'MerchantBizId', 'in' => 'query', 'schema' => ['description' => 'The merchant-side custom business unique identifier, which is used for subsequent troubleshooting. The value can be a combination of letters and digits with a maximum length of 32 characters. Ensure that the value is unique.', 'type' => 'string', 'required' => true, 'example' => 'dso932dsjsd22', 'title' => ''], ], [ 'name' => 'MerchantUserId', 'in' => 'query', 'schema' => ['description' => 'The custom user ID, or another identifier that can identify a specific user, such as a phone number or email address. We strongly recommend that you desensitize the value of this field in advance, for example, by hashing the value.', 'type' => 'string', 'required' => true, 'example' => '123456789', 'title' => ''], ], [ 'name' => 'IdNumber', 'in' => 'query', 'schema' => ['description' => 'The ID card number.', 'type' => 'string', 'required' => true, 'example' => '3612841***47001', 'title' => ''], ], [ 'name' => 'BirthDate', 'in' => 'query', 'schema' => ['description' => 'The date of birth.', 'type' => 'string', 'required' => true, 'example' => '2000-01-01', 'title' => ''], ], [ 'name' => 'FullName', 'in' => 'query', 'schema' => ['description' => 'The full name.', 'type' => 'string', 'required' => true, 'example' => 'ray', 'title' => ''], ], [ 'name' => 'SourceFacePicture', 'in' => 'formData', 'schema' => ['description' => 'The Base64-encoded facial photo.'."\n" ."\n" .'> **Note**'."\n" ."\n" .'- If you use this method to pass the ID photo, check the photo size and do not pass an excessively large photo.'."\n" .'- Specify one of the following parameters: SourceFacePicture, SourceFacePictureUrl, or SourceFacePictureFile.', 'type' => 'string', 'required' => false, 'example' => ' '."\n" .'base64'."\n", 'title' => ''], ], [ 'name' => 'SourceFacePictureUrl', 'in' => 'query', 'schema' => ['description' => 'The URL of the facial photo. The URL must be a publicly accessible HTTP or HTTPS link.', 'type' => 'string', 'required' => false, 'example' => 'https://***face1.jpeg', 'title' => ''], ], [ 'name' => 'SourceFacePictureFile', 'in' => 'query', 'schema' => ['description' => 'The file stream of the facial photo.', 'type' => 'string', 'isFileTransferUrl' => true, 'required' => false, 'example' => 'InputStream', 'title' => ''], ], [ 'name' => 'Mobile', 'in' => 'query', 'schema' => ['description' => 'The Indonesian mobile phone number. The number must start with +62, followed by 9 to 11 digits.', 'type' => 'string', 'required' => true, 'example' => '+6281293671234', 'title' => ''], ], [ 'name' => 'Email', 'in' => 'query', 'schema' => ['description' => 'The email address of the user.', 'type' => 'string', 'required' => true, 'example' => 'a*@gmail.com', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5E63B760-0ECB-5C07-8503-A65C27876968'], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'TransactionId' => ['description' => 'The unique identifier of the authentication request.', 'type' => 'string', 'example' => 'hk573be80f944d95ac812e0*******a8', 'title' => ''], 'Passed' => ['description' => 'Indicates whether the verification is passed. Valid values:'."\n" .'- Y: passed.'."\n" .'- N: not passed.', 'type' => 'string', 'example' => 'Y', 'title' => ''], 'SubCode' => ['description' => 'The sub-result code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'ExtSourceInfo' => ['description' => 'The detailed verification results from the data source are described as follows (using the Indonesian data source as an example):'."\n" .'- **govId, fullName, dob**: A comparison score equal to 1.0 indicates a complete match with the official data source. A score lower than 1.0 indicates a mismatch. '."\n" .'- **selfiePhoto**: A comparison score greater than 0.8 indicates a match with the official data source. A score equal to or lower than 0.8 indicates a mismatch. '."\n" .'- **liveness**: A score higher than 0.95 indicates a liveness detection risk. '."\n" .'- **imgManipulationScore**: A score higher than 0.95 indicates an image tampering risk.', 'type' => 'string', 'example' => '{'."\n" .' "govId": 1.0,'."\n" .' "fullName": 1.0,'."\n" .' "dob": 0.9,'."\n" .' "selfiePhoto": 0.8777,'."\n" .' "liveness": 0.1152,'."\n" .' "imgManipulationScore": 0.2253'."\n" .'}', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Indonesian authoritative data source authentication', 'summary' => 'Verifies the identity of an Indonesian user by calling the authoritative source API in a standalone business scenario.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5E63B760-0ECB-5C07-8503-A65C27876968\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"hk573be80f944d95ac812e0*******a8\\",\\n \\"Passed\\": \\"Y\\",\\n \\"SubCode\\": \\"200\\",\\n \\"ExtSourceInfo\\": \\"{\\\\n \\\\\\"govId\\\\\\": 1.0,\\\\n \\\\\\"fullName\\\\\\": 1.0,\\\\n \\\\\\"dob\\\\\\": 0.9,\\\\n \\\\\\"selfiePhoto\\\\\\": 0.8777,\\\\n \\\\\\"liveness\\\\\\": 0.1152,\\\\n \\\\\\"imgManipulationScore\\\\\\": 0.2253\\\\n}\\"\\n }\\n}","type":"json"}]', ], 'Initialize' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '149600', 'abilityTreeNodes' => ['FEATUREcloudauthCW0JNH', 'FEATUREcloudauth6RJHVQ'], ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => ['description' => 'The product solution to use.'."\n" .'>For more information, see the official documentation: https://www.alibabacloud.com/help/zh/ekyc/latest/product-introduction?spm=a2c63.p38356.0.i1', 'type' => 'string', 'required' => false, 'example' => 'eKYC', 'title' => ''], ], [ 'name' => 'MerchantBizId', 'in' => 'query', 'schema' => ['description' => 'The merchant-defined unique business ID used for subsequent troubleshooting. The value can contain letters and digits and can be up to 32 characters in length. Make sure the value is unique.', 'type' => 'string', 'required' => false, 'example' => 'e0c34a***353888', 'title' => ''], ], [ 'name' => 'MetaInfo', 'in' => 'query', 'schema' => ['description' => 'The Metainfo environment parameter. Obtain this value by using the client SDK.', 'type' => 'string', 'required' => false, 'example' => '{\\"bioMetaInfo\\":\\"4.1.0:2916352,0\\",\\"deviceType\\":\\"web\\",\\"ua\\":\\"Mozilla/5.0 (Macintosh', 'title' => ''], ], [ 'name' => 'DocType', 'in' => 'query', 'schema' => ['description' => 'The document type.'."\n" .'>For the eKYC_PRO and ID_OCR_MAX solutions, see the official documentation: https://www.alibabacloud.com/help/zh/ekyc/latest/certificate-code-table?spm=a2c63.p38356.help-menu-445633.d_2_8_2_0.279147abwKAWbr'."\n" ."\n" .'>For the ID_OCR, eKYC, and eKYC_MIN solutions, see the official documentation for the document type list: https://www.alibabacloud.com/help/zh/ekyc/latest/gnhekqy05ni51m4c?spm=a2c63.p38356.help-menu-445633.d_2_3_1_0_0_0.6243244777KoZ7', 'type' => 'string', 'required' => false, 'example' => '00000001'."\n", 'title' => ''], ], [ 'name' => 'MerchantUserId', 'in' => 'query', 'schema' => ['description' => 'A custom user ID or another identifier that can identify a specific user, such as a phone number or email address. We strongly recommend that you desensitize this field value in advance, for example, by hashing the value.', 'type' => 'string', 'required' => false, 'example' => '1221****6543', 'title' => ''], ], [ 'name' => 'SceneCode', 'in' => 'query', 'schema' => ['description' => 'The scene code. (IDV product input parameter)', 'type' => 'string', 'required' => false, 'example' => '123****123', 'title' => ''], ], [ 'name' => 'Pages', 'in' => 'query', 'schema' => ['description' => 'The capture page configuration. Use commas (,) to connect multiple pages. Valid values:'."\n" .'- **01**: the portrait side of the document'."\n" ."\n" .'- **01,02**: the portrait side and the back side of the document'."\n" ."\n" .'> When this value is set to 01,02, only Chinese ID cards and Vietnamese ID cards are supported.', 'type' => 'string', 'required' => false, 'example' => '01', 'title' => ''], ], [ 'name' => 'FacePictureBase64', 'in' => 'formData', 'schema' => ['description' => 'The Base64-encoded face photo. If you use FacePictureBase64 to pass in the face photo, check the photo size and do not pass in an excessively large photo.', 'type' => 'string', 'required' => false, 'example' => 'Base64', 'title' => ''], ], [ 'name' => 'FacePictureUrl', 'in' => 'query', 'schema' => ['description' => 'The URL of the face photo. The URL must be a publicly accessible HTTP or HTTPS link.', 'type' => 'string', 'required' => false, 'example' => '***', 'title' => ''], ], [ 'name' => 'Crop', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable cropping. (IDV product input parameter)', 'type' => 'string', 'required' => false, 'example' => 'N', 'title' => ''], ], [ 'name' => 'Ocr', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable OCR. (IDV product input parameter)', 'type' => 'string', 'required' => false, 'example' => 'Y', 'title' => ''], ], [ 'name' => 'IdFaceQuality', 'in' => 'query', 'schema' => ['description' => 'The face image quality. (IDV product input parameter)', 'type' => 'string', 'required' => false, 'example' => 'Y', 'title' => ''], ], [ 'name' => 'IdSpoof', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable document anti-spoofing detection. (IDV product input parameter)', 'type' => 'string', 'required' => false, 'example' => 'Y', 'title' => ''], ], [ 'name' => 'ReturnUrl', 'in' => 'query', 'schema' => ['description' => 'The client-side callback URL.', 'type' => 'string', 'required' => false, 'example' => 'http*****', 'title' => ''], ], [ 'name' => 'Authorize', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable authoritative identity verification. Currently, this parameter applies only to second-generation ID cards in the Chinese mainland. (IDV product input parameter)', 'type' => 'string', 'required' => false, 'example' => 'Y', 'title' => ''], ], [ 'name' => 'DocScanMode', 'in' => 'query', 'schema' => ['description' => 'The document capture mode.'."\n" ."\n" .'- manual: manual capture.'."\n" .'- auto: automatic capture (default).', 'type' => 'string', 'required' => false, 'example' => 'manual', 'title' => ''], ], [ 'name' => 'ProductFlow', 'in' => 'query', 'schema' => ['description' => 'The order of document and face capture:'."\n" ."\n" .'- DOC_FACE (default)'."\n" .'- FACE_DOC'."\n" ."\n" .'Note: This parameter is required only when ProductCode is set to KYC_GLOBAL.', 'type' => 'string', 'required' => false, 'example' => 'DOC_FACE', 'title' => ''], ], [ 'name' => 'CallbackUrl', 'in' => 'query', 'schema' => ['description' => 'The callback URL for the verification result. The callback request method is GET by default. The callback URL must start with https. After the verification is complete, the platform calls back this URL and automatically appends the transactionId, passed, and subcode fields.', 'type' => 'string', 'required' => false, 'example' => 'https://www.aliyun.com?callbackToken=1000004826&transactionId=shaxxxx&passed=Y&subCode=200', 'title' => ''], ], [ 'name' => 'CallbackToken', 'in' => 'query', 'schema' => ['description' => 'The security token used for anti-replay and anti-tampering verification. If this parameter is specified, the CallbackToken field is included in the callback URL.', 'type' => 'string', 'required' => false, 'example' => '7ca5c68d869344ea8eeb30cdfd544544-6358700', 'title' => ''], ], [ 'name' => 'LanguageConfig', 'in' => 'query', 'schema' => ['description' => 'The language configuration. (IDV product input parameter)', 'type' => 'string', 'required' => false, 'example' => 'en', 'title' => ''], ], [ 'name' => 'SecurityLevel', 'in' => 'query', 'schema' => ['description' => 'The pattern that represents different security levels of the verification flow. Valid values:'."\n" ."\n" .'01: normal pattern (default).'."\n" .'02: safe mode, a relatively strict pattern that is active for high-risk scenarios. (IDV product input parameter)', 'type' => 'string', 'required' => false, 'example' => '01', 'title' => ''], ], [ 'name' => 'StyleConfig', 'in' => 'query', 'schema' => ['description' => 'The custom UI configuration. Convert your custom UI configuration to a JSON string based on the configuration template and pass it in through this parameter. For more information, see [IDV UI style customization](https://www.alibabacloud.com/help/zh/ekyc/latest/idv-kyc-custom-skin?spm=a2c63.p38356.0.i60).', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "guidepage:": {****}, '."\n" .' "ocrPage": {****},'."\n" .' "ocrResultPage": [****],'."\n" .' "facePage": {****},'."\n" .'}', 'title' => ''], ], [ 'name' => 'ExperienceCode', 'in' => 'query', 'schema' => ['description' => 'The experience code.', 'type' => 'string', 'required' => false, 'example' => '9be7b7d0180041219e5ab03ac6dab5fb', 'title' => ''], ], [ 'name' => 'DocVideo', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to save an evidence video.'."\n" ."\n" .'- N: not required (default).'."\n" ."\n" .'- Y: a face verification video (1 to 2 seconds) is captured during the verification process and returned through the query API.'."\n" ."\n" .'> Because video files are large, the system discards the video file when the network is unstable to prioritize the transmission of required verification images.', 'type' => 'string', 'required' => false, 'example' => 'N', 'title' => ''], ], [ 'name' => 'Model', 'in' => 'query', 'schema' => ['description' => 'The type of liveness detection:'."\n" ."\n" .'- **LIVENESS** (default): blink action liveness detection.'."\n" ."\n" .'- **PHOTINUS_LIVENESS**: blink action liveness + colorful liveness dual detection.'."\n" ."\n" .'> '."\n" .'> - For supported SDK versions, see [SDK release notes](https://www.alibabacloud.com/help/zh/ekyc/latest/sdk-publishing-record?spm=a2c63.p38356.0.i99).'."\n" .'> - Colorful liveness dual detection is not supported on PC.', 'type' => 'string', 'required' => false, 'example' => 'PHOTINUS_LIVENESS', 'title' => ''], ], [ 'name' => 'IdThreshold', 'in' => 'query', 'schema' => ['description' => 'The custom OCR quality detection threshold mode. Valid values:'."\n" .'- **0**: standard mode'."\n" .'- **1**: strict mode'."\n" .'- **2**: loose mode'."\n" .'- **3** (default): quality detection disabled', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'ShowAlbumIcon', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to display the album upload entry during the document OCR recognition phase:'."\n" ."\n" .'- **1**: display (default)'."\n" ."\n" .'- **0**: do not display', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'ShowOcrResult', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to display the recognition result page during the document OCR recognition phase:'."\n" ."\n" .'- **1**: display (default)'."\n" ."\n" .'- **0**: do not display', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'ShowGuidePage', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to display the guide page:'."\n" ."\n" .'- **1**: display (default)'."\n" ."\n" .'- **0**: do not display', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'ProcedurePriority', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to allow a degraded processing method when compatibility issues occur during mobile H5 verification.'."\n" ."\n" .'- **url (default)**: degradation supported. The page displays the verification URL, and the user can copy the URL or switch browsers to continue verification.'."\n" ."\n" .'- **keep**: degradation not supported. The error reason is returned directly, and the verification flow ends.'."\n" ."\n\n" .'> '."\n" .'> - This parameter is not supported on PC.'."\n" .'> - If the business scenario involves completing verification within an in-app embedded web page, set this parameter to keep to disallow URL degradation.', 'type' => 'string', 'required' => false, 'example' => 'url', 'title' => ''], ], [ 'name' => 'AppQualityCheck', 'in' => 'query', 'schema' => ['description' => 'This feature is **not supported by the Web SDK**. To use this feature, integrate the App SDK.'."\n" ."\n" .'Specifies whether to enable strict face quality detection:'."\n" .'- Y: enabled (default)'."\n" .'- N: disabled', 'type' => 'string', 'required' => false, 'example' => 'N', 'title' => ''], ], [ 'name' => 'DocPageConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The custom configuration for capturing additional pages.', 'type' => 'array', 'items' => ['description' => 'The capture side.', 'type' => 'string', 'required' => false, 'example' => 'OCR_ID_BACK', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'MRTDInput', 'in' => 'query', 'schema' => ['description' => 'The input source for MRTD verification parameters. This parameter is required for decrypting information when reading document chip data via NFC.'."\n" ."\n" .'- **0**: user input'."\n" ."\n" .'- **1**: OCR reading'."\n" ."\n" .'- **2**: API input', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'DocumentNumber', 'in' => 'query', 'schema' => ['description' => 'The document number.'."\n" ."\n" .'Required when **MRTDInput = 2**.', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], ], [ 'name' => 'DateOfBirth', 'in' => 'query', 'schema' => ['description' => 'The date of birth on the document.'."\n" ."\n" .'Required when **MRTDInput = 2**.', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], ], [ 'name' => 'DateOfExpiry', 'in' => 'query', 'schema' => ['description' => 'The expiration date on the document.'."\n" ."\n" .'Required when **MRTDInput** = 2.', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], ], [ 'name' => 'UseNFC', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable NFC verification when **DocType** is set to 01000000 (global passport).'."\n" .'- **Y** (enabled)'."\n" .'- **N** (disabled)', 'type' => 'string', 'required' => false, 'example' => 'N', 'title' => ''], ], [ 'name' => 'ChameleonFrameEnable', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable the adaptive color-changing window frame.'."\n" .'- **Y**: enabled'."\n" .'- **N**: disabled', 'type' => 'string', 'required' => false, 'example' => 'N', 'title' => ''], ], [ 'name' => 'DocNo', 'in' => 'query', 'schema' => ['description' => 'The document number of the user.', 'type' => 'string', 'required' => false, 'example' => '411xxxxxxxxxxx0001', 'title' => ''], ], [ 'name' => 'DocName', 'in' => 'query', 'schema' => ['description' => 'The real name of the user.', 'type' => 'string', 'required' => false, 'example' => '张三', 'title' => ''], ], [ 'name' => 'EditOcrResult', 'in' => 'query', 'schema' => ['description' => 'Specifies whether the recognition result page is editable during the document OCR recognition phase:'."\n" ."\n" .'- **0**: not editable'."\n" ."\n" .'- **1** (default): editable', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'VerifyModel', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The verification type.', 'type' => 'string', 'example' => '0', 'required' => false], ], [ 'name' => 'FaceGroupCodes', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The face libraries for comparison.', 'type' => 'string', 'example' => '0e0c34a77f', 'required' => false], ], [ 'name' => 'TargetFacePicture', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The Base64-encoded portrait photo.', 'type' => 'string', 'example' => 'base64', 'required' => false], ], [ 'name' => 'TargetFacePictureUrl', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The URL of the portrait image. The URL must be a publicly accessible HTTP or HTTPS link.', 'type' => 'string', 'example' => 'https://www.xxxxx.com/1.jpg', 'required' => false], ], [ 'name' => 'AutoRegistration', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies whether to enable automatic registration.', 'type' => 'string', 'example' => '0', 'required' => false], ], [ 'name' => 'FaceRegisterGroupCode', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The face registration library.', 'type' => 'string', 'example' => '0e0c34a77f', 'required' => false], ], [ 'name' => 'SaveFacePicture', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies whether to save the face picture.', 'type' => 'string', 'example' => '0', 'required' => false], ], [ 'name' => 'FaceVerifyThreshold', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The face verification threshold.', 'type' => 'string', 'example' => '0.5', 'required' => false], ], [ 'name' => 'ReturnFaces', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The number of duplicate faces returned.', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ 'name' => 'Mobile', 'in' => 'query', 'schema' => ['description' => 'The Indonesian phone number. The format must start with +62 followed by 9 to 11 digits. This field takes effect only when Authorize is set to T.'."\n" ."\n" .'> '."\n" .'> - This field is required only when the Indonesian data source is enabled.', 'type' => 'string', 'required' => false, 'example' => '+6281293671234', 'title' => ''], ], [ 'name' => 'Email', 'in' => 'query', 'schema' => ['description' => 'The Indonesian email address. This field takes effect only when Authorize is set to T.'."\n" ."\n" .'> '."\n" .'> - This field is required only when the Indonesian data source is enabled.', 'type' => 'string', 'required' => false, 'example' => 'evxxx@imigxxxxx.go.id', 'title' => ''], ], [ 'name' => 'TemplateType', 'in' => 'query', 'schema' => ['description' => 'The execution order of liveness detection actions in TemplateConfig.'."\n" .'This parameter is required when Model is set to TEMPLATE.'."\n" ."\n" .'- Seq: actions are executed in the order configured in TemplateConfig from left to right.'."\n" .'- Ran: actions are executed in random order. When this option is selected, TemplateConfig must contain more than one action.', 'type' => 'string', 'required' => false, 'example' => 'Seq', 'title' => ''], ], [ 'name' => 'TemplateConfig', 'in' => 'query', 'schema' => ['description' => 'The custom action pool configuration for liveness detection.'."\n" .'This parameter is required when Model is set to TEMPLATE.'."\n" .'Configuration rule: separate multiple action codes with commas (,). Best Practices: include at least one frontal face action (such as blink) and no more than 3 actions in total.'."\n" .'Action lookup table:'."\n" ."\n" .'- Blink: 01'."\n" .'- Open Mouth: 02'."\n" .'- Shake Head Left: 03'."\n" .'- Shake Head Right: 04'."\n" .'- Move Farther: 05'."\n" .'- Move Closer: 06'."\n" .'- Photinus: 07', 'type' => 'string', 'required' => false, 'example' => '01,02,07', 'title' => ''], ], [ 'name' => 'TemplateRanCount', 'in' => 'query', 'schema' => ['description' => 'The number of actions randomly selected from TemplateConfig.'."\n" .'This parameter takes effect only when TemplateType is set to Ran.'."\n" ."\n" .'- Validation rules:'."\n" .'- The value must be greater than 1. The value must be less than or equal to the total number of actions configured in TemplateConfig. If not specified, the default value equals the total number of actions in TemplateConfig.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'OcrValueStandard', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies whether to return additional OCR recognition standardized format fields:'."\n" ."\n" .'0: no (default)'."\n" ."\n" .'1: yes', 'type' => 'string', 'example' => '0', 'default' => '0', 'required' => false], ], [ 'name' => 'FaceAttributeCheck', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '4EB35****87EBA1'], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'The response result.', 'type' => 'object', 'properties' => [ 'TransactionId' => ['description' => 'The verification transaction ID.', 'type' => 'string', 'example' => '08573be80f944d95ac812e019e3655a8', 'title' => ''], 'ClientCfg' => ['description' => 'The client configuration.', 'type' => 'string', 'example' => '***', 'title' => ''], 'TransactionUrl' => ['description' => 'The web verification URL.', 'type' => 'string', 'example' => 'http****', 'title' => ''], 'Protocol' => ['description' => 'The standard encryption protocol for verification.'."\n" ."\n" .'> This field is required when you use iframe embedding for H5 web page integration.', 'type' => 'string', 'example' => 'hksb7ba1b28130d24e015d*********', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'title' => 'Init authentication', 'summary' => 'Initializes a verification session.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Initialize'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:Initialize', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"08573be80f944d95ac812e019e3655a8\\",\\n \\"ClientCfg\\": \\"***\\",\\n \\"TransactionUrl\\": \\"http****\\",\\n \\"Protocol\\": \\"hksb7ba1b28130d24e015d*********\\"\\n }\\n}","type":"json"}]', ], 'InitializeV2' => [ 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '149600', 'abilityTreeNodes' => ['FEATUREcloudauthCW0JNH', 'FEATUREcloudauth6RJHVQ'], ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => ['description' => 'The product solution to use.'."\n" ."\n" .'>Note: For more information, see the official documentation: https://www.alibabacloud.com/help/zh/ekyc/latest/product-introduction?spm=a2c63.p38356.0.i1', 'type' => 'string', 'required' => false, 'example' => 'eKYC', 'title' => ''], ], [ 'name' => 'MerchantBizId', 'in' => 'query', 'schema' => ['description' => 'The merchant-defined unique business ID used for subsequent troubleshooting. The value can contain letters and digits with a maximum length of 32 characters. Ensure that the value is unique.', 'type' => 'string', 'required' => false, 'example' => 'e0c34a***353888', 'title' => ''], ], [ 'name' => 'MetaInfo', 'in' => 'query', 'schema' => ['description' => 'The Metainfo environment parameter. Obtain this value from the client SDK.', 'type' => 'string', 'required' => false, 'example' => '{\\"bioMetaInfo\\":\\"4.1.0:2916352,0\\",\\"deviceType\\":\\"web\\",\\"ua\\":\\"Mozilla/5.0\\"}', 'title' => ''], ], [ 'name' => 'DocType', 'in' => 'query', 'schema' => ['description' => 'The document type.'."\n" .'>For eKYC_PRO and ID_OCR_MAX solutions, see the official documentation: https://www.alibabacloud.com/help/zh/ekyc/latest/certificate-code-table?spm=a2c63.p38356.help-menu-445633.d_2_8_2_0.279147abwKAWbr'."\n" ."\n" .'>For ID_OCR, eKYC, and eKYC_MIN solutions, see the official documentation for the document type list: https://www.alibabacloud.com/help/zh/ekyc/latest/gnhekqy05ni51m4c?spm=a2c63.p38356.help-menu-445633.d_2_3_1_0_0_0.6243244777KoZ7', 'type' => 'string', 'required' => false, 'example' => '00000001'."\n", 'title' => ''], ], [ 'name' => 'MerchantUserId', 'in' => 'query', 'schema' => ['description' => 'A custom user ID or other identifier that can identify a specific user, such as a phone number or email address. We strongly recommend that you desensitize this field value in advance, such as by hashing the value.', 'type' => 'string', 'required' => false, 'example' => '1221****6543', 'title' => ''], ], [ 'name' => 'SceneCode', 'in' => 'query', 'schema' => ['description' => 'The scene code. This is an input parameter for the IDV product.', 'type' => 'string', 'required' => false, 'example' => '1234567890', 'title' => ''], ], [ 'name' => 'Pages', 'in' => 'query', 'schema' => ['description' => 'The collection page configuration. Use commas to connect multiple pages. Valid values:'."\n" .'- **01**: document portrait page'."\n" ."\n" .'- **01,02**: document portrait page and back page'."\n" ."\n" .'> When this value is set to 01,02, only Chinese ID cards and Vietnamese ID cards are supported.', 'type' => 'string', 'required' => false, 'example' => '01', 'title' => ''], ], [ 'name' => 'FacePictureBase64', 'in' => 'formData', 'schema' => ['description' => 'The Base64-encoded face photo. If you use FacePictureBase64 to pass in the face photo, check the photo size and do not pass in an excessively large photo.', 'type' => 'string', 'required' => false, 'example' => 'Base64', 'title' => ''], ], [ 'name' => 'FacePictureUrl', 'in' => 'query', 'schema' => ['description' => 'The URL of the face photo. The URL must be a publicly accessible HTTP or HTTPS link.', 'type' => 'string', 'required' => false, 'example' => 'https://digital-face-prod8.oss-cn-hangzhou.aliyuncs.com/1669520556530-expo/default/face/20221127114236530_w3kx2e6t.jpg', 'title' => ''], ], [ 'name' => 'Crop', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable cropping. This is an input parameter for the IDV product.', 'type' => 'string', 'required' => false, 'example' => 'N', 'title' => ''], ], [ 'name' => 'Ocr', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable OCR. This is an input parameter for the IDV product.', 'type' => 'string', 'required' => false, 'example' => 'Y', 'title' => ''], ], [ 'name' => 'IdFaceQuality', 'in' => 'query', 'schema' => ['description' => 'The face image quality. This is an input parameter for the IDV product.', 'type' => 'string', 'required' => false, 'example' => 'Y', 'title' => ''], ], [ 'name' => 'IdSpoof', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable document anti-spoofing detection. This is an input parameter for the IDV product.', 'type' => 'string', 'required' => false, 'example' => 'Y', 'title' => ''], ], [ 'name' => 'ReturnUrl', 'in' => 'query', 'schema' => ['description' => 'The client-side callback URL.', 'type' => 'string', 'required' => false, 'example' => 'http*****', 'title' => ''], ], [ 'name' => 'Authorize', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable authoritative identity verification. Currently, this applies only to second-generation ID cards in the Chinese mainland. This is an input parameter for the IDV product.', 'type' => 'string', 'required' => false, 'example' => 'T', 'title' => ''], ], [ 'name' => 'DocScanMode', 'in' => 'query', 'schema' => ['description' => 'The document capture photo mode.'."\n" ."\n" .'- manual: manual photo capture.'."\n" .'- auto: automatic photo capture (default).', 'type' => 'string', 'required' => false, 'example' => 'manual', 'title' => ''], ], [ 'name' => 'ProductFlow', 'in' => 'query', 'schema' => ['description' => 'The order of document and face verification:'."\n" ."\n" .'- DOC_FACE (default)'."\n" .'- FACE_DOC'."\n" ."\n" .'Note: This parameter is required only when ProductCode is KYC_GLOBAL.', 'type' => 'string', 'required' => false, 'example' => 'DOC_FACE', 'title' => ''], ], [ 'name' => 'CallbackUrl', 'in' => 'query', 'schema' => ['description' => 'The callback URL for authentication results. The callback request method is GET by default. The callback URL must start with https. After authentication is complete, the platform calls back this URL and automatically appends the transactionId, passed, and subcode fields.', 'type' => 'string', 'required' => false, 'example' => 'https://www.aliyun.com?callbackToken=1000004826&transactionId=shaxxxx&passed=Y&subCode=200', 'title' => ''], ], [ 'name' => 'CallbackToken', 'in' => 'query', 'schema' => ['description' => 'The security token used for anti-replay and anti-tampering verification. If this parameter is passed in, the CallbackToken field is displayed in the callback URL.', 'type' => 'string', 'required' => false, 'example' => '7ca5c68d869344ea8eeb30cdfd544544-6358700', 'title' => ''], ], [ 'name' => 'LanguageConfig', 'in' => 'query', 'schema' => ['description' => 'The language configuration. This is an input parameter for the IDV product.', 'type' => 'string', 'required' => false, 'example' => 'en', 'title' => ''], ], [ 'name' => 'SecurityLevel', 'in' => 'query', 'schema' => ['description' => 'The pattern that represents different security levels of the authentication flow. Valid values:'."\n" ."\n" .'01: normal pattern (default).'."\n" .'02: safe mode, a relatively strict pattern that is active for high-risk scenarios. This is an input parameter for the IDV product.', 'type' => 'string', 'required' => false, 'example' => '01', 'title' => ''], ], [ 'name' => 'StyleConfig', 'in' => 'query', 'schema' => ['description' => 'The custom UI configuration. Convert your custom UI configuration to a JSON string based on the configuration template and pass it in through this parameter. For more information, see [IDV UI style customization](https://www.alibabacloud.com/help/zh/ekyc/latest/idv-kyc-custom-skin?spm=a2c63.p38356.0.i60).', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "guidepage:": {****}, '."\n" .' "ocrPage": {****},'."\n" .' "ocrResultPage": [****],'."\n" .' "facePage": {****},'."\n" .'}', 'title' => ''], ], [ 'name' => 'ExperienceCode', 'in' => 'query', 'schema' => ['description' => 'The experience code.', 'type' => 'string', 'required' => false, 'example' => '9be7b7d0180041219e5ab03ac6dab5fb', 'title' => ''], ], [ 'name' => 'DocVideo', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to save the verification video.'."\n" ."\n" .'- N: not required (default).'."\n" ."\n" .'- Y: the system captures a video of the user\'s face verification process (1–2 seconds) during authentication and returns it through the query API.'."\n" ."\n" .'> Because video files are large, the system discards video files when the network is unstable to prioritize the transmission of images required for authentication.', 'type' => 'string', 'required' => false, 'example' => 'N', 'title' => ''], ], [ 'name' => 'Model', 'in' => 'query', 'schema' => ['description' => 'The type of liveness detection to perform:'."\n" ."\n" .'- **LIVENESS** (default): blink action liveness detection.'."\n" ."\n" .'- **PHOTINUS_LIVENESS**: blink action liveness + colorful liveness dual detection.'."\n" ."\n" .'> '."\n" .'> - For supported SDK versions, see [SDK release notes](https://www.alibabacloud.com/help/zh/ekyc/latest/sdk-publishing-record?spm=a2c63.p38356.0.i99).'."\n" .'> - Colorful liveness dual detection is not supported on PC.', 'type' => 'string', 'required' => false, 'example' => 'PHOTINUS_LIVENESS', 'title' => ''], ], [ 'name' => 'IdThreshold', 'in' => 'query', 'schema' => ['description' => 'The custom OCR quality detection threshold mode:'."\n" ."\n" .'- 0: system default'."\n" .'- 1: strict mode'."\n" .'- 2: loose mode'."\n" .'- 3 (default): disable quality detection', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'ShowAlbumIcon', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to display the album upload entry during the document OCR recognition step:'."\n" ."\n" .'- **1**: display (default)'."\n" ."\n" .'- **0**: do not display', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'ShowOcrResult', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to display the recognition result page during the document OCR recognition step:'."\n" ."\n" .'- **1**: display (default)'."\n" ."\n" .'- **0**: do not display', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'ShowGuidePage', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to display the guide page:'."\n" ."\n" .'- **1**: display (default)'."\n" ."\n" .'- **0**: do not display', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'ProcedurePriority', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to allow a degraded processing method when compatibility issues occur during mobile H5 authentication.'."\n" ."\n" .'- **url (default)**: degradation is supported. The page displays the authentication URL, and the user can copy the URL or shift to another browser to continue authentication.'."\n" ."\n" .'- **keep**: degradation is not supported. The error reason is returned directly and the authentication flow ends.'."\n" ."\n\n" .'> '."\n" .'> - This switch is not supported on PC.'."\n" .'> - If the common scenarios involve completing authentication within an in-app web page, set this parameter to keep to disallow URL replication degradation.', 'type' => 'string', 'required' => false, 'example' => 'url', 'title' => ''], ], [ 'name' => 'AppQualityCheck', 'in' => 'query', 'schema' => ['description' => 'This feature is **not supported by Web SDK**. To use this feature, use the App SDK.'."\n" ."\n" .'Specifies whether to enable strict face quality detection:'."\n" .'- Y: enable (default)'."\n" .'- N: do not enable', 'type' => 'string', 'required' => false, 'example' => 'N', 'title' => ''], ], [ 'name' => 'DocPageConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The custom configuration for collecting additional pages.', 'type' => 'array', 'items' => ['description' => 'The collection page.', 'type' => 'string', 'required' => false, 'example' => 'OCR_ID_BACK', 'title' => ''], 'required' => false, 'example' => 'OCR_ID_BACK', 'title' => '', ], ], [ 'name' => 'MRTDInput', 'in' => 'query', 'schema' => ['description' => 'The input source for MRTD verification parameters. This parameter is required for decrypting information when reading document chip data via NFC.'."\n" ."\n" .'- **0**: user input'."\n" ."\n" .'- **1**: OCR reading'."\n" ."\n" .'- **2**: API input', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'DocumentNumber', 'in' => 'query', 'schema' => ['description' => 'The document number.'."\n" ."\n" .'Required when **MRTDInput = 2**.', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], ], [ 'name' => 'DateOfBirth', 'in' => 'query', 'schema' => ['description' => 'The date of birth on the document.'."\n" ."\n" .'Required when **MRTDInput = 2**.', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], ], [ 'name' => 'DateOfExpiry', 'in' => 'query', 'schema' => ['description' => 'The expiry date on the document.'."\n" ."\n" .'Required when **MRTDInput** = 2.', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], ], [ 'name' => 'UseNFC', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable NFC verification when **DocType** = 01000000 (global passport).'."\n" .'- **Y** (enable)'."\n" .'- **N** (do not enable)', 'type' => 'string', 'required' => false, 'example' => 'N', 'title' => ''], ], [ 'name' => 'ChameleonFrameEnable', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable the adaptive color-changing window frame.'."\n" .'- **Y**: enable'."\n" .'- **N**: do not enable', 'type' => 'string', 'required' => false, 'example' => 'N', 'title' => ''], ], [ 'name' => 'DocNo', 'in' => 'query', 'schema' => ['description' => 'The document number of the user.', 'type' => 'string', 'required' => false, 'example' => '410***************'."\n", 'title' => ''], ], [ 'name' => 'DocName', 'in' => 'query', 'schema' => ['description' => 'The real name of the user.', 'type' => 'string', 'required' => false, 'example' => '张**', 'title' => ''], ], [ 'name' => 'EditOcrResult', 'in' => 'query', 'schema' => ['description' => 'Specifies whether the recognition result page is editable during the document OCR recognition step:'."\n" ."\n" .'- **0**: not editable'."\n" ."\n" .'- **1** (default): editable', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'VerifyModel', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The verification type.', 'type' => 'string', 'example' => '0', 'required' => false], ], [ 'name' => 'FaceGroupCodes', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The face libraries for comparison.', 'type' => 'string', 'example' => '0e0c34a77f', 'required' => false], ], [ 'name' => 'TargetFacePicture', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The Base64-encoded portrait photo.', 'type' => 'string', 'example' => 'base64', 'required' => false], ], [ 'name' => 'TargetFacePictureUrl', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The URL of the portrait image. The URL must be a publicly accessible HTTP or HTTPS link.', 'type' => 'string', 'example' => 'https://www.xxxxx.com/1.jpg', 'required' => false], ], [ 'name' => 'AutoRegistration', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies whether to enable auto-registration.', 'type' => 'string', 'example' => '0', 'required' => false], ], [ 'name' => 'FaceRegisterGroupCode', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The face registration library.', 'type' => 'string', 'example' => '0e0c34a77f', 'required' => false], ], [ 'name' => 'SaveFacePicture', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies whether to save the face picture.', 'type' => 'string', 'example' => '0', 'required' => false], ], [ 'name' => 'FaceVerifyThreshold', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The face verification threshold.', 'type' => 'string', 'example' => '0.5', 'required' => false], ], [ 'name' => 'ReturnFaces', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The number of duplicate faces returned.', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ 'name' => 'Mobile', 'in' => 'query', 'schema' => ['description' => 'The Indonesian phone number. The format must start with +62 followed by 9 to 11 digits. This field takes effect only when Authorize=T.'."\n" ."\n" .'> '."\n" .'> - This field is required only when the Indonesian data source is enabled.', 'type' => 'string', 'required' => false, 'example' => '+6281293671234', 'title' => ''], ], [ 'name' => 'Email', 'in' => 'query', 'schema' => ['description' => 'The Indonesian email address. This field takes effect only when Authorize=T.'."\n" ."\n" .'>Note:'."\n" .'This field is required only when the Indonesian data source is enabled.', 'type' => 'string', 'required' => false, 'example' => 'evxxx@imigxxxxx.go.id', 'title' => ''], ], [ 'name' => 'TemplateType', 'in' => 'query', 'schema' => ['description' => 'The execution order of liveness detection actions in TemplateConfig.'."\n" .'Required when Model is TEMPLATE.'."\n" ."\n" .'- Seq: execute in the order configured in TemplateConfig from left to right.'."\n" .'- Ran: execute in random order. When this option is selected, TemplateConfig must contain more than one action.', 'type' => 'string', 'required' => false, 'example' => 'Seq', 'title' => ''], ], [ 'name' => 'TemplateConfig', 'in' => 'query', 'schema' => ['description' => 'The custom action pool configuration parameter for liveness detection.'."\n" .'Required when Model is TEMPLATE.'."\n" .'Configuration rule: separate multiple action codes with commas. Best practice: include at least one frontal face action (such as blink) and no more than 3 actions in total.'."\n" .'Action lookup table:'."\n" ."\n" .'- Blink: 01'."\n" .'- Open Mouth: 02'."\n" .'- Shake Head Left: 03'."\n" .'- Shake Head Right: 04'."\n" .'- Move Farther: 05'."\n" .'- Move Closer: 06'."\n" .'- Photinus: 07', 'type' => 'string', 'required' => false, 'example' => '01,02,07', 'title' => ''], ], [ 'name' => 'TemplateRanCount', 'in' => 'query', 'schema' => ['description' => 'The number of actions to randomly select from TemplateConfig.'."\n" .'Takes effect only when TemplateType is Ran.'."\n" ."\n" .'- Validation rules:'."\n" .'- The value must be greater than 1. The value must be less than or equal to the total number of actions configured in TemplateConfig. If not specified, the default value equals the total number of actions in TemplateConfig.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'OcrValueStandard', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies whether to return additional OCR recognition standardized format fields:'."\n" ."\n" .'0: no (default)'."\n" ."\n" .'1: yes', 'type' => 'string', 'example' => '0', 'default' => '0', 'required' => false], ], [ 'name' => 'TargetFacePictureFile', 'in' => 'query', 'schema' => ['description' => 'The file stream of the base face image.', 'type' => 'string', 'isFileTransferUrl' => true, 'required' => false, 'example' => 'InputStream', 'title' => ''], ], [ 'name' => 'FacePictureFile', 'in' => 'query', 'schema' => ['description' => 'The file stream of the face photo.', 'type' => 'string', 'isFileTransferUrl' => true, 'required' => false, 'example' => 'InputStream', 'title' => ''], ], [ 'name' => 'FaceAttributeCheck', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '86C40EC3-5940-5F47-995C-BFE90B70E540'."\n"], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'The response result.', 'type' => 'object', 'properties' => [ 'TransactionId' => ['description' => 'The unique ID of the authentication request.', 'type' => 'string', 'example' => '4ab0b***cbde97', 'title' => ''], 'ClientCfg' => ['description' => 'The client configuration.', 'type' => 'string', 'example' => '***', 'title' => ''], 'TransactionUrl' => ['description' => 'The web authentication URL.', 'type' => 'string', 'example' => 'http****', 'title' => ''], 'Protocol' => ['description' => 'The standard authentication encryption protocol.'."\n" ."\n" .'> This field is required for H5 web integration using iframe embedding.', 'type' => 'string', 'example' => 'hksb7ba1b28130d24e015d*********', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'title' => 'Init authentication', 'summary' => 'Initializes an authentication session.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:InitializeV2', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86C40EC3-5940-5F47-995C-BFE90B70E540\\\\n\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"4ab0b***cbde97\\",\\n \\"ClientCfg\\": \\"***\\",\\n \\"TransactionUrl\\": \\"http****\\",\\n \\"Protocol\\": \\"hksb7ba1b28130d24e015d*********\\"\\n }\\n}","type":"json"}]', ], 'KeepaliveIntl' => [ 'summary' => 'Configures client connection keep-alive settings.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcloudauthNOQ41U'], ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4EB35****87EBA1'], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The return message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'Result' => ['description' => 'The returned result.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Configure client connection keep-alive', 'description' => 'Configures client connection keep-alive settings.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:KeepaliveIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"Result\\": \\"SUCCESS\\"\\n }\\n}","type":"json"}]', ], 'Mobile2MetaVerifyIntl' => [ 'summary' => 'Verifies the identity of a phone number owner by using two-factor authentication.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREcloudauthPZCZ2I'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'formData', 'schema' => ['description' => 'The product code. Set this parameter to MOBILE_2META.', 'type' => 'string', 'required' => true, 'example' => 'MOBILE_2META', 'title' => ''], ], [ 'name' => 'ParamType', 'in' => 'formData', 'schema' => ['description' => 'The parameter type. Valid values:'."\n" ."\n" .'- normal: not encrypted'."\n" .'- md5: MD5-encrypted.', 'type' => 'string', 'required' => true, 'example' => 'normal', 'title' => ''], ], [ 'name' => 'UserName', 'in' => 'formData', 'schema' => ['description' => 'The name. Valid values:'."\n" ."\n" .'- If ParamType is set to normal, pass in the name in plaintext.'."\n" .'- If ParamType is set to md5, pass in the name in ciphertext as a 32-character lowercase MD5 string.', 'type' => 'string', 'required' => true, 'example' => '张*', 'title' => ''], ], [ 'name' => 'Mobile', 'in' => 'formData', 'schema' => ['description' => 'The phone number.'."\n" ."\n" .'- If ParamType is set to normal, pass in the phone number in plaintext.'."\n" .'- If ParamType is set to md5, pass in the phone number in ciphertext as a 32-character lowercase MD5 string.', 'type' => 'string', 'required' => true, 'example' => '186****1234', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '4EB35****87EBA1'], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The return message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'BizCode' => ['description' => 'The verification result code. Valid values:'."\n" .'- 1: Consistent.'."\n" .'- 2: Inconsistent.'."\n" .'- 3: No record found.', 'type' => 'string', 'example' => '1', 'title' => ''], 'IspName' => ['description' => 'The name of the telecommunications service provider. Valid values:'."\n" ."\n" .'- CMCC: China Mobile'."\n" .'- CUCC: China Unicom'."\n" .'- CTCC: China Telecom.', 'type' => 'string', 'example' => 'CMCC', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Two-factor phone number verification', 'description' => 'Pass in a phone number and name to verify their authenticity and consistency through an authoritative data source. Before using this operation, make sure that you fully understand the billing method and pricing of the two-factor phone number verification service.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:Mobile2MetaVerifyIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"IspName\\": \\"CMCC\\"\\n }\\n}","type":"json"}]', ], 'Mobile3MetaVerifyIntl' => [ 'summary' => 'Verifies the authenticity and consistency of a phone number, name, and ID card number against an authoritative data source. If the information is inconsistent, returns the reason for the inconsistency.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '199210', 'abilityTreeNodes' => ['FEATUREcloudauthPZCZ2I'], ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => ['description' => 'The product solution code. Fixed value: MOBILE_3META.', 'type' => 'string', 'required' => false, 'example' => 'MOBILE_3META', 'title' => ''], ], [ 'name' => 'ParamType', 'in' => 'query', 'schema' => ['description' => 'The parameter type. Valid values:'."\n" ."\n" .'- normal: not encrypted'."\n" .'- md5: MD5-encrypted.', 'type' => 'string', 'required' => false, 'example' => 'normal', 'title' => ''], ], [ 'name' => 'IdentifyNum', 'in' => 'query', 'schema' => ['description' => 'The ID card number.'."\n" ."\n" .'- If ParamType is set to normal, enter the plaintext value.'."\n" .'- If ParamType is set to md5, enter a 32-character lowercase MD5 string.', 'type' => 'string', 'required' => false, 'example' => '429001********8211'."\n", 'title' => ''], ], [ 'name' => 'UserName', 'in' => 'query', 'schema' => ['description' => 'The name.'."\n" ."\n" .'- If ParamType is set to normal, enter the plaintext value.'."\n" .'- If ParamType is set to md5, enter a 32-character lowercase MD5 string.', 'type' => 'string', 'required' => false, 'example' => '张*'."\n", 'title' => ''], ], [ 'name' => 'Mobile', 'in' => 'query', 'schema' => ['description' => 'The phone number.'."\n" ."\n" .'- If ParamType is set to normal, enter the plaintext value.'."\n" .'- If ParamType is set to md5, enter a 32-character lowercase MD5 string.', 'type' => 'string', 'required' => false, 'example' => '186****1234', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D241532C-4EE9-5A2A-A5A5-C1FD98CE2EDD'], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The return message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Result' => [ 'description' => 'The verification result.', 'type' => 'object', 'properties' => [ 'BizCode' => ['description' => 'The verification result code. Valid values:'."\n" .'- 1: Consistent.'."\n" .'- 2: Inconsistent.'."\n" .'- 3: No record found.', 'type' => 'string', 'example' => '1', 'title' => ''], 'SubCode' => ['description' => 'The detailed verification result. Valid values:'."\n" ."\n" .'- 101: Verification passed. '."\n" .'- 201: The phone number is inconsistent with the name, and the phone number is inconsistent with the ID card number. '."\n" .'- 202: The phone number is consistent with the name, but the phone number is inconsistent with the ID card number. '."\n" .'- 203: The phone number is consistent with the ID card number, but the phone number is inconsistent with the name. '."\n" .'- 204: Other inconsistency.'."\n" .'- 301: No record found.', 'type' => 'string', 'example' => '101', 'title' => ''], 'IspName' => ['description' => 'The carrier name. Valid values:'."\n" ."\n" .'- CMCC: China Mobile'."\n" .'- CUCC: China Unicom'."\n" .'- CTCC: China Telecom.', 'type' => 'string', 'example' => 'CMCC', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D241532C-4EE9-5A2A-A5A5-C1FD98CE2EDD\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"SubCode\\": \\"101\\",\\n \\"IspName\\": \\"CMCC\\"\\n }\\n}","type":"json"}]', 'title' => 'Phone number three-factor verification', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Mobile3MetaVerifyIntl'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:Mobile3MetaVerifyIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ModifyFaceGroup' => [ 'summary' => 'Modifies a face library.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcloudauthHJ4WQV'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'formData', 'schema' => ['description' => 'The primary key ID.', 'type' => 'string', 'required' => false, 'example' => '65c030cd54b23283ceb27b4ade5da49d', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'formData', 'schema' => ['description' => 'The name of the face library.', 'type' => 'string', 'required' => true, 'example' => 'test008', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'formData', 'schema' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => 'description', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '4EB35****87EBA1'], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The return message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Data' => ['description' => 'The returned result.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Modify a face library', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'yundun-cloudauth:ModifyFaceGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": 1\\n}","type":"json"}]', ], 'ModifyFaceRecord' => [ 'summary' => 'Edits a face record.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcloudauthHJ4WQV'], ], 'parameters' => [ [ 'name' => 'ImgOssInfos', 'in' => 'formData', 'schema' => ['description' => 'The OSS information of the image.', 'type' => 'string', 'required' => true, 'example' => 'JSON', 'title' => ''], ], [ 'name' => 'FaceGroupCode', 'in' => 'formData', 'schema' => ['description' => 'The face library code.', 'type' => 'string', 'required' => true, 'example' => '4EB35****87', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '4EB35****87EBA1'], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Data' => ['description' => 'The result.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Edit face record', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'yundun-cloudauth:ModifyFaceRecord', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": 1\\n}","type":"json"}]', ], 'QueryFaceGroup' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcloudauthHJ4WQV'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The name of the face library.', 'type' => 'string', 'required' => false, 'example' => 'test008', 'title' => ''], ], [ 'name' => 'GroupCode', 'in' => 'query', 'schema' => ['description' => 'The code of the face library.', 'type' => 'string', 'required' => false, 'example' => 'groupCode001', 'title' => ''], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['description' => 'The maximum number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['description' => 'The token for the next query.', 'type' => 'string', 'required' => false, 'example' => 'WpY9RBGa5Vrzxi3+mp2Cdw==', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5E63B760-0ECB-5C07-8503-A65C27876968'], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The return message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'CurrentPage' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'Items' => [ 'description' => 'The list of returned entries.', 'type' => 'array', 'items' => [ 'description' => 'The object details.', 'type' => 'object', 'properties' => [ 'Id' => ['description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '162261', 'title' => ''], 'Name' => ['description' => 'The name of the face library.', 'type' => 'string', 'example' => 'test-888', 'title' => ''], 'Code' => ['description' => 'The code of the face library.', 'type' => 'string', 'example' => 'faceGroup001', 'title' => ''], 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'desc', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'MaxResults' => ['description' => 'The number of entries per page in a paged query.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], 'NextToken' => ['description' => 'The token for the next query.', 'type' => 'string', 'example' => 'N/zmQeG/x9TDWmaB/pbfBQ==', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query face libraries', 'summary' => 'Queries face libraries.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'yundun-cloudauth:QueryFaceGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5E63B760-0ECB-5C07-8503-A65C27876968\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"TotalCount\\": 0,\\n \\"TotalPage\\": 1,\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 100,\\n \\"Items\\": [\\n {\\n \\"Id\\": 162261,\\n \\"Name\\": \\"test-888\\",\\n \\"Code\\": \\"faceGroup001\\",\\n \\"Description\\": \\"desc\\"\\n }\\n ],\\n \\"MaxResults\\": 50,\\n \\"NextToken\\": \\"N/zmQeG/x9TDWmaB/pbfBQ==\\"\\n}","type":"json"}]', ], 'QueryFaceRecord' => [ 'summary' => 'Queries face records.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcloudauthHJ4WQV'], ], 'parameters' => [ [ 'name' => 'FaceId', 'in' => 'query', 'schema' => ['description' => 'The face ID.', 'type' => 'string', 'required' => false, 'example' => '5006538', 'title' => ''], ], [ 'name' => 'MerchantUserId', 'in' => 'query', 'schema' => ['description' => 'The merchant user ID.', 'type' => 'string', 'required' => false, 'example' => 'CuN6hiD08qr', 'title' => ''], ], [ 'name' => 'RegistrationType', 'in' => 'query', 'schema' => ['description' => 'The registration type.', 'type' => 'string', 'required' => false, 'example' => 'MANUAL', 'title' => ''], ], [ 'name' => 'FaceGroupCode', 'in' => 'query', 'schema' => ['description' => 'The face library code.', 'type' => 'string', 'required' => true, 'example' => 'Cu****D08q', 'title' => ''], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', 'title' => ''], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['description' => 'The maximum number of entries per page for a paginated query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['description' => 'The token used to retrieve the next page of results.', 'type' => 'string', 'required' => false, 'example' => 'AAAAARbaCuN6hiD08qrLdwJ9Fh0OP1yH8z+7FV4KKGUw4X32', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '7F971622-38C0-5F56-B2EC-315367979B4F'], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''], 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'CurrentPage' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'Items' => [ 'description' => 'The list of returned records.', 'type' => 'array', 'items' => [ 'description' => 'The details of the returned object.', 'type' => 'object', 'properties' => [ 'Id' => ['description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '16112', 'title' => ''], 'FaceId' => ['description' => 'The face ID.', 'type' => 'string', 'example' => '230642938', 'title' => ''], 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2025-01-15T02:20:28Z', 'title' => ''], 'RegistrationType' => ['description' => 'The registration type.', 'type' => 'string', 'example' => 'MANUAL', 'title' => ''], 'ImgOssUrl' => ['description' => 'The URL of the face image.', 'type' => 'string', 'example' => 'http://www.xxxx.com/1.jpg', 'title' => ''], 'MerchantUserId' => ['description' => 'The merchant user ID.', 'type' => 'string', 'example' => 'CuN6hiD08qr', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'MaxResults' => ['description' => 'The maximum number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'NextToken' => ['description' => 'The token for the next query.', 'type' => 'string', 'example' => 'AAAAARfZmVDe9NvRXloR5+8CK9nwqHyx44CQz3pa71+mmu0e', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query face records', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'yundun-cloudauth:QueryFaceRecord', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7F971622-38C0-5F56-B2EC-315367979B4F\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"TotalCount\\": 6,\\n \\"TotalPage\\": 1,\\n \\"CurrentPage\\": 2,\\n \\"PageSize\\": 10,\\n \\"Items\\": [\\n {\\n \\"Id\\": 16112,\\n \\"FaceId\\": \\"230642938\\",\\n \\"GmtCreate\\": \\"2025-01-15T02:20:28Z\\",\\n \\"RegistrationType\\": \\"MANUAL\\",\\n \\"ImgOssUrl\\": \\"http://www.xxxx.com/1.jpg\\",\\n \\"MerchantUserId\\": \\"CuN6hiD08qr\\"\\n }\\n ],\\n \\"MaxResults\\": 100,\\n \\"NextToken\\": \\"AAAAARfZmVDe9NvRXloR5+8CK9nwqHyx44CQz3pa71+mmu0e\\"\\n}","type":"json"}]', ], 'TempAccessTokenIntl' => [ 'summary' => 'Retrieves a temporary token.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcloudauthNYJI62'], ], 'parameters' => [ [ 'name' => 'Type', 'in' => 'formData', 'schema' => ['description' => 'The type.', 'type' => 'string', 'required' => false, 'example' => 'none', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '86C40EC3-5940-5F47-995C-BFE90B70E540'], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Data' => [ 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'AccessKeyId' => ['description' => 'The AccessKeyId of the temporary credential for file upload.', 'type' => 'string', 'example' => '***', 'title' => ''], 'AccessKeySecret' => ['description' => 'The temporary authorization secret.', 'type' => 'string', 'example' => '3hxuRpEJ3Jv2Rtzyg4HooFCYqps762XcNtzhn19wQymk', 'title' => ''], 'SecurityToken' => ['description' => 'The security token of the temporary credential for file upload.', 'type' => 'string', 'example' => '***', 'title' => ''], 'OssEndPoint' => ['description' => 'OssEndPoint。', 'type' => 'string', 'example' => ' ossEndPoint', 'title' => ''], 'BucketName' => ['description' => 'The bucket name.', 'type' => 'string', 'example' => 'liyi', 'title' => ''], 'FileNamePrefix' => ['description' => 'The file name prefix.', 'type' => 'string', 'example' => 'test001', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Retrieve a temporary token', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'yundun-cloudauth:TempAccessTokenIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86C40EC3-5940-5F47-995C-BFE90B70E540\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"AccessKeyId\\": \\"***\\",\\n \\"AccessKeySecret\\": \\"3hxuRpEJ3Jv2Rtzyg4HooFCYqps762XcNtzhn19wQymk\\",\\n \\"SecurityToken\\": \\"***\\",\\n \\"OssEndPoint\\": \\" ossEndPoint\\",\\n \\"BucketName\\": \\"liyi\\",\\n \\"FileNamePrefix\\": \\"test001\\"\\n }\\n}","type":"json"}]', ], 'TempOssUrlIntl' => [ 'summary' => 'Retrieves a temporary URL for a file.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcloudauthHJ4WQV'], ], 'parameters' => [ [ 'name' => 'ObjectName', 'in' => 'formData', 'schema' => ['description' => 'The object name.', 'type' => 'string', 'required' => true, 'example' => '20250512/pdf/579047.pdf', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'EFA11401-C961-5E89-A2D3-BF9883E5CC3D'], 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Data' => [ 'description' => 'The result.', 'type' => 'object', 'properties' => [ 'Url' => ['description' => 'The file URL.', 'type' => 'string', 'example' => 'http://bzxh.cdn.weijin365.com/assets/index-55338127.png', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Retrieve a temporary file URL', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'yundun-cloudauth:TempOssUrlIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EFA11401-C961-5E89-A2D3-BF9883E5CC3D\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Url\\": \\"http://bzxh.cdn.weijin365.com/assets/index-55338127.png\\"\\n }\\n}","type":"json"}]', ], ], 'endpoints' => [ ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudauth-intl.cn-hongkong.aliyuncs.com', 'endpoint' => 'cloudauth-intl.cn-hongkong.aliyuncs.com', 'vpc' => 'cloudauth-intl-vpc.cn-hongkong.aliyuncs.com'], ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudauth-intl.ap-southeast-1.aliyuncs.com', 'endpoint' => 'cloudauth-intl.ap-southeast-1.aliyuncs.com', 'vpc' => 'cloudauth-intl-vpc.ap-southeast-1.aliyuncs.com'], ], 'errorCodes' => [], 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddressVerifyIntl'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FaceCompare'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeepfakeDetectIntl'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FaceLiveness'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FaceGuardRisk'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EkycVerify'], ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Initialize'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Id2MetaPeriodVerifyIntl'], ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DocOcrMax'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CardOcr'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BankMetaVerifyIntl'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DocOcr'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckResult'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CredentialVerifyIntl'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FraudResultCallBack'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteVerifyResult'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Mobile3MetaVerifyIntl'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckVerifyLog'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Id2MetaVerifyIntl'], ], ], 'ram' => [ 'productCode' => 'Cloudauth', 'productName' => 'ID Verification', 'ramCodes' => ['yundun-cloudauth', 'antcloudauth'], 'ramLevel' => 'OPERATION', 'ramConditions' => [], 'ramActions' => [ [ 'apiName' => 'TempOssUrlIntl', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'yundun-cloudauth:TempOssUrlIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteFaceGroup', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'yundun-cloudauth:DeleteFaceGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryFaceRecord', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'yundun-cloudauth:QueryFaceRecord', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryFaceGroup', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'yundun-cloudauth:QueryFaceGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'TempAccessTokenIntl', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'yundun-cloudauth:TempAccessTokenIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyFaceRecord', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'yundun-cloudauth:ModifyFaceRecord', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyFaceGroup', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'yundun-cloudauth:ModifyFaceGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteFaceRecord', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'yundun-cloudauth:DeleteFaceRecord', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'FraudResultCallBack', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'antcloudauth:FraudResultCallBack', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CredentialSubmitIntl', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:CredentialSubmitIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AddFaceRecord', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:AddFaceRecord', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CheckVerifyLog', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:CheckVerifyLog', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'Id2MetaVerifyIntl', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:Id2MetaVerifyIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AddressCompareIntl', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:AddressCompareIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeepfakeDetectIntl', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:DeepfakeDetectIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CredentialRecognitionIntl', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:CredentialRecognitionIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DownloadVerifyRecordIntl', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:DownloadVerifyRecordIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeepfakeDetectIntlStream', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:DeepfakeDetectIntlStream', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CardOcr', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:CardOcr', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DocOcrMax', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:DocOcrMax', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'Initialize', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:Initialize', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'IdnAuthorityVerifyIntl', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:IdnAuthorityVerifyIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DocOcrMaxV2', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:DocOcrMaxV2', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'FaceVerifyIntl', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:FaceVerifyIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CredentialGetResultIntl', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:CredentialGetResultIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'FaceCompare', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:FaceCompare', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'Mobile3MetaVerifyIntl', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:Mobile3MetaVerifyIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'Id2MetaPeriodVerifyIntl', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:Id2MetaPeriodVerifyIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'InitializeV2', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:InitializeV2', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AddressVerifyIntl', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:AddressVerifyIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'BankMetaVerifyIntl', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:BankMetaVerifyIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'EkycVerify', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:EkycVerify', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'FaceDuplicationCheckIntl', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:FaceDuplicationCheckIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DocOcr', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:DocOcr', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'KeepaliveIntl', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:KeepaliveIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'FaceGuardRisk', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:FaceGuardRisk', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CredentialVerifyIntl', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:CredentialVerifyIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CheckResult', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'antcloudauth:CheckResult', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'Mobile2MetaVerifyIntl', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:Mobile2MetaVerifyIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'FaceCrossCompareIntl', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:FaceCrossCompareIntl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteVerifyResult', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:DeleteVerifyResult', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'FaceLiveness', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:FaceLiveness', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AddressVerifyV2Intl', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'antcloudauth:AddressVerifyV2Intl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'resourceTypes' => [], ], ];