SiteLock license

Endpoint: !AutoApplyOrder

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

Use the POST method for this endpoint.

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

Request 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.

product

required

string

64 chars

Specifies a comma-separated string of integers for a product code.

There must be exactly one of the following integers specified:

  • 1059 — SiteLock Monitor

  • 1060 — SiteLock Basic

  • 1061 — SiteLock Pro

  • 1062 — SiteLock Business

  • 1082 — SiteLock 911

  • 1068 — 5 GB Backup Addon

  • 1069 — 10 GB Backup Addon

  • 1070 — 25 GB Backup Addon

  • 1071 — TrueShield Addon

  • 1078 — SiteLock DNS - Pro Addon

  • 1076 — SiteLock DNS - Business Addon.

These addon products can only be ordered and used in addition to and during validity period of the SiteLock license.

The appRepEmailAddress parameter must be provided to provision the SiteLock product.

days

required

integer

The validity period, in days.

For SiteLock products the allowed values are:

  • 30

  • 365

appRepEmailAddress

required

string

255 chars

The applicant representative’s email address which is used for the organizational callback by Sectigo.

appRepTelephone

optional

string

32 chars

The applicant representative’s telephone number which is used for the organizational callback by Sectigo.

Required when Sectigo will perform the organizational callback.

appRepForename

conditional

string

64 chars

The applicant representative’s name which is used for the organizational callback by Sectigo.

Required when Sectigo will perform the organizational callback.

appRepSurname

conditional

string

64 chars

The applicant representative’s last name which is used for the organizational callback by Sectigo.

Required when Sectigo will perform the organizational callback.

appRepTitle

optional

string

64 chars

The applicant representative’s job title which is used for the organizational callback by Sectigo.

Required when Sectigo will perform the organizational callback.

callbackMethod

optional

char

1 char

The callback method for verification of the applicant representative’s identity.

The allowed values are:

  • T — The appRepTelephone number will be called to communicate a callback verification code which will be used to confirm the identity of the applicant representative.

  • E — An email, containing a callback verification code, will be posted to the applicant representative.

domainName

required

string

64 chars

The domain name the SiteLock product is ordered for.

enableAutoRenew

optional

char

1 char

Indicates whether the SiteLock product should renew automatically at expiry.

To allow automatic renewal, sufficient account funds are required.

The allowed values are:

  • Y — Enable automatic renewal (requires sufficient account funds).

  • N — Disable automatic renewal.

If omitted, the value is determined by the account’s auto‑renew settings.

isCustomerValidated

required

char

1 char

Specifies whether the customer will validate the customer’s documents.

The allowed values are:

  • Y — The customer validates the customer’s documents.

  • N — The customer does not validate the customer’s documents.

organizationName

required

string

64 chars

Specifies the organization name.

streetAddress1

conditional

string

128 chars

The street address where the organization operates.

streetAddress2

optional

string

128 chars

The second part of the company’s street address (if necessary).

streetAddress3

optional

string

128 chars

The third part of the company’s street address (if necessary).

localityName

optional

string

128 chars

The city in which the organization operates.

stateOrProvinceName

optional

string

128 chars

The state or province in which the organization operates.

countryName

optional

string

2 chars

An ISO 3166 two-character country code.

responseFormat

optional

char

1 char

Specifies the response format.

The allowed values are:

  • 0 — Newline-delimited parameters.

  • 1 — URL-encoded parameters.

If omitted, the value defaults to 0.

test

optional

char

1 char

Specifies whether this is a test order.

The allowed values are:

  • Y — The account will not be charged and the order will be processed as a test order.

  • N — The order will be processed as a live order.

If omitted, the value defaults to N.

Sample request

curl --location 'https://secure.trust-provider.com/products/!AutoApplyOrder' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'loginName=login_name' \
--data-urlencode 'loginPassword=login_password' \
--data-urlencode 'product=1060' \
--data-urlencode 'days=365' \
--data-urlencode 'isCustomerValidated=N' \
--data-urlencode 'organizationName=Company 3443695' \
--data-urlencode 'organizationalUnitName=Department` \
--data-urlencode 'streetAddress1=Elm Street 12' \
--data-urlencode 'stateOrProvinceName=California' \
--data-urlencode 'countryName=US' \
--data-urlencode '[email protected]' \
--data-urlencode 'appRepTelephone= 38 1234578' \
--data-urlencode 'callbackMethod=T' \
--data-urlencode 'appRepForename=John' \
--data-urlencode 'appRepSurname=Doe' \
--data-urlencode 'appRepTitle=Senior Manager' \
--data-urlencode 'domainName=domain_name.com'

