Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.yoid.me/llms.txt

Use this file to discover all available pages before exploring further.

Overview

Credentials can be revoked when they are no longer valid — a fraudulent completion, an expired certification, or incorrect data that needs re-issuance. When a credential is revoked, any future verification attempt against it will show isValid: false.

When to Revoke

ScenarioExample
Fraudulent issuanceA youth didn’t actually complete the programme
Credential expiryAnnual certifications that need renewal
Data correctionCredential issued with incorrect attributes — revoke and re-issue
Programme withdrawalYouth withdraws after a credential was issued

Endpoint

POST https://test.didxtech.com/me-creds/api/credentials/revoke

Request

Revocation is a batch operation — you pass an array of credential IDs to revoke in a single call.
curl -X POST "https://test.didxtech.com/me-creds/api/credentials/revoke" \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": ["cred_abc123def456"]
  }'

Request Body

FieldTypeDescription
idsstring[]Array of credential IDs to revoke
Revocation is permanent. To re-credential a youth after revoking, issue a new credential through the standard issuance workflow.

Impact on Verification

When a verifier checks a revoked credential, the isValid field will be false. The verifier’s application should check isValid before trusting any presented data.