Get Organization by ID

Retrieves information that describes an organization through which you may validate your OV and EV certificates.

Key information:

• Using multiple organizations for the same corporate entity may delay or block the validation of your certificate. Use this endpoint to verify that you are assigning the correct organization to your certificate request.
• If your organization has registered with the Digicert certificate authority (CA) with various names, then Digicert will contain multiple entries for your organization.

• If you previously purchased an OV or EV certificate directly from Digicert, then it is possible for your organization to only be registered with Digicert.

  Use the Get Organization by Name endpoint to find out the exact name under which your organization was registered.

  Organizations that have only been registered with Digicert have an ID of 0. Look up your organization by its exact name using the following query string syntax:

  ?name=Organization Name

Request

Retrieve organizations by ID through the following request:

HTTP Method	Request URI
GET	Get an organization by ID: https://api.vdms.io/sec/cps/v2.0/organizations/Organization ID Get an organization that is only registered within Digicert: https://api.vdms.io/sec/cps/v2.0/organizations/0?name=Organization Name

Define one of the following variables 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
Organization ID Required	Replace this variable with the system-defined ID of the desired organization.
Organization Name Required	Replace this variable with the exact name of the desired organization as defined within Digicert.

Use the Get Organization by Name endpoint to search for organizations by name.

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

Request body parameters are not required by this endpoint.

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 will contain an error response that provides additional information.

Sample Request and Response

A sample JSON request is shown below.

A sample JSON response is shown below.

{
	"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
		}
	]
}