Domain name for API request: ssl.intl.tencentcloudapi.com.
Submit certificate information for payment
A maximum of 10 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: CertificateInfoSubmit. |
| Version | Yes | String | Common Params. The value used for this API: 2019-12-05. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| CertId | Yes | String | Paid SSL certificate ID of materials to be submitted. |
| GenCsrType | Yes | String | This field is required. CSR generation method, value is: -online: Tencent Cloud submits the filled parameter information to generate a CSR and private key, and by Tencent Cloud for encrypted storage. -parse: Generate CSR and private key manually, and apply for a certificate by uploading CSR. |
| CertCommonName | Yes | String | Common name for certificate binding. If an uploaded CSR is used, that domain name must match the common name resolved by the CSR. |
| CompanyType | Yes | Integer | Organization information type. Valid values: 1 (Personal): Only DV-type certificates can be set to 1. For personal-type certificates, organization information fields (Org, Admin, Tech) can be omitted. 2 (Company): All types of certificates can be set to 2. Pass organization information fields as needed. |
| CompanyId | Yes | String | Company ID can be viewed in the Tencent Cloud Console. If no company information is found, set this parameter to 0. If company information matching the current order exists, you can view the company ID via DescribeCompanies. If a company ID is provided, parameters starting with "Org" can be omitted. |
| OrgIdType | No | String | Company document type. Valid values: TYDMZ (unified social credit code): This field is required only for CFCA certificates, not required for other types. OTHERS |
| OrgIdNumber | No | String | Company identification number, value ranges from...to... TYDMZ (unified social credit code): 11532xxxxxxxx24820 |
| AdminIdType | No | String | Document type of the manager. Valid values: SFZ (ID card): This field is required only for CFCA certs, not required for other types. HZ (passport): This field is required only for CFCA certs and not required for other types. |
| AdminIdNumber | No | String | ID number of the manager. This field is required only for CFCA certificates, not required for other types. Value ranges from...to... ID card: 110000xxxxxxxx1242 HZ (Passport): EFxxxxxxx |
| TechIdType | No | String | Contact person document type. Valid values: SFZ (ID card): This field is required only for CFCA certs, not required for other types. HZ (passport): This field is required only for CFCA certs and not required for other types. |
| TechIdNumber | No | String | ID number of the contact person. This field is required only for CFCA certs and not required for other types. Value ranges from...to... ID card: 110000xxxxxxxx1242 HZ (Passport): EFxxxxxxx |
| Csr | No | String | Uploaded CSR content. If GenCsrType is parse, this field is required. |
| DnsNames.N | No | Array of String | Other domains bound to the certificate. No need to provide for single domain or wildcard certificates. Required for multi-domain names and multiple wildcard certificates. |
| KeyPass | No | String | Private key password. Currently used only when generating certs in jks or pfx format; private key certificates in other formats are unencrypted. |
| OrgOrganization | No | String | Company name. This field is required if CompanyId or ManagerId is not provided. |
| OrgDivision | No | String | Department name. If not passing CompanyId or ManagerId, this field is required. |
| OrgAddress | No | String | Company detailed address. If not pass CompanyId or ManagerId, this field is required. |
| OrgCountry | No | String | Country/region name, for example China: CN. If not passing CompanyId or ManagerId, this field is required. |
| OrgCity | No | String | Located city. If not pass CompanyId or ManagerId, this field is required. |
| OrgRegion | No | String | Province where the company is located. If not passing CompanyId or ManagerId, this field is required. |
| OrgPhoneArea | No | String | Area code of the company. If not passing CompanyId or ManagerId, this field is required. For example: 021. Pass 86 as the mobile number. |
| OrgPhoneNumber | No | String | Company number. If CompanyId or ManagerId is not provided, this field is required. |
| VerifyType | No | String | Domain validation method of the certificate DNS: Manually add domain DNS validation. The user needs to manually add the verification value at the DNS service provider. FILE: Manual addition of domain name FILE verification. Users are advised to manually add a specified path FILE in the root directory of the domain site to perform FILE verification. Either http or https passing is sufficient. The domain site must be accessible by overseas certificate authorities. The specific access allowlist is: 64.78.193.238, 216.168.247.9, 216.168.249.9, 54.189.196.217. |
| AdminFirstName | No | String | Manage name. If not passing ManagerId, this field is required. |
| AdminLastName | No | String | Manager name. If not, this field is required when ManagerId is not passed. |
| AdminPhone | No | String | Manager mobile number. If not passing ManagerId, this field is required. |
| AdminEmail | No | String | Manager email address. If not passing ManagerId, this field is required. |
| AdminTitle | No | String | Manager position. If not passing ManagerId, this field is required. |
| TechFirstName | No | String | Contact name. If not passing ManagerId, this field is required. |
| TechLastName | No | String | Last name of the contact. If not, this field is required when ManagerId is not passed. |
| ContactEmail | No | String | Contact email address. This field is required when CompanyType is 1. |
| AutoRenewFlag | No | Integer | Whether to enable auto-renewal: 0, not enabled; 1, enabled; defaults to 0. |
| CsrKeyParameter | No | String | Key pair parameters. RSA supports 2048 and 4096. ECC is only supported for prime256v1. This parameter is required when the CSR generation method is online. |
| CsrEncryptAlgo | No | String | Encryption algorithm, value is ECC or RSA, defaults to RSA. This parameter is required when CSR generation method is online. |
| ManagerId | No | String | Manager ID can be viewed in the Tencent Cloud Console. If no administrator information is found, pass 0 for this parameter. If administrator information exists that meets the current order, the manager ID can be selected based on DescribeManagers. If the manager ID is passed, parameters beginning with Org, Admin, or Tech can be omitted. The manager ID includes company information. |
| TechPhone | No | String | Contact phone. If not passing ManagerId, this field is required. |
| TechEmail | No | String | contact email |
| TechTitle | No | String | Contact person position. If not passing ManagerId, this field is required. |
| Type | No | Integer | Certificate type |
| CaType | No | String | Valid only for Dnspod series certs. ca organization kind can be sectigo and digicert. |
| SignAlgo | No | String | signature algorithm |
| UseCrossSignRoot | No | Boolean | Whether to use intersect root certificate |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Submit documentation for a paid SSL certificate
POST / HTTP/1.1
Host: ssl.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CertificateInfoSubmit
<Common request parameters>
{
"AdminEmail": "ssl@tencent.com",
"AdminFirstName": "Ning"
"AdminIdNumber": "110000000000000001",
"AdminIdType": "SFZ",
"AdminLastName": "Huang"
"AdminPhone": "13112341234",
"AdminTitle": "R&D"
"CertCommonName": "tencent.com",
"CertId": "J2lX2maH",
"CompanyId": "134",
"CompanyType": 2,
"CsrEncryptAlgo": "RSA",
"CsrKeyParameter": "2048",
"GenCsrType": "online",
"ManagerId": "2345",
"OrgAddress": "No. 101, xxxxxx, xx District, Guangzhou, Guangdong Province"
"OrgCity": "Guangzhou",
"OrgCountry": "CN",
"OrgDivision": "R&D Department",
"OrgIdNumber": "111111111111110000",
"OrgIdType": "TYDMZ",
"OrgOrganization": "Tencent Cloud SSL Certificate"
"OrgPhoneArea": "010",
"OrgPhoneNumber": "234123123",
"OrgRegion": "Guangdong Province"
"TechEmail": "ssl@tencent.com",
"TechFirstName": "Ning",
"TechIdNumber": "110000000000000001",
"TechIdType": "SFZ",
"TechLastName": "Huang"
"TechPhone": "13112341234",
"TechTitle": "R&D"
"VerifyType": "FILE"
}
{
"Response": {
"RequestId": "54c73858-77a6-435c-addc-65919b550900"
}
}
POST / HTTP/1.1
Host: ssl.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CertificateInfoSubmit
<Common request parameters>
{
"CertId": "LrmeMvQr",
"GenCsrType": "online",
"CertCommonName": "tencent.com",
"CompanyType": "2",
"OrgIdType": "",
"OrgIdNumber": "",
"AdminIdType": "",
"AdminIdNumber": "",
"TechIdType": "",
"TechIdNumber": "",
"CompanyId": "11772",
"Csr": "",
"KeyPass": "12345678",
"OrgOrganization": "Tencent Cloud SSL Certificate Trial"
"OrgDivision": "R&D Department",
"OrgAddress": "Tencent Cloud SSL Certificate test URL"
"OrgCountry": "CN",
"OrgCity": "Beijing",
"OrgRegion": "Beijing"
"OrgPhoneArea": "010",
"OrgPhoneNumber": "123456789010",
"AdminFirstName": "Ning"
"AdminLastName": "Huang"
"AdminPhone": "18169239105",
"AdminEmail": "ssl@tencent.com",
"AdminTitle": "R&D"
"TechFirstName": "Test",
"TechLastName": "Test",
"CsrKeyParameter": "2048",
"CsrEncryptAlgo": "RSA",
"TechEmail": "ssl@tencent.com",
"TechPhone": "18169239105",
"TechTitle": "R&D"
"ManagerId": "12895"
}
{
"Response": {
"RequestId": "54c73858-77a6-435c-addc-65919b550900"
}
}
POST / HTTP/1.1
Host: ssl.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CertificateInfoSubmit
<Common request parameters>
{
"CertId": "LrmeMvQr",
"GenCsrType": "parse",
"CertCommonName": "tencent.com",
"CompanyType": "2",
"OrgIdType": "",
"OrgIdNumber": "",
"AdminIdType": "",
"AdminIdNumber": "",
"TechIdType": "",
"TechIdNumber": "",
"CompanyId": "11772",
"Csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIIC5zCCAc8CAQAweTELMAkGA1UEBhMCQ04xEjAQBgNVBAgMCea5luWNl+ecgTES\nMBAGA1UEBwwJ6ZW/5rKZ5biCMRswGQYDVQQKDBLohb7orq/kupFTU0zor4HkuaYx\nDzANBgNVBAsMBueglOWPkTEUMBIGA1UEAxMLdGVuY2VudC5jb20wggEiMA0GCSqG\nSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDWACnWh6gA1dGDi/pJtGZtp/Wp4ou6//JM\nEu4OpXQ5t/afvX4xPGm7laWE4aFItZpfhXc1SGVwOBwWsOArw9xwmdCDFY3Icbu9\n8O1mIAIYfMDuc8bWL5lQfuyBeGJw+9i++E/1SkYnx3sRD+vMNlJdkaueWW4qXVo+\nZnE7FX/6Mqi1PE53ccXU55iviLHAaSnztpmUmF4vcKIVbDTsI2TF1raHwdnmvQFx\nvifh7h49xRz3Jj3QWCJqdtGKAktFzofDCYPKcIKT4A52u7WsoBspLIds1H93dITD\nVxnZaE3oe4sHfQpnlHRbO72Cz1QEgGBQeOW/wH8/WygFiRIWHwZpAgMBAAGgKTAn\nBgkqhkiG9w0BCQ4xGjAYMBYGA1UdEQQPMA2CC3RlbmNlbnQuY29tMA0GCSqGSIb3\nDQEBCwUAA4IBAQAcr+Wy3uqr+PL+uUMwd1scB7x27/j2JDXTKBdZnsLnaEFCzz2f\ny4aqN7hWLHNEoqGGNSg5luKO6DCFXOnzu6/bI4Ziy/w003RD1wMPinpo0C0YIzwM\nW99sDPoI1qIxAoNEVLOP11EnPPdlq/D7T4UOMjPxjYSo4Ge2BcG5Bk1zTu/O8She\nxHc6lEWniExaYomIboULnLTdSI1Dx0g7segNMvhLGUjRyump3/0jANfk7qbS0Nnz\n6Q/i0NmiqUiA38iTdIBY57QAJBbXiJJ3HRF5wZyJESobTr9dHPuZH4ebJvfSaNBp\n4KqzUxjAe5GZJs/z5EuJkG/LC/h1L3rFT7AS\n-----END CERTIFICATE REQUEST-----\n",
"KeyPass": "12345678",
"OrgOrganization": "Tencent Cloud SSL Certificate Trial"
"OrgDivision": "R&D Department",
"OrgAddress": "Tencent Cloud SSL Certificate test URL"
"OrgCountry": "CN",
"OrgCity": "Beijing",
"OrgRegion": "Beijing"
"OrgPhoneArea": "010",
"OrgPhoneNumber": "123456789010",
"AdminFirstName": "Ning"
"AdminLastName": "Huang"
"AdminPhone": "18162039301",
"AdminEmail": "ssl@tencent.com",
"AdminTitle": "R&D"
"TechFirstName": "Ning",
"TechLastName": "Huang"
"CsrKeyParameter": "",
"CsrEncryptAlgo": "",
"TechEmail": "ssl@tencent.com",
"TechPhone": "18162039301",
"TechTitle": "R&D"
"ManagerId": "12895"
}
{
"Response": {
"RequestId": "54c73858-77a6-435c-addc-65919b550900"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.AuthError | You do not have permission to perform this operation. |
| FailedOperation.CertificateInfoSubmitContactEmailEmpty | Mailbox cannot be empty |
| FailedOperation.CertificateInfoSubmitDomainInvalid | The input domain name %s is in incorrect format. Please check and resubmit. |
| FailedOperation.CertificateInfoSubmitStatusInvalid | Certificate status does not allow submitting documentation. |
| FailedOperation.CertificateNotFound | The certificate does not exist. |
| FailedOperation.CertificateOrderSubmitRootCAInvalid | The currently selected root certificate is invalid. Please reselect. |
| FailedOperation.CertificateSubmitHostingCertError | Uploaded certificate managed renewal cannot submit order manually |
| FailedOperation.ExceedsFreeLimit | The number of free certificates exceeds the maximum value. |
| FailedOperation.InvalidCertificateStatusCode | The certificate status is incorrect. |
| FailedOperation.InvalidParam | Incorrect parameters. |
| FailedOperation.NoProjectPermission | You do not have the permission to operate on this project. |
| FailedOperation.NoRealNameAuth | You have not completed the identity verification. |
| InternalError | Internal error. |
| InvalidParameter.RenewAlgorithmInvalid | The algorithm is invalid. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback