Request

Endpoint: !getPostPaymentStatus

https://secure.trust-provider.com/products/!getPostPaymentStatus

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

loginName

required

string

64 chars

Your account username.

This value is case sensitive.

loginPassword

requried

string

128 chars

Your account password.

This value is case sensitive.

orderNumber

required

string

128 chars

The order number of the certificate for which the post-payment page status needs to be retrieved.

CertificateID

optional

number

16 digits

The certificate ID.

Not relevant for VMC/CMC.

Sample request

curl --location 'https://secure.trust-provider.com/products/!getPostPaymentStatus' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'loginName=login_name' \
--data-urlencode 'loginPassword=login_password' \
--data-urlencode 'orderNumber=1234567'

Response

The response from getPostPaymentStatus is in JSON format.

The character encoding is charset=UTF-8.

Response parameters

The following table describes the parameters included in the response.

Parameter Type Description

errorCode

integer

A numeric code that identifies the type of error.

For more information, see Error codes.

errorMessage

string

A description of the error.

data

Object (PostPaymentData)

Contains the description of statuses.

Object (PostPaymentData)

orderNumber

string

The order number.

productType

integer

The object type ID.

productName

string

The product name.

certificateDuration

integer

The certificate duration, in days.

productTerm

integer

The product term, in days.

uploadDocumentUrl

string

The URL to upload documents of the order.

For more information, see Upload document.

uploadDocumentToken

string

The JSON Web Token (JWT) to upload a file.

For more information, see Upload document.

orderStatus

string

The order status.

The possible values are:

  • Current

  • Awaiting Payment

  • Payment Promised

  • Pending

  • Awaiting Authorization

  • Processed

  • Rejected

  • Refunded

  • ERROR!!!

domainName

string

Contains a common name for a single domain certificate.

Contains static text 'Multiple domains' for MDC.

primaryDomainName

string

(MDC only) The primary domain name.

maxMDCDomains

integer

(MDC only) The maximum number of domains that a certificate can contain.

maxMDCWildcardDomains

integer

(MDC only) The maximum number of wildcard domains that a certificate can contain.

maStatus

integer

(OV/EV only) The master account status.

The possible values are:

  • -1 — Not required. For example, no matching record found for the Enterprise Authentication for instant issuance to apply.

  • 0 — Not completed. For example, since no confirmation was received to apply the matching record for Enterprise Authentication related to instant issuance, manual organization validation has started.

  • 1 — Completed. For example, the organization has been automatically validated through Enterprise Authentication for instant issuance.

  • 2 — In progress. For example, the matching record for Enterprise Authentication related to instant issuance has been found, and its confirmation request is awaiting the customer’s action.

  • 3 — Rejected. For example, the request for confirmation to apply the matching record for the Enterprise Authentication for instant issuance has been rejected.

csrStatus

Object (csrStatus)

The CSR status detail.

dcvStatus

Object (dcvStatus)

The DCV status detail.

agreementStatus

Object (agreementStatus)

The agreement execution status detail.

callbackStatus

Object (callbackStatus)

The callback status detail.

organizationStatus

Object (organizationStatus)

The organization validation status detail.

secondApprovalStatus

Object (secondApproval)

The second approval status for the EV order.

fsupStatus

Object (fsupStatus)

The fast service status.

caaCheckStatus

Object (caaCheckStatus)

The CAA check status.

Object (csrStatus)

title

string

The section title.

status

string

The general status of the CSR.

The possible values are:

  • NotApplicable

  • ActionRequired

  • Completed

  • InProgress

  • Unknown

description

string

The text of the description.

availableActions

array of string

The actions available within Sectigo for the current status.

Object (dcvStatus)

title

string

The section title.

status

string

The general DCV status.

The possible values are:

  • NotApplicable

  • ActionRequired

  • Completed

  • InProgress

  • Unknown

description

string

The text of the description.

availableActions

array of string

The actions available within Sectigo for the current status.

