2.21 Modify Application Information
2.21.1 Api Information
| Test environment | |
|---|---|
| Production environment | https://portal.racent.com/ssl/alter |
| Request method | POST |
| content-type | multipart/form-data |
| Description | This interface is only used to modify application information when a CFCA certificate request fails. |
2.21.2 Parameter Definition
| Parameter name | Parameter type | Required | Description |
|---|---|---|---|
| api_token | String | Y | Identity credential; contact Racent technical support to generate a token. |
| certId | String | Y | Racent certificate ID |
| refId | String | N | Unique customer order number provided by the customer |
| verificationPic | File | N | Alternative verification material. Used for organization validation, supporting .jpg/.jpeg/.png/.gif/.bmp/.rar/.zip formats, with a file size no larger than 2MB. |
| domainVerificationPic | File | N | This field is required (Y) when the domain verification method is set to VERIFY_DOCUMENT. It is used for Domain Control Validation (DCV) (currently only supported by CFCA). |
| params | String | Y | Order information, described in detail as follows |
| csr | String | N | When this parameter is empty, a CSR will be generated for you and the private key will be saved. |
| privateKey | String | N | Private key. |
| server | String | N | Server. This parameter is only relevant to SSL certificates. The parameter value is Y for SSL certificates, and N for other product types. If this parameter is not required, use the default value "other". |
| orgCheck | Int | N | The value is 0 or 1. When the value is 1, the system will retrieve all organizations under your account based on the organization information you submitted. If a matching organization exists, the associated information of the existing organization will be used; if no match exists, the submitted information will be saved as a new organization. When the value is 0, organization information will not be saved. |
| duplicateOrgCheck | Int | N | The value is 0 or 1. This parameter currently only applies to Digicert SSL certificates. It is used to determine whether to reuse previously validated organization and domain information. When the value is 1, existing validated information is reused. When the value is 0, new information is created. The default value is 1. |
| dcvMethod | String | N | Uniformly set the validation method for the domain in the certificate request. Must be one of the following four methods: EMAIL (Email validation) HTTP_CSR_HASH (File validation) CNAME_CSR_HASH (DNS validation) HTTPS_CSR_HASH (HTTPS file validation) VERIFY_DOCUMENT (Domain certificate proof, only supported by CFCA) This field is required (Y) for CFCA. |
| domainInfo | String | N | Domain information, applicable only to SSL certificates. The parameter is Y for SSL certificates and N for other product types. The total number of standard domains and wildcard domains cannot exceed the respective purchased quotas for standard domains and wildcard domains. Example: [ { "dcvEmail": "admin@xxx.com", "dcvMethod": "EMAIL", "domainName": "www.xxx.com" }, { "dcvEmail": "admin@aaa.com", "dcvMethod": "EMAIL", "domainName": "aaa.com" }, "dcvEmail": "admin@racent.com", "dcvMethod": "EMAIL", "domainName": "racent.com" } ] Detailed descriptions are as follows: |
| dcvMethod | String | N | Domain Control Validation (DCV) method. Must be one of the following four methods: EMAIL (Email validation) HTTP_CSR_HASH (File validation) CNAME_CSR_HASH (DNS validation) HTTPS_CSR_HASH (HTTPS file validation) This field is Y when the parent-level dcvMethod does not exist. If the parent-level dcvMethod exists and this field is also specified, the parent-level dcvMethod will take precedence. |
| dcvEmail | String | N | Domain Control Validation (DCV) email address. Default values when this field is N are as follows: racent.com : admin@racent.com www.racent.com : admin@racent.com *.racent.com : admin@racent.com |
| domainName | String | N | Domain name |
| organizationInfo | String | N | Company information. This parameter is Y when ordering products that require enterprise validation. The example is as follows: { "organizationCity": "上海", "organizationName": "某公司", "organizationMobile": "18111111111", "organizationAddress": "上海市路", "organizationCountry": "CN", "organizationPostCode": "401320" }" |
| organizationCity | String | N | City where the company is located. |
| organizationName | String | N | Company name. |
| organizationMobile | String | N | Company phone number. |
| organizationAddress | String | N | Company address. |
| organizationCountry | String | N | Country where the company is located (two-letter code per the ISO 3166-1 standard). |
| organizationPostCode | String | N | Postal code of the company's location. |
| organizationRegNumbe | String | N | Company registration number. This field is required (Y) for CFCA. |
| idType | String | N | Company certificate type. This field is mandatory (Y) for CFCA. Available values: TYDMZ: Unified Social Credit Code OTHERS: Other |
| Administrator | String | Y | Administrator information and contact. This parameter is used as application information when applying for code signing, email signing, or document signing certificates. In addition, if csr is N, this information is used for CSR generation. { "job": "General Manager's Office", "city": "Shanghai", "email": "xx@yy.com", "state": "Shanghai", "mobile": "18111111111", "address": "Shanghai", "country": "CN", "lastName": "zhang", "postCode": "401320", "firstName": "nick", "organation": "Company Name" }" |
| job | String | Y | Administrator job title. |
| city | String | Y | The city where the administrator is located. |
| String | Y | The email address of the administrator. | |
| state | String | Y | The province or state where the administrator is located. |
| mobile | String | Y | Administrator contact number. |
| address | String | Y | Administrator contact address. |
| country | String | Y | Country where the administrator is located (two-letter code in ISO 3166-1 standard). |
| lastName | String | Y | The administrator's last name. |
| postCode | String | Y | The postal code of the administrator's location. |
| firstName | String | Y | The administrator's first name. |
| organation | String | Y | Name of the administrator's company. |
| idType | String | N | ID type. This field is required (Y) for CFCA. Values are as follows: SFZ: ID card HZ: Passport |
| idNumber | String | N | ID number. This field is required (Y) for CFCA. |
| finance | String | Applies only to SSL certificates. Finance staff information. Can be the same as administrator information. This parameter is required (Y) when the ordered product is not of DV type. { "job": "Finance Department", "city": "Shanghai", "email": "xx@yy.com", "state": "Shanghai", "mobile": "18111111111", "address": "Shanghai", "country": "CN", "lastName": "zhang", "postCode": "401320", "firstName": "nick", "organation": "Some Company" }" | |
| job | String | N | Position of the finance staff member. |
| city | String | N | City where the finance staff member is located. |
| String | N | Email address of the finance staff. | |
| state | String | N | Province or state where the finance staff is located. |
| mobile | String | N | Contact number of the finance staff. |
| address | String | N | Contact address of the finance staff. |
| country | String | N | Country where the finance staff is located (two-letter code in the ISO 3166-1 standard). |
| lastName | String | N | Last name of the finance staff. |
| postCode | String | N | Postal code of the financial officer's location. |
| firstName | String | N | First name of the financial officer. |
| organation | String | N | Company of the financial officer. |
| idType | String | N | ID type. This field is Y for CFCA. Values are as follows: SFZ: ID Card HZ: Passport |
| idNumber | String | N | ID number. This field is Y for CFCA. |
| tech | String | N | Related to SSL certificates only. Technical contact information. This parameter is Y when the ordered product is not of DV type. { "job": "技术部","city": "上海市", "email": "xx@yy.com", "state": "上海市", "mobile": "18111111111", "address": "上海市", "country": "CN", "lastName": "zhang", "postCode": "401320", "firstName": "nick", "organation": "某公司" }" |
| job | String | N | Technician position. |
| city | String | N | City where the technician is located. |
| String | N | Technician's email address. | |
| state | String | N | Province or state where the technician is located. |
| mobile | String | N | Contact information of the technician. |
| address | String | N | Contact address of the technician. |
| country | String | N | The country where the technician is located (two-letter code according to the ISO 3166-1 standard). |
| lastName | String | N | The technician's last name. |
| postCode | String | N | The postal code of the technician's location. |
| firstName | String | N | Name of the technician. |
| organation | String | N | Company of the technician. |
| idType | String | N | ID type. This field is required (Y) for CFCA. Possible values: SFZ: National ID card HZ: Passport |
| idNumber | String | N | ID number. This field is required (Y) for CFCA. |
Function Return
| code | Int | Y | Return status. For detailed explanations, see Appendix 3.1. |
|---|---|---|---|
| errors | Object or String | N | Specific error information when the return status is error. |
| data | Object | N | This parameter is Y when the return status is successful. The specific description is as follows: |
| certId | String | N | Racent certificate ID. Please keep it properly, as this parameter is the unique credential for the Racent instance. |
| vendorId | String | N | CA order number. |
| vendorCertId | String | N | CA certificate number. |
| DCVfileName | String | N | File validation file name |
| DCVfileContent | String | N | File validation file content |
| DCVdnsHost | String | N | DNS validation host value |
| DCVdnsValue | String | N | DNS validation record value |
| DCVdnsType | String | N | DNS validation record type |
| DCVfilePath | String | N | File validation file path |
| dcvInfo | Object | N | This item is Y when the validation values differ for each domain name in the certificate request The type of each entry is Object, and the object name of each entry is the requested domain name, for example: racent.com. Details of each entry are as follows: |
| DCVfileName | String | N | File validation file content |
| DCVfileContent | String | N | File validation file content |
| DCVdnsHost | String | N | DNS validation host value |
| DCVdnsValue | String | N | DNS validation record value |
| DCVdnsType | String | N | DNS validation record type |
| DCVfilePath | String | N | File validation file path |
| failReason | Object | N | This field is returned when Racent fails to submit a certificate request to the CA and the specific failure reason can be identified. |
| dataReasons | Array | N | Data reason |
| key | String | N | Item |
| reason | String | N | Reason |
| sysReason | String | N | System reason |