Skip to main content

2.1 Validate Data

2.1.1 Interface Description​

Environment
Production environmenthttps://portal.racent.com/ssl/validate
Request methodPOST
content-typemultipart/form-data
DescriptionThis interface is used to validate all order data you submit. Please call this interface before calling the order interface to ensure smooth order processing. This validation confirms your account information, verifies that your order information is correct, and returns relevant error codes (see Appendix 3.1).

2.1.2 Parameter Definition​

Parameter nameParameter typeRequiredDescription
api_tokenStringYUser token. Please contact Racent technical support to obtain the token.
productCodeStringYProduct code. Obtain the product code (see Section 2.7).
yearsIntYPurchase period (currently only 1, 2, 3, 4, and 5 years are supported), subject to the specific product.
refIdStringNUnique customer order number provided by the client
verificationPicFileNBackup verification material. Used for organization verification, supports .jpg/.jpeg/.png/.gif/.bmp/.rar/.zip/.pdf formats, with a maximum file size of 2 MB.
domainVerificationPicFileNThis field is required (Y) when the Domain Control Validation (DCV) method is set to VERIFY_DOCUMENT. Used for Domain Control Validation (DCV) (currently only supported by CFCA).
paramsStringYOrder information (JSON string), detailed as follows
csrStringNWhen this parameter is empty, a CSR will be generated for you and the private key will be saved.
privateKeyStringNPrivate key.
serverStringNServer. Only related to SSL certificates. This parameter is Y for SSL certificates and N for other product types. If this parameter is not required, use the default value "other".
uniqueValueStringNOnly related to Sectigo products. A 1-20 character string (a-z A-Z 0-9) used by resellers to independently generate verification values.
dcvMethodStringNSet the Domain Control Validation (DCV) method uniformly for the 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 parameter is Y for CFCA.
domainInfoStringNDomain information, only relevant for SSL certificates. The parameter is Y for SSL certificates and N for other certificate 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:
dcvMethodStringNDomain validation 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)
When the higher-level dcvMethod does not exist, this field is Y.
If the higher-level dcvMethod exists and this field is also provided, the higher-level dcvMethod will take precedence.
dcvEmailStringNDomain Control Validation (DCV) email address.
When this parameter is set to N, the default values are as follows:
racent.com : admin@racent.com
www.racent.com : admin@racent.com
*.racent.com : admin@racent.com
domainNameStringNDomain name
organizationInfoStringNCompany information. This parameter is required (Y) when ordering products that require enterprise validation. Example:
{
"organizationCity": "Shanghai",
"organizationName": "Some Company",
"organizationMobile": "18111111111",
"organizationAddress": "Road, Shanghai",
"organizationCountry": "CN",
"organizationPostCode": "401320"
}"
organizationCityStringNCity where the company is located.
organizationNameStringNCompany name.
organizationMobileStringNCompany phone number.
organizationAddressStringNCompany address.
organizationCountryStringNCountry where the company is located (two-letter code in ISO 3166-1 standard).
organizationPostCodeStringNPostal code of the company's location.
organizationRegNumberStringNCompany certificate number. This field is required (Y) for CFCA.
idTypeStringNCompany certificate type. This field is required (Y) for CFCA.
Allowed values:
TYDMZ: Unified Social Credit Code
OTHERS: Other
AdministratorstringYAdministrator information, contact person. This parameter is used as application information when applying for code signing, email signing, and document signing certificates. In addition, if the csr field 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"
}"
jobStringYAdministrator's job title.
cityStringYCity where the administrator is located.
emailStringYAdministrator's email address.
stateStringYProvince or state where the administrator is located.
mobileStringYContact phone number of the administrator.
addressStringYContact address of the administrator.
countryStringYThe administrator's country of residence, using a two-letter code as defined in the ISO 3166-1 standard.
lastNameStringYThe administrator's last name.
postCodeStringYThe postal code of the administrator's location.
firstNameStringYAdministrator name.
organationStringYAdministrator company name.
idTypeStringNID type. This field is Y for CFCA.
Values are as follows:
SFZ: ID card
HZ: Passport
idNumberStringNIdentification number. This field is required (Y) for CFCA.
financestringOnly applicable to SSL certificates.
Financial contact information, which can be the same as the 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": "某公司"
}"
jobStringNThe position of the financial officer.
cityStringNThe city where the financial officer is located.
emailStringNThe email address of the financial officer.
stateStringNProvince or state where the finance officer is located.
mobileStringNContact information of the finance officer.
addressStringNContact address of the finance officer.
countryStringNThe country where the finance staff is located (two-letter code in ISO 3166-1 standard).
lastNameStringNThe last name of the finance staff.
postCodeStringNThe postal code of the location where the finance staff is located.
firstNameStringNName of the finance officer.
organationStringNCompany of the finance officer.
idTypeStringNID type. This field is mandatory (Y) for CFCA.
Available values:
SFZ: ID card
HZ: Passport
idNumberStringNID number. This parameter is Y for CFCA.
techstringNRelevant to SSL certificates only.
Technician information. This parameter is Y when the ordered product is not of the DV type.
{
"job": "技术部","city": "上海市",
"email": "xx@yy.com",
"state": "上海市",
"mobile": "18111111111",
"address": "上海市",
"country": "CN",
"lastName": "zhang",
"postCode": "401320",
"firstName": "nick",
"organation": "某公司"
}"
jobStringNTechnician job title.
cityStringNThe city where the technician is located.
emailStringNThe email address of the technician.
stateStringNThe province or state where the technician is located.
mobileStringNContact information of the technical personnel.
addressStringNContact address of the technical personnel.
countryStringNCountry where the technical personnel is located (two-letter code in ISO 3166-1 standard).
lastNameStringNLast name of the technical contact.
postCodeStringNPostal code of the technical contact's location.
firstNameStringNFirst name of the technical contact.
organationStringNThe company where the technician is employed.
idTypeStringNID type. This field is required (Y) for CFCA.
Possible values are:
SFZ: Resident Identity Card
HZ: Passport
idNumberStringNID number. This field is required (Y) for CFCA.

