NotaryLive API - Getting Started

Return to NotaryLive
Return to NotaryLive

Documentation

Endpoints

Getting Started

Welcome to the NotaryLive API documentation! This documentation is intended for integrated partners who wish to integrate NotaryLive into their own services. Below you will find a list of API endpoints and their respective documentation.

During local development, you can use the following credentials to test the API:

  • API user ID: api_test_user
  • API key: api_test_key

During local development you will be using the sandbox environment. Please take the time to read the Sandbox Environment section below. Once you are ready to move to production, take a look at the Moving to Production section below.

Please note: All API calls must be made over HTTPS. All API calls must be authenticated using HTTP Basic Authentication. All API calls must be made with the Content-Type header set to application/json unless otherwise specified.

Endpoints

The following is a list of API endpoints and their respective documentation:

Endpoint Method Description
/api/v2/order/create POST Creates a new order session
/api/v2/order/ids POST Please reach out to us at support@notarylive.com for more information
/api/v2/order/status POST Check the status of an order
/api/v2/id/upload POST Preuploads an ID to the system for use when creating an order

Sandbox Environment

The NotaryLive API sandbox credentials expose limited functionality to the NotaryLive API and are intended for testing purposes. In the sandbox environment, payment processing and the notarial session itself are disabled. Please note: The API examples shown in this documentation are all working examples. You can copy any of the curl calls throughout the documentation into your terminal to get started right away with sandbox testing!

Troubleshooting Issues

If your integration is not behaving as it should, the following checklist is useful to narrow down the source of the problem:

  1. Do the example curl calls work on your local machine?
  2. Do the example curl calls work in your production environment?
  3. Does your integration code work on your local machine?
  4. Does your integration code work in your production environment?

If the example curl calls throughout the documentation work on your local machine but do not work in your production environment, please reach out to us at support@notarylive.com to ensure that your production environment has not been flagged by any automated security measures.

Moving to Production

Please reach out to us at support@notarylive.com to request access to the production environment. Once you have been provided with your production API user ID and API key, you will then replace api_test_user and api_test_key in the examples throughout the documentation with your production credentials.

Copyright © 2024, NotaryLive.com