Skip to content

Create a certification holder

Credentials module

POST/certification-holderscertificationHolders.create

A person's certification with evidence and expiry. It cannot be self-verified and verifies publicly only with consent. Creates a certification holder. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requires the capability people.certification.write.
  • OAuth scopes: people.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: CertificationHolderCreate

certificationHolders.create: CertificationHolderCreate
FieldTypeRequiredDescription
certification_idstring (uuid)YesIdentifier of the certification.
person_idstring (uuid)YesIdentifier of the holder.
expires_onstring (date) | nullNoExpiry date.
issued_onstring (date)YesWhen the certification was issued.
{
  "certification_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "expires_on": "2026-10-08",
  "issued_on": "2026-10-08"
}

Response 201: CertificationHolder

certificationHolders.create: CertificationHolder
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the certification holder.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
certification_idstring (uuid)YesIdentifier of the certification.
person_idstring (uuid)YesIdentifier of the holder.
expires_onstring (date) | nullYesExpiry date.
verified_bystring (uuid) | nullYesIdentifier of the verifier.
issued_onstring (date)YesWhen the certification was issued.
public_verification_consentedbooleanYesWhether the holder allows public verification by code.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "certification_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "expires_on": "2026-10-08",
  "verified_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "issued_on": "2026-10-08",
  "public_verification_consented": false
}

Code samples

curl -X POST "$XOS_BASE_URL/certification-holders" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"certification_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","expires_on":"2026-10-08","issued_on":"2026-10-08"}'
const { data } = await xos.certificationHolders.create({
    "certification_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "expires_on": "2026-10-08",
    "issued_on": "2026-10-08"
  });
response = xos.certification_holders.create({"certification_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "expires_on": "2026-10-08", "issued_on": "2026-10-08"})
xos certification-holders create --data '{"certification_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","expires_on":"2026-10-08","issued_on":"2026-10-08"}'