Response

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

Any error code less than 0 indicates an error condition, and the error message provides additional details.

Error responses are returned in application/x-www-form-urlencoded format.

Response format 0 (Plain text)

The MIME type will be text/plain for responseFormat=0 (by default).

The first line of the response contains a status code.

Whether 0 or 1 is returned for successful orders depends on how your account is configured with Sectigo. Usually, you will take payment from your customer and Sectigo will debit your account funds when you place the order. However, in special circumstances it can be arranged for Sectigo to take payment from your customer on your behalf.

If the status code is less than 0, the second line of the response contains an error message describing the error.

If the status code is greater than or equal to 0, the response can contain the following lines which provide:

Line Possible Value Description

Line 1

The status of the order. For more information, see Error codes.

The status code.

Line 2

An integer.

The second line contains an order number.

Line 3

  • If the status code = 0, it contains the debited amount.

  • If the status code = 1, it contains the required amount, not including UK VAT (if required).

The amount in your account’s native currency, without a currency symbol.

Line 4

The expected delivery time.

This value can be ignored and has been deprecated for SiteLock.

Line 5, 6 or 7 (if applicable)

A unique alphanumeric value up to 20 characters long.

The unique value. Returned if the uniqueValue parameter was passed in to this API, or if uniqueValue has been generated by Sectigo for this order.

Line 5 or 6

The SiteLock user ID up to 16 integers long.

The fifth line contains slUserID

Line 6 or 7

The SiteLock site ID (string).

The sixth line contains slSiteID.

Response format 1 (URL-encoded)

Most of Sectigo’s API endpoints use URL-encoded responses. AutoApplyOrder can return responses in the same format by specifying responseFormat=1 in the request.

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

The following table displays the various parameters that can appear for responseFormat=1.

Parameter Description

errorCode

A numeric code that identifies the type of error and is always present in the response.

For more information, see Error codes.

errorMessage

A description of the error.

errorMessage is not present when the status code = 0.

orderNumber

An integer. This parameter is only present when errorCode=0.

totalCost

The amount in your account’s native currency, without a currency symbol. This parameter is only present when errorCode=0.

expectedDeliveryTime

This value can be ignored and has been deprecated for SiteLock. This parameter is only present when errorCode=0.

uniqueValue

A unique alphanumeric value up to 20 characters long.

Returned if the uniqueValue parameter was passed in to this API endpoint, or if uniqueValue has been generated by Sectigo for this order.

slUserID

The SiteLock user ID up to 16 integers long. This parameter is only present if a SiteLock license is the only product ordered.

slSiteID

The SiteLock site ID, represented as a string. This parameter is only present if a SiteLock license is the only product ordered.

Sample success response for ordering SiteLock license

0
987654321
100.00
123456
12ab34cd
Output Details

0

The successful response.

987654321

The Sectigo order number.

100.00

The amount debited to the account — $100.00.

Displayed price is for sample purposes only.

123456

The SiteLock user ID up to 16 integers long.

1234abcd

The SiteLock site ID.

Sample error response

errorCode=-3&errorMessage=The+%27loginName%27+argument+is+missing%21

Upgrading and downgrading SiteLock license

When you place an upgrade order:

  • You are charged a pro-rated price for the new license based on the remaining time of the existing license. For example, if you have a one-year SiteLock Basic license for $149, and 6 months into the license you decide to upgrade to SiteLock Pro for $249, you will be charged for the 6 months of the new pro-rated license: ($249/2)-($149/2) = $50. Half of the remaining funds on your SiteLock Basic license are converted to your new license so you’re only charged $50 (all prices are examples).

  • The new license starts from the date of the upgrade and lasts for the duration left on the previous license. In the preceding example, the duration of the new license will be 6 months.

  • If a license is upgraded to a product with lower capacity than an existing add-on, the add-on remains unchanged with the same renewal date, billing term, and auto-renewal setting.

  • If a license is upgraded to a product with a higher capacity than an existing add-on, the existing add-on is cancelled.

