Postman Collection

Snapdocs offers a public Postman collection demonstrating the basic client use cases of the eClose API. Download and install the Postman desktop application, then download the collection and its accompanying environment here.

The collection works in conjunction with the Postman "Public Collection" environment to run simple end-to-end (ETE) closing workflows. It saves request responses into environment variables and uses them in subsequent requests: upon creating a closing, the new closing UUID is saved and used to upload documents to that closing in the next request. New to Postman? Start with importing and exporting data.

Collections by integration type

There are multiple collections because clients usually focus on one experience:

  • Lender or LOS systems
  • Borrower or POS systems
  • Settlement Agents or TPS systems

Closings are created by the LOS, so you always need the LOS collection to create closings. Download all the collections and import them into Postman with Import → Folder.

Inside each collection, requests are grouped by functionality, and every collection starts with a "Get Access Token" request — you need the token before any other request. The LOS collection carries requests to get a token, create a closing, and operate on the closing.

LOS Postman Collection

The POS collection is much smaller, since POS integrations mostly consume broadcast events through webhooks.

POS Postman Collection

Set up the environment

  1. Import both JSON files (collection and environment) into your Postman workspace.
  2. Navigate to Environment > Public Collection and update the variables. Defaults are provided for a basic demo; customer support may recommend changes. The important ones:
    • AuthBaseUrl — URL for acquiring an authentication token
    • BaseUrl — URL to access the eClose API
    • ClientId — the preconfigured client ID for authentication
    • ClientSecret — the preconfigured client secret for authentication
    • audience — the API you intend to call with the generated token
    • company_id — Snapdocs's assigned company ID for your organization
  3. Select the Public Collection environment.

How the collections use variables

The collections lean on Postman collection variables to store and reuse values between requests. Select a collection's Variables tab to see them: some are set once and used across requests (like BaseUrl), others are set by JavaScript after a response arrives. Edit the "Current Value" to change one.

The "Get Token" request reads the configuration variables (AuthBaseUrl, ClientId, ClientSecret, audience); its Tests tab holds the script that saves access_token into the ApiToken variable used by every following request's authorization header. Requests can also run scripts before sending — "Step 1 Create Closing Record" generates testing values in its Pre-request Script tab and uses them in the request body.

Postman Collection Variables

Run workflows

With the environment selected, either run the entire collection, or run individual workflows:

  • Select Auth > Regular Use and click Run to obtain an authenticated client.
  • Select any workflow folder and click Run — for example, Closings > ETE Happy Path Wet Closing walks from creating a wet closing through completing it.

To receive events while you test, stand up the local webhook sink from Test your integration, then continue to Set Up Testing.