Revoke a credential
Credentials module
POST/credentials/{id}/revokecredentials.revoke
Revokes the credential; scans after revocation are refused. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
- Requires the capability credentials.credential.revoke.
- OAuth scopes: credentials.
- 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 credential. |
Response 200: Credential
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the credential. |
| 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. |
| project_id | string (uuid) | Yes | Identifier of the project. |
| credential_category_id | string (uuid) | Yes | Identifier of the credential category. |
| engagement_id | string (uuid) | null | Yes | Identifier of the engagement. |
| issued_by | string (uuid) | null | Yes | Identifier of the issuer. |
| valid_from | string (date-time) | Yes | Start of validity. |
| valid_to | string (date-time) | null | Yes | End of validity. |
| holder_person_id | string (uuid) | Yes | Identifier of the holder. |
| credential_number | string | Yes | Number printed on the badge, issued by the database.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| revoked_at | string (date-time) | null | Yes | When the credential was revoked. |
| revoked_by | string (uuid) | null | Yes | Identifier of the person who revoked it. |
{
"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",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"credential_category_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"issued_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"valid_from": "2026-10-08T14:30:00Z",
"valid_to": "2026-10-08T14:30:00Z",
"holder_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"credential_number": "CR-000123",
"revoked_at": "2026-10-08T14:30:00Z",
"revoked_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X POST "$XOS_BASE_URL/credentials/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/revoke" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"const { data } = await xos.credentials.revoke("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.credentials.revoke("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos credentials revoke 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f