Update a certification holder
Credentials module
PATCH/certification-holders/{id}certificationHolders.update
A person's certification with evidence and expiry. It cannot be self-verified and verifies publicly only with consent. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.
- Requires the capability people.certification.write.
- OAuth scopes: people.
- Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
- Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the certification holder. |
Request body: CertificationHolderUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| expires_on | string (date) | null | No | Expiry date. |
| issued_on | string (date) | No | When the certification was issued. |
| public_verification_consented | boolean | No | Whether the holder allows public verification by code. |
{
"expires_on": "2026-10-08",
"issued_on": "2026-10-08",
"public_verification_consented": false
}Response 200: CertificationHolder
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the certification holder. |
| 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 | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| certification_id | string (uuid) | Yes | Identifier of the certification. |
| person_id | string (uuid) | Yes | Identifier of the holder. |
| expires_on | string (date) | null | Yes | Expiry date. |
| verified_by | string (uuid) | null | Yes | Identifier of the verifier. |
| issued_on | string (date) | Yes | When the certification was issued. |
| public_verification_consented | boolean | Yes | 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
}Code samples
curl -X PATCH "$XOS_BASE_URL/certification-holders/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H 'If-Match: W/"etag-from-your-last-read"' \
-H "Content-Type: application/json" \
-d '{"expires_on":"2026-10-08","issued_on":"2026-10-08","public_verification_consented":false}'const { data, etag } = await xos.certificationHolders.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"expires_on": "2026-10-08",
"issued_on": "2026-10-08",
"public_verification_consented": false
}, { ifMatch: etag });response = xos.certification_holders.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"expires_on": "2026-10-08", "issued_on": "2026-10-08", "public_verification_consented": False}, if_match=etag)xos certification-holders update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"expires_on":"2026-10-08","issued_on":"2026-10-08","public_verification_consented":false}' --if-match auto