SSL247 API API Reference

SSL247 API for clients

API Endpoint
https://api.ssl247.com/api/v3
Contact: api@ssl247.com
Response Content-Types: application/json
Schemes: https
Version: 3.0

Account

Account

Account - general information

POST /account

Returns Account information and users.

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

Request Content-Types: application/json
Request Example
{
  "u": "api@example.com",
  "p": "SecretPassword123!",
  "k": "secret_key_x123+?"
}
200 OK

Basic account information

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "Account": {
      "account_code": "string",
      "company": "string",
      "country": "string",
      "currency": "string",
      "allowance_limit": "string",
      "remaining_allowance": "string",
      "Users": [
        {
          "full_name": "string",
          "email": "string"
        }
      ]
    }
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Account

Account - Users

POST /account/users

Returns Account users and contact profiles.

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

Request Content-Types: application/json
Request Example
{
  "u": "api@example.com",
  "p": "SecretPassword123!",
  "k": "secret_key_x123+?"
}
200 OK

Account User information

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "Users": {
      "User": [
        {
          "id": "string",
          "full_name": "string",
          "email": "string"
        }
      ],
      "ContactProfile": [
        {
          "id": "string",
          "full_name": "string",
          "email": "string",
          "tech": "boolean",
          "admin": "boolean",
          "billing": "boolean"
        }
      ]
    }
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Account

Account - Deposit information

POST /account/deposit

Returns Account Deposit.

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string"
}
200 OK

Basic account depoist information

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "Deposit": {
      "value": "string",
      "currency": "string"
    }
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Account

Account - Monthly Allowance Limit information

POST /account/monthly-allowance

Returns Account Monthly Allowance Limit.

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string"
}
200 OK

Basic account allowance limit information

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "Allowance": {
      "remaining": "string",
      "limit": "string",
      "currency": "string"
    }
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Account

User - View

POST /account/user/{id}

Get an Account User details

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

id: string
in path

User ID.

Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string"
}
200 OK

User details

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "full_name": "string",
    "account_id": "string",
    "email": "string",
    "title": "string",
    "firstname": "string",
    "lastname": "string",
    "phone": "string",
    "second_factor_mobile": "string",
    "mobile": "string",
    "fax": "string",
    "direct_line": "string",
    "skype": "string",
    "address_1": "string",
    "address_2": "string",
    "address_3": "string",
    "admin_contact": "boolean",
    "billing_contact": "boolean",
    "technical_contact": "boolean",
    "mailing_contact": "boolean",
    "city": "string",
    "state": "string",
    "postcode": "string",
    "country": "string",
    "subscribed": "boolean"
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Account

User - Add

POST /account/users/add

Adds a User to the Account Users

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

title: string
firstname: string
lastname: string
email: string
password: string
phone: string
mobile: string
fax: string
direct_line: string
skype: string
address_1: string
address_2: string
address_3: string
admin_contact: boolean
billing_contact: boolean
technical_contact: boolean
mailing_contact: boolean
city: string
state: string
postcode: string
country: string
subscribed: boolean
Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string",
  "title": "string",
  "firstname": "string",
  "lastname": "string",
  "email": "string",
  "password": "string",
  "phone": "string",
  "mobile": "string",
  "fax": "string",
  "direct_line": "string",
  "skype": "string",
  "address_1": "string",
  "address_2": "string",
  "address_3": "string",
  "admin_contact": "boolean",
  "billing_contact": "boolean",
  "technical_contact": "boolean",
  "mailing_contact": "boolean",
  "city": "string",
  "state": "string",
  "postcode": "string",
  "country": "string",
  "subscribed": "boolean"
}
200 OK

User id if user creation was successful

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "user_id": "string"
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Account

User - Edit

POST /account/user/{id}/edit

Edit an Account User

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

title: string
firstname: string
lastname: string
email: string
phone: string
mobile: string
fax: string
direct_line: string
skype: string
address_1: string
address_2: string
address_3: string
admin_contact: boolean
billing_contact: boolean
technical_contact: boolean
mailing_contact: boolean
city: string
state: string
postcode: string
country: string
subscribed: boolean
vat_number: string
id: string
in path

User ID.

Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string",
  "title": "string",
  "firstname": "string",
  "lastname": "string",
  "email": "string",
  "phone": "string",
  "mobile": "string",
  "fax": "string",
  "direct_line": "string",
  "skype": "string",
  "address_1": "string",
  "address_2": "string",
  "address_3": "string",
  "admin_contact": "boolean",
  "billing_contact": "boolean",
  "technical_contact": "boolean",
  "mailing_contact": "boolean",
  "city": "string",
  "state": "string",
  "postcode": "string",
  "country": "string",
  "subscribed": "boolean",
  "vat_number": "string"
}
200 OK

User id if user update was successful

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "user_id": "string"
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Account

Contact Profile - View

POST /account/contact-profile/{id}

View Account Contact Profile

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

