---
title: "Retrieve a specific transaction"
method: GET
path: "/transactions/{transaction_id}"
tags: ["Transaction Request"]
---

# Retrieve a specific transaction

`GET /transactions/{transaction_id}`

Retrieve a specific transaction initiated against a product

## Path parameters

- `transaction_id` string, uuid, required — Unique identifier (GUID) for the subject resource

## Headers

- `Authorization` string, required

## Response `200`

A transaction resource

- Transaction — Transaction Resource
  - `id` string, uuid — Unique identifier (GUID) for the subject resource
  - `status` 'pending' | 'completed' — Transaction Status
  - `clientId` string — Unique identifier for requesting organization
  - `entityRef` EntityRef — Source loan data entity reference
    - `entityId` string — Source loan data entity identifier
    - `entityType` 'urn:elli:encompass:loan' — Source loan data entity type
  - `product` ProductTransactionView
    - `id` string, uuid — Unique identifier (GUID) for the subject resource
    - `partnerId` PartnerId — unresolved $ref
    - `name` Name — unresolved $ref
  - `environment` Environment — unresolved $ref
  - `application` 'urn:elli:application:encompass' | 'urn:elli:application:loconnect' | 'urn:elli:application:consumerconnect' | 'urn:elli:application:tpoconnect' | 'urn:elli:application:developerconnect' — Originating Encompass application
  - `orderType` 'MANUAL' | 'ONECLICK' | 'AUTOMATED' — Order Type
  - `request` TransactionRequest — Transaction Request
    - `type` string — A specific type of transaction request lenders/borrowers can initiate with the subject product. Data entitlements for the product are indexed around each request type.
    - `requestingParty` Organization — Originating/requesting organization information
      - `name` string — Organization Name
      - `address` string — Organization Street Address
      - `city` string — Organization City
      - `state` string — Organization State
      - `postalCode` string — Organization Postal Code
      - `pointOfContact` User — Originating/requesting user information
        - `name` string — User Name
        - `role` string — User Role
        - `email` string — User Email
        - `phone` string — User Phone Number
    - `credentials` Credentials — User/organization product credentials
    - `loanFormat` 'application/vnd.plm-2.0.0+json' — Loan data representation format
    - `loan` object — Loan data object
    - `resources` TransactionResource[] — Transaction Request Resources
      - `name` string, required — Resource name including extension
      - `mimeType` 'text/plain' | 'application/xml' | 'application/json' | 'image/jpeg' | 'image/png' | 'image/bmp' | 'image/gif' | 'application/msword' | 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' | 'text/html' | 'application/vnd.ms-xpsdocument' | 'application/emf' | 'application/zip' | 'application/pdf' | 'text/csv', required — Resource MIME type
      - `type` string — Type of resource - must be one of the resource types that the product is entitled to deliver for the subject request type, as defined in its data entitlements
      - `id` string, uuid, required — EPC generated UUID for the subject resource
    - `options` object — Transaction request options
  - `response` TransactionResponse — Transaction response
    - `status` 'processing' | 'completed' | 'failed' | 'canceled' | 'inputRequired', required — Transaction response status as canonicalized by EPC
    - `referenceNumber` string, required — External reference for the transaction as maintained by the Partner
    - `partnerStatus` string — Transaction status as maintained by the Partner
    - `respondingParty` Organization — Originating/requesting organization information
      - `name` string — Organization Name
      - `address` string — Organization Street Address
      - `city` string — Organization City
      - `state` string — Organization State
      - `postalCode` string — Organization Postal Code
      - `pointOfContact` User — Originating/requesting user information
        - `name` string — User Name
        - `role` string — User Role
        - `email` string — User Email
        - `phone` string — User Phone Number
    - `loanFormat` 'application/vnd.plm-2.0.0+json' — Loan data representation format
    - `loan` object — Loan data object
    - `resources` TransactionResource[] — Transaction Response Resources
      - `name` string, required — Resource name including extension
      - `mimeType` 'text/plain' | 'application/xml' | 'application/json' | 'image/jpeg' | 'image/png' | 'image/bmp' | 'image/gif' | 'application/msword' | 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' | 'text/html' | 'application/vnd.ms-xpsdocument' | 'application/emf' | 'application/zip' | 'application/pdf' | 'text/csv', required — Resource MIME type
      - `type` string — Type of resource - must be one of the resource types that the product is entitled to deliver for the subject request type, as defined in its data entitlements
      - `id` string, uuid, required — EPC generated UUID for the subject resource
    - `result` TransactionResponseResult — Transaction Response Result
      - `resultFormat` 'application/vnd.productpricing-lock-1.0.0.json' | 'application/vnd.productpricing-extendlock-1.0.0.json' | 'application/vnd.productpricing-relock-1.0.0.json' | 'application/vnd.productpricing-cancellock-1.0.0.json' | 'application/vnd.productpricing-lock-and-confirm-1.0.0.json', required — One of an enumerated set of supported custom transaction result formats
      - `action` 'LOCK' | 'RELOCK' | 'EXTEND' | 'CANCEL' | 'LOCK_CONFIRM', required — One of an enumerated set of resulting actions initiated by a custom transaction result
      - `details` object, required — Object encapulating details pertinent to the resulting action
    - `errors` ErrorModel[] — Errors
      - `code` string, required — Unique code for the error
      - `description` string, required — Human-friendly description for the error
      - `type` 'system' — Error type
      - `fieldId` string — Resource field related to the error
      - `resourceId` 'TRANSACTION' | 'PRODUCT' | 'ORIGIN', required — Resource related to the error
    - `inputRequired` TransactionInputRequired[] — Transaction data input required as reported by the Partner
      - `name` string — Input Required Item name
      - `type` 'field' | 'resource' — Input Required Item Type
      - `value` string — Input Required Item Current Value
      - `description` string — Input Required Item Description
      - `jsonPath` string — Input Required field JSON Path
  - `events` TransactionEvent[] — Transaction Events
    - `id` string, uuid — EPC generated UUID for the event
    - `text` string — Event text
    - `type` string — Event type URN
    - `from` string — Event sender identifier
    - `sent` string, date-time — Event sent ISO 8601 UTC time-stamp
    - `comments` string — Event free-form comments
    - `resources` TransactionResource[] — Event resources
      - `name` string, required — Resource name including extension
      - `mimeType` 'text/plain' | 'application/xml' | 'application/json' | 'image/jpeg' | 'image/png' | 'image/bmp' | 'image/gif' | 'application/msword' | 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' | 'text/html' | 'application/vnd.ms-xpsdocument' | 'application/emf' | 'application/zip' | 'application/pdf' | 'text/csv', required — Resource MIME type
      - `type` string — Type of resource - must be one of the resource types that the product is entitled to deliver for the subject request type, as defined in its data entitlements
      - `id` string, uuid, required — EPC generated UUID for the subject resource
  - `created` string, date-time — Resource created/updated time-stamp (IS0 8601 UTC)
  - `createdBy` string — Entity that created/updated the subject resource
  - `updated` string, date-time — Resource created/updated time-stamp (IS0 8601 UTC)
  - `updatedBy` string — Entity that created/updated the subject resource

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.dev/elliemae/apis/oauth2-restful-api.md) · [All operations](https://skmtc.dev/elliemae/apis/oauth2-restful-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/elliemae/oauth2-restful-api/revisions/f1196f5edd58/schema)