DgVerseDgVerse
Home
Get Started
  • Auth Endpoint
  • Create Collection
  • Create Certificate
  • Create Directory
  • Transfer Certificate Via Wallet
  • Transfer Certificate Via Mail
  • Cancel Claim
  • Freeze User
  • Un-freeze User
  • Pause Collection
  • Un-Pause Collection
  • Delete Collection
  • Invalidate Certificates
  • Delete Certificates
  • Get Collection
  • Get Certificates
  • Get Directory of a Collection
Home
Get Started
  • Auth Endpoint
  • Create Collection
  • Create Certificate
  • Create Directory
  • Transfer Certificate Via Wallet
  • Transfer Certificate Via Mail
  • Cancel Claim
  • Freeze User
  • Un-freeze User
  • Pause Collection
  • Un-Pause Collection
  • Delete Collection
  • Invalidate Certificates
  • Delete Certificates
  • Get Collection
  • Get Certificates
  • Get Directory of a Collection
  • Invalidate certificate

Invalidate certificate

Path: v1/hts/api/integration/invalidate-certificate

How to use

The invalidate-certificate API endpoint can be used to invalidate a specific certificate or multiple certificates that belong to another user within a particular collection. screenshot

Parameter List

FieldTypeRequiredUsage
collectionIdStringYesThe unique ID of the collection.
targetEmailAddressStringYesThe email address of the recipient.
certificateIdsArrayYesList of certificate IDs associated with the collection.
- Format: ["certificateID1", "certificateID2", ...]

cURL command

curl --request POST \
  --url http://<dgverse-api-base-url>/v1/hts/api/integration/invalidate-certificate \
  --header 'Authorization: Bearer <YOUR_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{"collectionId": "<value>","targetEmailAddress": "<value>","certificateIds": ["<value1>", "<value2>"]}'

Response

When the precess is successful a '200 OK' messege is displayed. screenshot

Error Troubleshooting

  • 400 Bad Request: User not found.
  • 400 Bad Request: Sender and receiver cannot be same.
  • 400 Bad Request: No such collection found; please create collection to start.
  • 400 Bad Request: Collection does not have invalidate capability enabled.
  • 404 Not Found: Any one/all certificates given in the list does not belong to the user mentioned in the request.
Last Updated:
Contributors: John
Prev
Delete Collection
Next
Delete Certificate