Foundation model
This topic describes how to use the foundation model API to rate enterprise authenticity.
Basic information
API name: EntVerify.
Endpoint: cloudauth.aliyuncs.com.
Request methods: POST and GET.
Protocol: HTTPS.
Description: The foundation model API provides a service to rate enterprise authenticity. You can use the returned rating with your business scene rules to take action.
Request parameters
Field | Type | Required | Description | Example |
SceneCode | String | Yes | A custom scene code that you define to distinguish between business scenarios. It can be up to 32 characters long and can contain letters, digits, and underscores. | 1000000006 |
MerchantBizId | String | Yes | A custom unique business ID used for troubleshooting. It can be a 32-character string of letters and digits. Ensure this ID is unique. | e0c34a77f5ac40a5aa5e6ed20c35**** |
MerchantUserId | String | Yes | A custom user ID in your business, used for troubleshooting. | None |
UserAuthorization | String | Yes | Indicates whether user authorization is obtained.
| 1 |
RiskVerifyType | String | No | The type of enterprise risk verification. Currently, only BUSINESS_ANTIFRAUD is supported, which indicates business authenticity rating. | BUSINESS_ANTIFRAUD |
RiskModelVersion | String | No | The version of the enterprise risk verification model. This parameter is required if RiskVerifyType is not empty. Currently, only BASIC (Basic Edition). | BASIC |
LicenseNo | String | Yes | The Unified Social Credit Code. | 91330106673959**** |
EntName | String | No | The enterprise name. | **** Co., Ltd. |
LegalPersonName | String | No | The name of the legal representative. | Zhang** |
LegalPersonCertNo | String | Yes | The ID card number of the legal representative. | 1******************9 |
LegalPersonMobile | String | No | The mobile phone number of the legal representative. | 1390000**** |
AccountNo | String | No | The receiving account. This helps improve the risk assessment results. | 2013092809********* |
Response parameters
Field | Type | Description | |||
HTTP Status Code | Integer | The HTTP status code. | |||
HTTP Body | RequestId | String | The request ID. | ||
Code | String | The return code. For more information, see the Return codes section below. | |||
Message | String | The detailed information of the response. | |||
Result | RiskVerifyResult | Found | Boolean | Indicates whether a result is found. You are billed if a result is found. | |
ModelResults | List<EntRiskVerifyModelResult> | A list of results for the enterprise authenticity rating. The EntRiskVerifyModelResult structure contains the following fields:
| |||
Return codes
HTTP Status Code | Code | Description |
200 | Success | The request was successful. |
400 | MissingParameter | A required parameter is missing. |
401 | InvalidParameter | The parameter is invalid. |
403 | Forbidden.AccountAccessDenied | You do not have permission. The service may not be activated, or your account may have an overdue payment. |
403 | Forbidden.RAMUserAccessDenied | The Resource Access Management (RAM) user does not have permission. Grant the Aliyu***FullAccess permission to the RAM user. |
403 | Forbidden.NoUserAuthorization | User authorization was not obtained. |
500 | InternalError | An internal system error occurred. Retry the request or record the request ID and submit a ticket to technical support for confirmation. |