id: string
in path

Contact Profile Id

Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string"
}
200 OK

Contact Profile

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "ContactProfile": {
      "id": "string",
      "email": "string",
      "title": "string",
      "firstname": "string",
      "lastname": "string",
      "admin": "boolean",
      "tech": "boolean",
      "billing": "boolean",
      "company_name": "string",
      "assumed_name": "string",
      "address_1": "string",
      "address_2": "string",
      "address_3": "string",
      "city": "string",
      "county": "string",
      "postcode": "string",
      "country": "string",
      "phone": "string",
      "fax": "string",
      "registration_number": "string",
      "vat_number": "string",
      "business_category_code": "string",
      "duns": "string",
      "active": "boolean",
      "deleted": "boolean"
    }
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Account

Contact Profile - Add

POST /account/contact-profile/add

Add an Account Contact Profile

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

title: string
firstname: string
lastname: string
email: string
phone: string
mobile: string
fax: string
direct_line: string
skype: string
address_1: string
address_2: string
address_3: string
admin: boolean

Is admin contact?

billing: boolean

Is billing contact?

tech: boolean

Is technical contact?

city: string
state: string
postcode: string
country: string
Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string",
  "title": "string",
  "firstname": "string",
  "lastname": "string",
  "email": "string",
  "phone": "string",
  "mobile": "string",
  "fax": "string",
  "direct_line": "string",
  "skype": "string",
  "address_1": "string",
  "address_2": "string",
  "address_3": "string",
  "admin": "boolean",
  "billing": "boolean",
  "tech": "boolean",
  "city": "string",
  "state": "string",
  "postcode": "string",
  "country": "string"
}
200 OK

Contact Profile id if user insertion was successful

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "contact_id": "string"
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Account

Contact Profile - Edit

POST /account/contact-profile/{id}/edit

Edit an Account Contact Profile

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

title: string
firstname: string
lastname: string
email: string
phone: string
mobile: string
fax: string
direct_line: string
skype: string
address_1: string
address_2: string
address_3: string
admin: boolean

Is admin contact?

billing: boolean

Is billing contact?

tech: boolean

Is technical contact?

city: string
state: string
postcode: string
country: string
id: string
in path

Contact Profile Id

Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string",
  "title": "string",
  "firstname": "string",
  "lastname": "string",
  "email": "string",
  "phone": "string",
  "mobile": "string",
  "fax": "string",
  "direct_line": "string",
  "skype": "string",
  "address_1": "string",
  "address_2": "string",
  "address_3": "string",
  "admin": "boolean",
  "billing": "boolean",
  "tech": "boolean",
  "city": "string",
  "state": "string",
  "postcode": "string",
  "country": "string"
}
200 OK

Contact Profile id if update was successful

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "contact_id": "string"
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}

Certificate

Certificate

Certificate - List

POST /certificates

Returns Account certificates basic information.

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string"
}
200 OK

Certificate List

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": [
    {
      "id": "string",
      "common_name": "string",
      "status": "string"
    }
  ]
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Certificate

Certificate - List per status

POST /certificates/{status}

Returns Account certificates basic information.

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

status: string Incomplete, Expiring, External, Issued, Stock, Pending, ReadyToReview, Expired, Subscription, Cancelled, Archived, TemporaryCertificate
in path

Status (e.g.: Issued).

Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string"
}
200 OK

Certificate List

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": [
    {
      "id": "string",
      "common_name": "string",
      "status": "string"
    }
  ]
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Certificate

Certificate - Get Approver Emails

POST /certificates/get-approver-email/{product-code}/{common-name}

Get possible Certificate Approver Email.

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

product-code: string
in path

Product Code (e.g.: com-ent-ssl-pro-wildcard).

common-name: string
in path

Common Name (e.g.: ssl247.co.uk).

Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string"
}
200 OK

Approver Email List

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": [
    {
      "{email}": "string"
    }
  ]
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Certificate

Certificate - Check common name

POST /certificates/check-common-name/{product-code}/{common-name}

Validate common name towards the product.

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

product-code: string
in path

Product Code (e.g.: com-ent-ssl-pro-wildcard).

common-name: string
in path

Common Name (e.g.: ssl247.co.uk).

Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string"
}
200 OK

Validity of Common Name

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "valid": "boolean",
    "type": "string",
    "message": "string"
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Certificate

Certificate - Check SAN

POST /certificates/check-san/{product-code}/{common-name}/{san}

Validate subject alternative name towards the common name and the product.

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

product-code: string
in path

Product Code (e.g.: com-ent-ssl-pro-wildcard).

common-name: string
in path

Common Name (e.g.: ssl247.co.uk).

san: string
in path

Product Subject Alternative Name (e.g.: sub-domain.ssl247.co.uk).

Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string"
}
200 OK

Validity ofSubject Alternative Name

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "valid": "boolean",
    "type": "string",
    "product_addon_id": "string",
    "message": "string"
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Certificate

