Change Organization

Change the organization associated with a request for an OV or EV certificate that has already been generated by the Certificate Authority (CA).

You cannot change the organization for a certificate that is still being processed by the Certificate Authority (CA).

Request

Update a certificate request's organization through the following endpoint:

HTTP Method	Request URI
PUT	https://api.vdms.io/sec/cps/v2.0/certificates/Certificate Request ID/organization

Define the following variable when submitting the above request:

VariableA variable represents a value that must be replaced. A variable consists of either a URL segment (e.g., "0001" in /0001/) or a query string value (e.g., "3" in mediaTypes=3).	Description
Certificate Request ID Required	Replace this variable with the system-defined ID for the desired certificate request. Use the Get All Certificate Requests endpoint to retrieve a list of certificate requests and their system-defined ID.

Description

Certificate Request ID

Required

Replace this variable with the system-defined ID for the desired certificate request.

Use the Get All Certificate Requests endpoint to retrieve a list of certificate requests and their system-defined ID.

Request Headers

This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.

Unlike requests to api.edgecast.com, requests to our API gateway (api.vdms.io) require an access token (OAuth).

Request Body

Pass the following request body parameters:

Name	Data Type	Description
additional_contacts Required	Array of objects	Required for EV certificates Contains additional contacts that are also responsible for validating certificates for this organization.
city Required	String	Required for OV and EV certificates Indicates the organization's city.
company_address Required	String	Required for OV and EV certificates Indicates the organization's address.
company_address2 Required	String	Indicates the organization's secondary address information (e.g., suite number).
company_name Required	String	Required for OV and EV certificates Indicates the organization's name. If we are unable to identify an organization through the id property, then we will compare the name specified in this property to all of your organizations. If an exact match is found, then the certificate request will be associated with that organization. Additionally, all other properties defined within this object will be ignored. If we cannot identify an existing organization through either the id or company_name properties, then we will create a new organization using the information supplied in this object.
contact_email Required	String	Required for OV and EV certificates Indicates the email address for the individual responsible for validating certificates for this organization.
contact_first_name Required	String	Required for OV and EV certificates Indicates the first name for the individual responsible for validating certificates for this organization.
contact_last_name Required	String	Required for OV and EV certificates Indicates the last name for the individual responsible for validating certificates for this organization.
contact_phone Required	String	Required for OV and EV certificates Indicates the phone number for the individual responsible for validating certificates for this organization.
contact_title	String	Indicates the title of the individual responsible for validating certificates for this organization.
country Required	String	Required for OV and EV certificates Indicates the organization's country by its ISO 3166 country code. Use the Get Country Codes endpoint to retrieve a list of countries and their codes.
id	Integer	Identifies an organization by its system-defined ID. Key information: Specify an existing organization by passing either of the following values: ID: Set this property to the system-defined ID for the desired organization. 0: Set this property to 0 if the desired organization has only been registered with Digicert. Additionally, you must set the company_name property to your organization's exact name as defined within Digicert. Use the Get Organization by Name endpoint to find organizations by name. Use the Get Organization by ID endpoint to get detailed information about a specific organization. You cannot modify an existing organization. If you assign an existing organization to this certificate, then other properties defined within this object will be ignored.
organizational_unit	String	Indicates the name of the organizational unit responsible for validating certificates for this organization.
state Required	String	United States Only: Required for OV and EV certificates Indicates the organization's state by its abbreviation.
zip_code Required	String	United States Only: Required for OV and EV certificates Indicates the organization's zip code.

additional_contacts Array

The additional_contacts array describes each of the organization's additional contacts through the following properties:

Name	Data Type	Description
contact_type Required	String	Required for EV certificates Set to EVApprover.
email Required	String	Required for EV certificates Indicates the email address for the current contact.
first_name Required	String	Required for EV certificates Indicates the first name for the current contact.
id	Integer	Reserved for future use.
last_name Required	String	Required for EV certificates Indicates the last name for the current contact.
phone Required	String	Required for EV certificates Indicates the phone number for the current contact.
title Required	String	Required for EV certificates Indicates the title of the current contact.

Response

The response to the above request includes an HTTP status code, response headers, and a response body.

Status Code

A status code indicates whether the request was successfully performed.

Response Headers

The response for this endpoint only includes standard HTTP response headers.

View common response headers.

Response Body

The response body for a successful request (200 OK) contains the following response elements:

Name	Data Type	Description
additional_contacts	Array of objects	Contains additional contacts that are also responsible for validating certificates for this organization.
city	String	Indicates the organization's city.
company_address	String	Indicates the organization's address.
company_address2	String	Indicates the organization's secondary address information (e.g., suite number).
company_name	String	Indicates the organization's name.
contact_email	String	Indicates the email address for the individual responsible for validating certificates for this organization.
contact_first_name	String	Indicates the first name for the individual responsible for validating certificates for this organization.
contact_last_name	String	Indicates the last name for the individual responsible for validating certificates for this organization.
contact_phone	String	Indicates the phone number for the individual responsible for validating certificates for this organization.
contact_title	String	Indicates the title of the individual responsible for validating certificates for this organization.
country	String	Indicates the organization's country by its ISO 3166 country code. Use the Get Country Codes endpoint to retrieve a list of countries and their codes.
id	Integer	Identifies an organization by its system-defined ID.
organizational_unit	String	Indicates the name of the organizational unit responsible for validating certificates for this organization.
state	String	Indicates the organization's state by its abbreviation.
zip_code	String	Indicates the organization's zip code.