Function Return​

Parameter NameParameter TypeRequiredDescription
codeIntYReturn status. For detailed explanations, please refer to Appendix 3.1
errorsObject or StringNError message when the return status indicates an error.

2.1.3 Request Example​

请求示例

{
"years": 2,
"params": ‘{"server":"iis7","csr":"-----BEGIN CERTIFICATE REQUEST-----\nxxxxxxyyyoo\n-----END CERTIFICATE REQUEST-----\n","domainInfo":[{"domainName":"tt.cn","dcvMethod":"HTTP_CSR_HASH","dcvEmail":""}],"Administrator":{"organation":"cola","job":"it","firstName":"nick","lastName":"zhang","email":"xx@tt.com.cn","mobile":"13911111111","country":"CN","address":"上海市","city":"上海","state":"上海","postCode":"4457145"},"finance":{"organation":"某公司","job":"ceo","firstName":"nick","lastName":"zhang","email":"xxx@qq.com","mobile":"18111111111","country":"CN","address":"上海市","city":"上海","state":"上海","postCode":"4514154"},"tech":{"organation":"某公司","job":"ceo","firstName":"nick","lastName":"zhang","email":"xxx@qq.com","mobile":"15122222222","country":"CN","address":"上海市","city":"上海","state":"上海","postCode":"48787"},"organizationInfo":{"organizationCity":"上海","organizationState":"上海","organizationMobile":"153999999999","organizationAddress":"上海某地","organizationCountry":"CN","organizationPostCode":"200233","organizationName":"个人"}}’,
"api_token": "zzzoooppzz",
"productCode": "comodo-positivessl"
}