Certificate - Get full

POST /certificate/{id}

Certificate with all the details.

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

id: string
in path

Certificate ID

Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string"
}
200 OK

Certificate Object

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "order_id": "string",
    "certificate_id": "string",
    "product_addon_id": "string",
    "CertificateDetails": {
      "product_code": "string",
      "common_name": "string",
      "approver_email": "string",
      "dv_auth_method": "string",
      "dns_auth_string": "string",
      "file_auth_filename": "string",
      "file_auth_contents": "string",
      "general_auth_string": "string",
      "licenses": "string",
      "hash": "string",
      "serial_number": "string",
      "years": "string",
      "remaining_reissues": "string",
      "csr": "string",
      "email_subscription": "string",
      "VettingData": "string",
      "Addons": {
        "Addon": [
          {
            "id": "string",
            "type": "string",
            "value": "string",
            "approver_email": "string"
          }
        ]
      },
      "Status": {
        "code": "string",
        "description": "string"
      },
      "StatusMinor": {
        "code": "string",
        "description": "string"
      }
    },
    "Contacts": {
      "Company": {
        "category": "string",
        "organisation_legal_name": "string",
        "registration_number": "string",
        "duns": "string"
      },
      "Administrative": {
        "organisation": "string",
        "title": "string",
        "firstname": "string",
        "lastname": "string",
        "email": "string",
        "phone": "string",
        "address_1": "string",
        "address_2": "string",
        "city": "string",
        "postcode": "string",
        "region": "string",
        "country": "string"
      },
      "Technical": {
        "organisation": "string",
        "title": "string",
        "firstname": "string",
        "lastname": "string",
        "email": "string",
        "phone": "string",
        "address_1": "string",
        "address_2": "string",
        "city": "string",
        "postcode": "string",
        "region": "string",
        "country": "string"
      }
    },
    "Dates": {
      "order": "string",
      "issuance": "string",
      "created": "string",
      "expiry": "string"
    },
    "Notes": {
      "Note": [
        {
          "note": "string",
          "user": "string",
          "date": "string"
        }
      ]
    },
    "VettingData": [
      {
        "status_type": "string",
        "status_text": "string",
        "created": "string"
      }
    ],
    "Status": {
      "code": "string",
      "description": "string"
    },
    "Product": {
      "name": "string",
      "code": "string",
      "Brand": {
        "name": "string"
      }
    }
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Certificate

Certificate - Get Details

POST /certificate/{id}/{type}

Get possible Certificate Approver Email.

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

id: string
in path

Certificate ID.

type: string x509, pkcs7, intermediate, root, bundle
in path

Download Type (e.g.: intermediate).

Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string"
}
200 OK

Certificate in format 'x509','pkcs7','intermediate','root','bundle'

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": [
    {
      "{type}": "string"
    }
  ]
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Certificate

Certificate - Request health check

POST /certificate/{id}/request-health-check

Request health check if the user have rights.

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

id: string
in path

Certificate ID.

Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string"
}
200 OK

Certificate Request results

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": "string"
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Certificate

Certificate - Renew

POST /certificate/{original_certificate_id}/renew

Request Certificate renewal.

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

years: string

Renewal years

original_certificate_id: string
in path

Certificate ID.

Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string",
  "years": "string"
}
200 OK

Certificate Request results

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "certificate_id": "string"
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Certificate

Certificate - Reissue

POST /certificate/{id}/reissue

Request Certificate re-issuance.

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

new_csr: string

New Csr

hash: string

New hashing algorithm

id: string
in path

Certificate ID.

Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string",
  "new_csr": "string",
  "hash": "string"
}
200 OK

Certificate Request results

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "status": "string",
    "message": "string"
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Certificate

Certificate - List by status

POST /orders/certificates/{status}

Shows certificates with the provided status

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

status: string Stock, Expiring, Subscription, Issued, Pending, Expired, Deactivated, External, Cancelled, Archived, Incomplete
in path

Status.

Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string"
}
200 OK

Orders

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "Certificate": [
      {
        "order_id": "string",
        "order_ref": "string",
        "email_subscription": "string",
        "CertificateDetails": {
          "id": "string",
          "product_code": "string",
          "product_name": "string",
          "common_name": "string",
          "approver_email": "string",
          "licenses": "string",
          "years": "string",
          "remaining_reissues": "string",
          "Addons": {
            "Addon": [
              {
                "type": "string",
                "value": "string"
              }
            ]
          },
          "Status": {
            "code": "string",
            "description": "string"
          }
        },
        "Dates": {
          "order": "string",
          "issuance": "string",
          "created": "string",
          "expiry": "string"
        },
        "Contacts": {
          "Company": {
            "category": "string",
            "organisation_legal_name": "string",
            "registration_number": "string",
            "duns": "string"
          },
          "Administrative": {
            "organisation": "string",
            "title": "string",
            "firstname": "string",
            "lastname": "string",
            "email": "string",
            "phone": "string",
            "address_1": "string",
            "address_2": "string",
            "city": "string",
            "postcode": "string",
            "region": "string",
            "country": "string"
          },
          "Technical": {
            "organisation": "string",
            "title": "string",
            "firstname": "string",
            "lastname": "string",
            "email": "string",
            "phone": "string",
            "address_1": "string",
            "address_2": "string",
            "city": "string",
            "postcode": "string",
            "region": "string",
            "country": "string"
          }
        }
      }
    ]
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Certificate

