generated: '2026-07-15'
method: generated
source: openapi/encompass-openapi.yml
description: Recommended x-agentic-access execution contracts, classified heuristically from
  the OpenAPI. A governance starting point for exposing this API to AI agents — review and bind
  audience per deployment. See research/curity/agentic-governance/.
summary:
  operations: 43
  by_action_class:
    acting: 21
    connected: 22
  by_consequence:
    write: 21
    read: 22
  human_in_the_loop_required: 0
operations:
- path: /oauth2/v1/token
  method: post
  operationId: getToken
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /encompass/v3/loans
  method: post
  operationId: createLoan
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /encompass/v3/loans/{loanId}
  method: get
  operationId: getLoan
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /encompass/v3/loans/{loanId}
  method: patch
  operationId: updateLoan
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /encompass/v3/loans/{loanId}
  method: delete
  operationId: deleteLoan
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /encompass/v3/loans/{loanId}/ucdFields
  method: get
  operationId: getLoanUcdFields
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /encompass/v1/loans/{loanId}/moveToFolder
  method: patch
  operationId: moveLoanToFolder
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /encompass/v3/loanPipeline
  method: post
  operationId: viewPipeline
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /encompass/v3/loanPipeline/cursor
  method: post
  operationId: createPipelineCursor
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /encompass/v3/loanPipeline/canonicalNames
  method: get
  operationId: getPipelineCanonicalNames
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /encompass/v3/loans/{loanId}/applications
  method: get
  operationId: listBorrowerPairs
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /encompass/v3/loans/{loanId}/applications
  method: post
  operationId: createBorrowerPair
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /encompass/v3/loans/{loanId}/applications/{applicationId}
  method: get
  operationId: getBorrowerPair
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /encompass/v3/loans/{loanId}/applications/{applicationId}
  method: delete
  operationId: deleteBorrowerPair
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /encompass/v1/borrowerContacts
  method: get
  operationId: listBorrowerContacts
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /encompass/v1/borrowerContacts
  method: post
  operationId: createBorrowerContact
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /encompass/v1/borrowerContacts/{contactId}
  method: get
  operationId: getBorrowerContact
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /encompass/v1/borrowerContacts/{contactId}
  method: patch
  operationId: updateBorrowerContact
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /encompass/v1/businessContacts
  method: get
  operationId: listBusinessContacts
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /encompass/v1/businessContacts
  method: post
  operationId: createBusinessContact
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /encompass/v3/loans/{loanId}/documents
  method: get
  operationId: listEfolderDocuments
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /encompass/v3/loans/{loanId}/documents
  method: post
  operationId: createEfolderDocument
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /encompass/v3/loans/{loanId}/attachments
  method: get
  operationId: listEfolderAttachments
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /encompass/v3/loans/{loanId}/attachments/{attachmentId}
  method: get
  operationId: getEfolderAttachment
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /encompass/v3/loans/{loanId}/milestones
  method: get
  operationId: listMilestones
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /encompass/v3/loans/{loanId}/milestones/{milestoneId}
  method: patch
  operationId: updateMilestone
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /encompass/v3/loans/{loanId}/associates
  method: get
  operationId: listLoanAssociates
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /encompass/v1/loans/{loanId}/conditions/underwriting
  method: get
  operationId: listUnderwritingConditions
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /encompass/v1/loans/{loanId}/conditions/underwriting
  method: post
  operationId: createUnderwritingCondition
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /encompass/v1/loans/{loanId}/conditions/underwriting/{conditionId}
  method: patch
  operationId: updateUnderwritingCondition
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /encompass/v1/users
  method: get
  operationId: listUsers
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /encompass/v1/users
  method: post
  operationId: createUser
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /encompass/v1/users/{userId}
  method: get
  operationId: getUser
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /encompass/v1/users/{userId}
  method: patch
  operationId: updateUser
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /webhook/v1/subscriptions
  method: get
  operationId: listWebhookSubscriptions
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /webhook/v1/subscriptions
  method: post
  operationId: createWebhookSubscription
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /webhook/v1/subscriptions/{id}
  method: get
  operationId: getWebhookSubscription
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /webhook/v1/subscriptions/{id}
  method: put
  operationId: updateWebhookSubscription
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /webhook/v1/subscriptions/{id}
  method: delete
  operationId: deleteWebhookSubscription
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /webhook/v1/resources
  method: get
  operationId: listWebhookResources
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /webhook/v1/resources/{id}/events
  method: get
  operationId: getWebhookResourceEvents
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /webhook/v1/events
  method: get
  operationId: listWebhookEvents
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /webhook/v1/events/{id}
  method: get
  operationId: getWebhookEvent
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none