The possible values are:

  • selectDCVMethod

  • canChangeDCVMethod

  • enterDCVCode

domains

Array of object (domainDescription)

The list of domains.

For single domain certificate the array contains one element only.

MD5

string

The MD5 CSR’s hash.

SHA256

string

The SHA-256 CSR’s hash.

uniqueValue

string

The unique request tokens.

Object (agreementStatus)

title

string

The section title.

status

string

The general status of the agreement.

The possible values are:

  • NotApplicable

  • ActionRequired

  • Completed

  • InProgress

  • Unknown

description

string

The text of the description.

availableActions

string

The actions available within Sectigo for the current status.

The possible values are:

  • canUpdateEmailAddress

  • resendAgreementEmail

  • needUpdateEmailAddress

clickThroughStatus

string

The click-through agreement status.

The possible values are:

  • notExecuted

  • Executed

clickThroughEmailAddress

string

The EV subscriber agreement and certificate request form email address.

lastEmailSent

date

Specifies the date when the email was last sent.

The format is YYYY-MM-DD.

lastOpenDate

date

Specifies the date when the email was last open. The format is YYYY-MM-DD.

Object (callbackStatus)

title

string

The section title.

status

string

The general status of the callback.

The possible values are:

  • NotApplicable

  • ActionRequired

  • Completed

  • InProgress

  • Unknown

description

string

The text of the description.

phoneNumber

string

The callback phone number.

availableActions

array of string

The actions available within Sectigo for the current status.

The possible values are:

  • callMeNow

  • callMeLater

  • provideCorrectPhoneNumber

  • enterCallbackCode

  • requestManualCallback

Object (organizationStatus)

title

string

The section title.

status

string

The general organization status.

The possible values are:

  • NotApplicable

  • ActionRequired

  • Completed

  • InProgress

  • Unknown

description

string

The text of the description.

availableActions

array of string

The actions available within Sectigo for the current status.

The possible value is uploadDocument.

organizationName

Object (requirementStatus)

(OV/EV only) The status of the organization name check.

legalExistence

Object (requirementStatus)

(EV only) The status of the legal existence check.

assumedName

Object (requirementStatus)

(EV only) The status of the assumed name check.

physicalExistence

Object (requirementStatus)

(EV only) The status of the physical existence check.

operationalExistence

Object (requirementStatus)

(EV only) The status of the operational existence check.

trademarkCheck

Object (requirementStatus)

(OV/EV only) The status of the brand validation check.

Object (secondApproval)

title

string

The section title.

status

string

The general status of the second approval.

The possible values are:

  • NotApplicable

  • ActionRequired

  • Completed

  • InProgress

  • Unknown

description

string

The text of the description.

Object (fsupStatus)

title

string

The section title.

status

string

The general fast service status.

The possible values are:

  • NotApplicable

  • ActionRequired

  • Completed

  • InProgress

  • Unknown

description

string

The text of the description.

Object (requirementStatus)

title

string

The section title.

status

string

The validation status.

The possible values are:

  • NotApplicable

  • InProgress

  • Completed

description

string

The text of the description.

Object (domainDescription)

domainName

string

The section title.

dcvStatus

string

The validation status.

The possible values are:

  • NotApplicable

  • InProgress

  • Completed

selectedMethod

string

The selected DCV method.

methods

array of object (dcvMethod)

The available DCV methods for a domain.

Object (dcvMethod)

type

string

The method type.

The possible values are:

  • whoisEmail

  • email

  • csrHash

  • manual

title

string

The method title.

level

string

The level of the email list.

Applicable for type = email.

selectedMethod

string

The selected DCV method.

options

array of string

Specific options for the method.

If type=whoisEmail, the list of available email addresses for the DCV method is based on WHOIS.

If type=csrHash, the list of available dcv methods based on CSR HASH:

  • CNAME CSR Hash

  • HTTP CSR Hash

  • HTTPS CSR Hash

If type=email, the list of available email addresses for the DCV method is based on the email.

