Competitive Upgrade Info

Competitive Upgrade Info

Purpose
There are times when vendors offer additional month(s) benefits to competing vendors. For example: You can get up to 2 additional months if you switch to RapidSSL from GoDaddy (or other competitors) depending on a vendor’s current policy. From this method you can investigate if a CU (Competitive Upgrade) is available on your certificate.

URL

    • LIVE URL:
https://api.thesslstore.com/rest/free/cuinfo
    • SANDBOX URL:
https://sandbox-wbapi.thesslstore.com/rest/free/cuinfo

HTTP VERB
POST

PARAMETERS
JSON :
Content-type: application/json; charset=utf-8;

{
	"AuthRequest":{
		"PartnerCode":"String content",
		"AuthToken":"String content",
		"ReplayToken":"String content",
		"UserAgent":"String content"
	},
	"CustomOrderID":"String content",
	"ProductCode":"String content",
	"ExtraProductCodes":"String content",
	"OrganisationInfo":{
		"OrganizationName":"String content",
		"DUNS":"String content",
		"Division":"String content",
		"IncorporatingAgency":"String content",
		"RegistrationNumber":"String content",
		"JurisdictionCity":"String content",
		"JurisdictionRegion":"String content",
		"JurisdictionCountry":"String content",
		"OrganizationAddress":{
			"AddressLine1":"String content",
			"AddressLine2":"String content",
			"AddressLine3":"String content",
			"City":"String content",
			"Region":"String content",
			"PostalCode":"String content",
			"Country":"String content",
			"Phone":"String content",
			"Fax":"String content",
			"LocalityName":"String content"
		}
	},
	"ValidityPeriod":2147483647,
	"ServerCount":2147483647,
	"CSR":"String content",
	"DomainName":"String content",
	"WebServerType":"String content",
	"DNSNames":["String content"],
	"isCUOrder":true,
	"isRenewalOrder":true,
	"SpecialInstructions":"String content",
	"RelatedTheSSLStoreOrderID":"String content",
	"isTrialOrder":true,
	"AdminContact":{
		"FirstName":"String content",
		"LastName":"String content",
		"Phone":"String content",
		"Fax":"String content",
		"Email":"String content",
		"Title":"String content",
		"OrganizationName":"String content",
		"AddressLine1":"String content",
		"AddressLine2":"String content",
		"City":"String content",
		"Region":"String content",
		"PostalCode":"String content",
		"Country":"String content"
	},
	"TechnicalContact":{
		"FirstName":"String content",
		"LastName":"String content",
		"Phone":"String content",
		"Fax":"String content",
		"Email":"String content",
		"Title":"String content",
		"OrganizationName":"String content",
		"AddressLine1":"String content",
		"AddressLine2":"String content",
		"City":"String content",
		"Region":"String content",
		"PostalCode":"String content",
		"Country":"String content"
	},
	"ApproverEmail":"String content",
	"ReserveSANCount":2147483647,
	"AddInstallationSupport":true,
	"EmailLanguageCode":"String content"
}

XML:
Content-type: application/xml; charset=utf-8;

<NewOrderRequest>
<AuthRequest>
<PartnerCode>String content</PartnerCode>
<AuthToken>String content</AuthToken>
<ReplayToken>String content</ReplayToken>
<UserAgent>String content</UserAgent>
</AuthRequest>
<CustomOrderID>String content</CustomOrderID>
<ProductCode>String content</ProductCode>
<ExtraProductCodes>String content</ExtraProductCodes>
<OrganisationInfo>
<OrganizationName>String content</OrganizationName>
<DUNS>String content</DUNS>
<Division>String content</Division>
<IncorporatingAgency>String content</IncorporatingAgency>
<RegistrationNumber>String content</RegistrationNumber>
<JurisdictionCity>String content</JurisdictionCity>
<JurisdictionRegion>String content</JurisdictionRegion>
<JurisdictionCountry>String content</JurisdictionCountry>
<OrganizationAddress>
<AddressLine1>String content</AddressLine1>
<AddressLine2>String content</AddressLine2>
<AddressLine3>String content</AddressLine3>
<City>String content</City>
<Region>String content</Region>
<PostalCode>String content</PostalCode>
<Country>String content</Country>
<Phone>String content</Phone>
<Fax>String content</Fax>
<LocalityName>String content</LocalityName>
</OrganizationAddress>
</OrganisationInfo>
<ValidityPeriod>2147483647</ValidityPeriod>
<ServerCount>2147483647</ServerCount>
<CSR>String content</CSR>
<DomainName>String content</DomainName>
<WebServerType>String content</WebServerType>
<DNSNames>
<string>String content</string>
<string>String content</string>
</DNSNames>
<isCUOrder>true</isCUOrder>
<isRenewalOrder>true</isRenewalOrder>
<SpecialInstructions>String content</SpecialInstructions>
<RelatedTheSSLStoreOrderID>String content</RelatedTheSSLStoreOrderID>
<isTrialOrder>true</isTrialOrder>
<AdminContact>
<FirstName>String content</FirstName>
<LastName>String content</LastName>
<Phone>String content</Phone>
<Fax>String content</Fax>
<Email>String content</Email>
<Title>String content</Title>
<OrganizationName>String content</OrganizationName>
<AddressLine1>String content</AddressLine1>
<AddressLine2>String content</AddressLine2>
<City>String content</City>
<Region>String content</Region>
<PostalCode>String content</PostalCode>
<Country>String content</Country>
</AdminContact>
<TechnicalContact>
<FirstName>String content</FirstName>
<LastName>String content</LastName>
<Phone>String content</Phone>
<Fax>String content</Fax>
<Email>String content</Email>
<Title>String content</Title>
<OrganizationName>String content</OrganizationName>
<AddressLine1>String content</AddressLine1>
<AddressLine2>String content</AddressLine2>
<City>String content</City>
<Region>String content</Region>
<PostalCode>String content</PostalCode>
<Country>String content</Country>
</TechnicalContact>
<ApproverEmail>String content</ApproverEmail>
<ReserveSANCount>2147483647</ReserveSANCount>
<AddInstallationSupport>true</AddInstallationSupport>
<EmailLanguageCode>String content</EmailLanguageCode>
</NewOrderRequest>

