Skip to main content

Request a Verifiable Presentation to the user

Requests a W3C Verifiable Presentation to the user. The user will receive a notification to provide a verifiable presentation. When ready, the API will notify you through the provided callback url.

Request Body REQUIRED

Verifiable Presentation Request

target string REQUIRED

user DID. The holder of this did will receive a push notification in his/her VIDwallet. The wallet will create the presentation object and sign it.

type array[] REQUIRED

list of Verifiable Credentials types array

name string

Request identifier

Responses
201

Success

Schema
message string

Response message

data object

Data included in the response

id string

Object identifier

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.