If type=manual, the list contains only one element — Manual.

Object (caaCheckStatus)

title

string

The section title.

statud

string

The check status.

The possible values are:

  • NotApplicable

  • ActionRequired

  • Completed

  • InProgress

  • Unknown

latestCAACheckErrors

Object (latestCAACheckErrors)

The list of failed checks for the latest CAA check session.

Displayed if status=ActionRequired.

Object (latestCAACheckErrors)

lookupDatetime

date

The date and time of the check.

The format is YYYY-MM-DD HH24:MI:SS.

queriedFQDN

string

The fully qualified domain name (FQDN).

domainName

string

The domain name.

result

string

The check result.

The possible values are:

  • Empty

  • Authorized

  • Not Authorized

  • ERROR!

  • Timeout!

  • Unrecognized Critical Tag

  • Malformed Response

Upload document

Sectigo allows the client to upload electronic copies of documents to speed up the process of company validation.

For these purposes, a separate API is created. The JSON response contains the URL for this API in the uploadDocumentUrl attribute. There is also the uploadDocumentToken attribute that contains a JWT that is used for authorization on the server side when using an upload document API.

The following is an example HTML form for uploading documents:

<form action="<uploadDocumentUrl>" method="POST" enctype="multipart/form-data">
<input type="hidden" name="token" value="<uploadDocumentToken>" />
<input type="hidden" name="successURL" value="<go to URL if successful>" />
<input type="hidden" name="errorURL" value="<go to URL if failed>" />
<br>Document: <input type="file" name="file" multiple/>
<br>
<br>Comment: <input type="text" name="comment" size=64/>
<br>
<br>
<input type="submit" value="Upload"/>
</form>

Sample successful response

