Skip to main content

Getting started

With the Stavvy API you can create and update files and orders and retreive documents from the Stavvy application. We provide documentation to help you get started, and our support team is always available to assist you. Let's get started and build something amazing!

What the API enables

The Stavvy API is currently designed to support and expose programmatic access to hybrid workflows and signing eligibility data.

Note that anything created via the API will also be normally accessible from your User and Admin accounts within the Stavvy platform.

Accessing API endpoints

To start using the API, you'll need a special user provisioned in your customer account by the Stavvy team with an explicit API access grant. Get in contact with Stavvy for help provisioning this user.

The URLs in the documentation are relative to the host. The default host is:

**https://api.stavvy.com**

So if you want to access the Authorization endpoint at /v1/oauth/token you would make a POST to:

**https://api.stavvy.com/v1/oauth/token**

Authentication uses the OAuth standard, for more information proceed to the Authorization section.

  • Do not use the live environment for testing purposes, see the next section for our sandbox environment.

Testing on Sandbox environment

We also have a sandbox environment available for testing. This needs a separate API user. Contact Stavvy to get access.

The host for the sandbox environment is:

**https://api.sandbox.stavvy.com**
  • The sandbox environment is for testing. For the sake of consumer privacy and protecting your organization from potential legal liabilities please use test data, and not real customer data.

Account Model ############# The Stavvy platform has several types of accounts, including:

  • API User - Represents a system integrated with Stavvy.
  • User - Represents a person performing actions in the Stavvy platform such as a signer or notary.
  • Admin - Represents a person serving as an administrator.

Security

The Stavvy platform is built upon a foundation of trust and security with our customers. Our top priority is ensuring that our customer’s data is protected at all times and available when they need it. We are SOC 2®-compliant and we implement security best practices, such as principle of least privilege, multi-factor authentication, and continuous network monitoring.

Select the category you're looking for in the sidebar to get started.