Elliemae Encompass Partner Connect API
69
AI ReadinessAI-Aware (B+)69/100
Official vendor OpenAPI document · agent-readyFinanceBankingbearer17 EndpointsREST
For Agents
Integrate with the Encompass mortgage platform: obtain OAuth tokens, register partner products, process transactions, read origin resources, and record transaction events.
Use for: Register a new partner product on Encompass, Retrieve all registered products for my integration, Get the request resources for a specific transaction, Post a response to an Encompass transaction
Not supported: Does not handle loan underwriting decisions, credit scoring, or consumer-facing applications. Use for Encompass partner product and transaction integration only.
The Encompass Partner Connect API lets technology partners integrate with the Encompass mortgage platform from Ellie Mae and ICE Mortgage Technology. Your agent obtains an OAuth 2.0 bearer token, registers and manages partner products, and works a transaction through its lifecycle by reading its request resources, posting a response, and recording transaction events. It also exposes origin resources so a partner can tie a transaction back to the loan origination that triggered it.
Install Jentic One Beta
Connect the Encompass Partner Connect API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Encompass Partner Connect API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Felliemae.com%2Felliemae" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Felliemae.com%2Felliemae" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Encompass Partner Connect API.
Obtain, introspect, and revoke OAuth 2.0 access tokens
Register a partner product and update its registration
Retrieve registered products individually or as a list
Read a transaction's request resources and post its response
Record and retrieve transaction events for a given transaction
Access the origin resource behind a transaction
Use Cases
Patterns agents use Encompass Partner Connect API for, with concrete tasks.
★ Agent-Driven Transaction Processing
An AI agent connected through Jentic processes an Encompass transaction end to end: it reads the transaction's request resources, assembles a response, posts it, and records a completion event. Because Partner Connect models each step as its own operation, the agent advances the transaction one well-defined call at a time rather than guessing at a monolithic submit.
Read a transaction's request resources, post a response, then record a completion event for that transaction
Partner Product Registration
A partner onboarding onto Encompass registers its product so lenders can select it. The API registers a product, lets the partner update that registration, and lists registered products, so an agent keeps the partner's catalogue of offerings in sync with the platform.
Register a new product, confirm it appears in the product list, and update one field on its registration
Transaction Event Auditing
Operations teams audit how a transaction progressed by reading its event history. Partner Connect records events against a transaction and returns them individually or as a list, letting an agent reconstruct the sequence of actions on a given transaction for compliance review.
Retrieve all events for a transaction and flag any that lack a corresponding response resource
Key Endpoints
17 endpoints — the encompass partner connect api lets technology partners integrate with the encompass mortgage platform from ellie mae and ice mortgage technology.
METHOD
PATH
DESCRIPTION
POST
/oauth/token
Generate an access token
POST
/products
Register a new product
GET
/products
Retrieve all registered products
GET
/transactions
Retrieve all transactions
GET
/transactions/{transactionId}
Retrieve a specific transaction
PATCH
/transactions/{transactionId}/response
Update a transaction response
POST
/transactions/{transactionId}/events
Create a transaction event
GET
/transactions/{transactionId}/events
Retrieve all transaction events
POST
/oauth/token
Generate an access token
POST
/products
Register a new product
GET
/products
Retrieve all registered products
GET
/transactions
Retrieve all transactions
GET
/transactions/{transactionId}
Retrieve a specific transaction
PATCH
/transactions/{transactionId}/response
Update a transaction response
POST
/transactions/{transactionId}/events
Create a transaction event
GET
/transactions/{transactionId}/events
Retrieve all transaction events
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
E
Encompass Partner Connect API
- AI-Aware (B+)69/100
99
Foundational Compliance63
Developer Experience & Jentic Compatibility53
AI-Readiness & Agent Experience94
Agent Usability60
Security75
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.2
Show dimension breakdown
99
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A+Signals: 4
98%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
100%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
51%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
53
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: C-Signals: 4
54%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
57%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
60
Security
Trust, risk posture, and security compliance.
Grade: B-Signals: 1
60%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
75
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A-Signals: 1
75%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring Encompass Partner Connect by hand means running the OAuth 2.0 token exchange, refreshing bearer tokens, and sequencing product and transaction calls yourself. Through Jentic you install once, import the API from the API Directory, store the client credential once, and your agent calls the operations.
Permission scoping
Encompass Partner Connect puts the transaction id in the URL path, so a rule can scope your agent to the operations on a given transaction, such as reading it and recording events. You choose the operations it may call, so product registration or response updates are not included unless you add them.
Credential isolation
Your Encompass client credential is held by your own Jentic One instance, encrypted, and the bearer token is injected at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'post a transaction response' or 'record a transaction event', and Jentic returns the matching Encompass operation with its input schema so the agent calls the right step in the transaction lifecycle.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Encompass Partner Connect API through Jentic.
What authentication does the Encompass Partner Connect API use?
Encompass Partner Connect uses OAuth 2.0 bearer tokens, per its OpenAPI spec: your integration obtains a token from the token operation and sends it as a bearer token on each request. Through Jentic the client credential is held by your own Jentic One instance and the token is attached at execution time, so it never appears in your agent's prompt or logs.
Can I process a mortgage transaction with the Encompass Partner Connect API?
Yes. The API lets your agent read a transaction's request resources, post a response, create and manage response resources, and record transaction events. Each step is its own operation, so the agent advances a transaction through its lifecycle with explicit calls.
What are the rate limits for the Encompass Partner Connect API?
The OpenAPI spec does not specify rate limits. Check the ICE Mortgage Technology partner documentation at https://docs.partnerconnect.elliemae.com for the current limits before running high-volume integrations.
Is there an Encompass Partner Connect MCP server?
You do not need an MCP server to give your agent Encompass Partner Connect. Jentic connects it directly from the API Directory: import it, store your client credential once, and your agent discovers the product and transaction operations it needs on demand without loading an extra server's tool definitions into its context.
Can I limit what my agent is allowed to do with the Encompass Partner Connect API?
Yes. Write a rule that allows only the transaction-read and event-read operations, so the agent can inspect a transaction and its events but cannot register products or update responses, and every call it makes is logged.
How do I process Encompass transactions through Jentic?
Install the Jentic One command line with `curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh`, then add the Encompass Partner Connect API from the Jentic directory and search by intent such as 'post a transaction response'. Jentic returns the matching operation with its input schema so your agent builds a valid request. To run it on your own infrastructure, install Jentic One from its GitHub repo.
GET STARTED