Select a Page

Quick Start

This quick start guide will walk you through the process of signing up for your Zuva account, creating a token and making your first request.

Create your Zuva Account

To use Zuva API, you will have to create a Zuva account - either by signing up for free, or by joining an existing Zuva organization.

Option 1: Create a new Zuva organization

If you would like to create a new Zuva organization, start by creating a new user account on our website using the “Sign Up For Free” link. You will automatically be the Owner of the organization you create.

Option 2: Join an existing Zuva organization

If you would like to join an existing Zuva organization, ask the Owner to send you an invitation to your email address. Once you receive the invitation, click the link and follow the instructions to set up your account.

Create a token

  1. Sign into Zuva

  2. Click on your organization name to reach the Zuva Dashboard.

    • If you are an Owner of your Zuva organization, you can invite new members by adding their email addresses under the User Management section. This is also where you can define their roles and access to Zuva API and other Zuva products.

  3. Click the Zuva API link (on the left menu) to navigate to the Zuva API console.

    • This is where you can access Zuva API regions, usage reports and the Field Library.

  4. Click the link for the region you’d like to use (e.g. “United States”).

    • From here, you can see the base URL for the region as well as any existing tokens.

  5. Click the “Create Token” button to add a new token.

  6. Fill in the token’s name and, optionally, a description.

  7. Click the “Create” button.

  8. Copy your token and store it securely

    • Note: once you leave the page, you will not be able to view the token again.

Test your token

A good way to test that everything is working is to make a Get field list request.

Postman

Postman is an excellent tool for testing out API requests. See our Postman tutorial to get started.

Linux/MacOS command line (using cURL)

With your token copied to the clipboard, first paste it to an environment variable:

1

export DOCAI_TOKEN=$(pbpaste)

and then make the request:

1
2
3

curl https://us.app.zuva.ai/api/v2/fields -v \
     -H "Accept: application/json" \
     -H "Authorization: Bearer $DOCAI_TOKEN"

Remember to change the base URL if you are not using the United States region.

The request should return a 200 status code and a large JSON body containing metadata about all available fields.

Windows PowerShell

With your token copied to the clipboard, first paste it to an environment variable:

1

$DOCAI_TOKEN = Get-clipboard

and then make the request:

1
2

Invoke-WebRequest https://us.app.zuva.ai/api/v2/fields `
  -Headers @{"Authorization" = "Bearer $DOCAI_TOKEN"}

Remember to change the base URL if you are not using the United States region.

The request should return a 200 status code and a large JSON body containing metadata about all available fields.

Next steps

Congratulations! You are now ready to start exploring the workflows and tools that will help you build your own solution.

On This Page