Request

Endpoint: !GetDetailedOrderStatus

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

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

required

string

128 chars

Your account password.

This value is case sensitive.

orderNumber

conditional

integer

The incomplete order number of the webhost account.

If certificateID is specified, orderNumber is not required.

certificateID

conditional

integer

16 digits

The internal certificate ID of the SSL certificate, Personal Authentication certificate, or Code Signing certificate.

If orderNumber is specified, certificateID is not required.

Not relevant for VMC/CMC products.

queryType

required

integer

Specifies the type of the query.

The allowed values are:

  • 0 — Return the status only.

  • 1 — Return the status and detailed status information.

  • 2 — Return the status and detailed status information and information about the replacement orders if they exist.

showValidityPeriod

optional

char

1 char

Specifies the validity period of the certificate.

The allowed values are:

  • Y — Display the validity period of the certificate.

  • N — Do not display the validity period of the certificate.

If omitted, the value defaults to N.

responseFormat

required

integer

Specifies the format of the returned certificate data.

The allowed values are:

  • 1 — URL-encoded parameters.

  • 2 — JSON.

If omitted, the value defaults to 1.

Sample request

The following is a sample request to the GetDetailedOrderStatus API endpoint.

curl --location 'https://secure.trust-provider.com/products/!GetDetailedOrderStatus' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'loginName=login_name' \
--data-urlencode 'loginPassword=login_password' \
--data-urlencode 'orderNumber=order_number' \
--data-urlencode 'queryType=2' \
--data-urlencode 'showValidityPeriod=Y'

Response

The request is successful when the server returns a response with the status code equals 0.

Any status code less than 0 indicates an error condition.

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

The MIME type will be application/x-www-form-urlencoded for responseFormat=1 (the default).

The MIME type will be application/json for responseFormat=2.

Response parameters

The following table displays the various parameters that can appear in the response.

Parameter Presence Description

errorCode

present

A numeric code that identifies the type of the error.

errorMessage

optional

A description of the error.

For possible values, see Error codes.

This parameter is not present when errorCode=0.

X_orderNumber

optional

The order number.

X_orderDateTime

optional

The timestamp when this certificate was created.

X_orderStatus

optional

The string describing the current status of the order.

X_orderStatusReason

optional

The string describing the reason for the status.

Only relevant for rejected orders.

X_suggestedOrgDetails

optional

If auto-organizational validation was requested for this order, this parameter will include the status the validation as well as details of matching organizations if found.

The status parameter will be included.

The status parameter indicates status of the auto organizational validation.

The possible values for the status parameter are:

  • Found — Match found.

  • NotFound — Match not found.

  • NotYetCompleted — The process is not completed yet.

  • NotApplicable — The organizational validation is not required or was already completed.

If the status = found, Sectigo will return the following details of the matching organizations:

  • X_organizationName — The company name.

  • X_streetAddress — The street.

  • X_localityName — The city name.

  • X_stateOrProvinceName — The state or province.

  • X_postalCode — The postal code.

  • X_countryName — The country two-character code (ISO 3166-1 Alpha-2).

  • X_dunsNumber — The DUNS-number.

  • X_telephoneNumber — The phone number.

X_Y_serialNumber

optional

The SSL certificate, Personal Authentication certificate, or Code Signing certificate serial number.

X_Y_objectType

optional

The certificate type.

X_Y_notBefore

optional

The timestamp when the certificate became valid.

It is expressed as a UNIX time value.

This parameter is only present when showValidityPeriod=Y.

X_Y_notAfter

optional

The timestamp when the certificate will become invalid.

It is expressed as a UNIX time value.

This parameter is only present when showValidityPeriod=Y.

X_Y_certificateDuration

optional

The certificate duration, in days.

This parameter is only present when showValidityPeriod=Y.

X_Y_productTermStartDate

optional

The timestamp when the product term has started.

It is expressed as a UNIX time value.

This parameter is only present when showValidityPeriod=Y.

X_Y_productTermEndDate

optional

The timestamp when the product term will end.

It is expressed as a UNIX time value.

This parameter is only present when showValidityPeriod=Y.

X_Y_productTermDuration

optional

The product duration, in days.

This parameter is only present when showValidityPeriod=Y.

X_Y_ovCallBackStatus

optional

The OV callBack status of the account.

Available if queryType = 1 or 2.

The possible values are:

  • -1 — Not required.

  • 0 — Not completed.

  • 1 — Completed.

  • 2 — In progress.

X_Y_organizationValidationStatus

optional

The string describing the current status of account validation (OV).

Available if queryType = 1 or 2.

The possible values are:

  • -1 — Not required.

  • 0 — Not completed.

  • 1 — Completed.

  • 2 — In progress.

X_Y_freeDVUPStatus

optional

The status of Free DV Upgrade.

Available if queryType = 1 or 2.

The possible values are:

  • -1 — Not required.

  • 0 — Not completed.

  • 1 — Completed.

  • 2 — In progress.

