2.3 Retrieve certificate request status
2.3.1 API Information
| Test environment | |
|---|---|
| Production environment | https://portal.racent.com/ssl/collect |
| Request method | POST |
| content-type | multipart/form-data |
| Description | This interface is used to obtain the order certificate status, retrieve certificates, and obtain validation information. |
2.3.2 Parameter Definitions
| Parameter name | Parameter type | Required | Description |
|---|---|---|---|
| certId | String | Y | racent certificate ID |
| api_token | String | Y | Identity credential. Please contact Racent technical support to generate a token. |
Function Return
| Parameter name | Parameter type | Required | Description |
|---|---|---|---|
| code | int | Y | Return status. For detailed explanations, please refer to Appendix 3.1 |
| status | String | Y | Order status: PENDING: Application in progress COMPLETE: Application successful CANCELLED: Cancelled REISSUED: Reissued FAILED: Application failed RENEWED: Renewed REVOKED: Revoked |
| certStatus | String | Y | Certificate status: PENDING: Application in progress COMPLETE: Application successful CANCELLED: Cancelled REISSUED: Reissued FAILED: Application failed RENEWED: Renewed REVOKED: Revoked |
| data | Object | N | Return data, the specific details are as follows |
| failReason | Object | N | When the status is FAILED, the value of this parameter is Y, indicating the failure reason |
| dataReasons | Array | N | Data reason |
| key | String | N | Item |
| reason | String | N | Reason |
| sysReason | String | N | System reason |
| beginDate | String | N | When the status is COMPLETE, the value of this parameter is Y, indicating the certificate start time |
| endDate | String | N | When the status is COMPLETE, the value of this parameter is Y, indicating the certificate end time |
| certificate | String | N | When the status is COMPLETE, the value of this parameter is Y, indicating the PEM certificate |
| caCertificate | String | N | When the status is COMPLETE, this parameter returns Y, which is the PEM intermediate certificate |
| jks | String | N | When 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. |
| jksPass | String | N | When the status is COMPLETE and Racent holds the correct private key information, this parameter returns Y, which is the password for the JKS certificate. |
| pkcs12 | String | N | When 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. |
| pkcsPass | String | N | When the status is COMPLETE and Racent holds the correct private key information, this parameter returns Y, which is the password for the PKCS12 certificate. |
| privateKey | String | N | When the status is COMPLETE and Racent holds the correct private key information, this parameter returns Y, which contains the private key information |
| rsaPrivateKey | String | N | RSA 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 |
| replaceCertId | String | N | When the status is REISSUED, this parameter returns Y, which is the Racent certificate ID after reissue |
| oldCertId | String | N | When the certificate request is for a reissued certificate, this parameter returns Y, which is the old Racent certificate ID |
| vendorId | String | N | CA order number |
| vendorCertId | String | N | CA certificate number (Sectigo order number) |
| DCVfileName | String | N | File-based Domain Control Validation (DCV), file name |
| DCVfileContent | String | N | File-based Domain Control Validation (DCV), file content |
| DCVdnsHost | String | N | DNS-based Domain Control Validation (DCV), host |
| DCVdnsValue | String | N | DNS-based Domain Control Validation (DCV) value |
| DCVdnsType | String | N | DNS-based Domain Control Validation (DCV) type |
| dcvInfo | Object | N | This 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: |
| DCVfileName | String | N | File-based Domain Control Validation (DCV), file name |
| DCVfileContent | String | N | File-based Domain Control Validation (DCV), content of the verification file |
| DCVdnsHost | String | N | DNS-based Domain Control Validation (DCV), host |
| DCVdnsValue | String | N | DNS-based Domain Control Validation (DCV), value |
| DCVdnsType | String | N | DNS-based Domain Control Validation (DCV), type |
| DCVfilePath | String | N | File path for file-based Domain Control Validation (DCV) |
| dcvList | Array | N | Domain Control Validation (DCV) list, each item is of Object type. Details of each item are as follows: |
| domainName | String | N | Domain name |
| dcvMethod | String | N | Domain Control Validation (DCV) method |
| dcvEmail | String | N | Domain Control Validation (DCV) email address |
| is_verify | String | N | The parameter value is "verified" when verified; the parameter is not present if unverified |
| application | Object | N | Order submission status |
| status | String | N | The parameter is one of the following values: notdone: Incomplete done: Completed ongoing: In progress |
| dcv | Object | N | Domain validation status |
| status | String | N | The parameter is one of the following values: notdone: Incomplete done: Completed ongoing: In progress |
| ov | Object | N | Organization validation status |
| status | String | N | The parameter is one of the following values: notdone: Incomplete done: Completed ongoing: In progress |
| issued | Object | N | Issuance status |
| status | String | N | The parameter is one of the following values: notdone: Incomplete done: Completed ongoing: In progress |
| applyParams | Object | N | Application parameters. For details, refer to the request parameters of the application interface (place). |
| csr | String | N | CSR |
| Administrator | Object | N | Administrator information |
| job | String | N | Job title |
| city | String | N | City |
| String | N | ||
| state | String | N | Province or state |
| mobile | String | N | Contact information |
| address | String | N | Contact address |
| country | String | N | Country (two-letter code as defined in the ISO 3166-1 standard). |
| lastName | String | N | Last name |
| postCode | String | N | Postal code |
| firstName | String | N | First name |
| organation | String | N | Company name |
| idType | String | N | ID type. This field is required (Y) for CFCA. Possible values: SFZ: ID card HZ: Passport |
| idNumber | String | N | ID number. This field is required (Y) for CFCA. |
| tech | Object | N | Technical contact information, with the same specific fields as the administrator information. |
| finance | Object | N | Finance contact information, with the same specific fields as the administrator information. |
| organizationInfo | Object | N | Company information |
| organizationCity | String | N | City |
| organizationName | String | N | Name |
| organizationMobile | String | N | Phone number |
| organizationAddress | String | N | Address |
| organizationCountry | String | N | Country |
| organizationPostCode | String | N | Postal code |
| organizationRegNumbe | String | N | Company registration number. This field is mandatory (Y) for CFCA. |
| idType | String | N | Company identification document type. This field is mandatory (Y) for CFCA. Possible values are: TYDMZ: Unified Social Credit Code OTHERS: Other |
| errors | Object or String | N | Detailed error information when the returned status indicates an error. |