Using the Certificate Center APIs

Integrate your host system with the Certificate Center API.

About the Certificate Center API

The Vertex® Certificate Center API enables you to perform Certificate Center functions using REST requests and responses. The API includes an operation for each type of Certificate Center function.

Use the Certificate Center API to manage:

  • Customers - Retrieve a list of all existing customers, find a customer by UUID, and create a new customer record.
  • Certificates - Retrieve a list of certificates, find a certificate by UUID, update a certificate record, and create a new certificate.
  • Contacts - Retrieve a list of contacts associated with a customer, create a new customer contact, update a customer contact, and delete a customer contact.
  • Sellers - Retrieve a list of sellers.
  • Jurisdiction - Retrieve a jurisdiction hierarchy.
  • Taxpayer - Retrieve a list of taxpayers.
  • Taxability Driver - Retrieve a list of taxability drivers.
  • Supporting operations - Retrieve Special Condition categories required for creating certificates, retrieve Custom Field configurations for certificates, and retrieve Custom Field configurations for customers.

URL to access Certificate Center API endpoints

The base URL for Certificate Center is:

https://ccservices.vertexsmb.com/<version>/<endpoint>

The server URL pattern for accessing the Certificate Center API endpoints are in this format:

<server>/certificate-center/<version>/<endpoint>

where:

  • <server> identifies your network address.
  • certificate-center designates the Vertex Certificate Center RESTful API.
  • <version> is the version of the API.
  • <endpoint> is the target of the interaction.

For example:

https://ccservices.vertexsmb.com/certificate-center/v1/customer