Skip to main content

2.3 Retrieve certificate request status

2.3.1 API Information

Test environment
Production environmenthttps://portal.racent.com/ssl/collect
Request methodPOST
content-typemultipart/form-data
DescriptionThis interface is used to obtain the order certificate status, retrieve certificates, and obtain validation information.

2.3.2 Parameter Definitions

Parameter nameParameter typeRequiredDescription
certIdStringYracent certificate ID
api_tokenStringYIdentity credential. Please contact Racent technical support to generate a token.

Function Return

Parameter nameParameter typeRequiredDescription
codeintYReturn status. For detailed explanations, please refer to Appendix 3.1
statusStringYOrder status:
PENDING: Application in progress
COMPLETE: Application successful
CANCELLED: Cancelled
REISSUED: Reissued
FAILED: Application failed
RENEWED: Renewed
REVOKED: Revoked
certStatusStringYCertificate status:
PENDING: Application in progress
COMPLETE: Application successful
CANCELLED: Cancelled
REISSUED: Reissued
FAILED: Application failed
RENEWED: Renewed
REVOKED: Revoked
dataObjectNReturn data, the specific details are as follows
failReasonObjectNWhen the status is FAILED, the value of this parameter is Y, indicating the failure reason
dataReasonsArrayNData reason
keyStringNItem
reasonStringNReason
sysReasonStringNSystem reason
beginDateStringNWhen the status is COMPLETE, the value of this parameter is Y, indicating the certificate start time
endDateStringNWhen the status is COMPLETE, the value of this parameter is Y, indicating the certificate end time
certificateStringNWhen the status is COMPLETE, the value of this parameter is Y, indicating the PEM certificate
caCertificateStringNWhen the status is COMPLETE, this parameter returns Y, which is the PEM intermediate certificate
jksStringNWhen the status is COMPLETE and Racent holds the correct private key information, this parameter returns Y, which is the Base64-encoded content of the JKS certificate.
jksPassStringNWhen the status is COMPLETE and Racent holds the correct private key information, this parameter returns Y, which is the password for the JKS certificate.
pkcs12StringNWhen the status is COMPLETE and Racent holds the correct private key information, this parameter returns Y, which is the Base64-encoded content of the PKCS12 certificate.
pkcsPassStringNWhen the status is COMPLETE and Racent holds the correct private key information, this parameter returns Y, which is the password for the PKCS12 certificate.
privateKeyStringNWhen the status is COMPLETE and Racent holds the correct private key information, this parameter returns Y, which contains the private key information
rsaPrivateKeyStringNRSA format private key; when the status is COMPLETE and Racent holds the correct private key information, this parameter returns Y, which contains the private key information
replaceCertIdStringNWhen the status is REISSUED, this parameter returns Y,
which is the Racent certificate ID after reissue
oldCertIdStringNWhen the certificate request is for a reissued certificate, this parameter returns Y,
which is the old Racent certificate ID
vendorIdStringNCA order number
vendorCertIdStringNCA certificate number (Sectigo order number)
DCVfileNameStringNFile-based Domain Control Validation (DCV), file name
DCVfileContentStringNFile-based Domain Control Validation (DCV), file content
DCVdnsHostStringNDNS-based Domain Control Validation (DCV), host
DCVdnsValueStringNDNS-based Domain Control Validation (DCV) value
DCVdnsTypeStringNDNS-based Domain Control Validation (DCV) type
dcvInfoObjectNThis field will be returned as Y when the validation value differs for each domain in the certificate request.
Each item is of Object type, and each object name is the applied domain name, for example: racent.com. Details of each item are as follows:
DCVfileNameStringNFile-based Domain Control Validation (DCV), file name
DCVfileContentStringNFile-based Domain Control Validation (DCV), content of the verification file
DCVdnsHostStringNDNS-based Domain Control Validation (DCV), host
DCVdnsValueStringNDNS-based Domain Control Validation (DCV), value
DCVdnsTypeStringNDNS-based Domain Control Validation (DCV), type
DCVfilePathStringNFile path for file-based Domain Control Validation (DCV)
dcvListArrayNDomain Control Validation (DCV) list, each item is of Object type. Details of each item are as follows:
domainNameStringNDomain name
dcvMethodStringNDomain Control Validation (DCV) method
dcvEmailStringNDomain Control Validation (DCV) email address
is_verifyStringNThe parameter value is "verified" when verified; the parameter is not present if unverified
applicationObjectNOrder submission status
statusStringNThe parameter is one of the following values:
notdone: Incomplete
done: Completed
ongoing: In progress
dcvObjectNDomain validation status
statusStringNThe parameter is one of the following values:
notdone: Incomplete
done: Completed
ongoing: In progress
ovObjectNOrganization validation status
statusStringNThe parameter is one of the following values:
notdone: Incomplete
done: Completed
ongoing: In progress
issuedObjectNIssuance status
statusStringNThe parameter is one of the following values:
notdone: Incomplete
done: Completed
ongoing: In progress
applyParamsObjectNApplication parameters. For details, refer to the request parameters of the application interface (place).
csrStringNCSR
AdministratorObjectNAdministrator information
jobStringNJob title
cityStringNCity
emailStringNEmail
stateStringNProvince or state
mobileStringNContact information
addressStringNContact address
countryStringNCountry (two-letter code as defined in the ISO 3166-1 standard).
lastNameStringNLast name
postCodeStringNPostal code
firstNameStringNFirst name
organationStringNCompany name
idTypeStringNID type. This field is required (Y) for CFCA.
Possible values:
SFZ: ID card
HZ: Passport
idNumberStringNID number. This field is required (Y) for CFCA.
techObjectNTechnical contact information, with the same specific fields as the administrator information.
financeObjectNFinance contact information, with the same specific fields as the administrator information.
organizationInfoObjectNCompany information
organizationCityStringNCity
organizationNameStringNName
organizationMobileStringNPhone number
organizationAddressStringNAddress
organizationCountryStringNCountry
organizationPostCodeStringNPostal code
organizationRegNumbeStringNCompany registration number. This field is mandatory (Y) for CFCA.
idTypeStringNCompany identification document type. This field is mandatory (Y) for CFCA.
Possible values are:
TYDMZ: Unified Social Credit Code
OTHERS: Other
errorsObject or StringNDetailed error information when the returned status indicates an error.