summaryrefslogtreecommitdiff
path: root/data/en_us/cloudauth/2022-11-25
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/cloudauth/2022-11-25
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/cloudauth/2022-11-25')
-rw-r--r--data/en_us/cloudauth/2022-11-25/api-docs.php1381
1 files changed, 534 insertions, 847 deletions
diff --git a/data/en_us/cloudauth/2022-11-25/api-docs.php b/data/en_us/cloudauth/2022-11-25/api-docs.php
index f38d66a..9dcd7b4 100644
--- a/data/en_us/cloudauth/2022-11-25/api-docs.php
+++ b/data/en_us/cloudauth/2022-11-25/api-docs.php
@@ -1,45 +1,21 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'Cloudauth',
- 'version' => '2022-11-25',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'Cloudauth', 'version' => '2022-11-25'],
'directories' => [
[
- 'id' => 178446,
- 'title' => 'Other',
- 'type' => 'directory',
- 'children' => [
- 'EntVerify',
- 'EntElementVerify',
- 'EntRiskQuery',
- 'EntElementVerifyV2',
- ],
- ],
- [
- 'id' => 0,
- 'title' => '其它',
+ 'children' => ['EntVerify', 'EntElementVerify', 'EntRiskQuery', 'EntElementVerifyV2', 'EntElementVerifyPRO'],
'type' => 'directory',
- 'children' => [
- 'EntElementVerifyPRO',
- ],
+ 'title' => 'Others',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'EntVerify' => [
- 'summary' => 'Enterprise Authentication',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'EntElementVerify' => [
+ 'summary' => 'Verifies the authenticity of an enterprise identity based on business registration data from authoritative data sources, and returns the verify your identity - Enterprise account result.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -51,228 +27,145 @@
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREcloudauthXA9M4C',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudauthKKY1LP'],
],
'parameters' => [
[
'name' => 'SceneCode',
'in' => 'query',
- 'schema' => [
- 'description' => 'Scene code.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'withdraw',
- ],
+ 'schema' => ['description' => 'The scene code. The value can contain letters, digits, and underscores, with a maximum length of 32 characters.', 'type' => 'string', 'required' => false, 'example' => 'withdraw', 'title' => ''],
],
[
'name' => 'MerchantBizId',
'in' => 'query',
- 'schema' => [
- 'description' => 'A unique business identifier defined by the merchant, used for subsequent problem localization and troubleshooting. It supports a combination of letters and numbers, with a maximum length of 32 characters. Please ensure its uniqueness.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '32198****193000',
- ],
+ '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. Make sure the value is unique.', 'type' => 'string', 'required' => false, 'example' => '32198****193000', 'title' => ''],
],
[
'name' => 'MerchantUserId',
'in' => 'query',
- 'schema' => [
- 'description' => 'Merchant-side user ID. It supports a combination of letters and numbers, with a maximum length of 32 characters.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '432***421',
- ],
+ 'schema' => ['description' => 'The merchant-side user ID. The value can contain letters and digits, with a maximum length of 32 characters.', 'type' => 'string', 'required' => false, 'example' => '432***421', 'title' => ''],
],
[
'name' => 'UserAuthorization',
'in' => 'query',
- 'schema' => [
- 'description' => 'Whether the user authorization is obtained.'."\n"
- ."\n"
- .'- 1: Authorized'."\n"
- ."\n"
- .'- 0: Not authorized',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'Specifies whether user authorization is obtained. Valid values:'."\n"
+ .'- 1: Authorization is obtained.'."\n"
+ .'- 0: Authorization is not obtained.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'InfoVerifyType',
'in' => 'query',
'schema' => [
- 'description' => 'Enterprise element verification type, currently not supported.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '无',
- ],
- ],
- [
- 'name' => 'RiskVerifyType',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Enterprise risk verification type, at least one of InfoVerifyType or this must be selected. Currently supported:'."\n"
- ."\n"
- .'- BUSINESS_ANTIFRAUD',
+ 'description' => 'The enterprise element verification type. Valid values:'."\n"
+ .'- ENT_2META: two-element verification'."\n"
+ .'- ENT_3META: three-element verification'."\n"
+ .'- ENT_4META: four-element verification.',
+ 'enumValueTitles' => ['ENT_4META' => 'four-element verification.', 'ENT_2META' => 'two-element verification.', 'ENT_3META' => 'three-element verification.'],
'type' => 'string',
'required' => false,
- 'example' => 'BUSINESS_ANTIFRAUD',
- ],
- ],
- [
- 'name' => 'RiskModelVersion',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Enterprise risk verification model version, required when RiskVerifyType is not empty. Currently supported:'."\n"
- ."\n"
- .'- BASIC: Basic version',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'BASIC',
+ 'example' => 'ENT_2META',
+ 'title' => '',
],
],
[
'name' => 'LicenseNo',
'in' => 'query',
- 'schema' => [
- 'description' => 'Business license number.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '32132***328932',
- ],
+ 'schema' => ['description' => 'The business license number.', 'type' => 'string', 'required' => false, 'example' => '32132***328932', 'title' => ''],
],
[
'name' => 'EntName',
'in' => 'query',
- 'schema' => [
- 'description' => 'Enterprise name.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '***有限公司',
- ],
+ 'schema' => ['description' => 'The enterprise name.', 'type' => 'string', 'required' => false, 'example' => '***有限公司', 'title' => ''],
],
[
'name' => 'LegalPersonName',
'in' => 'query',
- 'schema' => [
- 'description' => 'Legal person\'s name.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '张**',
- ],
+ 'schema' => ['description' => 'The name of the legal representative. This parameter is required for three-element and four-element verification scenarios.', 'type' => 'string', 'required' => false, 'example' => '张**', 'title' => ''],
],
[
'name' => 'LegalPersonCertNo',
'in' => 'query',
- 'schema' => [
- 'description' => 'Legal person\'s ID number.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '370105*****3892',
- ],
- ],
- [
- 'name' => 'LegalPersonMobile',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Legal person\'s mobile phone number.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1300***53',
- ],
- ],
- [
- 'name' => 'AccountNo',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Receiving account, to assist in improving the risk assessment effect.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '321324***38293',
- ],
+ 'schema' => ['description' => 'The ID card number of the legal representative. This parameter is required for the four-element verification scenario.', 'type' => 'string', 'required' => false, 'example' => '370105*****3892', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'ID of the request',
- 'type' => 'string',
- 'example' => '473469C7-A***B-A3DC0DE3C83E',
- ],
- 'Code' => [
- 'description' => 'Return code',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => 'Error message',
- 'type' => 'string',
- 'example' => '成功',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '473469C7***B-A3DC0DE3C83E'],
+ 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'Result' => [
- 'description' => 'Result',
+ 'description' => 'The result.',
'type' => 'object',
'properties' => [
- 'RiskVerifyResult' => [
- 'description' => 'Enterprise risk verification result',
- 'type' => 'object',
- 'properties' => [
- 'ModelResults' => [
- 'description' => 'List of enterprise risk verification model results',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ModelName' => [
- 'description' => 'Model name',
- 'type' => 'string',
- 'example' => 'model_1',
- ],
- 'Result' => [
- 'description' => 'Model result',
- 'type' => 'string',
- 'example' => '5',
- ],
- ],
- ],
- ],
- 'Found' => [
- 'description' => 'Whether found',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
+ 'BizCode' => ['description' => 'The verification result code. Valid values:'."\n"
+ .'- 1: Consistent.'."\n"
+ .'- 2: Inconsistent.'."\n"
+ .'- 3: No record found.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'Status' => ['description' => 'The business operation status of the enterprise. Valid values:'."\n"
+ .'- 1: In operation (open).'."\n"
+ .'- 2: Relocated.'."\n"
+ .'- 3: Deregistered.'."\n"
+ .'- 4: License revoked.'."\n"
+ .'- 5: Revoked.'."\n"
+ .'- 6: Suspended.'."\n"
+ .'- 0: Other.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'ReasonCode' => ['description' => 'The description of ReasonCode:'."\n"
+ ."\n"
+ .'- 100: Consistent.'."\n"
+ ."\n"
+ .'- 201: The legal representative and enterprise verification is inconsistent.'."\n"
+ ."\n"
+ .'- 202: The enterprise two-element verification is inconsistent.'."\n"
+ ."\n"
+ .'- 301: Enterprise not found. Verification cannot be performed.'."\n"
+ ."\n"
+ .'- 302: The legal representative does not exist in the database.'."\n"
+ .'><warning>This field has been deprecated since June 15, 2023. Existing customers who have already integrated are not affected.></warning>.', 'type' => 'string', 'example' => '100', 'title' => ''],
+ 'ReasonDetail' => ['description' => 'The inconsistency details. Multiple inconsistent items are separated by commas. Valid values:'."\n"
+ .'- LegalPersonNameFlag: The legal representative name is inconsistent.'."\n"
+ .'- LegalPersonCertNoFlag: The legal representative certificate number is inconsistent.'."\n"
+ .'- EntNameFlag: The enterprise name is inconsistent.'."\n"
+ .'- LicenseNoFlag: The business license number is inconsistent.', 'type' => 'string', 'example' => 'LegalPersonNameFlag,LegalPersonCertNoFlag', 'title' => ''],
+ 'OpenTime' => ['description' => 'The business operation period, including the start time and end time.'."\n"
+ .'- Format: yyyy-MM-dd/yyyy-MM-dd.'."\n"
+ .'- Example: 2018-09-25/9999-09-09.', 'type' => 'string', 'example' => '2018-09-25/9999-09-09', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-A***B-A3DC0DE3C83E\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"成功\\",\\n \\"Result\\": {\\n \\"RiskVerifyResult\\": {\\n \\"ModelResults\\": [\\n {\\n \\"ModelName\\": \\"model_1\\",\\n \\"Result\\": \\"5\\"\\n }\\n ],\\n \\"Found\\": true\\n }\\n }\\n}","type":"json"}]',
- 'title' => 'Enterprise Risk Verification',
- 'translator' => 'machine',
- ],
- 'EntElementVerify' => [
- 'summary' => 'Enterprise Element Verification',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7***B-A3DC0DE3C83E\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"Status\\": \\"1\\",\\n \\"ReasonCode\\": \\"100\\",\\n \\"ReasonDetail\\": \\"LegalPersonNameFlag,LegalPersonCertNoFlag\\",\\n \\"OpenTime\\": \\"2018-09-25/9999-09-09\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Enterprise element verification',
+ 'description' => 'Only enterprises and individual businesses are supported.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'yundun-cloudauth:EntElementVerify',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'EntElementVerifyPRO' => [
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -284,110 +177,57 @@
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREcloudauthKKY1LP',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudauthKKY1LP'],
],
'parameters' => [
[
'name' => 'SceneCode',
'in' => 'query',
- 'schema' => [
- 'description' => 'Scene code. Supports a combination of letters, numbers, and underscores, with a maximum length of 32 characters.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'withdraw',
- ],
+ 'schema' => ['description' => 'Scene code. Supports a combination of letters, numbers, and underscores, with a maximum length of 32 characters.', 'type' => 'string', 'required' => false, 'example' => '1000000006', 'title' => ''],
],
[
'name' => 'MerchantBizId',
'in' => 'query',
- 'schema' => [
- 'description' => 'A unique business identifier defined by the merchant for subsequent troubleshooting. It supports a combination of letters and numbers, with a maximum length of 32 characters. Please ensure uniqueness.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '32198****193000',
- ],
+ 'schema' => ['description' => 'A unique business identifier defined by the merchant, used for subsequent problem localization and troubleshooting. Supports a combination of letters and numbers, with a maximum length of 32 characters. Ensure uniqueness.', 'type' => 'string', 'required' => false, 'example' => 'e0c34a77f5ac40a5aa5e6ed20c35****', 'title' => ''],
],
[
'name' => 'MerchantUserId',
'in' => 'query',
- 'schema' => [
- 'description' => 'Merchant-side user ID. Supports a combination of letters and numbers, with a maximum length of 32 characters.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '432***421',
- ],
+ 'schema' => ['description' => 'Merchant-side user ID. Supports a combination of letters and numbers, with a maximum length of 32 characters.', 'type' => 'string', 'required' => false, 'example' => 'mch7x9a2b4c8d3e5f6g1h2i3j4k5****'."\n", 'title' => ''],
],
[
'name' => 'UserAuthorization',
'in' => 'query',
- 'schema' => [
- 'description' => 'Whether user authorization is obtained.'."\n"
- .'- 1: Authorized'."\n"
- .'- 0: Not authorized',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'Whether user authorization has been obtained.'."\n"
+ ."\n"
+ .'- **1**: Authorized'."\n"
+ .'- **0**: Not authorized', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'InfoVerifyType',
'in' => 'query',
- 'schema' => [
- 'description' => 'Type of enterprise element verification.'."\n"
- .'- ENT_2META: Two elements'."\n"
- .'- ENT_3META: Three elements'."\n"
- .'- ENT_4META: Four elements',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'ENT_4META' => '四要素',
- 'ENT_2META' => '二要素',
- 'ENT_3META' => '三要素',
- ],
- 'example' => 'ENT_2META',
- ],
+ 'schema' => ['description' => 'Type of enterprise element verification, supporting only the following type:'."\n"
+ .'- **ENT_4META**: Four elements', 'type' => 'string', 'required' => false, 'example' => 'ENT_4META', 'title' => ''],
],
[
'name' => 'LicenseNo',
'in' => 'query',
- 'schema' => [
- 'description' => 'Business license number.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '32132***328932',
- ],
+ 'schema' => ['description' => 'Unified Social Credit Code.', 'type' => 'string', 'required' => false, 'example' => '91330106673959****', 'title' => ''],
],
[
'name' => 'EntName',
'in' => 'query',
- 'schema' => [
- 'description' => 'Enterprise name.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '***有限公司',
- ],
+ 'schema' => ['description' => 'Enterprise name.', 'type' => 'string', 'required' => false, 'example' => '***有限公司', 'title' => ''],
],
[
'name' => 'LegalPersonName',
'in' => 'query',
- 'schema' => [
- 'description' => 'Legal representative\'s name. Required for three-element and four-element scenarios.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '张**',
- ],
+ 'schema' => ['description' => 'Legal person\'s name. Required for the four-element scenario.', 'type' => 'string', 'required' => false, 'example' => '张**', 'title' => ''],
],
[
'name' => 'LegalPersonCertNo',
'in' => 'query',
- 'schema' => [
- 'description' => 'Legal representative\'s ID number. Required for the four-element scenario.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '370105*****3892',
- ],
+ 'schema' => ['description' => 'Legal person\'s ID number. Required for the four-element scenario.', 'type' => 'string', 'required' => false, 'example' => '370105*****3892', 'title' => ''],
],
],
'responses' => [
@@ -397,101 +237,57 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'ID of the request',
- 'type' => 'string',
- 'example' => '473469C7***B-A3DC0DE3C83E',
- ],
- 'Code' => [
- 'description' => 'Return code',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => 'Error message',
- 'type' => 'string',
- 'example' => 'success',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'ID of the request', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
+ 'Code' => ['description' => 'Return code', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Return message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'Result' => [
'description' => 'Result',
'type' => 'object',
'properties' => [
- 'BizCode' => [
- 'description' => 'Verification result code.'."\n"
- .'- 1: Verification consistent'."\n"
- .'- 2: Verification inconsistent'."\n"
- .'- 3: Not found',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'Status' => [
- 'description' => 'Enterprise operating status.'."\n"
- .'- 1: In operation (open)'."\n"
- .'- 2: Relocated'."\n"
- .'- 3: Deregistered'."\n"
- .'- 4: Revoked'."\n"
- .'- 5: Canceled'."\n"
- .'- 6: Suspended'."\n"
- .'- 0: Other',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'ReasonCode' => [
- 'description' => 'ReasonCode explanation:'."\n"
- ."\n"
- .'- 100: Verification consistent'."\n"
- ."\n"
- .'- 201: Inconsistent between person and enterprise'."\n"
- ."\n"
- .'- 202: Inconsistent in two elements of the enterprise'."\n"
- ."\n"
- .'- 301: No enterprise found, unable to verify'."\n"
- ."\n"
- .'- 302: Legal representative does not exist in the database'."\n"
- .'><warning>This field will be discontinued on June 15, 2023. Existing customers are not affected.></warning>',
- 'type' => 'string',
- 'example' => '100',
- ],
- 'ReasonDetail' => [
- 'description' => 'Details of inconsistencies, multiple inconsistencies will be separated by commas.'."\n"
- .'- LegalPersonNameFlag: Inconsistent legal representative name'."\n"
- .'- LegalPersonCertNoFlag: Inconsistent legal representative ID number'."\n"
- .'- EntNameFlag: Inconsistent enterprise name'."\n"
- .'- LicenseNoFlag: Inconsistent business license number',
- 'type' => 'string',
- 'example' => 'LegalPersonNameFlag,LegalPersonCertNoFlag',
- ],
- 'OpenTime' => [
- 'description' => 'Operating period: start and end time of operations.'."\n"
- .'- Format: yyyy-MM-dd/yyyy-MM-dd.'."\n"
- .'- Example: 2018-09-25/9999-09-09.',
- 'type' => 'string',
- 'example' => '2018-09-25/9999-09-09',
- ],
+ 'BizCode' => ['description' => 'Verification result code.'."\n"
+ .'- 1: Consistent'."\n"
+ .'- 2: Inconsistent'."\n"
+ .'- 3: Not found', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'Status' => ['description' => 'Business operation status.'."\n"
+ .'- 1: In operation (open)'."\n"
+ .'- 2: Relocated'."\n"
+ .'- 3: Deregistered'."\n"
+ .'- 4: Revoked'."\n"
+ .'- 5: Cancelled'."\n"
+ .'- 6: Suspended'."\n"
+ .'- 0: Other', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'ReasonDetail' => ['description' => 'Details of inconsistencies, multiple inconsistencies will be separated by commas.'."\n"
+ .'- LegalPersonNameFlag: Legal person\'s name is inconsistent'."\n"
+ .'- LegalPersonCertNoFlag: Legal person\'s ID number is inconsistent'."\n"
+ .'- EntNameFlag: Enterprise name is inconsistent'."\n"
+ .'- LicenseNoFlag: Business license number is inconsistent'."\n"
+ .'- LicenseNoNotFound: Business identification number cannot be verified'."\n"
+ .'- EntNameNotFound: Enterprise name cannot be verified'."\n"
+ .'- LegalPersonNameNotFound: Legal person\'s name cannot be verified'."\n"
+ .'- LegalPersonCertNoNotFound: Legal person\'s ID number cannot be verified', 'type' => 'string', 'example' => 'LegalPersonNameFlag,LegalPersonCertNoFlag', 'title' => ''],
+ 'OpenTime' => ['description' => 'Business term: start and end time of operations.'."\n"
+ .'- Format: yyyy-MM-dd/yyyy-MM-dd.'."\n"
+ .'- Example: 2018-09-25/9999-09-09.', 'type' => 'string', 'example' => '2018-09-25/9999-09-09', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7***B-A3DC0DE3C83E\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"Status\\": \\"1\\",\\n \\"ReasonCode\\": \\"100\\",\\n \\"ReasonDetail\\": \\"LegalPersonNameFlag,LegalPersonCertNoFlag\\",\\n \\"OpenTime\\": \\"2018-09-25/9999-09-09\\"\\n }\\n}","type":"json"}]',
- 'title' => 'Enterprise Element Verification',
- 'description' => 'Supports only enterprises and individual businesses.',
- 'translator' => 'machine',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Enterprise Element Verification PRO',
+ 'summary' => 'Enterprise Element Verification PRO',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"Status\\": \\"1\\",\\n \\"ReasonDetail\\": \\"LegalPersonNameFlag,LegalPersonCertNoFlag\\",\\n \\"OpenTime\\": \\"2018-09-25/9999-09-09\\"\\n }\\n}","type":"json"}]',
],
- 'EntRiskQuery' => [
- 'summary' => 'Abnormal Business Operation Query',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'EntElementVerifyV2' => [
+ 'summary' => 'Verifies enterprise identity elements (V2).',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -503,204 +299,131 @@
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREcloudauthKKY1LP',
- ],
+ 'abilityTreeCode' => '264853',
+ 'abilityTreeNodes' => ['FEATUREcloudauthKKY1LP'],
],
'parameters' => [
[
'name' => 'SceneCode',
'in' => 'query',
- 'schema' => [
- 'description' => 'Custom scene code, used to distinguish business scenarios, a 10-digit number.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1000000086',
- ],
+ 'schema' => ['description' => 'The custom scene code. You can set this parameter to a custom value to distinguish business scenarios. The value can contain letters, digits, and underscores (_), with a maximum length of 32 characters.', 'type' => 'string', 'required' => true, 'example' => '1000000006', 'title' => ''],
],
[
'name' => 'MerchantBizId',
'in' => 'query',
- 'schema' => [
- 'description' => 'A unique business identifier defined by the merchant side, used for subsequent problem localization and troubleshooting. Supports a combination of 32 alphanumeric characters, please ensure uniqueness.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '32198****193000',
- ],
+ 'schema' => ['description' => 'The merchant-defined unique business ID 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' => true, 'example' => 'e0c34a77f5ac40a5aa5e6ed20c35****', 'title' => ''],
],
[
'name' => 'MerchantUserId',
'in' => 'query',
- 'schema' => [
- 'description' => 'A custom user ID in your business, used for subsequent problem localization and troubleshooting.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '无',
- ],
+ 'schema' => ['description' => 'The merchant-side user ID. The value can contain letters and digits, with a maximum length of 32 characters.', 'type' => 'string', 'required' => true, 'example' => 'mch7x9a2b4c8d3e5f6g1h2i3j4k5****', 'title' => ''],
],
[
'name' => 'UserAuthorization',
'in' => 'query',
- 'schema' => [
- 'description' => 'Whether user authorization is obtained.'."\n"
- .'1: Authorized'."\n"
- .'0: Not authorized',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'Specifies whether user authorization is obtained. Valid values:'."\n"
+ .'- 1: Authorization is obtained.'."\n"
+ .'- 0: Authorization is not obtained.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'ParamType',
+ 'name' => 'InfoVerifyType',
'in' => 'query',
- 'schema' => [
- 'description' => 'Parameter type.'."\n"
- .'00: Company name;'."\n"
- .'01: Business registration number;'."\n"
- .'02: Unified Social Credit Code;'."\n"
- .'03: Organization code;',
- 'type' => 'string',
- 'required' => false,
- 'example' => '00',
- ],
+ 'schema' => ['description' => 'The enterprise element verification type. Valid values:'."\n"
+ .'- ENT_2META: two-element verification, which includes the enterprise name and the unified social credit code.'."\n"
+ .'- ENT_3META: three-element verification, which includes the enterprise name, the unified social credit code, and the legal representative name or organization head.'."\n"
+ .'- ENT_4META: four-element verification, which includes the enterprise name, the unified social credit code, the legal representative name or organization head, and the legal representative ID number.', 'type' => 'string', 'required' => true, 'example' => 'ENT_2META', 'title' => ''],
],
[
- 'name' => 'ParamValue',
+ 'name' => 'LicenseNo',
'in' => 'query',
- 'schema' => [
- 'description' => 'Enter one of the following based on the ParamType: company name, business registration number, unified social credit code, or organization code.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '91330106673959****',
- ],
+ 'schema' => ['description' => 'The unified social credit code.', 'type' => 'string', 'required' => true, 'example' => '91330106673959****', 'title' => ''],
+ ],
+ [
+ 'name' => 'EntName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The enterprise name.', 'type' => 'string', 'required' => true, 'example' => '****有限公司', 'title' => ''],
+ ],
+ [
+ 'name' => 'LegalPersonName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The legal representative name. This parameter is required for three-element and four-element verification.', 'type' => 'string', 'required' => false, 'example' => '张**', 'title' => ''],
+ ],
+ [
+ 'name' => 'LegalPersonCertNo',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID number of the legal representative. This parameter is required for four-element verification.', 'type' => 'string', 'required' => false, 'example' => '1******************9', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'API response',
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Request ID',
- 'type' => 'string',
- 'example' => '8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260',
- ],
- 'Code' => [
- 'description' => 'Error code. For details about error codes, see **[Error Codes](~~215420~~)**.',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'Response message for the request information.',
- 'type' => 'string',
- 'example' => 'success',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '473469C7***B-A3DC0DE3C83E'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'Result' => [
- 'description' => 'Result',
+ 'description' => 'The result.',
'type' => 'object',
'properties' => [
- 'BizCode' => [
- 'description' => 'Query result'."\n"
- .'0: Normal business operation'."\n"
- .'1: Abnormal business operation'."\n"
- .'2: Not found',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'Status' => [
- 'description' => 'Business operation status.'."\n"
- .'- 1: In operation (open)'."\n"
- .'- 2: Relocated'."\n"
- .'- 3: Deregistered'."\n"
- .'- 4: Revoked'."\n"
- .'- 5: Canceled'."\n"
- .'- 6: Suspended'."\n"
- .'- 0: Other',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'RiskList' => [
- 'description' => 'List of abnormal information',
- 'type' => 'array',
- 'items' => [
- 'description' => 'Detailed abnormal information',
- 'type' => 'object',
- 'properties' => [
- 'CreditCode' => [
- 'description' => 'Unified Social Credit Code',
- 'type' => 'string',
- 'example' => '92500112MA5UHU****',
- ],
- 'EntName' => [
- 'description' => 'Company name.',
- 'type' => 'string',
- 'example' => '杭州****',
- ],
- 'RegNo' => [
- 'description' => 'Business registration number',
- 'type' => 'string',
- 'example' => '50011260996****',
- ],
- 'ListedReason' => [
- 'description' => 'Reason for being listed as abnormal',
- 'type' => 'string',
- 'example' => '未按照《个体工商户年度报告暂行办法》***',
- ],
- 'ListedDate' => [
- 'description' => 'Date listed as abnormal'."\n"
- .'Example: 2023-02-03',
- 'type' => 'string',
- 'example' => '2023-02-03',
- ],
- 'RemovedReason' => [
- 'description' => 'Reason for being removed from the abnormal list',
- 'type' => 'string',
- 'example' => '根据《个体工商户年度报告暂行办法》第十三条的规定******',
- ],
- 'RemovedDate' => [
- 'description' => 'Date removed from the abnormal list'."\n"
- .'Example: 2023-02-03',
- 'type' => 'string',
- 'example' => '2023-02-06',
- ],
- 'OperationOrg' => [
- 'description' => 'Authority that handled the inclusion',
- 'type' => 'string',
- 'example' => '***市场监督***',
- ],
- 'RemovedOrg' => [
- 'description' => 'Authority that handled the removal',
- 'type' => 'string',
- 'example' => '***市场监督***',
- ],
- ],
- ],
- ],
+ 'BizCode' => ['description' => 'The verification result code. Valid values:'."\n"
+ .'- 1: Consistent.'."\n"
+ .'- 2: Inconsistent.'."\n"
+ .'- 3: No record found.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'Status' => ['description' => 'The enterprise business status. Valid values:'."\n"
+ .'- 1: In operation (open).'."\n"
+ .'- 2: Relocated.'."\n"
+ .'- 3: Deregistered.'."\n"
+ .'- 4: Revoked.'."\n"
+ .'- 5: Rescinded.'."\n"
+ .'- 6: Suspended.'."\n"
+ .'- 0: Other.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'ReasonDetail' => ['description' => 'The inconsistency details. If multiple items are inconsistent, they are separated by commas (,). Valid values:'."\n"
+ .'- LegalPersonNameFlag: The legal representative name is inconsistent.'."\n"
+ .'- LegalPersonCertNoFlag: The legal representative ID number is inconsistent.'."\n"
+ .'- EntNameFlag: The enterprise name is inconsistent.'."\n"
+ .'- LicenseNoFlag: The business license number is inconsistent.', 'type' => 'string', 'example' => 'LegalPersonNameFlag,LegalPersonCertNoFlag', 'title' => ''],
+ 'OpenTime' => ['description' => 'The business operation period, which includes the start time and end time.'."\n"
+ .'- Format: yyyy-MM-dd/yyyy-MM-dd.'."\n"
+ .'- Example: 2018-09-25/9999-09-09.', 'type' => 'string', 'example' => '2018-09-25/9999-09-09', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7***B-A3DC0DE3C83E\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"Status\\": \\"1\\",\\n \\"ReasonDetail\\": \\"LegalPersonNameFlag,LegalPersonCertNoFlag\\",\\n \\"OpenTime\\": \\"2018-09-25/9999-09-09\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Verify enterprise identity elements V2',
+ 'description' => 'The enterprise element verification operation provides a consistency verification service for enterprise element information to identify the authenticity of enterprise information.'."\n"
+ ."\n"
+ .'Two-element and three-element verification supports various types of organizations, such as enterprises, individual businesses, farmer professional cooperatives, government agencies, public institutions, social organizations, law firms, and property owners\' associations.'."\n"
+ ."\n"
+ .'Four-element verification supports enterprises, individual businesses, farmer professional cooperatives, and law firms.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'yundun-cloudauth:EntElementVerifyV2',
+ '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 \\"Result\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"Status\\": \\"1\\",\\n \\"RiskList\\": [\\n {\\n \\"CreditCode\\": \\"92500112MA5UHU****\\",\\n \\"EntName\\": \\"杭州****\\",\\n \\"RegNo\\": \\"50011260996****\\",\\n \\"ListedReason\\": \\"未按照《个体工商户年度报告暂行办法》***\\",\\n \\"ListedDate\\": \\"2023-02-03\\",\\n \\"RemovedReason\\": \\"根据《个体工商户年度报告暂行办法》第十三条的规定******\\",\\n \\"RemovedDate\\": \\"2023-02-06\\",\\n \\"OperationOrg\\": \\"***市场监督***\\",\\n \\"RemovedOrg\\": \\"***市场监督***\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => 'Query for Abnormal Business Operations',
- 'translator' => 'machine',
],
- 'EntElementVerifyV2' => [
- 'summary' => 'Enterprise Element Verification V2',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'EntRiskQuery' => [
+ 'summary' => 'Queries the business abnormality information of an enterprise.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -712,199 +435,125 @@
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'paid',
- 'abilityTreeCode' => '264853',
- 'abilityTreeNodes' => [
- 'FEATUREcloudauthKKY1LP',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudauthKKY1LP'],
],
'parameters' => [
[
'name' => 'SceneCode',
'in' => 'query',
- 'schema' => [
- 'description' => 'Custom scene code, defined by the user to distinguish between different business scenarios. Supports a combination of letters, numbers, and underscores, with a maximum length of 32 characters.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1000000006',
- ],
+ 'schema' => ['description' => 'The custom scene code that identifies a business scenario. The value is a 10-digit number.', 'type' => 'string', 'required' => false, 'example' => '1000000086', 'title' => ''],
],
[
'name' => 'MerchantBizId',
'in' => 'query',
- 'schema' => [
- 'description' => 'A unique business identifier defined by the merchant side, used for subsequent problem localization and troubleshooting. Supports a combination of letters and numbers, with a maximum length of 32 characters. Please ensure uniqueness.',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'e0c34a77f5ac40a5aa5e6ed20c35****',
- ],
+ 'schema' => ['description' => 'The merchant-side custom business unique identifier, which is used for subsequent troubleshooting. The value is a combination of letters and digits up to 32 characters in length. Make sure the value is unique.', 'type' => 'string', 'required' => false, 'example' => '32198****193000', 'title' => ''],
],
[
'name' => 'MerchantUserId',
'in' => 'query',
- 'schema' => [
- 'description' => 'Merchant-side user ID. Supports a combination of letters and numbers, with a maximum length of 32 characters.',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'mch7x9a2b4c8d3e5f6g1h2i3j4k5****',
- ],
+ 'schema' => ['description' => 'The custom user ID in your business, which is used for subsequent troubleshooting.', 'type' => 'string', 'required' => false, 'example' => '无', 'title' => ''],
],
[
'name' => 'UserAuthorization',
'in' => 'query',
- 'schema' => [
- 'description' => 'Whether user authorization has been obtained.'."\n"
- .'- 1: Authorization obtained'."\n"
- .'- 0: No authorization obtained',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'Specifies whether user authorization is obtained. Valid values:'."\n"
+ .'- 1: Authorization is obtained.'."\n"
+ .'- 0: Authorization is not obtained.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'InfoVerifyType',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Type of enterprise element verification.'."\n"
- .'- ENT_2META: Two-element verification (enterprise name + unified social credit code)'."\n"
- .'- ENT_3META: Three-element verification (enterprise name + unified social credit code + legal person\'s name or organization head)'."\n"
- .'- ENT_4META: Four-element verification (enterprise name + unified social credit code + legal person\'s name or organization head + legal person\'s ID number)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ENT_2META',
- ],
- ],
- [
- 'name' => 'LicenseNo',
+ 'name' => 'ParamType',
'in' => 'query',
- 'schema' => [
- 'description' => 'Unified Social Credit Code.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '91330106673959****',
- ],
+ 'schema' => ['description' => 'The parameter type. Valid values:'."\n"
+ .'- 00: enterprise name'."\n"
+ .'- 01: business registration number'."\n"
+ .'- 02: unified social credit code'."\n"
+ .'- 03: organization code.', 'type' => 'string', 'required' => false, 'example' => '00', 'title' => ''],
],
[
- 'name' => 'EntName',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Enterprise Name.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '****有限公司',
- ],
- ],
- [
- 'name' => 'LegalPersonName',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Legal Person\'s Name. Required for three-element and four-element scenarios.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '张**',
- ],
- ],
- [
- 'name' => 'LegalPersonCertNo',
+ 'name' => 'ParamValue',
'in' => 'query',
- 'schema' => [
- 'description' => 'Legal Person\'s ID Number. Required for four-element scenarios.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1******************9',
- ],
+ 'schema' => ['description' => 'The value that corresponds to the ParamType parameter. Enter one of the following values based on the parameter type: enterprise name, business registration number, unified social credit code, or organization code.', 'type' => 'string', 'required' => false, 'example' => '91330106673959****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '473469C7***B-A3DC0DE3C83E',
- ],
- 'Code' => [
- 'description' => 'Return code',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => 'Error message',
- 'type' => 'string',
- 'example' => 'success',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260'],
+ 'Code' => ['description' => 'The error code. For more information, see **[Error codes](~~215420~~)**.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The response message of the request.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'Result' => [
- 'description' => 'Result',
+ 'description' => 'The result.',
'type' => 'object',
'properties' => [
- 'BizCode' => [
- 'description' => 'Verification result code.'."\n"
- .'- 1: Verification consistent'."\n"
- .'- 2: Verification inconsistent'."\n"
- .'- 3: Not found',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'Status' => [
- 'description' => 'Business operation status.'."\n"
- .'- 1: In operation (open)'."\n"
- .'- 2: Relocated'."\n"
- .'- 3: Deregistered'."\n"
- .'- 4: Revoked'."\n"
- .'- 5: Canceled'."\n"
- .'- 6: Suspended'."\n"
- .'- 0: Other',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'ReasonDetail' => [
- 'description' => 'Details of inconsistencies, multiple inconsistencies will be separated by commas.'."\n"
- .'- LegalPersonNameFlag: Legal person\'s name does not match'."\n"
- .'- LegalPersonCertNoFlag: Legal person\'s ID number does not match'."\n"
- .'- EntNameFlag: Enterprise name does not match'."\n"
- .'- LicenseNoFlag: Business license number does not match',
- 'type' => 'string',
- 'example' => 'LegalPersonNameFlag,LegalPersonCertNoFlag',
- ],
- 'OpenTime' => [
- 'description' => 'Business term: start and end time of operations.'."\n"
- .'- Format: yyyy-MM-dd/yyyy-MM-dd.'."\n"
- .'- Example: 2018-09-25/9999-09-09.',
- 'type' => 'string',
- 'example' => '2018-09-25/9999-09-09',
+ 'BizCode' => ['description' => 'The query result. Valid values:'."\n"
+ .'- 0: The enterprise is operating normally.'."\n"
+ .'- 1: The enterprise has a business abnormality.'."\n"
+ .'- 2: No record found.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'Status' => ['description' => 'The business operation status of the enterprise. Valid values:'."\n"
+ .'- 1: In operation (active).'."\n"
+ .'- 2: Relocated.'."\n"
+ .'- 3: Deregistered.'."\n"
+ .'- 4: License revoked.'."\n"
+ .'- 5: Revoked.'."\n"
+ .'- 6: Suspended.'."\n"
+ .'- 0: Other.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'RiskList' => [
+ 'description' => 'The list of abnormality information.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The abnormality details.',
+ 'type' => 'object',
+ 'properties' => [
+ 'CreditCode' => ['description' => 'The unified social credit code.', 'type' => 'string', 'example' => '92500112MA5UHU****', 'title' => ''],
+ 'EntName' => ['description' => 'The enterprise name.', 'type' => 'string', 'example' => '杭州****', 'title' => ''],
+ 'RegNo' => ['description' => 'The business registration number.', 'type' => 'string', 'example' => '50011260996****', 'title' => ''],
+ 'ListedReason' => ['description' => 'The reason for being added to the abnormality list.', 'type' => 'string', 'example' => '未按照《个体工商户年度报告暂行办法》***', 'title' => ''],
+ 'ListedDate' => ['description' => 'The date when the enterprise was added to the abnormality list. Example: 2023-02-03.', 'type' => 'string', 'example' => '2023-02-03', 'title' => ''],
+ 'RemovedReason' => ['description' => 'The reason for being removed from the abnormality list.', 'type' => 'string', 'example' => '根据《个体工商户年度报告暂行办法》第十三条的规定******', 'title' => ''],
+ 'RemovedDate' => ['description' => 'The date when the enterprise was removed from the abnormality list. Example: 2023-02-03.', 'type' => 'string', 'example' => '2023-02-06', 'title' => ''],
+ 'OperationOrg' => ['description' => 'The authority that added the enterprise to the abnormality list.', 'type' => 'string', 'example' => '***市场监督***', 'title' => ''],
+ 'RemovedOrg' => ['description' => 'The authority that removed the enterprise from the abnormality list.', 'type' => 'string', 'example' => '***市场监督***', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"Status\\": \\"1\\",\\n \\"RiskList\\": [\\n {\\n \\"CreditCode\\": \\"92500112MA5UHU****\\",\\n \\"EntName\\": \\"杭州****\\",\\n \\"RegNo\\": \\"50011260996****\\",\\n \\"ListedReason\\": \\"未按照《个体工商户年度报告暂行办法》***\\",\\n \\"ListedDate\\": \\"2023-02-03\\",\\n \\"RemovedReason\\": \\"根据《个体工商户年度报告暂行办法》第十三条的规定******\\",\\n \\"RemovedDate\\": \\"2023-02-06\\",\\n \\"OperationOrg\\": \\"***市场监督***\\",\\n \\"RemovedOrg\\": \\"***市场监督***\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Query enterprise business abnormality',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'yundun-cloudauth:EntRiskQuery',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7***B-A3DC0DE3C83E\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"Status\\": \\"1\\",\\n \\"ReasonDetail\\": \\"LegalPersonNameFlag,LegalPersonCertNoFlag\\",\\n \\"OpenTime\\": \\"2018-09-25/9999-09-09\\"\\n }\\n}","type":"json"}]',
- 'title' => 'Enterprise Element Verification V2',
- 'description' => 'The Enterprise Element Verification API provides a service for verifying the consistency of enterprise element information, used to identify the authenticity of enterprise information.'."\n"
- ."\n"
- .'It supports various institutions including enterprises, individual businesses, farmers\' professional cooperatives, government agencies, public institutions, social organizations, legal profession institutions, and owners\' meetings for 2-3 elements;'."\n"
- ."\n"
- .'For 4 elements, it supports enterprises, individual businesses, farmers\' professional cooperatives, and legal professions.',
- 'translator' => 'machine',
],
- 'EntElementVerifyPRO' => [
- 'summary' => 'Enterprise Element Verification PRO',
- 'path' => '',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'EntVerify' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -916,259 +565,297 @@
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREcloudauthKKY1LP',
- ],
+ 'abilityTreeNodes' => ['FEATUREcloudauthXA9M4C'],
],
'parameters' => [
[
'name' => 'SceneCode',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1000000006',
- ],
+ 'schema' => ['description' => 'The scene code.', 'type' => 'string', 'required' => false, 'example' => 'withdraw', 'title' => ''],
],
[
'name' => 'MerchantBizId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'e0c34a77f5ac40a5aa5e6ed20c35****',
- ],
+ 'schema' => ['description' => 'The merchant-defined unique business ID used for subsequent troubleshooting. The value is a combination of letters and numbers with a maximum length of 32 characters. Ensure that the value is unique.', 'type' => 'string', 'required' => false, 'example' => '32198****193000', 'title' => ''],
],
[
'name' => 'MerchantUserId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'mch7x9a2b4c8d3e5f6g1h2i3j4k5****'."\n",
- ],
+ 'schema' => ['description' => 'The merchant-side user ID. The value is a combination of letters and numbers with a maximum length of 32 characters.', 'type' => 'string', 'required' => false, 'example' => '432***421', 'title' => ''],
],
[
'name' => 'UserAuthorization',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'Specifies whether user authorization is obtained. Valid values:'."\n"
+ ."\n"
+ .'- 1: Authorization is obtained.'."\n"
+ ."\n"
+ .'- 0: Authorization is not obtained.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'InfoVerifyType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENT_4META',
- ],
+ 'schema' => ['description' => 'The enterprise element verification type. This parameter is not supported.', 'type' => 'string', 'required' => false, 'example' => '无', 'title' => ''],
+ ],
+ [
+ 'name' => 'RiskVerifyType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The enterprise risk verification type. You must specify at least one of this parameter and InfoVerifyType. Valid values:'."\n"
+ ."\n"
+ .'- BUSINESS_ANTIFRAUD.', 'type' => 'string', 'required' => false, 'example' => 'BUSINESS_ANTIFRAUD', 'title' => ''],
+ ],
+ [
+ 'name' => 'RiskModelVersion',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The enterprise risk verification model version. This parameter is required when RiskVerifyType is specified. Valid values:'."\n"
+ ."\n"
+ .'- BASIC: Basic Edition.', 'type' => 'string', 'required' => false, 'example' => 'BASIC', 'title' => ''],
],
[
'name' => 'LicenseNo',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '91330106673959****',
- ],
+ 'schema' => ['description' => 'The business license number.', 'type' => 'string', 'required' => false, 'example' => '32132***328932', 'title' => ''],
],
[
'name' => 'EntName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The enterprise name.', 'type' => 'string', 'required' => false, 'example' => '***有限公司', 'title' => ''],
],
[
'name' => 'LegalPersonName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The legal representative name.', 'type' => 'string', 'required' => false, 'example' => '张**', 'title' => ''],
],
[
'name' => 'LegalPersonCertNo',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '370105*****3892',
- ],
+ 'schema' => ['description' => 'The ID card number of the legal representative.', 'type' => 'string', 'required' => false, 'example' => '370105*****3892', 'title' => ''],
+ ],
+ [
+ 'name' => 'LegalPersonMobile',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The mobile phone number of the legal representative.', 'type' => 'string', 'required' => false, 'example' => '1300***53', 'title' => ''],
+ ],
+ [
+ 'name' => 'AccountNo',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The payment receiving account, which helps improve the risk assessment accuracy.', 'type' => 'string', 'required' => false, 'example' => '321324***38293', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '473469C7-A***B-A3DC0DE3C83E'],
+ 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '成功', 'title' => ''],
'Result' => [
- 'description' => '',
+ 'description' => 'The result.',
'type' => 'object',
'properties' => [
- 'BizCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'ReasonDetail' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'LegalPersonNameFlag,LegalPersonCertNoFlag',
- ],
- 'OpenTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2018-09-25/9999-09-09',
+ 'RiskVerifyResult' => [
+ 'description' => 'The enterprise risk verification result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ModelResults' => [
+ 'description' => 'The list of enterprise risk verification model results.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ModelName' => ['description' => 'The model name.', 'type' => 'string', 'example' => 'model_1', 'title' => ''],
+ 'Result' => ['description' => 'The model result.', 'type' => 'string', 'example' => '5', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Found' => ['description' => 'Indicates whether a match is found.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => [],
+ 'title' => 'Enterprise risk verification',
+ 'summary' => 'Verifies the authenticity of enterprise registration information and business operations.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'yundun-cloudauth:EntVerify',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"Status\\": \\"1\\",\\n \\"ReasonDetail\\": \\"LegalPersonNameFlag,LegalPersonCertNoFlag\\",\\n \\"OpenTime\\": \\"2018-09-25/9999-09-09\\"\\n }\\n}","type":"json"}]',
- 'title' => 'Enterprise Element Verification PRO',
- 'translator' => 'machine',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-A***B-A3DC0DE3C83E\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"成功\\",\\n \\"Result\\": {\\n \\"RiskVerifyResult\\": {\\n \\"ModelResults\\": [\\n {\\n \\"ModelName\\": \\"model_1\\",\\n \\"Result\\": \\"5\\"\\n }\\n ],\\n \\"Found\\": true\\n }\\n }\\n}","type":"json"}]',
],
],
'endpoints' => [
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'cloudauth.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-northeast-1',
- 'endpoint' => 'cloudauth.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-south-1',
- 'endpoint' => 'cloudauth.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'cloudauth.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-2',
- 'endpoint' => 'cloudauth.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-3',
- 'endpoint' => 'cloudauth.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-5',
- 'endpoint' => 'cloudauth.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'cloudauth.cn-beijing.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-chengdu',
- 'endpoint' => 'cloudauth.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hongkong',
- 'endpoint' => 'cloudauth.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-huhehaote',
- 'endpoint' => 'cloudauth.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-qingdao',
- 'endpoint' => 'cloudauth.cn-qingdao.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'cloudauth.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'cloudauth.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'cloudauth.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-central-1',
- 'endpoint' => 'cloudauth.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-west-1',
- 'endpoint' => 'cloudauth.aliyuncs.com',
- ],
- [
- 'regionId' => 'me-east-1',
- 'endpoint' => 'cloudauth.aliyuncs.com',
- ],
- [
- 'regionId' => 'us-east-1',
- 'endpoint' => 'cloudauth.aliyuncs.com',
- ],
- [
- 'regionId' => 'us-west-1',
- 'endpoint' => 'cloudauth.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-finance',
- 'endpoint' => 'cloudauth.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen-finance-1',
- 'endpoint' => 'cloudauth.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-finance-1',
- 'endpoint' => 'cloudauth.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-north-2-gov-1',
- 'endpoint' => 'cloudauth.aliyuncs.com',
+ ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudauth.aliyuncs.com', 'endpoint' => 'cloudauth.aliyuncs.com', 'vpc' => 'cloudauth-vpc.ap-northeast-1.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudauth.aliyuncs.com', 'endpoint' => 'cloudauth.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudauth.aliyuncs.com', 'endpoint' => 'cloudauth.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudauth.aliyuncs.com', 'endpoint' => 'cloudauth.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudauth.aliyuncs.com', 'endpoint' => 'cloudauth.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudauth.cn-beijing.aliyuncs.com', 'endpoint' => 'cloudauth.cn-beijing.aliyuncs.com', 'vpc' => 'cloudauth-vpc.cn-beijing.aliyuncs.com'],
+ ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudauth.aliyuncs.com', 'endpoint' => 'cloudauth.aliyuncs.com', 'vpc' => 'cloudauth-vpc.cn-chengdu.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudauth.aliyuncs.com', 'endpoint' => 'cloudauth.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudauth.aliyuncs.com', 'endpoint' => 'cloudauth.aliyuncs.com', 'vpc' => 'cloudauth-vpc.cn-hongkong.aliyuncs.com'],
+ ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudauth.aliyuncs.com', 'endpoint' => 'cloudauth.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudauth.cn-qingdao.aliyuncs.com', 'endpoint' => 'cloudauth.cn-qingdao.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudauth.aliyuncs.com', 'endpoint' => 'cloudauth.aliyuncs.com', 'vpc' => 'cloudauth-vpc.cn-shanghai.aliyuncs.com'],
+ ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudauth.aliyuncs.com', 'endpoint' => 'cloudauth.aliyuncs.com', 'vpc' => 'cloudauth-vpc.cn-shenzhen.aliyuncs.com'],
+ ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudauth.aliyuncs.com', 'endpoint' => 'cloudauth.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'cloudauth.aliyuncs.com', 'endpoint' => 'cloudauth.aliyuncs.com', 'vpc' => 'cloudauth-vpc.us-west-1.aliyuncs.com'],
+ ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'cloudauth.aliyuncs.com', 'endpoint' => 'cloudauth.aliyuncs.com', 'vpc' => 'cloudauth-vpc.us-east-1.aliyuncs.com'],
+ ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'cloudauth.aliyuncs.com', 'endpoint' => 'cloudauth.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'cloudauth.aliyuncs.com', 'endpoint' => 'cloudauth.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'cloudauth.aliyuncs.com', 'endpoint' => 'cloudauth.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'cloudauth.aliyuncs.com', 'endpoint' => 'cloudauth.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cloudauth.aliyuncs.com', 'endpoint' => 'cloudauth.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cloudauth.aliyuncs.com', 'endpoint' => 'cloudauth.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cloudauth.aliyuncs.com', 'endpoint' => 'cloudauth.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cloudauth.aliyuncs.com', 'endpoint' => 'cloudauth.aliyuncs.com', 'vpc' => ''],
+ ],
+ 'errorCodes' => [
+ ['code' => '10001', 'message' => 'The current operation is not authorized, please contact the main account to authorize the operation on the RAM console.', 'http_code' => 403, 'description' => ''],
+ ['code' => '400', 'message' => 'BizType already exist.', 'http_code' => 400, 'description' => ''],
+ ['code' => '404', 'message' => 'ID_NOT_EXISTS', 'http_code' => 404, 'description' => ''],
+ ['code' => '409', 'message' => 'The scene name already exists', 'http_code' => 400, 'description' => ''],
+ ['code' => '500', 'message' => 'system error', 'http_code' => 500, 'description' => ''],
+ ['code' => '700', 'message' => 'Please complete OSS activation and authorization before enabling photo storage.', 'http_code' => 400, 'description' => ''],
+ ['code' => '701', 'message' => 'Please continue to complete the OSS authorization operation before enabling photo storage.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Abnormal.Repeated.Call', 'message' => 'Exceptionally repeated calls.', 'http_code' => 200, 'description' => 'Exceptionally repeated calls'],
+ ['code' => 'CertifyId.Invalid', 'message' => 'invalid certifyId.', 'http_code' => 200, 'description' => 'invalid certifyId'],
+ ['code' => 'ConsoleSystemError_1001', 'message' => 'There was an error with your request, please try again later.', 'http_code' => 500, 'description' => ''],
+ ['code' => 'ConsoleSystemError_1009', 'message' => 'console system error', 'http_code' => 500, 'description' => ''],
+ ['code' => 'Data.Duplication', 'message' => 'Data duplication.', 'http_code' => 200, 'description' => 'Data duplication'],
+ ['code' => 'DataExpired', 'message' => 'The data has expired and the records have been deleted.', 'http_code' => 410, 'description' => ''],
+ ['code' => 'DATA_EXPIRED', 'message' => 'The data has expired.', 'http_code' => 200, 'description' => 'Data expiration'],
+ ['code' => 'DownloadTimedOut', 'message' => 'Downloading resource timed out.', 'http_code' => 422, 'description' => ''],
+ ['code' => 'InDebt', 'message' => 'You have an outstanding payment. Please add funds first and try again.', 'http_code' => 200, 'description' => 'There is a arrears in the real person authentication, please recharge before operating.'],
+ ['code' => 'InnerNoSupported', 'message' => 'Login-free operation is not supported.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'Invalid.Input.Image', 'message' => 'Incoming picture not available.', 'http_code' => 200, 'description' => 'Incoming picture not available'],
+ ['code' => 'InvalidAction.NotFound', 'message' => 'Specified api is not found, please check your url and method.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'InvalidApi.NotFound', 'message' => 'Specified api is not found, please check your url and method.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'InvalidParam.ImageValuePatternError', 'message' => 'The image address format is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidParam.MaterialsEmpty', 'message' => 'The materials list is empty.', 'http_code' => null, 'description' => ''],
+ ['code' => 'InvalidParameter', 'message' => 'The specified parameter is invalid.', 'http_code' => 200, 'description' => ''],
+ ['code' => 'InvalidParameter.Format', 'message' => 'Specified parameter format is not valid.', 'http_code' => 400, 'description' => 'Invalid parameter'],
+ ['code' => 'InvalidSecurityToken.Expired', 'message' => 'Specified SecurityToken is expired.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'INVALID_PARAMETER', 'message' => 'The request parameters are invalid.', 'http_code' => 200, 'description' => ''],
+ ['code' => 'MissingIds', 'message' => 'Ids is mandatory for this action.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'MissingParameter', 'message' => 'Bad request. The parameter is missing.', 'http_code' => 200, 'description' => 'Bad request missing parameter'],
+ ['code' => 'MissingProcessType', 'message' => 'MissingProcessType', 'http_code' => 400, 'description' => ''],
+ ['code' => 'MissingSolution', 'message' => 'Solution is mandatory for this action.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'MissingStartDate', 'message' => 'StartDate is mandatory for this action', 'http_code' => 400, 'description' => ''],
+ ['code' => 'NoFaceDetected', 'message' => 'No face is detected in either the image or the video.', 'http_code' => 435, 'description' => ''],
+ ['code' => 'NoPermission', 'message' => 'This RAM user has no permissions to access API.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'NoSubscribeService', 'message' => 'OSS is not activated or you have not granted OSS the read write permission.', 'http_code' => 410, 'description' => ''],
+ ['code' => 'Not.Open.Service', 'message' => 'Service not opened.', 'http_code' => 200, 'description' => 'Service not opened'],
+ ['code' => 'ParameterIsNull', 'message' => 'The parameter must not be empty.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'PARAMETER_FORMAT_ERROR', 'message' => 'The parameter format is wrong.', 'http_code' => 200, 'description' => 'Format check error'],
+ ['code' => 'Ram.No.Permission', 'message' => 'RAM has no permissions.', 'http_code' => 200, 'description' => 'RAM has no permissions'],
+ ['code' => 'ResourcesTooLarge', 'message' => 'The size of the incoming resources are too large.', 'http_code' => 421, 'description' => ''],
+ ['code' => 'ServerError', 'message' => 'server error.', 'http_code' => 500, 'description' => ''],
+ ['code' => 'ServiceUnavailable', 'message' => 'The request has failed due to a temporary failure of the server.', 'http_code' => 503, 'description' => ''],
+ ['code' => 'STATUS_ERROR', 'message' => 'Status Error.', 'http_code' => 200, 'description' => 'Status Error'],
+ ['code' => 'SystemError', 'message' => 'A system error occurred.', 'http_code' => 500, 'description' => ''],
+ ['code' => 'Throttling.User', 'message' => 'Request was denied due to user flow control.', 'http_code' => 400, 'description' => ''],
+ ],
+ 'changeSet' => [],
+ 'ram' => [
+ 'productCode' => 'Cloudauth',
+ 'productName' => 'ID Verification',
+ 'ramCodes' => ['yundun-cloudauth', 'antcloudauth'],
+ 'ramLevel' => 'OPERATION',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'EntRiskQuery',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'yundun-cloudauth:EntRiskQuery',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'EntElementVerifyV2',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'yundun-cloudauth:EntElementVerifyV2',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'EntElementVerifyPRO',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'yundun-cloudauth:EntElementVerifyPRO',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'EntElementVerify',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'yundun-cloudauth:EntElementVerify',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'EntVerify',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'yundun-cloudauth:EntVerify',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Cloudauth', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'resourceTypes' => [],
],
];