Certificate - Cancel

POST /certificate/{id}/cancel

Cancel a Certificate

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

id: string
in path

Certificate ID.

Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string"
}
200 OK

Orders

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": [
    {
      "message": "string",
      "status": "string",
      "details": "string"
    }
  ]
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Certificate

Certificate - Revoke

POST /certificate/{id}/revoke

Revoke a Certificate

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

id: string
in path

Certificate ID.

Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string"
}
200 OK

Data

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": [
    {
      "message": "string",
      "status": "string",
      "details": "string"
    }
  ]
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Certificate

Certificate - Import External

POST /orders/certificates/import

Import an external certificate

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

common_name: string

Common Name or Domain name.

admin_contact_id: string

Id of admin contact.

tech_contact_id: string

Id of tech contact

internal_product: string

Id of internal product

external_product: string

Id of external product

validation_type: string OV, EV, DV

Validation Type

Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string",
  "common_name": "string",
  "admin_contact_id": "string",
  "tech_contact_id": "string",
  "internal_product": "string",
  "external_product": "string",
  "validation_type": "string"
}
200 OK

Data

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": [
    {
      "Certificate": "object",
      "CertificateAddon": "object",
      "Order": "object"
    }
  ]
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Order Certificate

Order - Validate

POST /order/certificate/validate

Order Validation (checking all paramter are valid and supported)

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

billing_contact_id: string
order: object[]
object
product_code: string
common_name: string
years: string
licenses: string
san: integer
sans: string
quantity: integer
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string",
  "billing_contact_id": "string",
  "order": [
    {
      "product_code": "string",
      "common_name": "string",
      "years": "string",
      "licenses": "string",
      "san": "integer",
      "sans": "string",
      "quantity": "integer"
    }
  ]
}
200 OK

Data

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "Valid": "boolean",
    "OrderLines": [
      {
        "type": "string",
        "product_id": "string",
        "product_type_id": "string",
        "contract_id": "string",
        "years": "string",
        "quantity": "string",
        "licenses": "string",
        "code": "string",
        "pre_discount_total": "string",
        "total": "string",
        "discount_amount": "string",
        "discount": "string",
        "discount_reason": "string",
        "free": "string",
        "label": "string",
        "value": "string",
        "original_certificate_id": "string",
        "order_line_id": "string",
        "addons": [
          {
            "index_link": "string",
            "type": "string",
            "product_id": "string",
            "product_type_id": "string",
            "product_type_addon_id": "string",
            "product_addon_id": "string",
            "years": "string",
            "quantity": "string",
            "licenses": "string",
            "code": "string",
            "pre_discount_total": "string",
            "total": "string",
            "discount_amount": "string",
            "discount": "string",
            "discount_reason": "string",
            "free": "string",
            "label": "string",
            "value": "string",
            "order_line_id": "string"
          }
        ],
        "nextstep": "integer"
      }
    ]
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Order Certificate

Order - Place order

POST /order/certificate/place-order

Order placing after validation, prior completion

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

billing_contact_id: string
order: object[]
object
product_code: string
common_name: string
years: string
licenses: string
san: integer
sans: string
quantity: integer
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string",
  "billing_contact_id": "string",
  "order": [
    {
      "product_code": "string",
      "common_name": "string",
      "years": "string",
      "licenses": "string",
      "san": "integer",
      "sans": "string",
      "quantity": "integer"
    }
  ]
}
200 OK

Data

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "order_ref": "integer",
    "Order": [
      {
        "order_id": "string",
        "label": "string",
        "total": "integer",
        "Certificate": {
          "id": "string"
        }
      }
    ],
    "Invoice": {
      "id": "string",
      "total": "integer",
      "currency": "string",
      "invoice_ref": "integer",
      "vat": "integer"
    }
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Order Certificate

Order - Complete Certificate

POST /order/certificate/complete

Fill certificate details

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

certificate_id: string
common_name: string
csr: string
dv_auth_method: string email, dns, file

Domain validation method

approver_email: string

required if the domain validation method is email

Addon: object[]
object
id: string
value: string
approver_email: string

required if the domain validation method is email

