Endpoint: CollectMC

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

The CollectMC API endpoint allows you to collect an issued mark certificate.

Use the POST method for this endpoint.

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

The following table lists the required and optional parameters.

Parameter Type Requirement Max. Length Description

loginName

string

conditional

64 chars

Your account username.

This value is case sensitive.

loginPassword

string

conditional

128 chars

Your account password.

This value is case sensitive.

orderNumber

integer

required

The order number of the account.

responseType

integer

optional

Specifies the format of the returned certificate data.

The possible values are:

  • 0 = ZIP archive

  • 2 = PKCS7

  • 3 = PEM

For more details, see Certificate formats.

responseEncoding

integer

optional

Specifies the encoding of the returned certificate data.

The possible values are:

  • 0 = BASE64 encoded

  • 1 = Binary encoded

Sample request

curl --location --request POST 'https://secure.trust-provider.com/products/!CollectMC' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'loginName=yourLoginName' \
--data-urlencode 'loginPassword=yourPassword' \
--data-urlencode 'responseType=2' \
--data-urlencode 'responseEncoding=0'

Response

The request is successful when the server returns a response with the status code greater than or equal to 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 = 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

-----BEGIN PKCS7-----
MIIbWQYJKoZIhvcNAQcCoIIbSjCCG0YCAQExDTALBglghkgBZQMEAgEwDwYJKoZI
hvcNAQcBoAIEAKCCGHEwggzyMIILWqADAgECAhBLVWcU36fkE8Hi/55APse9MA0G
...
Hi4ZaP9ok+JrTdy01WOmCnuAIaOUdM+w3wb+DSNLh9MoqqeM2mBZdC7EGthYeg+O
RhZWrKZng/nCi4Pt0PQrKEFNaMdscl+0rnrQA+U6llop7fmztjhKtOwDR6bQ
-----END PKCS7-----

Sample error response

-20
The certificate request has been rejected!

Certificate formats

Format Name Content-Type Description

PKCS7

application/x-pkcs7-certificates

A single .p7b file containing the complete chain: root, intermediate, and end-entity certificates.

ZIP archive

application/zip

A .zip archive with separate files for root, intermediate, and end-entity certificates.

Individually encoded

text\plain

A single .pem file bundling root, intermediate, and end-entity certificates together.

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

-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 permission for the specified context.

-160

Failed to collect the certificate.

An error occurred while attempting to collect the certificate.