Use the Certificate Center API to retrieve and create customer records.

Base URL:

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

Customers endpoint	Customers description
`/customers`	GET - Retrieve a list of customers based on filter criteria, pagination, and sorting parameters.
`/customer/{uuid}`	GET - Retrieve a customer by the assigned UUID.
`/customer`	POST - Create a customer.

Retrieve customers

Retrieve a list of customer records based on your choice of filter criteria, pagination, and sorting parameters. By default, customers are sorted by their name in ascending order.

Request

All request parameters are optional. Passing a request with no parameters returns all available records.

Retrieve customers request parameter name	Retrieve customers request parameter format	Retrieve customers request parameter description
`top`	int64	Number of returned records to display per page. Default = 20.
`skip`	int64	Number of records to skip before displaying records. Must be 0 or greater. Default = 0.
`filter`	string	Limit the returned records to those including the filter criteria, such as customer name or taxpayer name.
`count`	Boolean	If set to true, returns a count of the total records found. Default = false.
`orderBy`	string	Order the results according to any response field by entering it here. Results are in alphabetical or numerical order depending on the field format.

Example request

curl --request GET \
     --url https://ccservices.vertexsmb.com/certificate-center/v1/customers \
     --header 'accept: application/json'

Response

A response includes any number of customer records. Each customer record can include some or all of these fields.

Retrieve customers response field	Retrieve customers response description
`odata.count`	The number of customer records retrieved.
`value`	An array of objects, one for each customer record retrieved.
`UUID`	Unique identifier.
`code`	Code assigned to the customer.
`name`	Customer name.
`startDate`	Date the customer became active.
`endDate`	Date the customer is no longer active, if any.
`status`	Customer status, one of Approved, In Progress, or Pending.
`approvalDate`	When the customer was approved.
`isParentInd`	Indicates whether this customer is a parent (`true`) or not (`false`).
`customFields`	Each custom field, if any, includes an `id` (int), `label` (string), and `value` (string).
`parent`	The parent of the customer record, if any, includes a `uuid`(uuid), `code` (string), and `name` (string).
`taxpayer`	Taxpayer associated with this customer includes a `uuid`(uuid), `code` (string), and `name` (string).

Example response

{
  "odata.count": 0,
  "value": [
    {
      "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "code": "string",
      "name": "string",
      "startDate": "2025-09-15",
      "endDate": "2025-09-15",
      "status": "Approved",
      "approvalDate": "2025-09-15",
      "isParentInd": true,
      "customFields": [
        {
          "id": 0,
          "label": "string",
          "value": "string"
        }
      ],
      "parent": {
        "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "code": "string",
        "name": "string"
      },
      "taxpayer": {
        "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "code": "string",
        "name": "string"
      }
    }
  ]
}

Retrieve customer by UUID

Retrieve one customer record identified by their UUID.

Request path parameter

The only parameter, UUID, is required as a path parameter.

Retrieve customer by UUID request parameter name	Retrieve customer by UUID request parameter format	Retrieve customer by UUID request parameter description
`UUID`	uuid	Include the unique identifier as a path parameter.

Example request

curl --request GET \
     --url https://ccservices.vertexsmb.com/certificate-center/v1/customer/uuid \
     --header 'accept: application/json'

Response

A response includes one customer record associated with the UUID.

Retrieve customer by UUID response field	Retrieve customer by UUID response description
`UUID`	Unique identifier.
`code`	Code assigned to the customer.
`name`	Customer name.
`startDate`	Date the customer became active.
`endDate`	Date the customer is no longer active, if any.
`status`	Customer status, one of Approved, In Progress, or Pending.
`approvalDate`	When the customer was approved.
`isParentInd`	Indicates whether this customer is a parent (`true`) or not (`false`).
`customFields`	Each custom field, if any, includes an `id` (int), `label` (string), and `value` (string).
`parent`	The parent of the customer record, if any, includes a `uuid`(uuid), `code` (string), and `name` (string).
`taxpayer`	Taxpayer associated with this customer includes a `uuid`(uuid), `code` (string), and `name` (string).

Example response

{
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "string",
  "name": "string",
  "startDate": "2025-09-15",
  "endDate": "2025-09-15",
  "status": "Approved",
  "approvalDate": "2025-09-15",
  "isParentInd": true,
  "customFields": [
    {
      "id": 0,
      "label": "string",
      "value": "string"
    }
  ],
  "parent": {
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "code": "string",
    "name": "string"
  },
  "taxpayer": {
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "code": "string",
    "name": "string"
  }
}

Create a customer

Create a new customer record.

Request

Supply these request parameters to create a new customer record. Required parameters are in bold.

Create a customer request parameter name	Create a customer request parameter format	Create a customer request parameter description
`code`	string	A code to associate with the customer. Code must not be blank and must be less than or equal to 40 characters.
`name`	string	The customer name. Name must not be blank and must be less than or equal to 60 characters.
`taxpayer`	object	The taxpayer to associate with this customer. Identified by `uuid` (uuid).
`customFields`	array of objects	A custom field that includes required `id` (int), `label` (string), and `value` (string).
`parent`	object	The parent to associate with this customer record. Limited by selected taxpayer and customers that are not children of another parent customer. Identified by `uuid` (uuid).

Example request

curl --request POST \
     --url https://ccservices.vertexsmb.com/certificate-center/v1/customer \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

Response

A successful response consists of one link to the created resource.

Create a customer response field	Create a customer response description
`location`	A link to the created resource including the UUID.