Contacts: object
Company: object
organisation_category: string PO, BE, GE
organisation_legal_name: string
organisation_registration_number: string
organisation_duns: string
Administrative: object
organisation: string
title: string
firstname: string
lastname: string
email: string
phone: string
address_1: string
address_2: string
city: string
postcode: string
region: string
country: string
Technical: object
organisation: string
title: string
firstname: string
lastname: string
email: string
phone: string
address_1: string
address_2: string
city: string
postcode: string
region: string
country: string
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string",
  "certificate_id": "string",
  "common_name": "string",
  "csr": "string",
  "dv_auth_method": "string",
  "approver_email": "string",
  "Addon": [
    {
      "id": "string",
      "value": "string",
      "approver_email": "string"
    }
  ],
  "Contacts": {
    "Company": {
      "organisation_category": "string",
      "organisation_legal_name": "string",
      "organisation_registration_number": "string",
      "organisation_duns": "string"
    },
    "Administrative": {
      "organisation": "string",
      "title": "string",
      "firstname": "string",
      "lastname": "string",
      "email": "string",
      "phone": "string",
      "address_1": "string",
      "address_2": "string",
      "city": "string",
      "postcode": "string",
      "region": "string",
      "country": "string"
    },
    "Technical": {
      "organisation": "string",
      "title": "string",
      "firstname": "string",
      "lastname": "string",
      "email": "string",
      "phone": "string",
      "address_1": "string",
      "address_2": "string",
      "city": "string",
      "postcode": "string",
      "region": "string",
      "country": "string"
    }
  }
}
200 OK

Data

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "order_ref": "integer",
    "Certificate": [
      {
        "id": "string",
        "status": "string",
        "logs": [
          {
            "id": "string",
            "website_id": "string",
            "account_id": "string",
            "order_id": "string",
            "invoice_id": "string",
            "user_id": "string",
            "payment_id": "string",
            "certificate_id": "string",
            "code_signing_id": "string",
            "domain_name_id": "string",
            "hack_avert_domain_id": "string",
            "protected_brand_id": "string",
            "personal_signing_id": "string",
            "pdf_signing_id": "string",
            "inty_subscription_id": "string",
            "ticket_id": "string",
            "event_id": "string",
            "contract_id": "string",
            "subscription_id": "string",
            "token_ledger_id": "string",
            "url": "string",
            "admin": "string",
            "error": "string",
            "details": "string",
            "ip_address": "string",
            "source": "string",
            "created": "string"
          }
        ]
      }
    ]
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Order Certificate

Order - Place Order with only 1 request

POST /order/certificate/place-quick-order

Fill all certificate details in one go

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

billing_contact_id: string

default billing contact will be used if blank

product_code: string
common_name: string
years: string
licenses: string
dv_auth_method: string email, dns, file

Domain validation method

approver_email: string

required if the domain validation method is email

csr: string
Addon: object[]

If there are any SANs

object
value: string
approver_email: string

required if the domain validation method is email

Contacts: object
Company: object
organisation_category: string PO, BE, GE
organisation_legal_name: string
organisation_registration_number: string
organisation_duns: string
Administrative: object

Default Admin contact used if paramter not provided

organisation: string
department: string
title: string
firstname: string
lastname: string
email: string
phone: string
address_1: string
address_2: string
city: string
postcode: string
region: string
country: string
Technical: object

Default Tech contact used if paramter not provided

organisation: string
department: string
title: string
firstname: string
lastname: string
email: string
phone: string
address_1: string
address_2: string
city: string
postcode: string
region: string
country: string
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string",
  "billing_contact_id": "string",
  "product_code": "string",
  "common_name": "string",
  "years": "string",
  "licenses": "string",
  "dv_auth_method": "string",
  "approver_email": "string",
  "csr": "string",
  "Addon": [
    {
      "value": "string",
      "approver_email": "string"
    }
  ],
  "Contacts": {
    "Company": {
      "organisation_category": "string",
      "organisation_legal_name": "string",
      "organisation_registration_number": "string",
      "organisation_duns": "string"
    },
    "Administrative": {
      "organisation": "string",
      "department": "string",
      "title": "string",
      "firstname": "string",
      "lastname": "string",
      "email": "string",
      "phone": "string",
      "address_1": "string",
      "address_2": "string",
      "city": "string",
      "postcode": "string",
      "region": "string",
      "country": "string"
    },
    "Technical": {
      "organisation": "string",
      "department": "string",
      "title": "string",
      "firstname": "string",
      "lastname": "string",
      "email": "string",
      "phone": "string",
      "address_1": "string",
      "address_2": "string",
      "city": "string",
      "postcode": "string",
      "region": "string",
      "country": "string"
    }
  }
}
200 OK

Data

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "order_ref": "integer",
    "Certificate": [
      {
        "id": "string"
      }
    ]
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}

Product

Product

Product Types

POST /product-types

Shows available product type.

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string"
}
200 OK

Product Types

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "ProductTypeList": [
      {
        "code": "string",
        "name": "string"
      }
    ]
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Product

Products

POST /products/{product-type}

Shows available products

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

product-type: string
in path

Product Type.

Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string"
}
200 OK

