Important: Only HTTP POST is supported for this method.
namecheap.ssl.activate
Activates a newly purchased SSL certificate.
Sandbox Limitation: Activation process in Sandbox works only for the following SSL Certificates: RapidSSL, GeoTrust QuickSSL, GeoTrust QuickSSL Premium, GeoTrust True BusinessID with EV, GeoTrust TrueBusinessID ,GeoTrust TrueBusinessID WildCard, VeriSign Secure Site, VeriSign Secure Site Pro, VeriSign Secure Site EV and VeriSign Secure Site Pro EV
Request Parameters
Global parameters are not shown here for clarity, but should be present in all requests
| Name | Type | MaxLength | Required? | Default | Description |
| CertificateID | Number
| 10 | Yes | | Unique ID of the SSL certificate you wish to activate |
| ApproverEmail | String | 255 | Yes
| | The EmailID which is on the Approver Email list |
| csr | String | 2000 | Yes | | Certificate Signing Request |
| WebServerType | String | 50 | Yes | | WebServerType of the CSR (see below the table for possible values) |
AdminOrganizationName
| String
| 100 | No
| | Organization of the Administrator |
| AdminJobTitle | String | 100 | Yes* |
| Job title of the Administrator (refer to the note below the table)
|
| AdminFirstName | String
| 100 | Yes | | First name of the Administrator
|
| AdminLastName | String | 100 | Yes
| | Second name of the Administrator
|
| AdminAddress1 | String | 100 | Yes | | Address1 of the Administrator |
AdminAddress2
| String | 100 | No | | Address2 of the Administrator |
| AdminCity | String | 100 | Yes | | City of the Administrator |
| AdminStateProvince | String | 100 | Yes | | State/Province of the Administrator |
| AdminStateProvinceChoice | String | 100 | No | | StateProvinceChoice of the Administrator |
| AdminPostalCode | String | 100 | Yes | | PostalCode/ZIP of the Administrator
|
| AdminCountry | String | 100 | Yes | | Country of the Administrator |
| AdminPhone | String | 100 | Yes | | Phone number in the format +NNN.NNNNNNNNNN |
| AdminPhoneExt | String | 10 | No | | PhoneExt of the Admin user |
| AdminFax | String | 100 | No | | Fax number in the format +NNN.NNNNNNNNNN |
| AdminEmailAddress | String | 255 | Yes | | Email address of the Administrator |
TechOrganizationName
| String
| 100 | No
| | Organization of the Technical Contact |
| TechJobTitle | String | 100 | Yes* |
| Job title of the Technical Contact (refer to the note below)
|
| TechFirstName | String
| 100 | No | | First name of the Technical Contact
|
| TechLastName | String | 100 | No
| | Second name of the Technical Contact
|
| TechAddress1 | String | 100 | No | | Address1 of the Technical Contact |
TechAddress2
| String | 100 | No | | Address2 of the Technical Contact |
| TechCity | String | 100 | No | | City of the Technical Contact |
| TechStateProvince | String | 100 | No | | State/Province of the Technical Contact |
| TechStateProvinceChoice | String | 100 | No | | StateProvinceChoice of the Technical Contact |
| TechPostalCode | String | 100 | No | | PostalCode/ZIP of the Technical Contact
|
| TechCountry | String | 100 | No | | Country of the Technical Contact |
| TechPhone | String | 100 | No | | Phone number in the format +NNN.NNNNNNNNNN |
| TechPhoneExt | String | 10 | No | | PhoneExt of the Tech user |
| TechFax | String | 100 | No | | Fax number in the format +NNN.NNNNNNNNNN |
| TechEmailAddress | String | 255 | No | | Email address of the Technical Contact |
BillingOrganizationName
| String
| 100 | No
| | Organization of the BillingContact |
| BillingJobTitle | String | 100 | Yes* |
| Job title of the BillingContact (refer to the note below)
|
| BillingFirstName | String
| 100 | No | | First name of the BillingContact
|
| BillingLastName | String | 100 | No
| | Second name of the BillingContact
|
| BillingAddress1 | String | 100 | No | | Address1 of the BillingContact |
BillingAddress2
| String | 100 | No | | Address2 of the BillingContact |
| BillingCity | String | 100 | No | | City of the BillingContact |
| BillingStateProvince | String | 100 | No | | State/Province of the BillingContact |
| BillingStateProvinceChoice | String | 100 | No | | StateProvinceChoice of the BillingContact |
| BillingPostalCode | String | 100 | No | | PostalCode/ZIP of the BillingContact
|
| BillingCountry | String | 100 | No | | Country of the BillingContact |
| BillingPhone | String | 100 | No | | Phone number in the format +NNN.NNNNNNNNNN |
| BillingPhoneExt | String | 10 | No | | PhoneExt of the Billing user |
| BillingFax | String | 100 | No | | Fax number in the format +NNN.NNNNNNNNNN |
| BillingEmailAddress | String | 255 | No | | Email address of the BillingContact |
Possible Values for WebServerType:
apacheopenssl, apachessl, apacheraven, apachessleay, c2net, ibmhttp, iplanet, domino, dominogo4625, dominogo4626, netscape, zeusv3, apache2, apacheapachessl, cobaltseries, cpanel, ensim, hsphere, ipswitch, plesk, tomcat, weblogic, website, webstar, iis, other, iis4, iis5
Note: It is mandatory to send AdminJobTitle, TechJobTitle and BillingJobTitle parameters are only while activating Organization and EV SSL validation certs.
In addition to these parameters, you need to pass the following parameters for activating COMODO EV SSL and COMODO EV SSL SGC certificates:
| Name | Type | MaxLength | Required? | Default | Description |
| CompanyIncorporationCountry | String | 100 | Yes | | Country of Company incorpration |
CompanyIncorporationLocality
| String
| 100 | No | | Locality of company incorporation |
CompanyIncorporationStateProvince
| String | 100 | No
| | State/province of company incorporation |
| CompanyIncorporationDate | String | 100 | No | | Company Incorporation date |
CompanyDBA
| String
| 100 | No
| | Company DBA
|
| CompanyRegistrationNumber | String | 100 | No |
| Registration number of the company
|
Example Response
<?xml version="1.0" encoding="utf-8" ?>
<ApiResponse Status="OK">
<Errors/>
<RequestedCommand>namecheap.ssl.activate</RequestedCommand>
<CommandResponse Type="namecheap.ssl.activate">
<SSLActivateResult ID="123455" IsSuccess="true"/>
</CommandResponse>
<Server>SERVER-NAME</Server>
<GMTTimeDifference>+5:30</GMTTimeDifference>
<ExecutionTime>55.5</ExecutionTime>
</ApiResponse>
Error Codes
Specifies the error codes that might be returned from this method
| Number | Description |
| 2010326 | Error while validating administrative address |
| 2011294 , 4011294 | CertificateID is invalid |
| 2019331 | Certificate status is not available |
| 4020294 | Activation period for this certificate is over |
| 4011331 | Certificate status is invalid |
| 4011297 , 2011297 | WebServerType is invalid |
| 3011166 | Invalid renewal order domain |
| 3011296 | The CSR provided is invalid |
| 4024295 | Unable to update ApproverEmail in database |
| 4024331 | Unable to update status in database |
| 3028301 | Failed to purchase certificate |
| 3011295 | ApproverEmail is not valid |
| 2011300 | Validation for True Business with EV |
| 2030332 | Config file value does not support for activation |
| 2010297 | WebServerType is missing |
| 4011296 | CSR invalid error from Provider |
| 4024294 | Failed to update CertificateID |
| 4027295 | Failed to send ApproverEmail |
| 2011510 | Partner name is invalid |
| 5050900 | Unhandled exceptions |
| 2011333 | xmlfile is missing error while getting xml form from filepath and
xmlstring from config file |
| 4050900 | Unhandled exception from database error |