Getting Started

Postman Collection

Copy page

A Postman collection is available to help you quickly test and explore the Partners Portal API endpoints.

Download the Collection

You can download the Postman collection and import it directly into Postman:

Download Postman Collection

What's Included

The collection includes:

• Authentication - Login endpoint with automatic token extraction
• Simulations - Complete CRUD operations for loan simulations
• Processes - Mortgage process management endpoints
• Borrowers - Borrower information management
• Documents - Document upload and management
• Properties - Property information endpoints
• ESIS - ESIS document generation
• Messages - Message/note management
• Partners - Partner callback configuration
• Taxonomies - All taxonomy reference data endpoints

Environment Variables

The collection uses the following variables that you need to configure:

Variable	Description	Example
baseUrl	API base URL	https://your-domain.com/API/partnersPortal
xClientId	Master client ID	your_master_id
xClientSecret	Master client secret	your_master_secret
correlationId	Broker ID	12345
sessionToken	Bearer token (auto-populated)	Auto-set after login

How to Use

1. Import the Collection

1. Download the collection file using the link above
2. Open Postman
3. Click Import button
4. Select the downloaded JSON file
5. The collection will appear in your Collections sidebar

2. Configure Environment

1. Create a new environment in Postman
2. Add the variables listed above
3. Set the baseUrl, xClientId, xClientSecret, and correlationId values
4. Leave sessionToken empty (it will be auto-populated after authentication)

3. Authenticate

1. Open the Authentication → Authenticate request
2. Ensure your environment is selected
3. Click Send
4. The sessionToken will be automatically extracted and saved to your environment

4. Make Requests

All subsequent requests will automatically use the sessionToken from your environment via the collection-level authorization.

Features

Automatic Token Management

The collection includes a test script on the authentication endpoint that automatically extracts and saves the session token:

Code
 
pm.test("Save token", function () {
    var jsonData = pm.response.json();
    pm.environment.set("sessionToken", jsonData.sessionToken);
});

Pre-configured Headers

All requests are pre-configured with the required authentication headers:

• xClientID
• xClientSecret
• brokerID (correlationId)
• userID
• Authorization: Bearer {sessionToken}

Organized Structure

Requests are organized by resource type with logical grouping:

• Base operations (CRUD)
• Sub-resources (borrowers, documents, properties)
• Specialized operations (ESIS, messages)

Tips

• Token Expiry: Tokens expire after 30 minutes of inactivity. If you get a 401 error, re-run the authentication request
• Environment Selection: Always ensure you have the correct environment selected before making requests
• Request Order: Start with authentication, then proceed to other endpoints
• Collection Variables: Use {{variableName}} syntax to reference environment variables in requests

Support

For issues or questions about the API:

• Review the API Commons for common patterns
• Check the Authentication Guide for auth-related issues
• Refer to the API Reference for endpoint details

Next Steps

• Authentication Guide - Understand the authentication flow
• API Commons - Learn about headers, errors, and patterns
• API Reference - Explore all available endpoints