Product List per type

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "Products": {
      "Product": [
        {
          "code": "string",
          "brand": "string",
          "name": "string",
          "Prices": {
            "Price": [
              {
                "years": "integer",
                "value": "integer",
                "currency": "string"
              }
            ]
          }
        }
      ]
    }
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Product

Product - Details

POST /product/{product-code}

Shows product details

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

product-code: string
in path

Product Code.

Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string"
}
200 OK

Product Details

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "name": "string",
    "Code": "string",
    "url": "string",
    "brand": "string",
    "brand_id": "string",
    "sub_brand_id": "string",
    "ProductRequirements": "object",
    "ProductAddons": [
      "object"
    ],
    "ProductPrices": [
      {
        "price": "integer",
        "years": "integer",
        "currency": "string"
      }
    ],
    "ProductDetail": {
      "description": "string"
    },
    "ProductAddonPrices": {
      "{Addon Name}": {
        "prices": [
          {
            "price": "integer",
            "years": "integer",
            "currency": "string"
          }
        ]
      }
    }
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Product

Product - Requirements

POST /product/{product-code}/requirements

Shows product requirements

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

product-code: string
in path

Product Code.

Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string"
}
200 OK

Product Requirements List

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "ProductRequirements": "object"
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Product

Product - Addons

POST /product/{product-code}/addons

Shows product addon list

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

product-code: string
in path

Product Code.

Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string"
}
200 OK

Product Addons List

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "ProductAddons": [
      "object"
    ]
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Product

Product - Prices

POST /product/{product-code}/prices

Shows product and addon prices

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

product-code: string
in path

Product Code.

Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string"
}
200 OK

Product Prices

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "ProductPrices": [
      {
        "price": "integer",
        "years": "integer",
        "currency": "string"
      }
    ],
    "ProductAddonPrices": {
      "{Addon Name}": {
        "prices": [
          {
            "price": "integer",
            "years": "integer",
            "currency": "string"
          }
        ]
      }
    }
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}

Order

Order

Orders

POST /orders

Shows list of orders with details

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string"
}
200 OK

Orders

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "Orders": {
      "Certificate": [
        {
          "order_id": "string",
          "order_ref": "string",
          "email_subscription": "string",
          "CertificateDetails": {
            "id": "string",
            "product_code": "string",
            "product_name": "string",
            "common_name": "string",
            "approver_email": "string",
            "licenses": "string",
            "years": "string",
            "remaining_reissues": "string",
            "Addons": {
              "Addon": [
                {
                  "id": "string",
                  "type": "string",
                  "value": "string",
                  "approver_email": "string"
                }
              ]
            },
            "Status": {
              "code": "string",
              "description": "string"
            }
          },
          "Dates": {
            "order": "string",
            "issuance": "string",
            "created": "string",
            "expiry": "string"
          },
          "Contacts": {
            "Company": {
              "category": "string",
              "organisation_legal_name": "string",
              "registration_number": "string",
              "duns": "string"
            },
            "Administrative": {
              "organisation": "string",
              "title": "string",
              "firstname": "string",
              "lastname": "string",
              "email": "string",
              "phone": "string",
              "address_1": "string",
              "address_2": "string",
              "city": "string",
              "postcode": "string",
              "region": "string",
              "country": "string"
            },
            "Technical": {
              "organisation": "string",
              "title": "string",
              "firstname": "string",
              "lastname": "string",
              "email": "string",
              "phone": "string",
              "address_1": "string",
              "address_2": "string",
              "city": "string",
              "postcode": "string",
              "region": "string",
              "country": "string"
            }
          }
        }
      ]
    }
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Order

Invoice

POST /orders/invoice/{invoice-id}/{download}

Shows invoice pdf in base64 encoded

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

invoice-id: string
in path

Invoice Id.

download: string
in path

Url for the invoice OR the invoice pdf base64 encoded

Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string"
}
200 OK

Orders

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "invoice": "string"
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Order

Order - Details

POST /orders/{order-id}

Getting order details

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

order-id: string
in path

Id of the order OR the order ref.

Request Content-Types: application/json
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string"
}
200 OK

Data

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "Orders": [
      {
        "Certificate": {
          "id": "string",
          "order_id": "string",
          "label": "string",
          "CertificateDetails": {
            "total": "integer (int32)",
            "quantity": "integer (int32)",
            "product_code": "string",
            "product_name": "string",
            "common_name": "string",
            "approver_email": "string",
            "licenses": "integer (int32)",
            "years": "integer (int32)",
            "original_order_id": "string",
            "csr": "string",
            "x509": "string",
            "pkcs7": "string",
            "intermediate": "string",
            "root": "string",
            "remaining_reissues": "integer (int32)",
            "Addons": [
              {
                "id": "string",
                "type": "string",
                "value": "string",
                "total": "string"
              }
            ],
            "Status": {
              "code": "string",
              "description": "string"
            }
          }
        },
        "placed_with_api": "string",
        "email_subscription": "string",
        "payment_ref": "string",
        "invoice_id": "string"
      }
    ]
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Order Certificate

