Use the Certificate Center API to retrieve Special Condition categories for certificates, Custom Field configurations for certificates, and Custom Field configurations for customers.

Base URL:

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

Supporting operation endpoint	Supporting operation description
`/certificates/special-condition-categories`	GET - Retrieve Special Condition categories required for creating certificates with class Special Conditions.
`/certificates/custom-fields`	GET - Retrieve Custom Field configuration for certificates.
`/customers/custom-fields`	GET - Retrieve Custom Field configuration for customers.

Retrieve Special Condition categories for certificates

All request parameters are optional. Passing a request with no parameters returns all available records.
If the class is Special Condition, you need to supply a value for certificates.

Request

The request parameter is optional.

Retrieve Special Condition categories for certificates request parameter name	Retrieve Special Condition categories for certificates request parameter format	Retrieve Special Condition categories for certificates request parameter description
`asOfDate`	date	The date to filter results having an effectivity range (GMT). If not specified, the default value is the current date.

Example request

curl --request GET \
     --url https://vertex-enterprise-group.readme.io/certificate-center/v1/certificates/special-condition-categories \
     --header 'accept: application/json'

Response

A response includes any number of Special Condition categories. Each record includes the fields.

Retrieve Special Condition categories for certificates response field	Retrieve Special Condition categories for certificates response description
`id`	ID of the special condition category for certificates.
`name`	Name of the special condition category for certificates.

Example response

[
  {
    "id": 0,
    "name": "string"
  }
]

Retrieve Custom Field configurations for certificates

Retrieve Custom Field configurations for certificates. Use the results to create or update certificates with custom fields.

Managing the custom fields for certificates can be completed only by the tenant owner in Certificate Center settings.

Request

There are no request parameters.

Example request

curl --request GET \
     --url https://vertex-enterprise-group.readme.io/certificate-center/v1/certificates/custom-fields \
     --header 'accept: application/json'

Response

A response includes any number of Custom Field configurations. Each record includes these fields.

Retrieve Custom Field configurations for certificates response field	Retrieve Custom Field configurations for certificates response description
`id`	ID of the custom field configuration for certificates.
`label`	Label of the custom field configuration for certificates.

Example response

[
  {
    "id": 0,
    "label": "string"
  }
]

Retrieve Custom Field configurations for customers

Retrieve Custom Field configurations for customers. You can use the results to create customers with custom fields.

Managing the custom fields for customers can be completed oby the tenant owner in Certificate Center settings.

Request

There are no request parameters.

Example request

curl --request GET \
     --url https://vertex-enterprise-group.readme.io/certificate-center/v1/customers/custom-fields \
     --header 'accept: application/json'

Response

A response includes any number of Custom Field configurations. Each record includes these fields.

Retrieve Custom Field configurations for customers response field	Retrieve Custom Field configurations for customers response description
`id`	ID of the custom field configuration for customers.
`label`	Label of the custom field configuration for customers.

Example response

[
  {
    "id": 0,
    "label": "string"
  }
]