Vouch logoVouch documentation
Resources/OpenAPI

Vouch WebApp

API for initiating a Vouch session

Start a Vouch session

Initiates a Vouch session with the specified parameters.

GET
/start

Query Parameters

requestIdRequiredstring

Unique identifier for the request. Used to uniquely identify the current request or session, ensuring that it can be traced back or referenced as needed. Webhook will use this requestId to enable customer server to correlate vouch requests.

Format: "uuid"
datasourceIdRequiredstring

This identifier references the specific data source that is desired.

Format: "uuid"
customerIdRequiredstring

This identifier references the specific customer app that requests tha proof.

Format: "uuid"
inputsRequiredstring

Proof request params/inputs.

Format: "byte"
redirectBackUrlRequiredstring

A URL that specifies where the user should be redirected after completing a Web Proof generation.

Format: "uri"
webhookUrlRequiredstring

A URL that points to the webhook endpoint in your application. This URL will be used to send you the Web Proof generated by the user.

Format: "uri"
curl -X GET "https://getvouch.io/start?requestId=497f6eca-6276-4993-bfeb-53cbbbba6f08&datasourceId=497f6eca-6276-4993-bfeb-53cbbbba6f08&customerId=497f6eca-6276-4993-bfeb-53cbbbba6f08&inputs=eyJ0d2l0dGVyX3VzZXJuYW1lIjoiemttYXJlayJ9&redirectBackUrl=http%3A%2F%2Fexample.com&webhookUrl=http%3A%2F%2Fexample.com"

Redirect to the specified URL.