RESPONSE
JSON:

{
	"AuthResponse":{
		"isError":true,
		"Message":["String content"],
		"Timestamp":"String content",
		"ReplayToken":"String content",
		"InvokingPartnerCode":"String content"
	},
	"isSupported":true,
	"Months":2147483647,
	"SerialNumber":"String content",
	"ExpirationDate":"String content",
	"Issuer":"String content"
}

XML:

<CSRResponse>
<AuthResponse>
<isError>false</isError>
<Message>
<string>SUCCESS</string>
<string>MORE LINES</string>
</Message>
<Timestamp>Response generated on UTC</Timestamp>
<ReplayToken>TOKEN-FROM-YOUR-REQUEST</ReplayToken>
<InvokingPartnerCode>String content</InvokingPartnerCode>
</AuthResponse>
<DominName>String content</DominName>
<DNSNames>
<string>Alternate names</string>
<string> Alternate names</string>
</DNSNames>
<Country>String content</Country>
<Email>String content</Email>
<Locality>String content</Locality>
<Organization>String content</Organization>
<OrganisationUnit>String content</OrganisationUnit>
<State>String content</State>
<hasBadExtensions>true</hasBadExtensions>
<isValidDomainName>true</isValidDomainName>
<isWildcardCSR>true</isWildcardCSR>
</CSRResponse>

Fields Explanation

NAME FROM Type Description
AuthRequest.AuthToken Request string This is an alpha-numeric token code provided to you by thesslstore.com. It is required in all requests.

*Required for this request
AuthRequest.PartnerCode Request string This is an alpha-numeric code provided to you by thesslstore.com. It is required in all requests.

*Required for this request
AuthRequest.ReplayToken Request string This is an alpha-numeric -code provided by you in order request and thesslstore.com sent back in request.
AuthRequest.UserAgent Request string Browser’s user agent value provided by you for specific order.
NewOrderRequest.AddInstallationSupport Request string Indicates to Purchase Installation Support for this order.
NewOrderRequest.ApproverEmail Request string This is the email of the Approver – in the Domain vetted line of products this is the person responsible for approving the order.
NewOrderRequest.CSR Request string Certificate Signing Request (Base-64 encoded, with or without the —–BEGIN xxxxx—– and —–END xxxxx—– header and footer)

*Required for this request
NewOrderRequest.CustomOrderID Request string A Unique Number Provided by You.
NewOrderRequest.DomainName Request string The domain name for an Order. For an SSL Order this can be a fully qualified Domain (e.g., www.thesslstore.com) or possibly a wildcard domain (e.g., *.geotrust.com).
NewOrderRequest.EmailLanguageCode Request string The language code to be used when sending e-mail messages for this order. (right now is not supported) Default Value is “EN”.
NewOrderRequest.ExtraProductCodes Request string Field Description
NewOrderRequest.isCUOrder Request string The IsCUOrder is the validated CU results for a specified order.
*Required for this request
NewOrderRequest.isRenewalOrder Request string Indicates that this order is a renewal order.
NewOrderRequest.isTrialOrder Request string Indicates that this order is a Trial order.
NewOrderRequest.ProductCode Request string A code for the product that a particular request relates to. Note that a partner must have a valid contract for a product code for it to be valid in a request. Also, a product code must be valid for the context of the request.
*Required for this request
NewOrderRequest.RelatedTheSSLStoreOrderID Request string Provide Old Order’s TheSSLStoreOrderID in Case of Renewal Order.
NewOrderRequest.ReserveSANCount Request string Allows a partner to limit the number of values that a customer can enter in the SAN Field of a certificates
NewOrderRequest.ServerCount Request string Number of Server Licenses

