The Partners Portal API is a RESTful API designed to facilitate seamless integration between financial networks, intermediary companies (ICs), and their users. This API enables partners to manage simulations, processes, proposals, and access essential taxonomies for mortgage and loan operations.
Overview
The Partners Portal API provides a comprehensive set of endpoints for:
- Authentication - Secure multi-level authentication system
- Partners - Callback and partner configuration management
- Simulations - Create and manage loan simulations
- Processes - Handle mortgage application processes
- Proposals - Manage loan proposals
- Taxonomies - Access reference data and classifications
Key Features
Multi-Level Security
The API implements a three-level identification system to ensure secure and controlled access:
- Network Level - Credentials for the integrator network
- IC Level - Identity of the specific intermediary company
- User Level - Session-based user authentication
RESTful Design
All endpoints follow REST principles with:
- Standard HTTP methods (GET, POST, PUT, PATCH, DELETE)
- JSON request/response format
- Consistent error handling
- Correlation IDs for request tracking
Comprehensive Documentation
This documentation includes:
- Complete API reference with all endpoints
- Authentication flow diagrams
- Common patterns and best practices
- Request/response examples
Getting Started
To begin using the Partners Portal API:
- Obtain Network Credentials - Contact your network administrator to get your
x-client-idandx-client-secret - Review Authentication - Read the Authentication guide to understand the authentication flows
- Understand Common Patterns - Check the API Commons page for headers, error handling, and conventions
- Get Postman Collection - Download the Postman Collection to quickly test endpoints
- Explore the API - Browse the API Reference for detailed endpoint documentation
Base URL
Code
Support
For questions, issues, or integration support, please contact your network administrator or technical support team.
Next Steps
- Authentication Guide - Learn about login, session management, and protected requests
- API Commons - Understand common headers, responses, and patterns
- Postman Collection - Download the collection to test the API
- API Reference - Explore all available endpoints
Last modified on