X_Y_evClickThroughStatus

optional

The status of Click-Through Certificate Subscriber Agreement Acceptance.

Available if queryType = 1 or 2.

The possible values are:

  • -1 — Not required.

  • 0 — Not completed.

  • 1 — Completed.

X_Y_upsTrackingID

optional

The UPS tracking number (for token-based certificates).

X_Y_shippingOrganizationName

optional

The shipping address organization name (for token-based certificates).

X_Y_shippingOrganizationalUnitName

optional

The shipping address details (for token-based certificates).

X_Y_shippingStreetAddress1

optional

The shipping address details (for token-based certificates).

X_Y_shippingStreetAddress2

optional

The shipping address details (for token-based certificates).

X_Y_shippingStreetAddress3

optional

The shipping address details (for token-based certificates).

X_Y_shippingLocalityName

optional

The shipping address details (for token-based certificates).

X_Y_shippingStateOrProvinceName

optional

The shipping address details (for token-based certificates).

X_Y_shippingPostalCode

optional

The shipping address details (for token-based certificates).

X_Y_shippingCountry

optional

The shipping address details (for token-based certificates).

X_Y_shippingTitle

optional

The contact person details for shipment (for token-based certificates).

X_Y_shippingForename

optional

The contact person details for shipment (for token-based certificates).

X_Y_shippingSurname

optional

The contact person details for shipment (for token-based certificates).

X_Y_shippingEmail

optional

The contact person details for shipment (for token-based certificates).

X_Y_shippingPhone

optional

The contact person details for shipment (for token-based certificates).

X_Y_caaStatus

optional

The status of CAA Check.

Available if queryType = 1 or 2.

The possible values are:

  • -1 — Not required.

  • 0 — Not completed.

  • 1 — Completed.

  • 2 — In progress.

X_Y_licenceStatus

optional

The status of the licence.

The possible values are:

  • processed

  • rejected

X_Y_licenceSyncStatus

optional

The status of the license synchronization.

The possible statuses are:

  • Processed.

  • Awaiting Sync.

  • Sync Failed.

  • Sync Disabled.

  • Acc Deleted.

  • Acc Suspended.

X_Y_licenceRejectionSource

optional

The source of the licence rejection.

Available if it has been carried out.

The possible values are:

  • API

  • Manual

X_Y_licenceStatusReason

optional

Sync the error description.

X_Y_qualysMerchantID

optional

The Qualys Merchant ID.

Applicable to HackerGuardian license account and products with additional HackerGuardian license.

X_Y_qualysLoginName

optional

The login name on Qualys Platform that scans vulnerabilities.

Applicable to HackerGuardian license account and products with additional HackerGuardian license.

X_Y_qualysCompanyName

optional

The organization name for HackerGuardian license on Qualys Platform.

X_Y_qualysAccountType

optional

The Qualys account type.

The possible values are:

  • C — Customer.

  • P — Prospect.

X_Y_qualysIPsPurchased

optional

The IP addresses purchased under HackerGuardian licence.

X_Y_qualysIPsAdded

optional

The additional IP addresses purchased under HackerGuardian licence.

X_Y_qualysCreationDate

optional

The date or time of HackerGuardian account creation.

Available if queryType = 1 or 2.

X_Y_qualysExpirationDate

optional

The date of HackerGuardian account expiration.

Available if queryType = 1 or 2.

X_Y_swpID

optional

The Sectigo Web Platform (SWP) user ID.

X_Y_swpActive

optional

The Sectigo Web Platform (SWP) account status.

The possible values are:

  • 0 — Active.

  • 1 — Disabled.

X_Y_swpUserEmail

optional

The user email communicated for Sectigo Web Platform (SWP) account setup.

X_Y_swpPartnerID

optional

The Sectigo Web Platform (SWP) partner ID.

X_Y_slId

optional

The SiteLock user ID.

X_Y_slSiteIds

optional

The SiteLock site ID.

Sample success response

errorCode=0&1_orderNumber=*******&1_orderDateTime=2025-01-01+13%3A52&1_orderStatus=Pending&1_orderStatusReason=&1_1_serialNumber=&1_1_objectType=Verified+Mark+Certificate+%28VMC%29+%282+of+2+Domains%29&1_1_certificateDuration=365&1_1_productTermDuration=365&1_1_FQDN=**********.com%2********.com&1_1_certificateStatus=Awaiting+Validation&1_1_evClickThroughStatus=0&1_1_trademarkOffice=United+States+Copyright+Office&1_1_trademarkIdentifier=*********0&1_1_trademarkCountryName=United+States&1_1_trademarkCountry2CharCode=US&1_1_logoHostedByCA=-1

Sample error response

{'errorCode': '-4', 'errorMessage': "The value of the 'orderNumber' argument is invalid!"}

Error codes

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

'xxxx' is an 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 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 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.