additional_contacts Array

The additional_contacts array describes each of the organization's additional contacts through the following properties:

Name	Data Type	Description
contact_type	String	Returns EVApprover for EV certificates.
email	String	Indicates the email address for the current contact.
first_name	String	Indicates the first name for the current contact.
id	Integer	Reserved for future use.
last_name	String	Indicates the last name for the current contact.
phone	String	Indicates the phone number for the current contact.
title	String	Indicates the title of the current contact.

Errors

The response body for an unsuccessful request may contain an error element that provides additional information.

View common error messages.

Sample Request and Response (JSON)

A sample JSON request is shown below.

PUT https://api.vdms.io/sec/cps/v2.0/certificates/11604/organization HTTP/1.1

Authorization: Bearer A1bcbGciOiJSUzI1NiIsImtpZCI6Ij13N1VGQ01z...A1bcbGciOiJSUzI1NiIsImtpZCI6Ij13N1VGQ01zOTIzQjI1MTYzRjU4MU1wQ0I3MUNBRDk3QjAzNkUwQjgiLCJ01XAiOiJKV1QiLCJ4NXQiOiJGMDc4bzVJN0pSWV9XQm9Ndcc5dGw3QTI0TGcifQ.1yJuYmYiOj11NjUzMDgwNzgsImV4cCI6MTU2NTMwODM3OCwiaXNzIjoiacR0ccM6Ly9pZC52ZG1zLmlvIiwiYXVkIjpbImc0dcBzOi8vaWQudmRtcy5pby9yZXNvdXJjZXMiLCJlYy5ydWxlcyJdLCJjbGllbnRfaWQiOiIxNTccOWZmZi04MTQzLTRmOW1tOWY1Yi1jNDgzZWVkNzclM2QiLCJzY29wZSI6WyJlYy5ydWxlcyJdfQ.XQ4TvzDrwLo4bO71cb1TbgYxmtcgTzC46Do0A9F3inAqw1qcr_Nr9IgRDxJDqR4Udc9QR86LVTQC2-ogGWP3pI12GtDtiUQdKYs5fpcuMf2Kbqau6kuU1M5BJm_GOcBNCCAJnU7SrDprVbPlwanGqk3yjcyo9nto8KWCRTwq2t31UQ1Ci31FZSr4vaMZJqk1vBW6NS3-yGowGCZbSIQBKpSgcc75coPtSjF1Qi6M4yORDyMC8c3KKlIp2b-6mpfDFXINIFV-XvnNuQ9v-lcc43_VWuDA_cQO8wmS4VzS1Ac1tpg1Pp4Bcdtjt12yKAXvi0X19R1BDmpxmO17cRRKYQ

Accept: application/json

Content-Type: application/json

Host: api.vdms.io

{
	"country": "US",
	"state": "California",
	"zip_code": "90094",
	"city": "Los Angeles",
	"company_name": "Widgets LLC",
	"company_address": "13031 W Jefferson Blvd",
	"company_address2": "500",
	"organizational_unit": null,
	"contact_first_name": null,
	"contact_last_name": null,
	"contact_email": null,
	"contact_phone": null,
	"contact_title": null,
	"additional_contacts": [{
			"first_name": "Richard",
			"last_name": "Smith",
			"email": "richard.smith@widgets.com",
			"phone": "3105551212",
			"title": null,
			"contact_type": "OrganizationContact",
			"id": 4
		}, {
			"first_name": "Richard",
			"last_name": "Smith",
			"email": "richard.smith@widgets.com",
			"phone": "3105551212",
			"title": null,
			"contact_type": "TechnicalContact",
			"id": 5
		}
	]
}

A sample JSON response is shown below.

HTTP/1.1 200 OK

Cache-Control: private

Content-Type: application/json; charset=utf-8

Date: Thu, 15 Apr 2021 12:00:00 GMT

Content-Length: 821

{
	"id": 124,
	"country": "US",
	"state": "California",
	"zip_code": "90094",
	"city": "Los Angeles",
	"company_name": "Widgets LLC",
	"company_address": "13031 W Jefferson Blvd",
	"company_address2": "500",
	"organizational_unit": null,
	"contact_first_name": null,
	"contact_last_name": null,
	"contact_email": null,
	"contact_phone": null,
	"contact_title": null,
	"additional_contacts": [{
			"first_name": "Richard",
			"last_name": "Smith",
			"email": "richard.smith@widgets.com",
			"phone": "3105551212",
			"title": null,
			"contact_type": "OrganizationContact",
			"id": 4
		}, {
			"first_name": "Richard",
			"last_name": "Smith",
			"email": "richard.smith@widgets.com",
			"phone": "3105551212",
			"title": null,
			"contact_type": "TechnicalContact",
			"id": 5
		}
	]
}