Complete a course
Workforce module
POST/training-courses/{id}/completetrainingCourses.complete
Grades the caller's quiz answers once every reading and video lesson is finished. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
- Requires the capability knowledge.sop.acknowledge.
- OAuth scopes: knowledge.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 404, 409, 422, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the training course. |
Request body: CompleteTrainingRequest
| Field | Type | Required | Description |
|---|---|---|---|
| answers | object | Yes | Option numbers keyed by question id. |
{
"answers": {
"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f": 1
}
}Response 200: TrainingCompletion
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the training completion. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Person who created the row; null for seed, platform or system writes. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Person who last updated the row; null for seed, platform or system writes. |
| training_course_id | string (uuid) | Yes | Identifier of the course. |
| membership_id | string (uuid) | Yes | Identifier of the learner. |
| score_percent | integer | null | Yes | Quiz score in percent.Constraints: range 0 to any |
| passed | boolean | Yes | Whether the attempt passed. |
| completed_at | string (date-time) | Yes | When the attempt finished. |
| expires_at | string (date-time) | null | Yes | When the pass stops being current. |
| certificate_number | string | null | Yes | Completion certificate number.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| certification_holder_id | string (uuid) | null | Yes | Identifier of the certification record a verifier issued. |
{
"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",
"training_course_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"score_percent": 90,
"passed": true,
"completed_at": "2026-10-08T14:30:00Z",
"expires_at": "2026-10-08T14:30:00Z",
"certificate_number": "TRN-0001",
"certification_holder_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X POST "$XOS_BASE_URL/training-courses/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/complete" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"answers":{"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f":1}}'const { data } = await xos.trainingCourses.complete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"answers": {
"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f": 1
}
});response = xos.training_courses.complete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"answers": {"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f": 1}})xos training-courses complete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"answers":{"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f":1}}'