Skip to main content

Validate a Verifiable Credential

Validates the verifiable credential. This means that the signature, the format, the validity (expiration and revocation status) and the issuer are valid.

Request Body — REQUIRED

W3C Verifiable Credential

@context string[] — REQUIRED

The @context property ensures that two systems operating on the same DID document are using mutually agreed terminology. It can be one or more URIs.

id string — REQUIRED

Credential identifier.

type string[] — REQUIRED

This array contains the type and subtypes of credential.

issuanceDate date-time — REQUIRED

Date and time at which the information associated with the verifiable credential/presentation becomes valid.

issuer string — REQUIRED

Issuer of the verifiable credential.

credentialSubject object — REQUIRED

A thing about which claims are made

id string

Object MAY contain an id

proof object — REQUIRED

Cryptographic proofs that can be used to detect tampering and verify the authorship of a credential or presentation. An embedded proof is a mechanism where the proof is included in the data, such as a Linked Data Signature.

type string — REQUIRED

Type of the object or the datatype of the typed value.

created date-time — REQUIRED

Date and time at which proof has been created.

proofPurpose string — REQUIRED

It expresses the purpose of the proof and ensures the information is protected by the signature.

verificationMethod string — REQUIRED

Specifies the public key that can be used to verify the digital signature. Dereferencing a public key URL reveals information about the controller of the key, which can be checked against the issuer of the credential.

jws string — REQUIRED

JSON Web Signature

Responses
204

No Response (Valid credential)

400

Bad Request

Schema
type uri

An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type.

title string

A short summary of the problem type.

status int32

Possible values: 400 ≤ value < 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

401

Unauthorized

Schema
type uri

An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type.

title string

A short summary of the problem type.

status int32

Possible values: 400 ≤ value < 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

403

Forbidden

Schema
type uri

An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type.

title string

A short summary of the problem type.

status int32

Possible values: 400 ≤ value < 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

500

Internal Server Error

Schema
type uri

An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type.

title string

A short summary of the problem type.

status int32

Possible values: 400 ≤ value < 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.