Encompass (API user)

Overview

Use a lender’s own Encompass API key and an Encompass user’s login to make Encompass Developer Connect calls through Alter Vault. The client secret and the password stay in the vault: Alter exchanges them for a short-lived Encompass access token through the password grant, which ICE requires of lenders, and only that token is sent on the wire and returned to the SDK.

Property	Value
Template ID	encompass-api-user
Category	Finance
Credential Type	OAuth password grant (API user)

Note

Every call acts with the Encompass user’s persona, so that persona bounds what an agent can do in Encompass. For a user signing in themselves, see Encompass OAuth; for an ISV partner, see Encompass (ISV partner).

Why the password grant, and a dedicated user

ICE allows the client-credentials grant only for ISV partners: “Lenders must use grant type = password” (Encompass authentication guide). OAuth’s current security guidance (RFC 9700) says the password grant must not be used, because it exposes a user’s password to the application; this route uses it only because Encompass offers a lender no other grant for an agent that runs unattended. Encompass also issues no refresh token, so Alter keeps the password in the vault and sends it each time it mints a token, at least every 30 minutes. The exchange requests Encompass’s one scope, lp, as ICE’s own Postman collection does for this grant.

The password therefore stays stored for as long as the secret exists. Use a dedicated, non-human Encompass user created for the integration, never a person’s own login:

• Its persona grants only what the agent needs, and disabling the user in Encompass cuts off the agent and nothing else.
• Encompass records each change under the user who made it, so the agent’s changes stay apart from any person’s.
• A person’s password changes and lockouts do not stop the agent, and the agent’s logins never lock a person out.

Step 1: Get Credentials

Get the API key

An Encompass Super Admin signs in to Encompass Developer Connect, opens My Account → API Key, and copies the Client ID (OAuth) and Client Secret. Do not click Regenerate Secret: it breaks every application using this API key.

Create a dedicated Encompass user

Create an Encompass user for the agent to act as, not a person’s own login, with a persona that grants only what the agent needs. Note its user ID and password, and the instance ID (for example BE11234567).

Warning

Never share credentials publicly. Store them securely and only enter them in the Alter Vault Developer Portal.

Step 2: Add to Alter Vault

Open the Developer Portal

Go to portal.alterauth.com and navigate to the application.

Add Encompass (API user)

Go to Managed Secrets > Add Provider > Encompass (API user).

Enter credentials

Enter the client ID, the Instance ID, the Encompass user ID, and the password in their fields, and paste the client secret into the credential field. Enter the user ID alone: Alter adds @encompass:<Instance ID>.

Set the allowed host

Set the secret’s allowed host to api.elliemae.com.

Save

Click Save. Alter performs a real token exchange to verify the credentials before storing them; a client ID and secret, or a user ID and password, that Encompass rejects fail the save. You’ll receive a grant_id to use with the SDK.

Note

An Encompass token lapses 30 minutes after it is issued or last extended (a call in the first 15 minutes of that window extends it, for up to 24 hours), so Alter mints a new one before 30 minutes have passed since issue and sends only the token, as Authorization: Bearer. The SDK token channel returns only the minted token and its injection header, never the client ID, user ID, or password. When the Encompass user’s password changes, update it in Alter without pasting the client secret again. In the Developer Portal, open Edit Credential, enter the new password, and leave the key blank to keep the stored client secret. From the CLI, run alter managed-secrets rotate <provider> --credentials @password.json without --credential-value, where the file holds only {"password": "<new password>"}; a file keeps the password out of shell history (Update fields and keep the key).

Using in Code

response = await alter_app.request(
    HttpMethod.GET,
    "https://api.elliemae.com/encompass/v3/loans/LOAN_ID",
    grant_id="YOUR_GRANT_ID",
)

Grants with policy rules

request hands the token to the application, which then calls Encompass itself, so Alter never sees the request. Alter can only enforce an approval rule, a method and endpoint restriction, or a content rule (one that names an operation, a family, or a request field) on a call it makes itself. Once any such rule applies to the grant, at any level, every request on that grant is refused with RestrictedGrantRequiresProxyError (errors). Use proxy_request for a grant that carries the rules in Policy: it sends the whole request to Alter, which checks it against the rules, injects the token, and calls Encompass.

result = await alter_app.proxy_request(
    HttpMethod.GET,
    "https://api.elliemae.com/encompass/v3/loans/LOAN_ID",
    grant_id="YOUR_GRANT_ID",
    reason="Read the loan for the pipeline report",
)

proxy_request returns an ApprovalResult with Encompass’s status_code and body (result.body_json()), or a PendingApproval when a rule requires a person to approve the call first; see human-in-the-loop approvals. A recipients rule judges the body Alter sends, so it works only through proxy_request.

Policy

Every call runs through Alter’s policy rules, with the same operations and families as Encompass OAuth: require approval for send (Encompass Docs package deliveries, Loan Opportunity notifications, partner service orders, and webhook subscriptions) and payment (rate locks, trades, funding balances, compensation plans, a TPO company’s pricing and warehouse banks, and every route that writes a loan’s contract), and deny admin for agent grants. Sending an Encompass Docs package projects a recipients parameter with every email address and phone number it is delivered to; a package that names a recipient only by id, or a fulfillment sent by mail, cannot be judged, so a rule that names recipients refuses it. Issuing or introspecting a token, creating a Delivery Room session for a recipient in a partner portal, and changing a user’s own password are always refused, as on the OAuth route, because each would hand the caller a credential.

Notes

• An API key belongs to one Encompass client ID. An instance with a different client ID needs its own key.
• Encompass allows 30 concurrent calls per lender by default, shared by the lender’s own users and every partner, and answers 429 beyond that. ICE asks lenders to keep the remaining ratio at or below 80%; each response carries X-Concurrency-Limit-Limit and X-Concurrency-Limit-Remaining (concurrency limits).
• Rotating, deleting or revoking the secret discards Alter’s cached token and revokes at Encompass the tokens Alter recorded as minted from the secret’s credentials in the last 24 hours, and the tokens of its save-time checks: Encompass extends a token each time it is used, for up to 24 hours, so a token a caller still holds can outlive Alter’s copy. A token minted while Alter’s token cache was unavailable, or whose record could not be written, is not covered and expires on its own within 24 hours. Revocation is best effort; a failed one is audited as credential.minted_token_revocation_failed, and a token Encompass does not revoke lapses 30 minutes after it was issued or last extended, and 24 hours after issue at the latest.
• When Encompass rejects the login or the client pair, Alter does not send that login again until the credential is saved again, so a wrong password cannot lock the Encompass user out. Any other refusal of the exchange is replayed for 60 seconds instead of being sent again, with Retry-After set to the time left. A bare 401 does not say which credential is wrong, so Alter’s error names both, the Encompass user’s login first, then the client ID and secret: check the password before regenerating an API key’s secret, which breaks every other application that uses it.
• Only production (api.elliemae.com) is reachable. ICE’s API reference lists concept.api.elliemae.com as a separate UAT server, and Alter does not connect to it.
• Uploading or downloading an attachment takes a second call straight to ICE’s storage service, outside Alter; importing a MISMO 3.4 or Fannie Mae file cannot go through proxy_request; and Alter returns at most 5 MiB of a response body. See Files and large responses.
• A request field ICE adds to an operation after Alter’s catalog was generated is refused by a content rule that judges a request field on that operation until Alter regenerates the catalog; see the OAuth route’s notes.

Policy-cataloged operations

Alter policy rules can target these attested operations and families for operation-level and parameter-aware controls.

