Getting Started

On this page:


Follow just four steps to connect to our certification environment and begin testing our Partner eBoarding API in your platform or application.

1. Review documentation

Our Elavon Representatives will guide you through the setup process. The eBoarding API documentation is an overview of the API and its implementation.

API Reference

The API Reference lists and demonstrates valid endpoints, example requests, and responses. Operations that apply only to Europe (EU) or to North America (NA) are clearly labeled.

eBoarding Overview

Find supporting information on the:

Review our continuous improvements in our ​Release Notes.

2. Get a test account

Connect with your Elavon Representative or your assigned Solutions Engineer and set up a Partner account and credentials. You can then access our demo environment to view API data models and perform high-level structural data validation.

If you have not been assigned your Elavon Representative, then please email us at

3. Certification 

Begin testing and resolving errors in the certification environment. The process has two parts:

  1. Submit your application without errors. Your Elavon Solutions Engineer will help you. 
  2. Certification testing. Work with Elavon Certification Analysts to pass a small set of certification tests based on your specific business needs.

The testing and certification environment is at

4. Go live

After your application has passed the certification tests, you will receive your production credentials and move on to the production environment.

Back to Top

Using Postman

You can explore and download the eBoarding API YAML file from the API Reference.

When downloading the file, Elavon recommends using Postman to help get you testing fast. Postman is a versatile, free to try, and easy to install application with subscription levels to suit your enterprise scale.

To test the eBoarding API using Postman:

  1. Download and install the Postman application onto your Mac, Linux, or Windows desktop from the website.
  2. Sign in to Postman.
  3. Using your Internet browser, navigate to the eBoarding API Reference.
  4. Do one of the following:
    • Copy and paste the download URI into Postman:
      1. Right-click on Download, and then choose Copy Link Address.
      2. In the Postman menu, click Import. The Import dialog opens.
      3. Choose to Import from Link, and then paste the copied URI into the box and click Import.
    • Import the file into Postman from a local directory:
      1. Right-click on Download, and then choose Save As.
      2. Save the YAML file to your chosen directory.
      3. In the Postman menu, click Import. The Import dialog opens.
      4. Choose to Import File, and then navigate to your eBoarding API YAML file, or drag your file into dialog box.
  5. In the Import dialog box, confirm that:
    • The import is an API.
    • Postman is to generate a Collection.
  6. A Collection is created and named using the API title value by default. For example, “eBoarding Global Application”.
  7. To name the Postman API version, click on the menu icon (an ellipses), and then choose Rename. Edit the API name and when ready, press Enter or Return.
  8. To view an easy-to-read summary of the file in a webpage, open the Collections tab, click the chevron icon to expand the current collection, and then click View in web.


  • Due to the way Postman renders the eBoarding API reference, example data may not be visible in Postman. When in doubt, refer to the eBoarding API Reference for sample data.
  • The eBoarding YAML file is valid on the day it is downloaded. Check for updates regularly.
  • Find out more from the Postman Learning Center.

Screen grab of the Postman Import by file dialog
The Postman Import dialog's Import File tab.

Screen grab of the Postman Import dialog
The Postman Import dialog's Import From Link tab.

Screen grab of Postman's Import dialog confirmation
The Postman Import dialog's confirmation choices.

Screen grab of a Postman collection tile
Expanding the Postman collection options to reveal the View in Web button.

Back to Top

Swagger Environments

Use your API Partner credentials to access Swagger in our environments:

Swagger is an online portal used to access the most recent Partner eBoarding API requests and responses.

Navigating Swagger

When logged on to Swagger using a desktop computer, you can scroll through sections or use CTRL+F (Cmd+F on Mac) to search for specific items.

The Swagger code view.
Figure 1. The Swagger code view.

Click Model to explore detailed data formats. Use the expand buttons to expand and collapse contents.

Swagger's Model view
Figure 2. Swagger's Model view

Click Example Value to return to the sample code view (Figure 1.).

Back to Top


❮ Back to Overview   Next:  Get Unsigned Documents ❯