2.2 Order Certificate

2.2.1 Interface Description

Test environment
Production environment	https://portal.racent.com/ssl/place
Request method	POST
content-type	multipart/form-data
Description	This interface is used to order certificates.

2.2.2 Parameter Definition

Parameter name	Parameter type	Required	Description
api_token	String	Y	Identity credential. To generate a token, please contact Racent technical support.
productCode	String	Y	Product code, obtain the product code (see Section 2.7)
years	Int	Y	Purchase validity period in years (currently only 1, 2, 3, 4, and 5 are supported), subject to the specific product.
refId	String	N	Unique customer order number provided by the customer
verificationPic	File	N	Alternative verification material. Used for organization validation, supports .jpg/.jpeg/.png/.gif/.bmp/.rar/.zip/.pdf formats, with a file size no larger than 2 MB.
domainVerificationPic	File	N	This parameter is Y when the domain verification method is VERIFY_DOCUMENT. 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. Only relevant to SSL certificates. This parameter is Y for SSL certificates and N for other types of products. If this parameter is not required, use the default value "other".
orgCheck	Int	N	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 submit. If a matching organization exists, its associated information will be used; if no match is found, the submitted information will be saved as a new organization. When the value is 0, organization information will not be saved.
duplicateOrgCheck	Int	N	Value is 0 or 1. This parameter currently applies only to DigiCert SSL certificates. It is used to determine whether to reuse previously validated organization and domain information. When the value is 1, existing information is reused. When the value is 0, new information is created. The default value is 1.
needFree	Int	N	Value is 1 or 2. When the value is 1, the FQDN will be provided for free, and the www domain will also be provided for free along with the root domain. When the value is 2, no free domains are provided.
uniqueValue	String	N	Relevant to Sectigo products only. 1-20 characters (a-z A-Z 0-9) used by resellers to generate validation values independently.
dcvMethod	String	N	Unified configuration for the 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) VERIFY_DOCUMENT (Domain certificate proof, supported by CFCA only) This parameter is Y for CFCA.
domainInfo	String	N	Domain information, relevant to SSL certificates only. This parameter is Y for SSL certificates and N for other product types. 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 method. Must be one of the following four values: EMAIL(Email Validation) HTTP_CSR_HASH(File Validation) CNAME_CSR_HASH(DNS Validation) HTTPS_CSR_HASH(HTTPS File Validation) This field is required (Y) when the parent dcvMethod does not exist. If the parent dcvMethod exists and this field is also provided, the parent dcvMethod will take precedence.
dcvEmail	String	N	Domain Control Validation email address. Default values when this field is not provided: 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. Example 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/Region where the company is located (two-letter code in 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 registration document type. This field is required (Y) for CFCA. Allowed values: TYDMZ: Unified Social Credit Code OTHERS: Other
Administrator	string	Y	Administrator information, contact person. This parameter is used as application information when applying for code signing, email signing, or document signing certificates. In addition, if csr is set to N, this information will be used to generate the CSR. { "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	The job title of the administrator.
city	String	Y	The city where the administrator is located.
email	String	Y	The email address of the administrator.
state	String	Y	Province or state where the administrator is located.
mobile	String	Y	Administrator contact phone number.
address	String	Y	Administrator contact address.
country	String	Y	The country where the administrator is located (use the two-letter code as defined in the ISO 3166-1 standard).
lastName	String	Y	Last name of the administrator.
postCode	String	Y	Postal code of the administrator's location.
firstName	String	Y	Administrator name.
organation	String	Y	Administrator company name.
idType	String	N	Identity document type. This field is required (Y) for CFCA.
idNumber	String	N	Identification number. This field is Y for CFCA.
finance	string		Only relevant to SSL certificates. Financial personnel information. This can be consistent with the administrator information. This parameter is 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": "A Company" }"
job	String	N	Position of the financial staff member.
city	String	N	City where the finance staff member is located.
email	String	N	Email address of the finance staff member.
state	String	N	Province or state where the finance staff member is located.
mobile	String	N	Contact information 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 ISO 3166-1 standard).
lastName	String	N	Last name of the finance contact.
postCode	String	N	Postal code of the finance contact's location.
firstName	String	N	First name of the finance contact.
organation	String	N	The company where the finance staff member is located.
idType	String	N	ID type. This field is Y for CFCA. Values are as follows: SFZ: Resident ID Card HZ: Passport
idNumber	String	N	ID number. This field is Y for CFCA.
tech	string	N	Relevant to SSL certificates only. Technician information. This parameter is required (Y) when the ordered product is not of DV type. { "job": "Technical 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 technician.
city	String	N	City where the technician is located.
email	String	N	Email address of the technical contact.
state	String	N	Province or state where the technical contact is located.
mobile	String	N	Contact phone number of the technical contact.
address	String	N	Contact address of the technical contact.
country	String	N	Country where the technical contact is located (two-letter code per the ISO 3166-1 standard).
lastName	String	N	Last name of the technical contact.
postCode	String	N	Postal code of the technician's location.
firstName	String	N	First name of the technician.
organation	String	N	Company the technician works for.
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.

Function return

Parameter name	Parameter type	Required	Description
code	Int	Y	Return status. For detailed explanations, see Appendix 3.1
errors	Object or String	N	Specific error information when the return status indicates an error.
data	Object	N	This parameter is Y when the return status is success. The specific description is as follows:
certId	String	N	Racent certificate ID. Please keep it properly; this parameter is the unique credential of the Racent instance.
failReason	Object	N	This field is returned when Racent fails to apply for a certificate from the CA and the failure reason can be clearly identified.
dataReasons	Array	N	Data reason
key	String	N	Item
reason	String	N	Reason
sysReason	String	N	System reason
vendorId	String	N	CA order number.
vendorCertId	String	N	CA certificate number.
DCVfileName	String	N	File validation filename
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	If validation values differ for each domain in the certificate request, this field is set to Y Each entry is of type Object, with the requested domain as the object name, for example: racent.com. Details for 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