Request

Endpoint: CollectMC

https://secure.trust-provider.com/products/download/CollectMC

Use the POST method for this endpoint.

Submit parameters in the x-www-form-urlencoded format.

Request parameters

The following table displays the required, optional, and conditional parameters.

Parameter Requirement Type Max.Length Description

Parameter	Requirement	Type	Max.Length	Description
`loginName`	required	string	64 chars	Your account username. This value is case sensitive.
`loginPassword`	required	string	128 chars	Your account password. This value is case sensitive.
`orderNumber`	required	integer		The order number of the account.
`responseType`	optional	integer		Specifies the format of the returned certificate data. The allowed values are: `0` — ZIP archive. `responseEncoding` must be `1`. `2` — PKCS7. `responseEncoding` must be `1`.
`responseEncoding`	optional	integer		Specifies the encoding of the returned certificate data. The allowed values are: `0` — Base64-encoded. `1` — Binary encoded. `responseType` must be `0` or `2`.

loginName

required

string

64 chars

Your account username.

This value is case sensitive.

loginPassword

required

string

128 chars

Your account password.

This value is case sensitive.

orderNumber

required

integer

The order number of the account.

responseType

optional

integer

Specifies the format of the returned certificate data.

The allowed values are:

0 — ZIP archive. responseEncoding must be 1.
2 — PKCS7. responseEncoding must be 1.

responseEncoding

optional

integer

Specifies the encoding of the returned certificate data.

The allowed values are:

0 — Base64-encoded.
1 — Binary encoded. responseType must be 0 or 2.

Sample request

curl --location 'https://secure.trust-provider.com/products/download/CollectMC' \
--data-urlencode 'loginName=login_name' \
--data-urlencode 'loginPassword=login_password' \
--data-urlencode 'orderNumber=order_number' \
--data-urlencode 'RESPONSETYPE=2' \
--data-urlencode 'RESPONSEENCODING=1'

Response

The request is successful when the server returns a response with the status code >= 0:

2 — Certificates attached.
1 — Certificates available.
0 — Being processed by Sectigo.

Any status code less than 0 indicates an error condition.

The list of codes and their descriptions can be found in Error codes.

The response format depends on the value of the responseEncoding parameter in the request.

If responseEncoding=1, the certificate(s) are available and no error occurred, the output will consist simply of the requested binary structure.

If responseEncoding=0, the output will be formatted like one of the following:

If the status code is greater than 0, the output will be displayed as the value of responseMimeType or text/plain.
If the status code is less than or equal to 0, the output will be displayed as text/plain.

If the status code is less than 0, the response contains a textual representation of the error message.

If the status code equals 2, the response contains the encoded certificate(s):

----- BEGIN CERTIFICATE -----
Encoded Root Certificate
----- END CERTIFICATE -----
----- BEGIN CERTIFICATE -----
Encoded Intermediate Certificate
----- END CERTIFICATE -----
----- BEGIN CERTIFICATE -----
Encoded End Entity Certificate
---- END CERTIFICATE -----

Sample success response

Sample error response

-20
The certificate request has been rejected!

Error codes

The following table outlines error responses returned by the CollectMC API endpoint. Each error response consists of an errorCode and an errorMessage indicating why the request failed.

Error Code Error Message Description

Error Code	Error Message	Description
`-1`	`Request was not made over https!`	The request must use `HTTPS` protocol.
`-2`	`Unrecognised argument!`	The provided argument is not recognized.
`-3`	`The 'xxxx' argument is missing!`	The required argument is missing from the request.
`-4`	`The value of the 'xxxx' argument is invalid!`	The provided value for the 'xxxx' argument is invalid.
`-14`	`An unknown error occurred!`	An unknown error occurred.
`-16`	`Incorrect login details, account is locked, password has expired or your source IP is blocked.`	Authentication has failed due to one of the specified reasons. Verify your login credentials or check account restrictions.
`-17`	`Request used GET rather than POST!`	The request method should be `POST`.
`-20`	`The certificate request has been rejected!`	The requested certificate is in the rejected state.
`-21`	`The certificate has been revoked!`	The requested certificate is in the revoked state.
`-22`	`Still awaiting payment!`	The payment for the order is still pending.
`-91`	`Permission denied! 'xxxx'`	The user does not have the permission to perform the specified action.
`-160`	`Failed to collect the certificate.`	An error occurred while attempting to collect the certificate.

-1

Request was not made over https!

The request must use HTTPS protocol.

-2

Unrecognised argument!

The provided argument is not recognized.

-3

The 'xxxx' argument is missing!

The required argument is missing from the request.

-4

The value of the 'xxxx' argument is invalid!

The provided value for the 'xxxx' argument is invalid.

-14

An unknown error occurred!

An unknown error occurred.

-16

Incorrect login details, account is locked, password has expired or your source IP is blocked.

Authentication has failed due to one of the specified reasons.

Verify your login credentials or check account restrictions.

-17

Request used GET rather than POST!

The request method should be POST.

-20

The certificate request has been rejected!

The requested certificate is in the rejected state.

-21

The certificate has been revoked!

The requested certificate is in the revoked state.

-22

Still awaiting payment!

The payment for the order is still pending.

-91

Permission denied! 'xxxx'

The user does not have the permission to perform the specified action.

-160

Failed to collect the certificate.

An error occurred while attempting to collect the certificate.