Ctrlk
Sign InJoin
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Certificate

A certificate is issued to a client or partner as confirmation that they meet a specific program's requirements. This document is proof that the client or partner has adhered to the vendor's standards and is now eligible to purchase or access their products.

The following rules apply to certificates:

  • A certificate can only be created or re-enrolled for published programs.

  • A client or partner can re-enroll for a certificate if it's in Active or Expired status. Re-enrollment is not permitted for terminated certificates.

  • A certificate can automatically expire on its expiration date, changing its status to Expired.

This object contains the following attributes:

Field
Type
Description

id

string, core

(Read-only) The business identifier of the certificate.

href

string, core

(Read-only) The resource URI of the certificate.

program

object, core

Represents the program to which this certificate applies.

Example:

client

object

Represents the client or partner account object to which the certificate belongs.

applicableTo

string, core

The scope in which the given enrollment is created. Allowed values are buyer or licensee.

buyer

object, core

(Optional) Represents the buyer object, if the enrollment applies to the buyer.

licensee

object, core

(Optional) Represents the licensee object if the enrollment applies to the licensee.

Example:

eligibility

eligibility, core

Configuration of the partner program.

Example:

externalIds

object

Represents the externalIds object, containing the identifier for the external system.

Example:

status

enum, core

(Read-only) The certificate's status. Allowed values are:

  • Pending

  • Updating

  • Active

  • Terminated

  • Expired

statusNotes

string

(Optional) Notes provided by the vendor to terminate a certificate.

expirationDate

dateTime

(Optional) The expiration date of the certificate. When the date has passed, the system expires the certificate.

template

object

(Optional) Represents the template object.

Example:

parameters.fulfillment

object

Represents the orderParameter object, which holds a definition of a parameter, its value, and associated errors.

Example:

parameters.ordering

object

Represents the orderParameter object, which contains a definition of a parameter, its value, and associated errors.

Example:

audit

object

(Read-only) Represents the audit object.

Parameter value

This object contains the following attributes:

Field
Type
Description

id

string

The identifier of the parameter definition this value refers to.

externalId

string

The ID of the parameter in the external system.

type

string

The type of the parameter definition.

name

string

The display name of the parameter.

value

string

The value of the parameter.

Example

PreviousProgram APINextState diagram

Last updated

Was this helpful?