*Required for this request
NewOrderRequest.SpecialInstructions Request string Special Instructions for the order
NewOrderRequest.ValidityPeriod Request string Validity Period (in month)

*Required for this request
NewOrderRequest.WebServerType Request string This is from the OrderParameters structure. Designates the type of web server that an order is targeted for.

*Required for this request
OrganisationInfo.Division Request string The OrganizationalUnit name from the CSR. Up to three comma-separated Ous may be contained in this parameter.
OrganisationInfo.DUNS Request string The Dunn and Bradstreet number for a company
OrganisationInfo.IncorporatingAgency Request string Incorporating Agency Name
OrganisationInfo.JurisdictionCity Request string Jurisdiction City Name
OrganisationInfo.JurisdictionCountry Request string Jurisdiction of Incorporation: Country
OrganisationInfo.JurisdictionRegion Request string Jurisdiction Region Name
OrganisationInfo.OrganizationName Request string The name of the Organization applying for the product. This applies to Organization Vetted products.
OrganisationInfo.RegistrationNumber Request string Company Registration Number
OrganizationAddress.AddressLine1 Request string Organization Street AddressLine1
OrganizationAddress.AddressLine2 Request string Organization Street AddressLine2
OrganizationAddress.AddressLine3 Request string Organization Street AddressLine3
OrganizationAddress.City Request string Organization City Name
OrganizationAddress.Country Request string Organization Country Name
OrganizationAddress.Fax Request string Organization Fax Number
OrganizationAddress.LocalityName Request string The Locality field from the CSR or Certificate
OrganizationAddress.Phone Request string Organization Phone Number
OrganizationAddress.PostalCode Request string Organization Postal Code
OrganizationAddress.Region Request string Organization Region Name
AdminContact.AddressLine1 Request string Admin Contact Street AddressLine1
AdminContact.AddressLine2 Request string Admin Contact Street AddressLine1
AdminContact.City Request string Admin Contact City Name
AdminContact.Country Request string Admin Contact Country Name
AdminContact.Email Request string Admin Contact Email Address.
AdminContact.Fax Request string Admin Contact Fax Number.
AdminContact.FirstName Request string Admin Contact First Name.
AdminContact.LastName Request string Admin Contact Last Name.
AdminContact.OrganizationName Request string Admin Contact Organization Name.
AdminContact.Phone Request string Admin Contact Phone Number.
AdminContact.PostalCode Request string Admin Contact Postal Code
AdminContact.Region Request string Admin Contact Region Name
AdminContact.Title Request string Admin Contact Person’s title.
TechnicalContact.AddressLine1 Request string Technical Contact Street AddressLine1
TechnicalContact.AddressLine2 Request string Technical Contact Street AddressLine1
TechnicalContact.City Request string Technical Contact City Name
TechnicalContact.Country Request string Technical Contact Country Name
TechnicalContact.Email Request string Technical Contact Email Address.
TechnicalContact.Fax Request string Technical Contact Fax Number.
TechnicalContact.FirstName Request string Technical Contact First Name.
TechnicalContact.LastName Request string Technical Contact Last Name.
TechnicalContact.OrganizationName Request string Technical Contact Organization Name.
TechnicalContact.Phone Request string Technical Contact Phone Number.
TechnicalContact.PostalCode Request string Technical Contact Postal Code
TechnicalContact.Region Request string Technical Contact Region Name
TechnicalContact.Title Request string Technical Contact Person’s title.
AuthResponse.InvokingPartnerCode Response string This is an alpha-numeric code provided to you by thesslstore.com.
AuthResponse.isError Response string Return true if any error occurred during Order processing.
AuthResponse.ReplayToken Response string The value of the ReplayToken which provide by you in Order request.
AuthResponse.Timestamp Response string A date timestamp used in a variety of contexts. Note that the XML format is: YYYY-DD-MMTHH:MM:SS:000Z (for example, 2001-01-01T24:00:00:000Z is for Jan 1, 2001 at midnight).
CompetitiveInfoResponse.ExpirationDate Response string Expiration date of certificate
CompetitiveInfoResponse.Issuer Response string Issuer of the certificate
CompetitiveInfoResponse.isSupported Response string Whether Competitive upgrade is supported or not
CompetitiveInfoResponse.Months Response string Number of months for certificate
CompetitiveInfoResponse.SerialNumber Response string Serial number