Skip to main content
Documentation Powered by Redocly

VC Verifier HTTP API (0.0.3-unstable)

Download OpenAPI specification:Download

URL: https://github.com/w3c-ccg/vc-api License: W3C Software and Document License

This is an Experimental Open API Specification for the VC Data Model.

credentialsVerify

Verifies a verifiableCredential and returns a verificationResult in the response body.

Verifies a verifiableCredential and returns a verificationResult in the response body.

Request Body schema: application/json

Parameters for verifying a verifiableCredential.

object (VerifiableCredential)

A JSON-LD Verifiable Credential without a proof.

object (VerifyOptions)

Options for specifying how the LinkedDataProof is verified.

Responses

Request samples

Content type
application/json
{
  • "verifiableCredential": {
    },
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "checks": [
    ],
  • "warnings": [ ],
  • "errors": [ ]
}

presentationsVerify

Verifies a Presentation with or without proofs attached and returns a verificationResult in the response body.

Verifies a verifiablePresentation and returns a verificationResult in the response body. Given the possibility of denial of service, buffer overflow, or other style attacks, an implementation is permitted to rate limit or restrict requests against this API endpoint to those requests that contain only a single credential with a 413 or 429 error code as appropriate.

Request Body schema: application/json

Parameters for verifying a verifiablePresentation.

One of
object (VerifiablePresentation)

A JSON-LD Verifiable Presentation without a proof.

object (VerifyOptions)

Options for specifying how the LinkedDataProof is verified.

Responses

Request samples

Content type
application/json
Example
{
  • "verifiablePresentation": {
    },
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "checks": [
    ],
  • "warnings": [ ],
  • "errors": [ ]
}