Skip to content

Delete a certification holder

Credentials module

DELETE/certification-holders/{id}certificationHolders.delete

A person's certification with evidence and expiry. It cannot be self-verified and verifies publicly only with consent. Soft-deletes the certification holder: it moves to Trash and can be restored for its table's retention period.

  • Requires the capability people.certification.write.
  • OAuth scopes: people.
  • Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

certificationHolders.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the certification holder.

Response 204: no body.

Code samples

curl -X DELETE "$XOS_BASE_URL/certification-holders/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.certificationHolders.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.certification_holders.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos certification-holders delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f