Operation ID	Families	Method	Provider path	Notes
create-an-invitation	write	POST	/consumers/v1/invitations	—
create-reminder-url	write	POST	/consumers/v1/reminders	—
get-packages	read	GET	/delivery/v3/{groupNamespace}/{groupId}/packages	—
get-package	read	GET	/delivery/v3/{groupNamespace}/{groupId}/packages/{packageId}	—
get-compliance-reports	read	GET	/ecs/v1/complianceReports	—
create-a-compliance-report	write	POST	/ecs/v1/complianceReports	—
manage-comp-settings-rpt-permissions	admin, write	POST	/ecs/v1/settings/user	—
export-attachments	write	POST	/efolder/v1/exportjobs	—
get-export-status	read	GET	/efolder/v1/exportjobs/{jobId}	—
export-files-job-creator	write	POST	/efolder/v1/loans/{loanId}/exportJobsCreator	—
v1-get-attachment-metadata	read	GET	/efolder/v1/loans/{loanId}/files/{fileId}	—
view-contacts-with-pagination	read	POST	/encompass/v1/borrowerContactSelector	—
create-contact	write	POST	/encompass/v1/borrowerContacts	—
delete-borrower-contact	delete	DELETE	/encompass/v1/borrowerContacts/{contactId}	—
get-borrower-contacts	read	GET	/encompass/v1/borrowerContacts/{contactId}	—
update-contact	write	PATCH	/encompass/v1/borrowerContacts/{contactId}	—
get-notes	read	GET	/encompass/v1/borrowerContacts/{contactId}/notes	—
create-note	write	POST	/encompass/v1/borrowerContacts/{contactId}/notes	—
delete-note	delete	DELETE	/encompass/v1/borrowerContacts/{contactId}/notes/{noteId}	—
get-note	read	GET	/encompass/v1/borrowerContacts/{contactId}/notes/{noteId}	—
update-note	write	PATCH	/encompass/v1/borrowerContacts/{contactId}/notes/{noteId}	—
get-business-contact-list	read	POST	/encompass/v1/businessContactSelector	—
create-contact-business	write	POST	/encompass/v1/businessContacts	—
delete-contact-business	delete	DELETE	/encompass/v1/businessContacts/{contactId}	—
get-contact-business	read	GET	/encompass/v1/businessContacts/{contactId}	—
update-contact-1	write	PATCH	/encompass/v1/businessContacts/{contactId}	—
create-note-business	write	POST	/encompass/v1/businessContacts/{contactId}/notes	—
delete-note-business	delete	DELETE	/encompass/v1/businessContacts/{contactId}/notes/{noteId}	—
get-note-business	read	GET	/encompass/v1/businessContacts/{contactId}/notes/{noteId}	—
update-note-business	write	PATCH	/encompass/v1/businessContacts/{contactId}/notes/{noteId}	—
calculate-loan	read	POST	/encompass/v1/calculators/loan	—
get-global-cdos	read	GET	/encompass/v1/company/customObjects	—
delete-global-cdo	admin, delete	DELETE	/encompass/v1/company/customObjects/{objectName}	—
get-global-cdo	read	GET	/encompass/v1/company/customObjects/{objectName}	—
update-global-cdo	admin, write	PATCH	/encompass/v1/company/customObjects/{objectName}	—
create-or-replace-global-cdo	admin, write	PUT	/encompass/v1/company/customObjects/{objectName}	—
get-a-list-of-users	read	GET	/encompass/v1/company/users	—
get-a-user-profile	read	GET	/encompass/v1/company/users/{userId}	—
get-users-assigned-rights	read	GET	/encompass/v1/company/users/{userId}/assignedRights	—
get-compensation-plans	read	GET	/encompass/v1/company/users/{userId}/compensation	—
get-users-effective-rights	read	GET	/encompass/v1/company/users/{userId}/effectiveRights	—
get-list-of-user-groups	read	GET	/encompass/v1/company/users/{userId}/groups	—
get-license-details	read	GET	/encompass/v1/company/users/{userId}/licenses	—
get-contact-groups	read	GET	/encompass/v1/contactGroups	—
create-contact-group	write	POST	/encompass/v1/contactGroups	—
delete-contact-group	delete	DELETE	/encompass/v1/contactGroups/{groupId}	—
get-contact-group	read	GET	/encompass/v1/contactGroups/{groupId}	—
update-contact-group	write	PATCH	/encompass/v1/contactGroups/{groupId}	—
get-all-contacts-in-contact-group	read	GET	/encompass/v1/contactGroups/{groupId}/contacts	—
add-or-remove-group-contacts	delete, write	PATCH	/encompass/v1/contactGroups/{groupId}/contacts	—
create-loan-from-import-file	payment, write	POST	/encompass/v1/importers/loan	—
update-loans	admin, payment, write	POST	/encompass/v1/loanBatch/updateRequests	—
get-status	read	GET	/encompass/v1/loanBatch/updateRequests/{requestId}	—
post-encompass-v1-loanpipeline	read	POST	/encompass/v1/loanPipeline	—
v1-get-canonical-fields	read	GET	/encompass/v1/loanPipeline/fieldDefinitions	—
move-to-loan-folder	write	PATCH	/encompass/v1/loanfolders/{folderName}/loans	—
create-loan	payment, write	POST	/encompass/v1/loans	—
get-list-of-loan-cdos	read	GET	/encompass/v1/loans/customObjects/{loanId}	—
get-supported-entities	read	GET	/encompass/v1/loans/supportedEntities	—
get-associates	read	GET	/encompass/v1/loans/{id}/associates	—
get-associate	read	GET	/encompass/v1/loans/{id}/associates/{logId}	—
assign-loan-associate	write	PUT	/encompass/v1/loans/{id}/associates/{logId}	—
get-milestone-free-roles	read	GET	/encompass/v1/loans/{id}/milestoneFreeRoles	—
get-milestone-free-role	read	GET	/encompass/v1/loans/{id}/milestoneFreeRoles/{logId}	—
update-a-milestone-free-role	write	PATCH	/encompass/v1/loans/{id}/milestoneFreeRoles/{logId}	—
get-all-milestones	read	GET	/encompass/v1/loans/{id}/milestones	—
get-a-milestone	read	GET	/encompass/v1/loans/{id}/milestones/{logId}	—
update-a-milestone	write	PATCH	/encompass/v1/loans/{id}/milestones/{logId}	—
delete-loan	delete	DELETE	/encompass/v1/loans/{loanId}	—
get-loan	read	GET	/encompass/v1/loans/{loanId}	—
update-loan	payment, write	PATCH	/encompass/v1/loans/{loanId}	—
get-borrower-pairs	read	GET	/encompass/v1/loans/{loanId}/applications	—
move-borrower-pair	write	PATCH	/encompass/v1/loans/{loanId}/applications	—
create-borrower-pair	write	POST	/encompass/v1/loans/{loanId}/applications	—
delete-borrower-pair	delete	DELETE	/encompass/v1/loans/{loanId}/applications/{applicationId}	—
get-borrower-pair	read	GET	/encompass/v1/loans/{loanId}/applications/{applicationId}	—
update-borrower-pair	write	PATCH	/encompass/v1/loans/{loanId}/applications/{applicationId}	—
get-attachments	read	GET	/encompass/v1/loans/{loanId}/attachments	—
upload-attachment-to-efolder	write	PUT	/encompass/v1/loans/{loanId}/attachments/url	—
get-attachment	read	GET	/encompass/v1/loans/{loanId}/attachments/{attachmentId}	—
update-attachment	write	PATCH	/encompass/v1/loans/{loanId}/attachments/{attachmentId}	—
get-thumbnail-of-page	read	POST	/encompass/v1/loans/{loanId}/attachments/{attachmentId}/pages/{pageId}/thumbnail/url	—
get-page-of-attachment	read	POST	/encompass/v1/loans/{loanId}/attachments/{attachmentId}/pages/{pageId}/url	—
get-attachment-url	read	POST	/encompass/v1/loans/{loanId}/attachments/{attachmentId}/url	—
get-all-aus-tracking-log	read	GET	/encompass/v1/loans/{loanId}/ausTrackingLogs	—
create-an-aus-tracking-log	write	POST	/encompass/v1/loans/{loanId}/ausTrackingLogs	—
get-aus-tracking-log-snapshot	read	GET	/encompass/v1/loans/{loanId}/ausTrackingLogs/snapshot/{logId}	—
get-an-aus-tracking-log	read	GET	/encompass/v1/loans/{loanId}/ausTrackingLogs/{logId}	—
update-an-aus-tracking-log	write	PATCH	/encompass/v1/loans/{loanId}/ausTrackingLogs/{logId}	—
get-all-post-closing-conditions	read	GET	/encompass/v1/loans/{loanId}/conditions/postclosing	—
manage-post-closing-conditions	delete, write	PATCH	/encompass/v1/loans/{loanId}/conditions/postclosing	—
create-post-closing-conditions	write	POST	/encompass/v1/loans/{loanId}/conditions/postclosing	—
get-a-post-closing-condition	read	GET	/encompass/v1/loans/{loanId}/conditions/postclosing/{conditionId}	—
manage-post-closing-comments	delete, write	PATCH	/encompass/v1/loans/{loanId}/conditions/postclosing/{conditionId}/comments	—
manage-post-closing-documents	delete, write	PATCH	/encompass/v1/loans/{loanId}/conditions/postclosing/{conditionId}/documents	—
get-all-preliminary-conditions-1	read	GET	/encompass/v1/loans/{loanId}/conditions/preliminary	—
manage-preliminary-conditions	delete, write	PATCH	/encompass/v1/loans/{loanId}/conditions/preliminary	—
create-preliminary-conditions	write	POST	/encompass/v1/loans/{loanId}/conditions/preliminary	—
get-all-preliminary-conditions	read	GET	/encompass/v1/loans/{loanId}/conditions/preliminary/{conditionId}	—
manage-preliminary-comments	delete, write	PATCH	/encompass/v1/loans/{loanId}/conditions/preliminary/{conditionId}/comments	—
manage-preliminary-documents	delete, write	PATCH	/encompass/v1/loans/{loanId}/conditions/preliminary/{conditionId}/documents	—
get-all-underwriting-conditions	read	GET	/encompass/v1/loans/{loanId}/conditions/underwriting	—
manage-underwriting-conditions	delete, write	PATCH	/encompass/v1/loans/{loanId}/conditions/underwriting	—
create-underwriting-conditions	write	POST	/encompass/v1/loans/{loanId}/conditions/underwriting	—
get-an-underwriting-condition	read	GET	/encompass/v1/loans/{loanId}/conditions/underwriting/{conditionId}	—
manage-underwriting-comments	delete, write	PATCH	/encompass/v1/loans/{loanId}/conditions/underwriting/{conditionId}/comments	—
manage-underwriting-documents	delete, write	PATCH	/encompass/v1/loans/{loanId}/conditions/underwriting/{conditionId}/documents	—
get-all-conversation-logs	read	GET	/encompass/v1/loans/{loanId}/conversationLogs	—
get-a-conversation-log	read	GET	/encompass/v1/loans/{loanId}/conversationLogs/{logId}	—
get-list-of-loan-cdos-alternate-path	read	GET	/encompass/v1/loans/{loanId}/customObjects	The API reference documents this operation at /encompass/v1/loans/customObjects/{loanId} and every other loan custom data object route (and the user list, /encompass/v1/users/{userId}/customObjects) at this path; ICE does not say which it serves, so both are cataloged with the same families and parameters
delete-a-loan-cdo	delete	DELETE	/encompass/v1/loans/{loanId}/customObjects/{objectName}	—
get-a-loan-cdo	read	GET	/encompass/v1/loans/{loanId}/customObjects/{objectName}	—
update-a-loan-cdo	write	PATCH	/encompass/v1/loans/{loanId}/customObjects/{objectName}	—
create-or-replace-a-loan-cdo	write	PUT	/encompass/v1/loans/{loanId}/customObjects/{objectName}	—
get-all-disclosure-tracking-logs	read	GET	/encompass/v1/loans/{loanId}/disclosureTracking2015	—
get-a-disclosure-tracking-log	read	GET	/encompass/v1/loans/{loanId}/disclosureTracking2015/{logId}	—
get-snapshot	read	GET	/encompass/v1/loans/{loanId}/disclosureTracking2015/{logId}/snapshot	—
get-documentsefolder-document	read	GET	/encompass/v1/loans/{loanId}/documents	—
create-document	write	POST	/encompass/v1/loans/{loanId}/documents	—
get-document	read	GET	/encompass/v1/loans/{loanId}/documents/{documentId}	—
update-document	write	PATCH	/encompass/v1/loans/{loanId}/documents/{documentId}	—
get-document-attachments	read	GET	/encompass/v1/loans/{loanId}/documents/{documentId}/attachments	—
assign-document-attachment	delete, write	PATCH	/encompass/v1/loans/{loanId}/documents/{documentId}/attachments	—
add-comments-to-a-document	write	PATCH	/encompass/v1/loans/{loanId}/documents/{documentId}/comments	—
v1-field-reader	read	POST	/encompass/v1/loans/{loanId}/fieldReader	—
v1-get-loan-metadata	read	GET	/encompass/v1/loans/{loanId}/metadata	—
get-rate-lock	read	GET	/encompass/v1/loans/{loanId}/ratelockRequests	—
submit-a-rate-lock-request	payment, write	POST	/encompass/v1/loans/{loanId}/ratelockRequests	—
get-rate-lock-request	read	GET	/encompass/v1/loans/{loanId}/ratelockRequests/{requestId}	—
update-a-rate-lock-request	payment, write	PATCH	/encompass/v1/loans/{loanId}/ratelockRequests/{requestId}	—
cancel-lock-request	payment, write	PUT	/encompass/v1/loans/{loanId}/ratelockRequests/{requestId}/cancellation	—
confirm-a-rate-lock-request	payment, write	PUT	/encompass/v1/loans/{loanId}/ratelockRequests/{requestId}/confirmation	—
deny-a-rate-lock-request	payment, write	PUT	/encompass/v1/loans/{loanId}/ratelockRequests/{requestId}/denial	—
get-snapshot-of-a-rate-lock	read	GET	/encompass/v1/loans/{loanId}/ratelockRequests/{requestId}/snapshot	—
void-a-rate-lock-request	payment, write	PUT	/encompass/v1/loans/{loanId}/ratelockRequests/{requestId}/void	—
get-all-organizations	read	GET	/encompass/v1/organizations	—
get-root-organization-detail	read	GET	/encompass/v1/organizations/root	—
get-organization-detail	read	GET	/encompass/v1/organizations/{orgId}	—
get-children-of-organization	read	GET	/encompass/v1/organizations/{orgId}/children	—
get-resource-locks	read	GET	/encompass/v1/resourceLocks	—
lock-resource	write	POST	/encompass/v1/resourceLocks	—
unlock-resource	delete	DELETE	/encompass/v1/resourceLocks/{lockId}	—
get-resource-lock	read	GET	/encompass/v1/resourceLocks/{lockId}	—
get-loan-schema	read	GET	/encompass/v1/schema/loan	—
contract-generator	read	POST	/encompass/v1/schema/loan/contractGenerator	—
path-generator	read	POST	/encompass/v1/schema/loan/pathGenerator	—
get-field-schema	read	GET	/encompass/v1/schema/loan/{fieldId}	—
get-borrower-canonical-names	read	GET	/encompass/v1/settings/borrowerContacts/fieldDefinitions	—
get-business-canonical-names	read	GET	/encompass/v1/settings/businessContacts/fieldDefinitions	—
get-custom-fields	read	GET	/encompass/v1/settings/loan/customFields	—
get-a-custom-field	read	GET	/encompass/v1/settings/loan/customFields/{customFieldId}	—
get-a-list-of-personas	read	GET	/encompass/v1/settings/personas	—
get-a-persona	read	GET	/encompass/v1/settings/personas/{id}	—
get-a-list-of-roles	read	GET	/encompass/v1/settings/roles	—
get-template-folders	read	GET	/encompass/v1/settings/templates/loanTemplateSet/folders/{folderPath}	—
get-template-files	read	GET	/encompass/v1/settings/templates/loanTemplateSet/items	—
get-user-cdos	read	GET	/encompass/v1/users/{userId}/customObjects	—
delete-user-cdo	delete	DELETE	/encompass/v1/users/{userId}/customObjects/{objectName}	—
get-user-cdo	read	GET	/encompass/v1/users/{userId}/customObjects/{objectName}	—
update-user-cdo	write	PATCH	/encompass/v1/users/{userId}/customObjects/{objectName}	—
create-or-replace-user-cdo	write	PUT	/encompass/v1/users/{userId}/customObjects/{objectName}	—
evaluate-automated-conditions	read	POST	/encompass/v3/calculators/automatedConditions	—
v3-amortization-schedule-calculator	read	POST	/encompass/v3/calculators/payments/amortization	—
v3-get-external-organization-commitments	read	POST	/encompass/v3/calculators/tpoCommitments	—
converter-to-import-new-loan	write	POST	/encompass/v3/converter/loans	—
get-external-organizations	read	GET	/encompass/v3/externalOrganizations/tpos	—
get-an-external-organization	read	GET	/encompass/v3/externalOrganizations/tpos/{orgId}	—
get-all-external-users	read	GET	/encompass/v3/externalUsers	—
manage-external-users	admin, delete, write	PATCH	/encompass/v3/externalUsers	—
v3-change-external-user-password	admin, write	POST	/encompass/v3/externalUsers/me/changePassword	refused by default: leaves the caller holding a provider credential (a credential_minting rule can allow it); Announced in ICE’s 26.3 release notes (developer-connect/changelog/263-major-release, release scheduled 2026-12-05) and not yet in the API reference; cataloged so a request to it is classified under these families before ICE publishes it. The caller sets the user’s new Encompass password and would then hold a working Encompass login outside Alter, so it is refused on every grant
get-an-external-user	read	GET	/encompass/v3/externalUsers/{userId}	—
get-effective-rights-of-external-user	read	GET	/encompass/v3/externalUsers/{userId}/effectiveRights	—
get-list-of-loan-folders	read	GET	/encompass/v3/loanFolders	—
get-a-loan-folder	read	GET	/encompass/v3/loanFolders/{folderName}	—
view-pipeline-with-pagination-1	read	POST	/encompass/v3/loanPipeline	—
get-canonical-names	read	GET	/encompass/v3/loanPipeline/canonicalFields	—
v3-create-cursor	read	POST	/encompass/v3/loanPipeline/report	—
create-loan-1	payment, write	POST	/encompass/v3/loans	—
get-a-list-of-disclosure-tracking-logs-alternate-path	read	GET	/encompass/v3/loans/disclosureTracking2015Logs/{loanId}	The API reference documents this operation at /encompass/v3/loans/{loanId}/disclosureTracking2015Logs and ICE’s 26.1 release notes at this path; ICE does not say which it serves, so both are cataloged with the same families and parameters
delete-loan-1	delete	DELETE	/encompass/v3/loans/{loanId}	—
get-loan-1	read	GET	/encompass/v3/loans/{loanId}	—
update-loan-1	payment, write	PATCH	/encompass/v3/loans/{loanId}	—
get-affiliated-business-arrangements	read	GET	/encompass/v3/loans/{loanId}/affiliatedBusinessArrangements	—
manage-affiliated-business-arrangements	delete, write	PATCH	/encompass/v3/loans/{loanId}/affiliatedBusinessArrangements	—
get-additional-loans	read	GET	/encompass/v3/loans/{loanId}/applications/{applicationId}/additionalLoans	—
manage-additional-loans	delete, write	PATCH	/encompass/v3/loans/{loanId}/applications/{applicationId}/additionalLoans	—
get-gifts-and-grants	read	GET	/encompass/v3/loans/{loanId}/applications/{applicationId}/giftsGrants	—
manage-gifts-and-grants	delete, write	PATCH	/encompass/v3/loans/{loanId}/applications/{applicationId}/giftsGrants	—
get-other-assets	read	GET	/encompass/v3/loans/{loanId}/applications/{applicationId}/otherAssets	—
manage-other-assets	delete, write	PATCH	/encompass/v3/loans/{loanId}/applications/{applicationId}/otherAssets	—
get-other-income	read	GET	/encompass/v3/loans/{loanId}/applications/{applicationId}/otherIncomeSources	—
manage-other-incomes	delete, write	PATCH	/encompass/v3/loans/{loanId}/applications/{applicationId}/otherIncomeSources	—
get-other-liabilities	read	GET	/encompass/v3/loans/{loanId}/applications/{applicationId}/otherLiabilities	—
manage-other-liabilities	delete, write	PATCH	/encompass/v3/loans/{loanId}/applications/{applicationId}/otherLiabilities	—
get-reo-properties	read	GET	/encompass/v3/loans/{loanId}/applications/{applicationId}/reoProperties	—
manage-reo-properties	delete, write	PATCH	/encompass/v3/loans/{loanId}/applications/{applicationId}/reoProperties	—
v3-get-request-for-transcript-of-tax	read	GET	/encompass/v3/loans/{loanId}/applications/{applicationId}/tax4506Ts	—
v3-patch-request-for-transcript-of-tax	delete, write	PATCH	/encompass/v3/loans/{loanId}/applications/{applicationId}/tax4506Ts	—
get-vods	read	GET	/encompass/v3/loans/{loanId}/applications/{applicationId}/vods	—
manage-vods	delete, write	PATCH	/encompass/v3/loans/{loanId}/applications/{applicationId}/vods	—
get-vols	read	GET	/encompass/v3/loans/{loanId}/applications/{applicationId}/vols	—
manage-vols	delete, write	PATCH	/encompass/v3/loans/{loanId}/applications/{applicationId}/vols	—
get-employment	read	GET	/encompass/v3/loans/{loanId}/applications/{applicationId}/{applicantType}/employment	—
manage-employment	delete, write	PATCH	/encompass/v3/loans/{loanId}/applications/{applicationId}/{applicantType}/employment	—
get-residences	read	GET	/encompass/v3/loans/{loanId}/applications/{applicationId}/{applicantType}/residences	—
manage-residences	delete, write	PATCH	/encompass/v3/loans/{loanId}/applications/{applicationId}/{applicantType}/residences	—
get-urla-alternate-names	read	GET	/encompass/v3/loans/{loanId}/applications/{applicationId}/{applicantType}/urlaAlternateNames	—
update-urla-alternate-names	delete, write	PATCH	/encompass/v3/loans/{loanId}/applications/{applicationId}/{applicantType}/urlaAlternateNames	—
get-download-attachment-url	read	POST	/encompass/v3/loans/{loanId}/attachmentDownloadUrl	—
create-attachment-url	write	POST	/encompass/v3/loans/{loanId}/attachmentUploadUrl	—
get-list-of-attachments	read	GET	/encompass/v3/loans/{loanId}/attachments	—
update-or-remove-attachments	delete, write	PATCH	/encompass/v3/loans/{loanId}/attachments	—
get-an-attachment	read	GET	/encompass/v3/loans/{loanId}/attachments/{attachmentId}	—
pull-field-audit-data	read	POST	/encompass/v3/loans/{loanId}/auditTrail	—
view-vesting-entities	read	GET	/encompass/v3/loans/{loanId}/closingDocument/vestingEntities	—
manage-vesting-entities	delete, write	PATCH	/encompass/v3/loans/{loanId}/closingDocument/vestingEntities	—
get-all-enhanced-conditions	read	GET	/encompass/v3/loans/{loanId}/conditions	—
manage-enhanced-conditions-1	delete, write	PATCH	/encompass/v3/loans/{loanId}/conditions	—
get-an-enhanced-condition	read	GET	/encompass/v3/loans/{loanId}/conditions/{conditionId}	—
get-comments	read	GET	/encompass/v3/loans/{loanId}/conditions/{conditionId}/comments	—
manage-comments	delete, write	PATCH	/encompass/v3/loans/{loanId}/conditions/{conditionId}/comments	—
get-documents-1	read	GET	/encompass/v3/loans/{loanId}/conditions/{conditionId}/documents	—
manage-documents	delete, write	PATCH	/encompass/v3/loans/{loanId}/conditions/{conditionId}/documents	—
get-tracking-entries	read	GET	/encompass/v3/loans/{loanId}/conditions/{conditionId}/tracking	—
manage-tracking-entries	delete, write	PATCH	/encompass/v3/loans/{loanId}/conditions/{conditionId}/tracking	—
create-conversation-log	write	PATCH	/encompass/v3/loans/{loanId}/conversationlogs	—
v3-get-cpa-tracking-logs	read	GET	/encompass/v3/loans/{loanId}/cpaTrackingLogs	Announced in ICE’s 26.3 release notes (developer-connect/changelog/263-major-release, release scheduled 2026-12-05) and not yet in the API reference; cataloged so a request to it is classified under these families before ICE publishes it
v3-create-cpa-tracking-log	write	POST	/encompass/v3/loans/{loanId}/cpaTrackingLogs	Announced in ICE’s 26.3 release notes (developer-connect/changelog/263-major-release, release scheduled 2026-12-05) and not yet in the API reference; cataloged so a request to it is classified under these families before ICE publishes it
v3-get-cpa-tracking-log	read	GET	/encompass/v3/loans/{loanId}/cpaTrackingLogs/{cpaLogId}	Announced in ICE’s 26.3 release notes (developer-connect/changelog/263-major-release, release scheduled 2026-12-05) and not yet in the API reference; cataloged so a request to it is classified under these families before ICE publishes it
v3-update-cpa-tracking-log	write	PATCH	/encompass/v3/loans/{loanId}/cpaTrackingLogs/{cpaLogId}	Announced in ICE’s 26.3 release notes (developer-connect/changelog/263-major-release, release scheduled 2026-12-05) and not yet in the API reference; cataloged so a request to it is classified under these families before ICE publishes it
v3-get-disasters	read	GET	/encompass/v3/loans/{loanId}/disasters	—
v3-manage-disasters	delete, write	PATCH	/encompass/v3/loans/{loanId}/disasters	—
get-a-list-of-disclosure-tracking-logs	read	GET	/encompass/v3/loans/{loanId}/disclosureTracking2015Logs	—
add-a-disclosure-tracking-log	write	POST	/encompass/v3/loans/{loanId}/disclosureTracking2015Logs	—
v3-get-dt-snapshots	read	GET	/encompass/v3/loans/{loanId}/disclosureTracking2015Logs/snapshots	—
get-a-disclosure-tracking-log-1	read	GET	/encompass/v3/loans/{loanId}/disclosureTracking2015Logs/{disclosureLogId}	—
update-a-disclosure-tracking-log	write	PATCH	/encompass/v3/loans/{loanId}/disclosureTracking2015Logs/{disclosureLogId}	—
v3-get-disclosure-tracking-log-email-messages	read	GET	/encompass/v3/loans/{loanId}/disclosureTracking2015Logs/{disclosureLogId}/emailMessage	—
v3-add-manual-fulfillment	write	POST	/encompass/v3/loans/{loanId}/disclosureTracking2015Logs/{disclosureLogId}/fulfillments	—
v3-get-dt-snapshot	read	GET	/encompass/v3/loans/{loanId}/disclosureTracking2015Logs/{disclosureLogId}/snapshot	—
get-list-of-documents	read	GET	/encompass/v3/loans/{loanId}/documents	—
manage-documents-1-1	delete, write	PATCH	/encompass/v3/loans/{loanId}/documents	—
get-a-document-1	read	GET	/encompass/v3/loans/{loanId}/documents/{documentId}	—
assign-document-attachments	delete, write	PATCH	/encompass/v3/loans/{loanId}/documents/{documentId}/attachments	—
update-field-lock-data	delete, payment, write	PATCH	/encompass/v3/loans/{loanId}/fieldLockData	—
v3-field-reader	read	POST	/encompass/v3/loans/{loanId}/fieldReader	—
v3-field-writer	payment, write	POST	/encompass/v3/loans/{loanId}/fieldWriter	—
v3-get-funding-balances	read	GET	/encompass/v3/loans/{loanId}/fundingBalances	—
v3-get-funding-fees	read	GET	/encompass/v3/loans/{loanId}/fundingFees	—
v3-patch-funding-balances	payment, write	PATCH	/encompass/v3/loans/{loanId}/fundingFees	—
v3-get-efolder-history	read	GET	/encompass/v3/loans/{loanId}/histories/eFolder	—
get-homecounselingprovider	read	GET	/encompass/v3/loans/{loanId}/homeCounselingProviders	—
manage-home-counseling-providers-list	delete, write	PATCH	/encompass/v3/loans/{loanId}/homeCounselingProviders	—
importer-to-update-loan	payment, write	POST	/encompass/v3/loans/{loanId}/importer	—
v3-get-milestonefree-role-list	read	GET	/encompass/v3/loans/{loanId}/milestoneFreeRoles	—
v3-update-milestone-free-role	write	PATCH	/encompass/v3/loans/{loanId}/milestoneFreeRoles	—
v3-get-milestone-logs-list	read	GET	/encompass/v3/loans/{loanId}/milestones	—
v3-update-milestone-dates	write	PATCH	/encompass/v3/loans/{loanId}/milestones	—
v3-get-milestone-log	read	GET	/encompass/v3/loans/{loanId}/milestones/{milestoneId}	—
v3-update-milestone-log	write	PATCH	/encompass/v3/loans/{loanId}/milestones/{milestoneId}	—
get-non-borrowing-owners	read	GET	/encompass/v3/loans/{loanId}/nonBorrowingOwners	—
manage-non-borrowing-owners	delete, write	PATCH	/encompass/v3/loans/{loanId}/nonBorrowingOwners	—
get-non-vols	read	GET	/encompass/v3/loans/{loanId}/nonVols	—
manage-non-vols	delete, write	PATCH	/encompass/v3/loans/{loanId}/nonVols	—
get-recipients	read	GET	/encompass/v3/loans/{loanId}/recipients	—
get-registration-logs	read	GET	/encompass/v3/loans/{loanId}/registrationLogs	—
create-registration-log	write	POST	/encompass/v3/loans/{loanId}/registrationLogs	—
get-a-registration-log	read	GET	/encompass/v3/loans/{loanId}/registrationLogs/{logId}	—
update-registration-log	write	PATCH	/encompass/v3/loans/{loanId}/registrationLogs/{registrationLogId}	—
stage-service-order-resources	write	POST	/encompass/v3/loans/{loanId}/serviceOrderResources	served by the provider but absent from its published spec
get-service-orders	read	GET	/encompass/v3/loans/{loanId}/serviceOrders	served by the provider but absent from its published spec
create-service-order	payment, send, write	POST	/encompass/v3/loans/{loanId}/serviceOrders	served by the provider but absent from its published spec
get-service-order	read	GET	/encompass/v3/loans/{loanId}/serviceOrders/{serviceOrderId}	served by the provider but absent from its published spec
update-service-order-request	payment, send, write	PATCH	/encompass/v3/loans/{loanId}/serviceOrders/{serviceOrderId}/request	served by the provider but absent from its published spec
get-service-order-response-resources	read	GET	/encompass/v3/loans/{loanId}/serviceOrders/{serviceOrderId}/response/resources	served by the provider but absent from its published spec
get-service-provider-contacts	read	GET	/encompass/v3/loans/{loanId}/serviceProviderContacts	—
manage-service-provider-contacts-list	delete, write	PATCH	/encompass/v3/loans/{loanId}/serviceProviderContacts	—
v3-get-ucd-fields	read	GET	/encompass/v3/loans/{loanId}/ucdfields	—
update-urla-version	write	PATCH	/encompass/v3/loans/{loanId}/urlaVersion	—
get-list-of-resource-locks	read	GET	/encompass/v3/resourceLocks	—
lock-resource-1	write	POST	/encompass/v3/resourceLocks	—
unlock-resource-1	delete	DELETE	/encompass/v3/resourceLocks/{lockId}	—
get-a-resource-lock	read	GET	/encompass/v3/resourceLocks/{lockId}	—
get-loan-schema-1	read	GET	/encompass/v3/schemas/loan	—
get-field-schema-1	read	GET	/encompass/v3/schemas/loan/standardFields	—
get-virtual-fields	read	GET	/encompass/v3/schemas/loan/virtualFields	—
v3-get-list-standard-print-forms-loan	read	POST	/encompass/v3/settings/calculators/standardPrintForms	—
v3-compliance-calendar-date-calc	read	POST	/encompass/v3/settings/calculators/timerCompletion	—
v3-get-bus-contacts-categories	read	GET	/encompass/v3/settings/contacts/businessContacts/categories	—
v3-get-bus-contacts-custom-cat-fields	read	GET	/encompass/v3/settings/contacts/businessContacts/customCategoryFields	—
v3-get-bus-contacts-custom-fields	read	GET	/encompass/v3/settings/contacts/businessContacts/customFields	—
v3-get-efolder-document-groups	read	GET	/encompass/v3/settings/eFolder/documentGroup	—
v3-get-efolder-document-groups-alternate-path	read	GET	/encompass/v3/settings/eFolder/documentGroups	The API reference documents this operation at /encompass/v3/settings/eFolder/documentGroup and ICE’s 26.1 release notes at this path; ICE does not say which it serves, so both are cataloged with the same families and parameters
v3-get-list-efolder-doc-stacking-templates	read	GET	/encompass/v3/settings/eFolder/documentStackingTemplates	—
v3-get-efolder-doc-stacking-template-details	read	GET	/encompass/v3/settings/eFolder/documentStackingTemplates/{templateId}	—
v3-get-efolder-document-settings	read	GET	/encompass/v3/settings/efolder/documents	—
v3-get-efolder-document-options	read	GET	/encompass/v3/settings/efolder/documents/options	—
v3-get-external-banks	read	GET	/encompass/v3/settings/externalOrganizations/banks	—
v3-get-tpo-custom-field-definitions	read	GET	/encompass/v3/settings/externalOrganizations/tpoCustomFieldDefinitions	—
v3-get-global-tpo-fees	read	GET	/encompass/v3/settings/externalOrganizations/tpoFees	—
v3-get-global-tpo-fee-details	read	GET	/encompass/v3/settings/externalOrganizations/tpoFees/{feeId}	—
v3-get-global-tpo-late-fees	read	GET	/encompass/v3/settings/externalOrganizations/tpoLateFees	—
v3-get-company-price-groups	read	GET	/encompass/v3/settings/externalOrganizations/tpoSettings/PriceGroup	—
v3-get-company-rating	read	GET	/encompass/v3/settings/externalOrganizations/tpoSettings/companyRating	—
v3-get-company-status	read	GET	/encompass/v3/settings/externalOrganizations/tpoSettings/companyStatus	—
v3-get-list-of-available-external-site-urls	read	GET	/encompass/v3/settings/externalOrganizations/tpoSettings/externalUrls	—
v3-get-external-orgs	read	GET	/encompass/v3/settings/externalOrganizations/tpos	—
v3-create-external-organization	admin, payment, write	POST	/encompass/v3/settings/externalOrganizations/tpos	—
v3-get-external-organization	read	GET	/encompass/v3/settings/externalOrganizations/tpos/{orgId}	—
v3-update-external-organization	admin, payment, write	PATCH	/encompass/v3/settings/externalOrganizations/tpos/{orgId}	—
v3-manage-dba-records	admin, delete, write	PATCH	/encompass/v3/settings/externalOrganizations/tpos/{orgId}/dbas	—
v3-manage-external-organization-site-urls	admin, delete, write	PATCH	/encompass/v3/settings/externalOrganizations/tpos/{orgId}/externalUrls	—
v3-manage-external-organization-licenses	admin, write	PATCH	/encompass/v3/settings/externalOrganizations/tpos/{orgId}/licenses	Announced in ICE’s 26.3 release notes (developer-connect/changelog/263-major-release, release scheduled 2026-12-05) and not yet in the API reference; cataloged so a request to it is classified under these families before ICE publishes it
v3-get-external-organization-notes	read	GET	/encompass/v3/settings/externalOrganizations/tpos/{orgId}/notes	Announced in ICE’s 26.3 release notes (developer-connect/changelog/263-major-release, release scheduled 2026-12-05) and not yet in the API reference; cataloged so a request to it is classified under these families before ICE publishes it
v3-manage-external-organization-notes	admin, delete, write	PATCH	/encompass/v3/settings/externalOrganizations/tpos/{orgId}/notes	Announced in ICE’s 26.3 release notes (developer-connect/changelog/263-major-release, release scheduled 2026-12-05) and not yet in the API reference; cataloged so a request to it is classified under these families before ICE publishes it
v3-get-external-organization-note	read	GET	/encompass/v3/settings/externalOrganizations/tpos/{orgId}/notes/{noteId}	Announced in ICE’s 26.3 release notes (developer-connect/changelog/263-major-release, release scheduled 2026-12-05) and not yet in the API reference; cataloged so a request to it is classified under these families before ICE publishes it
v3-manage-warehouse-details	admin, delete, payment, write	PATCH	/encompass/v3/settings/externalOrganizations/tpos/{orgId}/warehouses	—
get-ami-limit-settings	read	GET	/encompass/v3/settings/fees/affordableLending/amiLimits	—
get-mfi-limit-settings	read	GET	/encompass/v3/settings/fees/affordableLending/mfiLimits	—
v3-get-itemization-fee-management	read	GET	/encompass/v3/settings/fees/itemization	—
v3-get-loan-originator-compensation-plans	read	GET	/encompass/v3/settings/fees/loCompensationPlans	—
get-all-enhanced-condition-sets	read	GET	/encompass/v3/settings/loan/conditions/sets	—
get-an-enhanced-condition-set	read	GET	/encompass/v3/settings/loan/conditions/sets/{setId}	—
get-all-enhanced-condition-templates	read	GET	/encompass/v3/settings/loan/conditions/templates	—
manage-enhanced-condition-templates	admin, delete, write	PATCH	/encompass/v3/settings/loan/conditions/templates	—
get-an-enhanced-condition-template	read	GET	/encompass/v3/settings/loan/conditions/templates/{templateId}	—
get-all-enhanced-condition-types	read	GET	/encompass/v3/settings/loan/conditions/types	—
manage-enhanced-condition-types	admin, delete, write	PATCH	/encompass/v3/settings/loan/conditions/types	—
get-an-enhanced-condition-type	read	GET	/encompass/v3/settings/loan/conditions/types/{typeId}	—
manage-custom-fields	read	GET	/encompass/v3/settings/loan/customFields	—
v3-manage-custom-fields	admin, delete, write	PATCH	/encompass/v3/settings/loan/customFields	—
get-encompass-v3-settings-loan-customprintforms	read	GET	/encompass/v3/settings/loan/customPrintForms	—
get-disclosure-tracking-settings	read	GET	/encompass/v3/settings/loan/disclosureTracking	—
v3-get-list-of-hmda-profiles	read	GET	/encompass/v3/settings/loan/hmdaProfiles	—
v3-get-hmda-profile-details	read	GET	/encompass/v3/settings/loan/hmdaProfiles/{profileId}	—
v3-get-print-form-group-details	read	GET	/encompass/v3/settings/loan/printFormGroupDetail	—
v3-get-list-print-form-groups	read	GET	/encompass/v3/settings/loan/printFormGroups	—
v3-get-list-standard-print-forms	read	GET	/encompass/v3/settings/loan/standardPrintForms	—
v3-get-list-milestones	read	GET	/encompass/v3/settings/milestones	—
v3-get-details-specific-milestone	read	GET	/encompass/v3/settings/milestones/{milestoneId}	—
get-a-list-of-personas-1	read	GET	/encompass/v3/settings/personas	—
get-a-persona-1	read	GET	/encompass/v3/settings/personas/{id}	—
referenceget-urla-configuration	read	GET	/encompass/v3/settings/policies/urla	—
v3-get-list-of-roles	read	GET	/encompass/v3/settings/roles	—
v3-get-role-mappings	read	GET	/encompass/v3/settings/roles/roleMappings	—
v3-get-specific-role-details	read	GET	/encompass/v3/settings/roles/{roleId}	—
get-funding-templates	read	GET	/encompass/v3/settings/secondary/fundingTemplates	—
get-investor-templates	read	GET	/encompass/v3/settings/secondary/investorTemplates	—
get-an-investor-template	read	GET	/encompass/v3/settings/secondary/investorTemplates/{templateId}	—
get-list-of-closing-cost-templates	read	GET	/encompass/v3/settings/templates/closingCost/folders	—
v3-get-closing-cost-template-settings	read	GET	/encompass/v3/settings/templates/closingCost/items	—
get-loan-program-templates	read	GET	/encompass/v3/settings/templates/loanProgram/folders	—
v3-get-loan-program-template-settings	read	GET	/encompass/v3/settings/templates/loanProgram/items	—
get-list-of-loan-template-sets	read	GET	/encompass/v3/settings/templates/loanTemplateSet/folders	—
get-list-of-settlement-service-providers-1	read	GET	/encompass/v3/settings/templates/settlementServiceProvider/folders	—
get-list-of-settlement-service-providers	read	GET	/encompass/v3/settings/templates/settlementServiceProvider/items	—
v3-get-list-of-transcript-of-tax-templates	read	GET	/encompass/v3/settings/templates/transcriptRequests	—
v3-get-transcript-of-tax-template	read	GET	/encompass/v3/settings/templates/transcriptRequests/{templateId}	—
v3-get-list-internal-users	read	GET	/encompass/v3/users	—
v3-update-internal-users	admin, write	PATCH	/encompass/v3/users	—
v3-create-internal-user	admin, payment, write	POST	/encompass/v3/users	—
v3-change-internal-user-password	admin, write	POST	/encompass/v3/users/me/changePassword	refused by default: leaves the caller holding a provider credential (a credential_minting rule can allow it); Announced in ICE’s 26.3 release notes (developer-connect/changelog/263-major-release, release scheduled 2026-12-05) and not yet in the API reference; cataloged so a request to it is classified under these families before ICE publishes it. The caller sets the user’s new Encompass password and would then hold a working Encompass login outside Alter, so it is refused on every grant
v3-create-pipeline-view	write	POST	/encompass/v3/users/me/views/pipelineViews	—
update-pipeline-view	write	PATCH	/encompass/v3/users/me/views/pipelineViews/{viewId}	—
v3-delete-internal-user-profile	admin, delete	DELETE	/encompass/v3/users/{userId}	—
v3-get-internal-user-profile	read	GET	/encompass/v3/users/{userId}	—
v3-update-internal-user	admin, write	PATCH	/encompass/v3/users/{userId}	—
v3-manage-internal-user-comp-plans	admin, payment, write	PUT	/encompass/v3/users/{userId}/compensationPlans	—
get-eligible-roles	read	GET	/encompass/v3/users/{userId}/eligibleRoles	—
v3-get-internal-user-public-profile	read	GET	/encompass/v3/users/{userId}/publicProfile	—
v3-update-internal-user-public-profile	admin, write	PATCH	/encompass/v3/users/{userId}/publicProfile	—
audit-closing-loan-file	write	POST	/encompassdocs/v1/documentAudits/closing	—
get-document-audit-to-remove-copy-copy	read	GET	/encompassdocs/v1/documentAudits/closing/{auditId}	—
audit-opening	write	POST	/encompassdocs/v1/documentAudits/opening	—
get-document-audit-to-remove-copy	read	GET	/encompassdocs/v1/documentAudits/opening/{auditId}	—
generate-closing-doc-set	write	POST	/encompassdocs/v1/documentOrders/closing	—
get-docs-added-to-closing-doc-set	read	GET	/encompassdocs/v1/documentOrders/closing/documents/{jobId}/{orderId}	—
get-closing-order-status	read	GET	/encompassdocs/v1/documentOrders/closing/{orderId}	—
send-closing-docs	send, write	POST	/encompassdocs/v1/documentOrders/closing/{orderId}/delivery	—
get-closing-package-delivery-details	read	GET	/encompassdocs/v1/documentOrders/closing/{orderId}/delivery/{jobId}	—
add-docs-to-closing-doc-set	write	POST	/encompassdocs/v1/documentOrders/closing/{orderId}/documents	—
generate-forms	write	POST	/encompassdocs/v1/documentOrders/forms	—
send-forms	send, write	POST	/encompassdocs/v1/documentOrders/forms/{orderId}/delivery	—
get-forms-delivery-details	read	GET	/encompassdocs/v1/documentOrders/forms/{orderId}/delivery/{jobId}	—
print-forms	write	POST	/encompassdocs/v1/documentOrders/ondemand	—
223-get-print-job-url	read	GET	/encompassdocs/v1/documentOrders/ondemand/{orderId}	—
generate-opening-doc-set	write	POST	/encompassdocs/v1/documentOrders/opening	—
get-order-status	read	GET	/encompassdocs/v1/documentOrders/opening/{orderId}	—
send-initial-disclosures	send, write	POST	/encompassdocs/v1/documentOrders/opening/{orderId}/delivery	—
get-delivery-details	read	GET	/encompassdocs/v1/documentOrders/opening/{orderId}/delivery/{jobId}	—
add-docs-to-opening-doc-set	write	POST	/encompassdocs/v1/documentOrders/opening/{orderId}/documents	—
get-docs-to-opening-doc-set	read	GET	/encompassdocs/v1/documentOrders/opening/{orderId}/documents/{jobId}	—
view-plan-codes	read	GET	/encompassdocs/v1/planCodes	—
apply-plan-code	write	POST	/encompassdocs/v1/planCodes/{planCodeID}/evaluator	—
search-for-field-form	read	POST	/encwsearch/v1/search	—
get-programs-and-rates	read	POST	/epps/v2/loanQualifier	—
get-adjustments-1	read	POST	/epps/v2/loans/programs/{programId}/adjustments	—
v2-get-eligible-rates	read	POST	/epps/v2/loans/programs/{programId}/eligibility	—
select-rate	payment, write	POST	/epps/v2/loans/{loanId}/rateSelector	—
nod-types	read	GET	/epps/v2/lookups/NODTypes	—
agency-approvals	read	GET	/epps/v2/lookups/agencyapprovals	—
bankruptcy	read	GET	/epps/v2/lookups/bankruptcy	—
get-buydown-contributor-type	read	GET	/epps/v2/lookups/buydownContributorType	—
get-buydown-type	read	GET	/epps/v2/lookups/buydownType	—
get-citizenship	read	GET	/epps/v2/lookups/citizenship	—
get-client-settings	read	GET	/epps/v2/lookups/clientSettings	—
get-commitment-types	read	GET	/epps/v2/lookups/commitmentTypes	—
epps-get-custom-fields	read	GET	/epps/v2/lookups/customFields	—
delivery-types	read	GET	/epps/v2/lookups/deliveryTypes	—
get-documentation-types	read	GET	/epps/v2/lookups/documentationTypes	—
encompass-elements	read	GET	/epps/v2/lookups/encompassElements	—
foreclosure	read	GET	/epps/v2/lookups/foreclosure	—
investors	read	GET	/epps/v2/lookups/investors	—
lien-position	read	GET	/epps/v2/lookups/lienPos	—
get-loan-limits	read	GET	/epps/v2/lookups/loan/{loanID}/loanLimits	—
loan-terms	read	GET	/epps/v2/lookups/loanTerms	—
loan-usage	read	GET	/epps/v2/lookups/loanUsage	—
lock-days	read	GET	/epps/v2/lookups/lockdays	—
get-non-qm-doc-level	read	GET	/epps/v2/lookups/nonQMDocLevel	—
prepay-penalty-terms	read	GET	/epps/v2/lookups/prepayPenaltyTerms	—
product-options	read	GET	/epps/v2/lookups/productOptions	—
property-types	read	GET	/epps/v2/lookups/propertyTypes	—
property-use	read	GET	/epps/v2/lookups/propertyUse	—
special-products	read	GET	/epps/v2/lookups/specialProducts	—
standard-products	read	GET	/epps/v2/lookups/standardProducts	—
counties	read	GET	/epps/v2/lookups/state/{stateId}/counties	—
states	read	GET	/epps/v2/lookups/states	—
get-unit-types	read	GET	/epps/v2/lookups/unitTypes	—
get-locations	read	GET	/epps/v2/lookups/zipcodes/{zipCode}/locations	—
get-guidelines	read	GET	/epps/v2/programs/{programID}/guidelines/details/{qualificationID}	—
get-user-mapping-1	read	GET	/epps/v2/userMappings	—
map-epps-user	admin, delete, write	PATCH	/epps/v2/userMappings	—
get-loan-opportunities	read	GET	/loanOpportunity/v1/loanOpportunities	—
create-loan-opportunity	write	POST	/loanOpportunity/v1/loanOpportunities	—
convert-loan-opportunity	write	POST	/loanOpportunity/v1/loanOpportunities/opportunityContractGenerator	—
create-a-document	write	POST	/loanOpportunity/v1/loanOpportunities/{OpportunityId}/documents	—
convert-scenario-to-loan	read	GET	/loanOpportunity/v1/loanOpportunities/{OpportunityId}/scenarios/{ScenarioId}/loanContractGenerator	—
delete-loan-opportunity	delete	DELETE	/loanOpportunity/v1/loanOpportunities/{opportunityId}	—
get-a-loan-opportunity	read	GET	/loanOpportunity/v1/loanOpportunities/{opportunityId}	—
update-loan-opportunity-1	write	PATCH	/loanOpportunity/v1/loanOpportunities/{opportunityId}	—
update-loan-opportunity	write	PUT	/loanOpportunity/v1/loanOpportunities/{opportunityId}	—
get-a-document	read	GET	/loanOpportunity/v1/loanOpportunities/{opportunityId}/documents/{documentId}	—
update-a-document	write	PATCH	/loanOpportunity/v1/loanOpportunities/{opportunityId}/documents/{documentId}	—
create-a-notification	send, write	GET	/loanOpportunity/v1/loanOpportunities/{opportunityId}/notifications	—
create-a-notification-post	send, write	POST	/loanOpportunity/v1/loanOpportunities/{opportunityId}/notifications	ICE documents this request only as a GET with a body. The POST form is cataloged with the GET’s families so a POST to the route is classified, not left unclassified; ICE does not document whether it serves the POST form
get-a-scenario	read	GET	/loanOpportunity/v1/loanOpportunities/{opportunityId}/scenarios	—
create-a-scenario	write	POST	/loanOpportunity/v1/loanOpportunities/{opportunityId}/scenarios	—
delete-a-scenario	delete	DELETE	/loanOpportunity/v1/loanOpportunities/{opportunityId}/scenarios/{scenarioId}	—
get-a-scenario-1	read	GET	/loanOpportunity/v1/loanOpportunities/{opportunityId}/scenarios/{scenarioId}	—
updates-a-scenario	write	PATCH	/loanOpportunity/v1/loanOpportunities/{opportunityId}/scenarios/{scenarioId}	—
update-a-scenario	write	PUT	/loanOpportunity/v1/loanOpportunities/{opportunityId}/scenarios/{scenarioId}	—
get-loan-opportunities-with-search	read	GET	/loanOpportunity/v1/loanOpportunitySelector	—
get-affordability-qualification	read	GET	/loanOpportunity/v1/settings/affordabilityQualification	—
create-affordability-qualification-setting	admin, write	POST	/loanOpportunity/v1/settings/affordabilityQualification	—
delete-affordability-qualification	admin, delete	DELETE	/loanOpportunity/v1/settings/affordabilityQualification/{affordabilityQualificationId}	—
update-affordabilityqualification	admin, write	PUT	/loanOpportunity/v1/settings/affordabilityQualification/{affordabilityQualificationId}	—
get-email-templates	read	GET	/loanOpportunity/v1/settings/emailTemplates	—
create-new-email-template	admin, write	POST	/loanOpportunity/v1/settings/emailTemplates	—
delete-an-email-template	admin, delete	DELETE	/loanOpportunity/v1/settings/emailTemplates/{templateId}	—
get-email-template-details	read	GET	/loanOpportunity/v1/settings/emailTemplates/{templateId}	—
update-email-template	admin, write	PUT	/loanOpportunity/v1/settings/emailTemplates/{templateId}	—
get-feature-management	read	GET	/loanOpportunity/v1/settings/featureManagement	—
update-feature-management	admin, write	PATCH	/loanOpportunity/v1/settings/featureManagement	—
create-new-feature	admin, write	POST	/loanOpportunity/v1/settings/featureManagement	—
delete-a-feature-management-setting	admin, delete	DELETE	/loanOpportunity/v1/settings/featureManagement/{featureManagementId}	—
update-a-feature	admin, write	PUT	/loanOpportunity/v1/settings/featureManagement/{featureManagementId}	—
get-letter-template	read	GET	/loanOpportunity/v1/settings/letterTemplates	—
create-a-new-letter-template	admin, write	POST	/loanOpportunity/v1/settings/letterTemplates	—
delete-a-letter-template	admin, delete	DELETE	/loanOpportunity/v1/settings/letterTemplates/{templateId}	—
get-letter-template-details	read	GET	/loanOpportunity/v1/settings/letterTemplates/{templateId}	—
update-existing-letter-template	admin, write	PUT	/loanOpportunity/v1/settings/letterTemplates/{templateId}	—
oauth2-token	admin	POST	/oauth2/v1/token	refused by default: leaves the caller holding a provider credential (a credential_minting rule can allow it); served by the provider but absent from its published spec
oauth2-token-introspection	admin	POST	/oauth2/v1/token/introspection	refused by default: leaves the caller holding a provider credential (a credential_minting rule can allow it); served by the provider but absent from its published spec
oauth2-token-revocation	admin, delete	POST	/oauth2/v1/token/revocation	served by the provider but absent from its published spec
create-a-session	write	POST	/pos/v1/sessions	refused by default: leaves the caller holding a provider credential (a credential_minting rule can allow it)
create-account-link	admin, write	POST	/scim2/v1/accountLinks	—
delete-account-link	admin, delete	DELETE	/scim2/v1/accountLinks/{globalUserId}	—
get-linked-accounts	read	GET	/scim2/v1/accountLinks/{globalUserId}	—
link-user-to-existing-guid	admin, write	PATCH	/scim2/v1/accountLinks/{globalUserId}	—
get-user-groups	read	GET	/scim2/v1/groups	—
get-user-group	read	GET	/scim2/v1/groups/{groupId}	—
update-user-group	admin, write	PATCH	/scim2/v1/groups/{groupId}	—
get-users	read	GET	/scim2/v1/users	—
create-user	admin, write	POST	/scim2/v1/users	—
delete-user	admin, delete	DELETE	/scim2/v1/users/{globalUserId}	—
get-user	read	GET	/scim2/v1/users/{globalUserId}	—
update-user	admin, write	PATCH	/scim2/v1/users/{globalUserId}	—
get-trade-pipeline-of-correspondent-trade	read	POST	/secondary/v1/tradePipeline	—
get-field-definitions	read	GET	/secondary/v1/tradePipeline/canonicalFields	—
create-a-correspondent-trade	payment, write	POST	/secondary/v1/trades/correspondent	—
get-correspondent-trade	read	GET	/secondary/v1/trades/correspondent/{tradeId}	—
update-a-correspondent-trade	payment, write	PATCH	/secondary/v1/trades/correspondent/{tradeId}	—
get-event-history	read	GET	/secondary/v1/trades/correspondent/{tradeId}/eventHistory	—
delete-correspondent-trade	delete, payment	DELETE	/secondary/v1/trades/correspondent/{tradeId}/loans	—
assign-loans-to-correspondent-trade	payment, write	PUT	/secondary/v1/trades/correspondent/{tradeId}/loans	—
extend-a-correspondent-trade	payment, write	PUT	/secondary/v1/trades/correspondent/{tradeId}/loans/extend	—
update-assigned-loans-in-a-correspondent-trade	payment, write	PUT	/secondary/v1/trades/correspondent/{tradeId}/loans/update	—
get-correspondent-trade-notes	read	GET	/secondary/v1/trades/correspondent/{tradeId}/notes	—
update-a-note	write	PATCH	/secondary/v1/trades/correspondent/{tradeId}/notes	—
create-trade-note	write	PUT	/secondary/v1/trades/correspondent/{tradeId}/notes	—
get-correspondent-trade-statistics	read	GET	/secondary/v1/trades/correspondent/{tradeId}/statistics	—
generate-download-url	read	POST	/secondary/v1/trades/downloadUrlGenerator	—
create-loan-trade	payment, write	POST	/secondary/v1/trades/loanTrades	—
assign-loans-to-a-loan-trade	payment, write	PUT	/secondary/v1/trades/loanTrades/loans/{tradeId}	—
get-loan-trade	read	GET	/secondary/v1/trades/loanTrades/{tradeId}	—
update-loan-trade	payment, write	PATCH	/secondary/v1/trades/loanTrades/{tradeId}	—
manage-loan-trade-documents	delete, write	PATCH	/secondary/v1/trades/loanTrades/{tradeId}/documents	—
get-loan-trade-document	read	POST	/secondary/v1/trades/loanTrades/{tradeId}/documents	—
unassign-loans-from-a-loan-trade	delete, payment	DELETE	/secondary/v1/trades/loanTrades/{tradeId}/loans	—
assign-loans-to-a-loan-trade-alternate-path	payment, write	PUT	/secondary/v1/trades/loanTrades/{tradeId}/loans	The API reference documents this operation at /secondary/v1/trades/loanTrades/loans/{tradeId} and ICE’s 26.1 release notes at this path; ICE does not say which it serves, so both are cataloged with the same families and parameters
update-assigned-loans-in-a-loan-trade	payment, write	PUT	/secondary/v1/trades/loanTrades/{tradeId}/loans/update	—
generate-upload-url	write	POST	/secondary/v1/trades/urlGenerator	—
order-services	payment, send, write	POST	/services/v1/partners/{partnerId}/transactions	—
get-service-order-status	read	GET	/services/v1/partners/{partnerId}/transactions/{transactionId}	—
export-loan-to-mismo-34	read	GET	/services/v1/transformer	—
202-get-all-events	read	GET	/webhook/v1/events	—
get-an-event	read	GET	/webhook/v1/events/{eventId}	—
get_webhook-v1-functions-auth	read	GET	/webhook/v1/functions/auth	—
post_webhook-v1-functions-auth	admin, write	POST	/webhook/v1/functions/auth	—
delete_webhook-v1-functions-auth-functionid	admin, delete	DELETE	/webhook/v1/functions/auth/{functionId}	—
patch_webhook-v1-functions-auth-functionid	admin, write	PATCH	/webhook/v1/functions/auth/{functionId}	—
put_webhook-v1-functions-auth-functionid	admin, write	PUT	/webhook/v1/functions/auth/{functionId}	—
post_webhook-v1-functions-auth-functionid-test	admin, write	POST	/webhook/v1/functions/auth/{functionId}/test	—
get-all-resources	read	GET	/webhook/v1/resources	—
get-a-resource	read	GET	/webhook/v1/resources/{name}	—
get-resource-events	read	GET	/webhook/v1/resources/{resourceName}/events	—
get-all-subscriptions	read	GET	/webhook/v1/subscriptions	—
create-a-subscription	admin, send, write	POST	/webhook/v1/subscriptions	—
delete-subscription	admin, delete	DELETE	/webhook/v1/subscriptions/{subscriptionId}	—
get-a-subscription	read	GET	/webhook/v1/subscriptions/{subscriptionId}	—
update-subscription	admin, send, write	PUT	/webhook/v1/subscriptions/{subscriptionId}	—
get_webhook-v1-subscriptions-subscriptionid-functions-auth	read	GET	/webhook/v1/subscriptions/{subscriptionId}/functions/auth	—
delete_webhook-v1-subscriptions-subscriptionid-functions-auth-functionid	admin, delete	DELETE	/webhook/v1/subscriptions/{subscriptionId}/functions/auth/{functionId}	—
patch_webhook-v1-subscriptions-subscriptionid-functions-auth-functionid	admin, write	PATCH	/webhook/v1/subscriptions/{subscriptionId}/functions/auth/{functionId}	—
get-workflow-v1-settings-task	read	GET	/workflow/v1/settings/task	—
update-task-settings	admin, write	PUT	/workflow/v1/settings/task	—
get-task-pipeline	read	GET	/workflow/v1/taskPipeline	—
get-tasks	read	GET	/workflow/v1/tasks	—
update-tasks	write	PATCH	/workflow/v1/tasks	—
create-a-task	write	POST	/workflow/v1/tasks	—
tasks-bulk-update	write	PATCH	/workflow/v1/tasks/bulk	—
delete-a-task	delete	DELETE	/workflow/v1/tasks/{id}	—
get-a-task	read	GET	/workflow/v1/tasks/{id}	—
update-a-task	write	PATCH	/workflow/v1/tasks/{id}	—
get-comments-for-a-task	read	GET	/workflow/v1/tasks/{id}/comments	—
add-a-comment-to-a-task	write	POST	/workflow/v1/tasks/{id}/comments	—
get-subtasks	read	GET	/workflow/v1/tasks/{taskId}/subtasks	—
create-a-subtask	write	POST	/workflow/v1/tasks/{taskId}/subtasks	—
delete-a-subtask	delete	DELETE	/workflow/v1/tasks/{taskId}/subtasks/{subTaskId}	—
get-a-subtask	read	GET	/workflow/v1/tasks/{taskId}/subtasks/{subTaskId}	—
update-a-task-1	write	PATCH	/workflow/v1/tasks/{taskId}/subtasks/{subTaskId}	—
get-comments-for-a-subtask	read	GET	/workflow/v1/tasks/{taskId}/subtasks/{subTaskId}/comments	—
add-a-comment-to-a-subtask	write	POST	/workflow/v1/tasks/{taskId}/subtasks/{subTaskId}/comments	—
get-all-templates	read	GET	/workflow/v1/templates/task/items	—
update-templates	admin, write	PATCH	/workflow/v1/templates/task/items	—
create-a-template	admin, write	POST	/workflow/v1/templates/task/items	—
delete-a-template	admin, delete	DELETE	/workflow/v1/templates/task/items/{id}	—
get-a-template-1	read	GET	/workflow/v1/templates/task/items/{id}	—
update-a-template	admin, write	PATCH	/workflow/v1/templates/task/items/{id}	—
get-subtask-templates	read	GET	/workflow/v1/templates/task/items/{taskTemplateId}/subtasks	—
create-a-subtask-template	admin, write	POST	/workflow/v1/templates/task/items/{taskTemplateId}/subtasks	—
delete-a-subtask-template	admin, delete	DELETE	/workflow/v1/templates/task/items/{taskTemplateId}/subtasks/{subTaskTemplateId}	—
get-a-subtask-template	read	GET	/workflow/v1/templates/task/items/{taskTemplateId}/subtasks/{subTaskTemplateId}	—
update-a-subtask-template	admin, write	PATCH	/workflow/v1/templates/task/items/{taskTemplateId}/subtasks/{subTaskTemplateId}	—