Order document signing certificate

POST

https://www.digicert.com/services/v2/order/certificate/{{document_certificate_id}}

This page describes products with the document_signing group name (see Glossary – Product identifiers).

Use this endpoint to submit a document signing certificate request order using document_signing_org_1 or document_signing_org_2 as the document_certificate_id.

cURL

curl -X POST \
  'https://www.digicert.com/services/v2/order/certificate/{{document_certificate_id}}' \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}' \
  -d '{
    "certificate": {
        "server_platform": {
            "id": 21
        },
        "signature_hash": "sha256"
    },
    "cs_provisioning_method": "ship_token",
    "use_org_as_common_name": true,
    "validity_years": 2,
    "comments": "Comments for the the approver.",
    "organization": {
        "id": 334455
    },
    "container": {
        "id": 221122
    },
    "ship_info": {
        "name": "Erin Guerra",
        "addr1": "360 Taylor Street",
        "addr2": "Floor 74",
        "city": "Richmond",
        "state": "va",
        "zip": "69662",
        "country": "us",
        "method": "standard"
    },
    "subject": {
        "name": "Rene Pierce",
        "job_title": "School Counselor",
        "phone": "054-139-0798",
        "email": "rene.pierce@yahoo.com"
    },
    "csa_agreed_to": 1,
    "skip_approval": true,
    "payment_method": "balance"
}'

Python

import requests

url = "https://www.digicert.com/services/v2/order/certificate/{{document_certificate_id}}"

payload = "{\n    \"certificate\": {\n        \"server_platform\": {\n            \"id\": 21\n        },\n        \"signature_hash\": \"sha256\"\n    },\n    \"cs_provisioning_method\": \"ship_token\",\n    \"use_org_as_common_name\": true,\n    \"validity_years\": 2,\n    \"comments\": \"Comments for the the approver.\",\n    \"organization\": {\n        \"id\": 334455\n    },\n    \"container\": {\n        \"id\": 221122\n    },\n    \"ship_info\": {\n        \"name\": \"Erin Guerra\",\n        \"addr1\": \"360 Taylor Street\",\n        \"addr2\": \"Floor 74\",\n        \"city\": \"Richmond\",\n        \"state\": \"va\",\n        \"zip\": \"69662\",\n        \"country\": \"us\",\n        \"method\": \"standard\"\n    },\n    \"subject\": {\n        \"name\": \"Rene Pierce\",\n        \"job_title\": \"School Counselor\",\n        \"phone\": \"054-139-0798\",\n        \"email\": \"rene.pierce@yahoo.com\"\n    },\n    \"csa_agreed_to\": 1,\n    \"skip_approval\": true,\n    \"payment_method\": \"balance\"\n}"
headers = {
    'X-DC-DEVKEY': "{{api_key}}",
    'Content-Type': "application/json"
    }

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://www.digicert.com/services/v2/order/certificate/{{document_certificate_id}}"

	payload := strings.NewReader("{\n    \"certificate\": {\n        \"server_platform\": {\n            \"id\": 21\n        },\n        \"signature_hash\": \"sha256\"\n    },\n    \"cs_provisioning_method\": \"ship_token\",\n    \"use_org_as_common_name\": true,\n    \"validity_years\": 2,\n    \"comments\": \"Comments for the the approver.\",\n    \"organization\": {\n        \"id\": 334455\n    },\n    \"container\": {\n        \"id\": 221122\n    },\n    \"ship_info\": {\n        \"name\": \"Erin Guerra\",\n        \"addr1\": \"360 Taylor Street\",\n        \"addr2\": \"Floor 74\",\n        \"city\": \"Richmond\",\n        \"state\": \"va\",\n        \"zip\": \"69662\",\n        \"country\": \"us\",\n        \"method\": \"standard\"\n    },\n    \"subject\": {\n        \"name\": \"Rene Pierce\",\n        \"job_title\": \"School Counselor\",\n        \"phone\": \"054-139-0798\",\n        \"email\": \"rene.pierce@yahoo.com\"\n    },\n    \"csa_agreed_to\": 1,\n    \"skip_approval\": true,\n    \"payment_method\": \"balance\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-DC-DEVKEY", "{{api_key}}")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

NodeJS

var request = require("request");

