API Reference
Certificates
Course completion certificates with verification and PDF generation
List User Certificates
Authorization
HTTPBearer AuthorizationBearer <token>
In: header
Response Body
application/json
curl -X GET "https://loading/api/v1/certificates"[
{
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"course_id": "5e757794-c815-4ccc-bf16-1010d8ef2347",
"recipient_name": "string",
"course_title": "string",
"course_difficulty": "beginner",
"completion_date": "2019-08-24T14:15:22Z",
"total_time_spent_minutes": 0,
"total_lessons_completed": 0,
"final_score": 100,
"certificate_template": "default",
"instructor_name": "string",
"instructor_signature_url": "string",
"is_public": true,
"metadata": {},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"verification_code": "string",
"issue_date": "2019-08-24T14:15:22Z",
"certificate_number": "string",
"certificate_pdf_url": "string",
"verification_url": "string",
"qr_code_url": "string",
"is_revoked": false,
"revocation_reason": "string",
"revoked_at": "2019-08-24T14:15:22Z",
"revoked_by": "609d09bf-be33-45e0-963a-ff4cf608e85c",
"shared_count": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]Get Certificate
Authorization
HTTPBearer AuthorizationBearer <token>
In: header
Path Parameters
certificate_id*string
Format
uuidResponse Body
application/json
application/json
curl -X GET "https://loading/api/v1/certificates/497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"course_id": "5e757794-c815-4ccc-bf16-1010d8ef2347",
"recipient_name": "string",
"course_title": "string",
"course_difficulty": "beginner",
"completion_date": "2019-08-24T14:15:22Z",
"total_time_spent_minutes": 0,
"total_lessons_completed": 0,
"final_score": 100,
"certificate_template": "default",
"instructor_name": "string",
"instructor_signature_url": "string",
"is_public": true,
"metadata": {},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"verification_code": "string",
"issue_date": "2019-08-24T14:15:22Z",
"certificate_number": "string",
"certificate_pdf_url": "string",
"verification_url": "string",
"qr_code_url": "string",
"is_revoked": false,
"revocation_reason": "string",
"revoked_at": "2019-08-24T14:15:22Z",
"revoked_by": "609d09bf-be33-45e0-963a-ff4cf608e85c",
"shared_count": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}Verify Certificate
Authorization
HTTPBearer AuthorizationBearer <token>
In: header
Path Parameters
verification_code*string
Response Body
application/json
application/json
curl -X GET "https://loading/api/v1/certificates/verify/string"{
"is_valid": true,
"certificate_id": "620df92a-0599-41ff-b912-58ec0e5bd21f",
"recipient_name": "string",
"course_title": "string",
"issue_date": "2019-08-24T14:15:22Z",
"completion_date": "2019-08-24T14:15:22Z",
"is_revoked": true,
"revocation_reason": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}Generate Certificate Pdf
Authorization
HTTPBearer AuthorizationBearer <token>
In: header
Path Parameters
certificate_id*string
Format
uuidResponse Body
application/json
application/json
curl -X POST "https://loading/api/v1/certificates/497f6eca-6276-4993-bfeb-53cbbbba6f08/pdf"null{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}