Order - Validate

POST /order/certificate/validate

Order Validation (checking all paramter are valid and supported)

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

billing_contact_id: string
order: object[]
object
product_code: string
common_name: string
years: string
licenses: string
san: integer
sans: string
quantity: integer
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string",
  "billing_contact_id": "string",
  "order": [
    {
      "product_code": "string",
      "common_name": "string",
      "years": "string",
      "licenses": "string",
      "san": "integer",
      "sans": "string",
      "quantity": "integer"
    }
  ]
}
200 OK

Data

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "Valid": "boolean",
    "OrderLines": [
      {
        "type": "string",
        "product_id": "string",
        "product_type_id": "string",
        "contract_id": "string",
        "years": "string",
        "quantity": "string",
        "licenses": "string",
        "code": "string",
        "pre_discount_total": "string",
        "total": "string",
        "discount_amount": "string",
        "discount": "string",
        "discount_reason": "string",
        "free": "string",
        "label": "string",
        "value": "string",
        "original_certificate_id": "string",
        "order_line_id": "string",
        "addons": [
          {
            "index_link": "string",
            "type": "string",
            "product_id": "string",
            "product_type_id": "string",
            "product_type_addon_id": "string",
            "product_addon_id": "string",
            "years": "string",
            "quantity": "string",
            "licenses": "string",
            "code": "string",
            "pre_discount_total": "string",
            "total": "string",
            "discount_amount": "string",
            "discount": "string",
            "discount_reason": "string",
            "free": "string",
            "label": "string",
            "value": "string",
            "order_line_id": "string"
          }
        ],
        "nextstep": "integer"
      }
    ]
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Order Certificate

Order - Place order

POST /order/certificate/place-order

Order placing after validation, prior completion

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

billing_contact_id: string
order: object[]
object
product_code: string
common_name: string
years: string
licenses: string
san: integer
sans: string
quantity: integer
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string",
  "billing_contact_id": "string",
  "order": [
    {
      "product_code": "string",
      "common_name": "string",
      "years": "string",
      "licenses": "string",
      "san": "integer",
      "sans": "string",
      "quantity": "integer"
    }
  ]
}
200 OK

Data

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "order_ref": "integer",
    "Order": [
      {
        "order_id": "string",
            "label": "string",
        "total": "integer",
        "Certificate": {
          "id": "string"
        }
          }
        ],
    "Invoice": {
      "id": "string",
      "total": "integer",
      "currency": "string",
      "invoice_ref": "integer",
      "vat": "integer"
      }
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Order Certificate

Order - Complete Certificate

POST /order/certificate/complete

Fill certificate details

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

certificate_id: string
common_name: string
csr: string
dv_auth_method: string email, dns, file

Domain validation method

approver_email: string

required if the domain validation method is email

Addon: object[]
object
id: string
value: string
approver_email: string

required if the domain validation method is email

Contacts: object
Company: object
organisation_category: string PO, BE, GE
organisation_legal_name: string
organisation_registration_number: string
organisation_duns: string
Administrative: object
organisation: string
title: string
firstname: string
lastname: string
email: string
phone: string
address_1: string
address_2: string
city: string
postcode: string
region: string
country: string
Technical: object
organisation: string
title: string
firstname: string
lastname: string
email: string
phone: string
address_1: string
address_2: string
city: string
postcode: string
region: string
country: string
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string",
  "certificate_id": "string",
  "common_name": "string",
  "csr": "string",
  "dv_auth_method": "string",
  "approver_email": "string",
  "Addon": [
    {
      "id": "string",
      "value": "string",
      "approver_email": "string"
    }
  ],
  "Contacts": {
    "Company": {
      "organisation_category": "string",
      "organisation_legal_name": "string",
      "organisation_registration_number": "string",
      "organisation_duns": "string"
    },
    "Administrative": {
      "organisation": "string",
      "title": "string",
      "firstname": "string",
      "lastname": "string",
      "email": "string",
      "phone": "string",
      "address_1": "string",
      "address_2": "string",
      "city": "string",
      "postcode": "string",
      "region": "string",
      "country": "string"
    },
    "Technical": {
      "organisation": "string",
      "title": "string",
      "firstname": "string",
      "lastname": "string",
      "email": "string",
      "phone": "string",
      "address_1": "string",
      "address_2": "string",
      "city": "string",
      "postcode": "string",
      "region": "string",
      "country": "string"
    }
    }
}
200 OK

