Saltar al contenido principal

GET /credentials/{id}

Consulta el estado de una credencial emitida por tu organizacion.

Request

GET /api/v1/credentials/{credential_id}

Headers

HeaderRequeridoDescripcion
X-API-KeySiTu API key

Path Parameters

ParametroTipoDescripcion
credential_idUUIDID de la credencial

Response

{
"id": "7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d",
"status": "active",
"credential_url": "https://app.unicreda.com/credential/7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d",
"issuance_date": "2026-02-22T15:30:00",
"recipient_email": "estudiante@ejemplo.com",
"achievement_name": "Certificado de Completitud - Curso Python",
"revocation_reason": null,
"ob3_data": {
"@context": ["https://www.w3.org/ns/credentials/v2", "..."],
"type": ["VerifiableCredential", "OpenBadgeCredential"],
"..."
}
}

Campos

CampoDescripcion
idUUID de la credencial
status"active" o "revoked"
credential_urlURL publica para ver la credencial
issuance_dateFecha de emision (ISO 8601)
recipient_emailEmail del recipiente
achievement_nameNombre del template/achievement
revocation_reasonRazon de revocacion (solo si status = revoked)
ob3_dataJSON-LD completo de Open Badges 3.0

Credencial revocada

{
"id": "7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d",
"status": "revoked",
"credential_url": "https://app.unicreda.com/credential/7a8b9c0d-...",
"issuance_date": "2026-02-22T15:30:00",
"recipient_email": "estudiante@ejemplo.com",
"achievement_name": "Certificado de Completitud",
"revocation_reason": "Plagio detectado en el proyecto final"
}

Errores

StatusDetalleCausa
404Credential not foundCredencial no existe o no pertenece a tu organizacion

Ejemplo

curl -X GET "https://app.unicreda.com/api/v1/credentials/7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d" \
-H "X-API-Key: uc_live_tu_key_aqui"
import requests

credential_id = "7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d"
response = requests.get(
f"https://app.unicreda.com/api/v1/credentials/{credential_id}",
headers={"X-API-Key": "uc_live_tu_key_aqui"}
)
credential = response.json()
print(f"Status: {credential['status']}")