canonical: https://jentic.com/apis/elliemae.com/elliemae

# Elliemae Encompass Partner Connect API

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.

## For AI agents

Integrate with the Encompass mortgage platform: obtain OAuth tokens, register partner products, process transactions, read origin resources, and record transaction events.

## Scope

Does not handle loan underwriting decisions, credit scoring, or consumer-facing applications. Use for Encompass partner product and transaction integration only.

## Capabilities

- 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

### 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.

Example prompt: 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.

Example prompt: 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.

Example prompt: Retrieve all events for a transaction and flag any that lack a corresponding response resource

## Key endpoints

| 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 |

## Key resources

- **OAuth tokens** — Generate, introspect, and revoke access tokens
- **Products** — Register, update, retrieve, and list partner products
- **Transactions** — Read request resources, post responses, and manage response resources
- **Transaction events** — Record and retrieve events against a transaction
- **Origins** — Access the origin resource that triggered a transaction

## AI readiness

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.

- **Score:** 69 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 99 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 53 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 75 / 100
- **View full report:** https://jentic.com/apis/elliemae.com/elliemae/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **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 handling:** 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.
- **Discovery method:** 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

- **nCino Mortgage API** — Another mortgage origination platform API, an alternative integration target for lender-facing workflows.
- **ATTOM Data API** — Property, deed, and valuation data that complements Encompass transactions during loan processing.
- **Consumer Financial Protection Bureau API** — U.S. mortgage and consumer-finance reference data that pairs with Encompass for compliance context.

## FAQ

### 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.