Downgrades are only allowed during refund and renewal periods. The renewal period is 30 days by default. The refund period is 14 days by default. Refunds aren’t provided for monthly licenses.

Sample request of upgrading/downgrading SiteLock license

The following is a sample request for upgrading/downgrading a SiteLock license using AutoApplyOrder:

Parameter Requirement Type Max.Length Description

loginName

required

string

64 chars

Your account username.

loginPassword

required

string

128 chars

Your account password.

days

required

integer

The validity period, in days.

product

required

string

64 chars

Specifies a comma-separated string of integers for a product code.

appRepEmailAddress

required

string

255 chars

The applicant representative’s email address which is used for the organizational callback by Sectigo.

domainName

required

string

64 chars

The domain name the SiteLock product is ordered for.

previousOrderNumber

optional

integer

The order number of the previous license.

Sample success response for upgrading and downgrading SiteLock license

0
987654321
100.00
Output Details

0

The successful response.

987654321

The Sectigo order number.

100.00

The amount debited to the account — $100.00.

Displayed price is for sample purposes only.

Sample request of upgrading SiteLock license from monthly to annual

The following is a sample request for upgrading SiteLock license from monthly to annual using AutoApplyOrder:

Parameter Requirement Type Max.Length Description

loginName

required

string

64 chars

Your account username.

loginPassword

required

string

128 chars

Your account password.

days

required

integer

The validity period, in days.

product

required

string

64 chars

Specifies a comma-separated string of integers for a product code.

domainName

required

string

64 chars

The domain name the SiteLock product is ordered for.

isCustomerValidated

required

char

1 char

Specifies whether the customer will validate the customer’s documents.

The allowed values are:

  • Y — The customer validates the customer’s documents.

  • N — The customer does not validate the customer’s documents.

previousOrderNumber

optional

integer

The order number of the previous license.

appRepEmailAddress

required

string

255 chars

The applicant representative’s email address which is used for the organizational callback by Sectigo.

enableAutoRenew

optional

char

1 char

Indicates whether the SiteLock product should renew automatically at expiry.

To allow automatic renewal, sufficient account funds are required.

The allowed values are:

  • Y — Enable automatic renewal (requires sufficient account funds).

  • N — Disable automatic renewal.

If omitted, the value is determined by the account’s auto‑renew settings.

responseFormat

optional

char

1 char

Specifies the response format.

The allowed values are:

  • 0 — Newline-delimited parameters.

  • 1 — URL-encoded parameters.

If omitted, the value defaults to 0.

Sample success response of upgrading SiteLock license from monthly to annual

The following is a sample success response of upgrading SiteLock license from monthly to annual, using AutoApplyOrder:

Output Details

0

The successful response.

987654321

The Sectigo order number.

100.00

The amount debited to the account — $100.00.

Displayed price is for sample purposes only. 
0
987654321
210.00

SiteLock addon

Request parameters for ordering SiteLock addon

The following is a sample request for ordering a SiteLock addon using AutoApplyOrder:

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.

days

required

integer

The validity period, in days.

product

required

string

64 chars

Specifies a comma-separated string of integers for a product code.

The allowed values are:

  • 1068 — 5 GB Backup Addon

  • 1069 — 10 GB Backup Addon

  • 1070 — 25 GB Backup Addon

  • 1071 — TrueShield Addon

  • 1078 — SiteLock DNS - Pro Addon

  • 1076 — SiteLock DNS - Business Addon.

These addon products can only be ordered and used in addition to and during validity period of the SiteLock license.

appRepEmailAddress

required

string

255 chars

The applicant representative’s email address which is used for the organizational callback by Sectigo.

isAppRepValidated

optional

char

1 char

Specifies who will verify the applicant representative’s contact details before the callback is performed.

The allowed values are:

  • Y --The Partner Reseller has verified that the applicant representative’s contact details are legitimate, using a data source other than the applicant. Only Partner Resellers with sufficient RA privileges may specify Y.

  • N — Sectigo will verify the applicant representative’s contact details before performing the callback using the method specified by callbackMethod.

domainName

required

string

64 chars

The domain name the SiteLock product is ordered for.

enableAutoRenew

optional

char

1 char

Indicates whether the SiteLock product should renew automatically at expiry.