var options = { method: 'POST',
  url: 'https://www.digicert.com/services/v2/order/certificate/{{document_certificate_id}}',
  headers: 
   { 'Content-Type': 'application/json',
     'X-DC-DEVKEY': '{{api_key}}' },
  body: 
   { certificate: { server_platform: { id: 21 }, signature_hash: 'sha256' },
     cs_provisioning_method: 'ship_token',
     use_org_as_common_name: true,
     validity_years: 2,
     comments: 'Comments for the the approver.',
     organization: { id: 334455 },
     container: { id: 221122 },
     ship_info: 
      { name: 'Erin Guerra',
        addr1: '360 Taylor Street',
        addr2: 'Floor 74',
        city: 'Richmond',
        state: 'va',
        zip: '69662',
        country: 'us',
        method: 'standard' },
     subject: 
      { name: 'Rene Pierce',
        job_title: 'School Counselor',
        phone: '054-139-0798',
        email: 'rene.pierce@yahoo.com' },
     csa_agreed_to: 1,
     skip_approval: true,
     payment_method: 'balance' },
  json: true };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

201 Created (one-step approval)

{
    "id": 112233,
    "requests": [
        {
            "id": 113,
            "status": "pending"
        }
    ]
}

201 Created (two-step approval)

{
    "id": 112233,
    "requests": [
        {
            "id": 113,
            "status": "submitted"
        }
    ]
}

201 Created

{
    "id": 112233,
    "requests": [
        {
            "id": 113,
            "status": "approved"
        }
    ],
    "certificate_id": 113
}

Request parameters

Name	Req/Opt	Type	Description
certificate	required	object	Certificate details.
.. csr	optional*	string	Certificate signing request (CSR). Required if `cs_provisioning_method` is `email`. Note:* The Services API does not extract information from the CSR to fill in the details of a certificate request. You must provide values for all relevant request parameters, including `organization.id`. If you are requesting a certificate for an organization without an existing ID, you must provide values for all required parameters of the `organization` object.
.. server_platform	optional	object	Server platform type. Default: `-1` (other)
.. .. id	required	int	Server platform ID. See Glossary – Server platforms
.. signature_hash	required	string	Hash algorithm used to signing the certificate. Allowed values: `sha256`
cs_provisioning_method	optional	string	Specify how you want to receive the token. See Glossary – CS provisioning methods
use_org_as_common_name	optional	bool	Specify if the organization name should be used as the common name on the certificate. Default: `true`
validity_years	required	int	Number of years the certificate is valid. Allowed values: `1`, `2`, `3`
comments	optional	string	Comments about the order for the approver.
organization	required	object	Organization to associate with the order.
.. id	required	int	Organization ID.
container	optional	object	If needed, specify the container the order should be placed under.
.. id	required	int	Container ID.
ship_info	optional	object	Specify the shipping address for the token.
.. name	required	string	Name of the recipient.
.. addr1	required	string	Shipping address for the token.
.. addr2	optional	string
.. city	required	string	Shipping city.
.. state	required	string	Shipping state.
.. zip	required	string	Shipping postal code.
.. country	required	string	Shipping country.
.. method	required	string	Shipping priority for the token. Allowed values: `standard`, `expedited` (incurs added cost)
subject	required	object	Subject information for the certificate.
.. name	required	string	Subject's full name.
.. job_title	required	string	Subject job title.
.. phone	required	string	Subject phone number.
.. email	required	string	Subject email address.
custom_fields	optional*	object	Account-specific custom fields. *Whether or not these fields are required depends on your custom field settings.
.. metadata_id	required	int	Custom field ID.
.. value	required	string	Value for the custom field. Data validation type depends on your custom field settings.
user_id_assignments	optional	array	List of User IDs that can manage the order.
skip_approval	optional	bool	Specify if the order should skip the approval step and be immediately submitted for validation and issued when complete. Default: `false`
payment_method	optional	string	Specify the payment method to use. Allowed values: `balance`, `card`, `profile` Default: `balance`

Response parameters

Name	Type	Description
id	int	Order ID.
organization	object	Container for new organization details. Only returned if a new organization was created with the order.
.. id	int	Organization ID for the new organization.
requests	array	Contains information about the request.
.. id	int	Request ID.
.. status	string	Request status. Possible values: `pending`, `submitted`, `approved`, `rejected`
certificate_id	int	Certificate ID. Returned if request status is `approved`.

Request parameters

Response parameters

Informazioni