Collect Certificates

POST https://portal.nicsrs.com/ssl/collect

This API is used for checking the status of requested certificates and also downloading the signed certificate in various formats once it is issued.

Request parameters

Fields explanation:

▪ R – Required

▪ O – Optional

Name	Type	Req/Opt	Description
certId	String	R	This is the certificate ID previously returned (e.g. from the order call).
api_token	String	R	Authentication credentials (User token). To get token, please contact NicSRS technical support.

Response parameters

Name	Type	Req/Opt	Description
code	int	R	Response status codes. A response code identifies a specific status. See Appendix – Response Codes.
status	String	R	The status of requested certificates.Three statuses are below.PENDING: The requested certificate is in the process.COMPLETE: The requested certificate has been issued successfully.CANCELLED: The requested certificate has been cancelled by user.
data	Json	O	This is response data for the statuses of requested certificate. See the details below.
-beginDate	String	O	The activation date of the requested certificates. If the status of the requested certificate is COMPLETE, the value exists.
-endDate	String	O	The expiration date of the requested certificates. If the status of the requested certificate is COMPLETE, the value exists.
-certificate	String	O	The certificate issued by CA. If the status of the requested certificate is COMPLETE, the value exists.
-caCertificate	String	O	Intermediate certificate. If the status of the requested certificate is COMPLETE, the value exists.
-jks	String	O	If the paired private key of the certificate is saved in nicsrs.com, the certificate in JKS format Base-64 encoded can be provided.
-jksPass	String	O	If the status of the requested certificate is COMPLETE and the paired private key is saved in nicsrs.com, the password of certificate in JKS format can be provided.
-pkcs12	String	O	If the status of the requested certificate is COMPLETE and the paired private key is saved in nicsrs.com, the certificate in PKCS12 format Base-64 encoded can be provided.
-pkcsPass	String	O	If the status of the requested certificate is COMPLETE and the paired private key is saved in nicsrs.com, the password of certificate in PKCS12 format can be provided.
-privateKey	String	O	If the status of the requested certificate is COMPLETE and the paired private key is saved in nicsrs.com, the value exists.
-vendorId	String	O	The order ID from CA
-vendorCertId	String	O	The certificate ID from CA
-DCVfileName	String	O	Name of DCV file.
-DCVfileContent	String	O	Content of the DCV file.
-DCVdnsHost	String	O	DNS host for DCV.
-DCVdnsValue	String	O	DNS value for DCV.
-DCVdnsType	String	O	DNS type for DCV.
-dcvList	Array	O
–domainName	String	O	Domain name to be secured.
–dcvMethod	String	O	Domain control validation (DCV) methods.
–dcvEmail	String	O	Email address of domain administrator.
–is_verify	String	O	If domain control validation is successful, the value demonstrates “verified”. If not, the value does not exist.
-application	Array	O	Status of certificate order.
–status	Int	O	Three statuses:▪ Notdone ▪ Done ▪ Ongoing
-dcv	Array	O	Status of DCV.
–status	Int	O	Three statuses:▪ Notdone ▪ Done ▪ Ongoing
-ov	Array	O	Status of organization validation.
–status	Int	O	Three statuses:▪ Notdone ▪ Done ▪ Ongoing
-issued	Array	O	Status of issuing certificate.
–status	Int	O	Three statuses:▪ Notdone ▪ Done ▪ Ongoing
errors	Array or String	O	If the requested parameter for validation is false, the value will be Y.