VC API

Overview

The VC API provides a collection of HTTP request methods that involves Verifiable Credentials (VCs). This API allows a credential issuer to register a new VC with the vc_register operation or revoke an exisiting VC the vc_revoke operation. When a credential holder presents a VC to a credential verifier, the verifier could then obtain the VC's verification key with a GET request.

In the same way as the DID API, HTTP requests to a IDIN server must be in the JSON format with two attributes "message" and "signature". One distinction to the DID API is the GET method for a VC's verification key that requires no request body.

{
"message": "eyJjdXJyZW50X2tleSI6ICItLS0tLUJFR0lOIFBVQkxJQyBLRVktLS0tLVxuTUZrd0V3WUhLb1pJemowQ0FRWUlLb1pJemowREFRY0RRZ0FFdDBha0ZjUXE2eklacXpXV3FHY01mMUxIRXNtTVxuanlyb2Vla0lVbVZkRnkzMTVsZHhjbjJmUHpQcXlqSlZvbEpSdm9SYVZvWlpaalpDQnp5NHlBU3hxdz09XG4tLS0tLUVORCBQVUJMSUMgS0VZLS0tLS0iLCAibmV4dF9rZXlfaGFzaCI6ICI1MThiN2U5ZTRmY2EzNjVkZmY3YjZmNmQ0NTA5YmJlMjk5MDAzN2E4OGQ3NjMzZWYwZmFhYWRlYmEzNTEyM2VkIiwgIm9wZXJhdGlvbiI6ICJ2Y19yZWdpc3RlciIsICJkaWRfYWRkcmVzcyI6ICJkaWQ6aWRpbjphZmI3YmE4OGM3NmVkYmRhNTVjMzQ0YjcwYWUwY2YwNTU2ZDc3MGVjMjU2ODIwZDcxODUwMDBkZTM5NTM5MWI1IiwgIm5vbmNlIjogNX0=",
"signature": "MEUCIFSbmMEUcyjSYwq4QOXWZewn+xS/Jih04DRGKwNKlkQnAiEAuH3Es1opQ3LTTYbwyTJylskbaZOl7vSAF9RFp2Qn3TI="
}

Types of Requests

The table below summarizes all VC-related HTTP requests to the IDIN server.

Request Method

Description

HTTP Method

vc_register

Register a new VC.

POST

vc_revoke

Revoke a VC.

DELETE

Get a verification key of a VC.

GET