Vouch logoVouch documentation
Getting started

First steps

Actively in Development

Please note that the the following site is under construction and some data represented may not be accurate. If you experience any bugs, please let us know on vlayer's discord.

Redirect user to vouch

First step to trigger web proof generation is to redirect user to getvouch.io application.

This can be done with a following snippet:

const requestId = crypto.randomUUID();
const datasourceId = 'datasource-id-here'; // Replace with actual UUID of a selected datasource
const redirectBackUrl = `https://example.com/vouch-user-finished?requestId=${requestId}`; // Replace with URL to your app
const webhookUrl = 'https://api.example.com/vouch-webproof-webhook'; // Replace with URL to your app
 
const params = new URLSearchParams({
  requestId,
  datasourceId,
  redirectBackUrl,
  webhookUrl
});
 
// Redirect to the URL with the constructed query string
window.location.href = `https://getvouch.io/start?${params.toString()}`;

Full endpoint specification can be found here.

Available data sources

List of available data sources can be found here.

Await user redirection

From now on, we are going to guide your user through the process of creating a web proof for a specified data source. You have no other things to do besides simply waiting for the user to come back to your application after successful proof generation.

We will redirect back user to the URL specified in the redirectBackUrl parameter passed to Vouch app.

Await vouch webhook

As the last step of of this integration flow, you need to wait for a notification with WebProof at the specified webhookUrl, which was passed to Vouch app during the Redirect user to vouch step.

The webhook handler be able to process POST requests. Requests will have Content-Type of application/json, with the request body of WebProof structure.

On this page