Saltar al contenido

Get a certification holder

Módulo Credentials

GET/certification-holders/{id}certificationHolders.get

A person's certification with evidence and expiry. It cannot be self-verified and verifies publicly only with consent. Returns one certification holder with its `ETag`. A certification holder the caller may not see returns 404.

  • Requiere la capacidad people.certification.read.
  • Alcances de OAuth: people.
  • Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

certificationHolders.get: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the certification holder.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Respuesta 200: CertificationHolder

certificationHolders.get: CertificationHolder
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the certification holder.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
certification_idstring (uuid)SíIdentifier of the certification.
person_idstring (uuid)SíIdentifier of the holder.
expires_onstring (date) | nullSíExpiry date.
verified_bystring (uuid) | nullSíIdentifier of the verifier.
issued_onstring (date)SíWhen the certification was issued.
public_verification_consentedbooleanSíWhether 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
}

Ejemplos de código

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