Sign in

v1

latestSwagger 2.02026-07-132946124.7 KB
v2

Retrieve individual certificate details

Once the certificate order has been created, this method can be used to check the status of the certificate. This method can also be used to retrieve details of the certificate. <ul><li>shopperId is not the same as customerId. shopperId is a number of max length 10 digits (ex: 1234567890) whereas customerId is a UUIDv4 (ex: 295e3bc3-b3b9-4d95-aae5-ede41a994d13)</li></ul>

get/v2/customers/{customerId}/certificates/{certificateId}

Path parameters

customerIdstring required

An identifier for a customer

certificateIdstring required

Certificate id to lookup

Response

Certificate details retrieved

certificateIdstring required

The unique identifier of the certificate request. Only present if no errors returned

commonNamestring domain required

Common name of certificate

periodinteger required

Validity period of order. Specified in years

type'DV_SSL' | 'DV_WILDCARD_SSL' | 'EV_SSL' | 'OV_CODE_SIGNING' | 'OV_DRIVER_SIGNING' | 'OV_SSL' | 'OV_WILDCARD_SSL' | 'UCC_DV_SSL' | 'UCC_EV_SSL' | 'UCC_OV_SSL' required

Certificate type:

  • DV_SSL - (Domain Validated Secure Sockets Layer) SSL certificate validated using domain name only
  • DV_WILDCARD_SSL - SSL certificate containing subdomains which is validated using domain name only
  • EV_SSL - (Extended Validation) SSL certificate validated using organization information, domain name, business legal status, and other factors
  • OV_CODE_SIGNING - Code signing SSL certificate used by software developers to digitally sign apps. Validated using organization information
  • OV_DRIVER_SIGNING - Driver signing SSL certificate request used by software developers to digitally sign secure code for Windows hardware drivers. Validated using organization information
  • OV_SSL - SSL certificate validated using organization information and domain name
  • OV_WILDCARD_SSL - SSL certificate containing subdomains which is validated using organization information and domain name
  • UCC_DV_SSL - (Unified Communication Certificate) Multi domain SSL certificate validated using domain name only
  • UCC_EV_SSL - Multi domain SSL certificate validated using organization information, domain name, business legal status, and other factors
  • UCC_OV_SSL - Multi domain SSL certificate validated using organization information and domain name
status'PENDING_ISSUANCE' | 'ISSUED' | 'REVOKED' | 'CANCELED' | 'DENIED' | 'PENDING_REVOCATION' | 'PENDING_REKEY' | 'UNUSED' | 'EXPIRED' required

Certificate status (if issued or revoked):

  • CANCELED - Certificate request was canceled by customer
  • DENIED - Certificate request was denied by customer\n * EXPIRED - Issued certificate has exceeded the valid end date
  • ISSUED - Certificate has been issued and is within validity period
  • PENDING_ISSUANCE - Certificate request has completed domain verification and is in the process of being issued
  • PENDING_REKEY - Previously issued certificate was rekeyed by customer and is in the process of being reissued
  • PENDING_REVOCATION - Previously issued certificate is in the process of being revoked
  • REVOKED - Issued certificate has been revoked\n * UNUSED - Certificate in an error state
createdAtstring iso-datetime required

The date the certificate was ordered.

completedAtstring iso-datetime

The date the certificate request completed processing.

validEndAtstring iso-datetime

The end date of the certificate's validity (if issued or revoked).

validStartAtstring iso-datetime

The start date of the certificate's validity (if issued or revoked).

revokedAtstring iso-datetime

The revocation date of certificate (if revoked).

renewalAvailableboolean

Only returned when a renewal is available.

serialNumberstring

Serial number of certificate (if issued or revoked)

serialNumberHexstring

Hexadecmial format for Serial number of certificate(if issued or revoked)

slotSize'FIVE' | 'TEN' | 'FIFTEEN' | 'TWENTY' | 'THIRTY' | 'FOURTY' | 'FIFTY' | 'ONE_HUNDRED'

Number of subject alternative names (SAN) to be included in certificate (if UCC):

  • FIVE - Five slot UCC request
  • TEN - Ten slot UCC request
  • FIFTEEN - Fifteen slot UCC request
  • TWENTY - Twenty slot UCC request
  • THIRTY - Thirty slot UCC request
  • FOURTY - Fourty slot UCC request
  • FIFTY - Fifty slot UCC request
  • ONE_HUNDRED - One hundred slot UCC request
subjectAlternativeNamesstring[]

Subject Alternative names. Collection of subjectAlternativeNames to be included in certificate.

csrstring

Certificate signing request (if present) in PEM format

rootType'GODADDY_SHA_1' | 'GODADDY_SHA_2' | 'STARFIELD_SHA_1' | 'STARFIELD_SHA_2'

Root type:

  • GODADDY_SHA_1 - GoDaddy (Secure Hash Algorithm 1) SHA-1 root type
  • GODADDY_SHA_2 - GoDaddy (Secure Hash Algorithm 2) SHA-2 root type
  • STARFIELD_SHA_1 - Starfield SHA-1 root type
  • STARFIELD_SHA_2 - Starfield SHA-2 root type
deniedReasonstring

Only present if certificate order has been denied

progressinteger

Percentage of completion for certificate vetting