{
"errorCode": 0,
"errorMessage": "",
"data": {
"orderNumber": 654824,
"productType": 410,
"productName": "COMODO EV Multi-Domain SSL Certificate",
"certificateDuration": 365,
"productTerm": 365,
"uploadDocumentUrl": "https://avspartners.sectigolabs.com/avs/ws/api/v002/order",
"uploadDocumentToken":
"eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiIvb3JkZXIvNjU0ODI0Iiwic2NvcGVzIjpbIlBPU1RfUEFZTUVOVF9QQUdFX1VTRVIiXSwiaXNzIjoiaHR0c
HM6Ly9hdnMuc2VjdGlnby5jb20iLCJpYXQiOjE1NzUyOTQxMjEsImV4cCI6MTU3NTMzNzMyMX0.UTeXiv1rmu-
75kgAvVjuVHW0TPTHRgu_krv4BvfrggFOGbe8dGcmt-0ufgOp0QKcF4eT0KXRx3gQVsy-56eeAQ",
"orderStatus": "Pending",
"domainName": "Multiple domains",
"primaryDomainName": "example.com",
"maxMDCDomains": 3,
"maxMDCWildcardDomains": 0,
"maStatus": -1,
"csrStatus": {
"title": "Submit your CSR",
"status": "Completed",
"description": "You have already submitted your CSR.",
"availableActions": [
"canReplaceCSR"
]
},
"dcvStatus": {
"title": "Domain Control Validation",
"status": "ActionRequired",
"MD5": "55F0233969C9C4325B1A19D4B357ED20",
"SHA256": "549B164F1F97EC4095C3FEF212F6B86016FF66F7F9115FFEBBD2AB796FF226A8",
"uniqueValue": "mTpFcIIg",
"description": "In order to verify your ownership of the domain in the application, it is mandatory to complete domain control validation.",
"domains": [
{
"domainName": "example.com",
"dcvStatus": "notCompleted",
"selectedMethod": "Not yet set",
"methods": [
{
"type": "email",
"title": "Alternative Email Addresses",
"level": 2,
"options": [
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]"
]
},
{
"type": "csrHash",
"title": "Alternative Methods",
"options": [
"CNAME CSR Hash",
"HTTP CSR Hash",
"HTTPS CSR Hash"
]
},
{
"type": "manual",
"title": "None of the above",
"options": [
"Manual"
]
}
]
},
{
"domainName": "example.org",
"dcvStatus": "notCompleted",
"selectedMethod": "Not yet set",
"methods": [
{
"type": "email",
"title": "Alternative Email Addresses",
"level": 2,
"options": [
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]"
]
},
{
"type": "csrHash",
"title": "Alternative Methods",
"options": [
"CNAME CSR Hash",
"HTTP CSR Hash",
"HTTPS CSR Hash"
]
},
{
"type": "manual",
"title": "None of the above",
"options": [
"Manual"
]
}
]
},
{
"domainName": "some.example.com",
"dcvStatus": "notCompleted",
"selectedMethod": "Not yet set",
"methods": [
{
"type": "email",
"title": "Alternative Email Addresses",
"level": 3,
"options": [
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]"
]
},
{
"type": "csrHash",
"title": "Alternative Methods",
"options": [
"CNAME CSR Hash",
"HTTP CSR Hash",
"HTTPS CSR Hash"
]
},
{
"type": "manual",
"title": "None of the above",
"options": [
"Manual"
]
}
]
}
],
"availableActions": [
"selectDCVMethod"
]
},
"agreementStatus": {
"title": "Agreement Execution",
"status": "Completed",
"clickThroughStatus": "Executed",
"clickThroughEmailAddress": "[email protected]",
"lastEmailSent": "2019-11-20",
"lastOpenDate": "2019-11-20"
},
"callbackStatus": {
"title": "Signer Verification",
"status": "InProgress",
"description": "Our validation staff are currently verifying the phone number used in your application.\nOnce this process is complete, you will
receive an email containing further instructions."
},
"organizationStatus": {
"title": "Organization Validation",
"status": "InProgress",
"description": "Our validation staff will now attempt to validate your organization by consulting various federal and business databases.\nIn most
cases this is a routine process that should be completed within a couple of working days.\nIf they cannot locate certain pieces of information about
your organization, they may contact you to request that you provide documentation.",
"organizationName": {
"title": "Organization name",
"status": "Unknown"
},
"legalExistence": {
"title": "Legal Existence",
"status": "Unknown"
},
"assumedName": {
"title": "Assumed Name",
"status": "Unknown"
},
"physicalExistence": {
"title": "Physical Existence",
"status": "Unknown"
},
"operationalExistence": {
"title": "Operational Existence",
"status": "Unknown"
},
"trademarkCheck": {
"title": "Trademark check",
"status": "NotApplicable"
}
},
"secondApprovalStatus": {
"title": "Second Approval",
"status": "Unknown"
},
"fsupStatus": {
"title": "Fast Service Certificate",
"status": "NotApplicable"
},
"caaCheckStatus":{
"title":"CAA Check",
"status":"ActionRequired",
"latestCAACheckErrors":[
{
"lookupDatetime":"2019-11-20 08:45:26",
"queriedFQDN":"example.com",
"domainName":"example.com",
"result":"Not Authorized"
},
{
"lookupDatetime":"2019-11-20 08:45:26",
"queriedFQDN":"example.org",
"domainName":"example.org",
"result":"Not Authorized"
}
]
}
}
}

Sample error response

{
    "errorCode": "-17",
    "errorMessage": "Request used GET rather than POST!",
    "data": {}
}

Error codes

The following table outlines error responses returned by the getPostPaymentStatus 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

'xxx' is an unrecognized argument!

The provided argument is not recognized.

-3

The 'xxxx' argument is missing!

A required argument is missing from the request.

-4

The value of the 'xxxx' argument is invalid!

The argument value does not meet validation requirements.

-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 failed due to incorrect login details, a locked account, an expired password, or a blocked source IP address.

-17

Request used GET rather than POST!

The request method should be POST.

-42

Call limit reached! Please try again later

The maximum number of allowed API requests has been exceeded.