To allow automatic renewal, sufficient account funds are required.

The allowed values are:

  • Y — Enable automatic renewal (requires sufficient account funds).

  • N — Disable automatic renewal.

If omitted, the value is determined by the account’s auto‑renew settings.

previousOrderNumber

optional

integer

The order number of the previous license.

 
curl --location 'https://secure.trust-provider.com/products/!AutoApplyOrder' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'loginName=login_name' \
--data-urlencode 'loginPassword=login_password' \
--data-urlencode 'product=1068' \
--data-urlencode 'days=365' \
--data-urlencode 'domainName=domainname.test' \
--data-urlencode '[email protected]' \
--data-urlencode 'enableAutoRenew=N' \
--data-urlencode 'previousOrderNumber=1234567'

Sample success response

0
987654321
210.00
Output Details

0

The successful response.

987654321

The Sectigo order number.

210.00

The amount debited to the account — $210.00.

Error codes

Error Code Error Message Description

-1

Request was not made over HTTPS!

The request must use HTTPS protocol.

-2

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

-7

'xx' is not a valid ISO-3166 country!

The specified country code is not valid according to the ISO-3166 standard.

-14

An unknown error occurred!

An unknown error occurred.

-15

Not enough credit!

The account does not have sufficient credit.

-16

Permission denied! Contact Sectigo Support to have your account enabled for the !AutoApplyOrder API.

The user does not have permission to access the AutoApplyOrder API.

-17

Request used GET rather than POST!

The request method should be POST.

-45

You can not renew trial license!

Trial licenses cannot be renewed.

-47

'domainName' is already validated!

The specified domain name has already been validated.

-54

The order can have one main license only!

The order can include only one main license.

-56

Your current license expires on <EXPIRATION_DATE> . Licenses can only be renewed up to 30 days prior to the expiry of your existing license. <EXPIRATION_DATE> in format 'YYYY-MM-DD'

Your current license cannot be renewed more than 30 days before its expiration date.

-65

PlanID for this product not found.

The specified PlanID for the product could not be found.

-68

Argument 'xxxx' can be used just with License products!

The specified parameter can only be used with license products.

-70

Invalid Email Address!

The provided email address is not valid.

-71

The previous order must have a license of the same type!

The previous order must include a license of the same type.

-72

You can not renew trial licence!

Trial licenses cannot be renewed.

-83

'xxxx' is not applicable to this order!

The specified argument is not applicable for the current order.

-84

The order should include 'xxxx'!

The order must include the specified item.

-90

Permission denied 'Context'

The user does not have permission for the specified context.

-91

Permission denied 'Context'

The user does not have permission for the specified context.

-111

Tier1 Credit/Debit internal Error

The Tier1 credit/debit processing encountered an internal error.

-112

Tier1 Credit/Debit internal Error

The Tier1 credit/debit processing encountered an internal error.

-113

Tier1 Credit/Debit internal Error

The Tier1 credit/debit processing encountered an internal error.

-114

Unknown autoApply Type

The specified autoApply type is not recognized.

-115

No price found for 'xxx'! Contact Support!

No price information available for the specified item.

-116

Wrong Item Cost! Contact Support!

The provided item cost is incorrect.

-117

Wrong Item Cost! Contact Support!

The provided item cost is incorrect.

-118

Wrong product Identifier!

The specified product identifier is incorrect.

-119

Internal error occured!

An internal error occurred.

-121

"TAX" value is deprecated. The value "TIN" should be used instead'

Semantic error.

TAX is no longer a valid value.

Use TIN instead.

-121

Wrong format of 'xxxx' identifier.

Semantic error.

The format of the provided identifier is incorrect.

-121

Wrong country code value in 'xxxx' identifier.

Semantic error.

The country code in the provided identifier is incorrect.

-121

Site already exists

The specified site already exists in the system.

-122

a generic error that shows the SiteLock synchronous sync errors

A generic error indicating a SiteLock synchronous synchronization issue.

-124

SiteLock Monitor can only be ordered together with SSL product

SiteLock Monitor must be ordered in conjunction with an SSL product.

-150

Insufficient privileges to order this type of product

The user does not have sufficient privileges to order the specified product type.

-161

Parameter 'xxxx' is not applicable to this type of product!

The specified parameter is not valid for this product type.