In order to interface with some of the core functionality, Vouch has exposed specific resources via a REST API. This gives developers a great deal of flexibility when integrating Vouch and opens up the doors to very exciting activations.

The Vouch REST API is only available for customers who are on a Teams plan.

The API is accessed using a base URL in the form:

All requests to the API are authenticated by providing your API key. The API key should be provided as an HTTP header named X-API-TOKEN.

Header

Your API Key can be found in your account on the the Developer page within your Vouch Account. The REST API is only available for customers with a Teams plan.

The v1 API uses standard HTTP methods for indicating the action to take on a resource.

All API requests and response bodies adhere to a common JSON format representing individual items and collections of items.

The API uses HTTP status codes to indicate an error has occurred while processing a request. There are four main error status codes used by the API:

Vouch currently offers a suite of RESTful API endpoints. These APIs have be grouped under the section of the Platform they relate to. To find out more about a specific API call, simply click on the event below.