Data

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "order_ref": "integer",
    "Certificate": [
      {
        "id": "string",
        "status": "string",
        "logs": [
      {
            "id": "string",
            "website_id": "string",
            "account_id": "string",
        "order_id": "string",
            "invoice_id": "string",
            "user_id": "string",
            "payment_id": "string",
            "certificate_id": "string",
            "code_signing_id": "string",
            "domain_name_id": "string",
            "hack_avert_domain_id": "string",
            "protected_brand_id": "string",
            "personal_signing_id": "string",
            "pdf_signing_id": "string",
            "inty_subscription_id": "string",
            "ticket_id": "string",
            "event_id": "string",
            "contract_id": "string",
            "subscription_id": "string",
            "token_ledger_id": "string",
            "url": "string",
            "admin": "string",
            "error": "string",
            "details": "string",
            "ip_address": "string",
            "source": "string",
            "created": "string"
        }
        ]
      }
    ]
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Order Certificate

Order - Place Order with only 1 request

POST /order/certificate/place-quick-order

Fill all certificate details in one go

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

billing_contact_id: string

default billing contact will be used if blank

product_code: string
common_name: string
years: string
licenses: string
dv_auth_method: string email, dns, file

Domain validation method

approver_email: string

required if the domain validation method is email

csr: string
Addon: object[]

If there are any SANs

object
value: string
approver_email: string

required if the domain validation method is email

Contacts: object
Company: object
organisation_category: string PO, BE, GE
organisation_legal_name: string
organisation_registration_number: string
organisation_duns: string
Administrative: object

Default Admin contact used if paramter not provided

organisation: string
department: string
title: string
firstname: string
lastname: string
email: string
phone: string
address_1: string
address_2: string
city: string
postcode: string
region: string
country: string
Technical: object

Default Tech contact used if paramter not provided

organisation: string
department: string
title: string
firstname: string
lastname: string
email: string
phone: string
address_1: string
address_2: string
city: string
postcode: string
region: string
country: string
Request Example
{
  "u": "string",
  "p": "string",
  "k": "string",
  "billing_contact_id": "string",
  "product_code": "string",
  "common_name": "string",
  "years": "string",
  "licenses": "string",
  "dv_auth_method": "string",
  "approver_email": "string",
  "csr": "string",
  "Addon": [
    {
      "value": "string",
      "approver_email": "string"
    }
  ],
  "Contacts": {
    "Company": {
      "organisation_category": "string",
      "organisation_legal_name": "string",
      "organisation_registration_number": "string",
      "organisation_duns": "string"
    },
    "Administrative": {
      "organisation": "string",
      "department": "string",
      "title": "string",
      "firstname": "string",
      "lastname": "string",
      "email": "string",
      "phone": "string",
      "address_1": "string",
      "address_2": "string",
      "city": "string",
      "postcode": "string",
      "region": "string",
      "country": "string"
    },
    "Technical": {
      "organisation": "string",
      "department": "string",
      "title": "string",
      "firstname": "string",
      "lastname": "string",
      "email": "string",
      "phone": "string",
      "address_1": "string",
      "address_2": "string",
      "city": "string",
      "postcode": "string",
      "region": "string",
      "country": "string"
    }
  }
}
200 OK

Data

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": {
    "order_ref": "integer",
    "Certificate": [
      {
        "id": "string"
      }
    ]
  }
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}

Generic

Generic

Get Country List

POST /generic/get-country-list

Shows available countries

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

Request Example
{
  "u": "string",
  "p": "string",
  "k": "string"
}
200 OK

Certificate Request results

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": "string"
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Generic

Get User titles

POST /generic/get-user-titles

Shows available user titles

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

Request Example
{
  "u": "string",
  "p": "string",
  "k": "string"
}
200 OK

Certificate Request results

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": "string"
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Generic

Get US states list

POST /generic/get-us-state-list

Shows available USA state list

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

Request Example
{
  "u": "string",
  "p": "string",
  "k": "string"
}
200 OK

Certificate Request results

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": "string"
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Generic

Get Internal Products list

POST /generic/get-internal-product-list

Shows available product list on our platform

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

Request Example
{
  "u": "string",
  "p": "string",
  "k": "string"
}
200 OK

Certificate Request results

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": "string"
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Generic

Get External Products list

POST /generic/get-external-product-list

Shows product that are available for external certificates

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

Request Example
{
  "u": "string",
  "p": "string",
  "k": "string"
}
200 OK

Certificate Request results

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": "string"
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Generic

Get Websites List

POST /generic/get-websites-list

Shows our available territories

u: string

User email address

p: string

Standard / Super User password ( Not required if using API User)

k: string

API User Api key Or Account API Key if using a Standard / Super User

Request Example
{
  "u": "string",
  "p": "string",
  "k": "string"
}
200 OK

Certificate Request results

type
object
default
Error

Unexpected error

Response Example (200 OK) 
{
  "StatusCode": "string",
  "StatusDescription": "string",
  "Date": "string",
  "Data": "string"
}
Response Example (default ) 
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}

Schema Definitions

Error:

Response: object
Error: object
Code: string
Message: string
Date: string
Example
{
  "Response": {
    "Error": {
      "Code": "string",
      "Message": "string"
    },
    "Date": "string"
  }
}
Documentation by Spectacle