API Reference

Transaction Events

[
  {
    "id": "e95f6f0e-85b2-43f3-bc56-0fb19944e823",
    "text": "Transaction Request Created",
    "type": "urn:elli:epc:transaction:request:created",
    "from": "System",
    "sent": "2020-02-10T05:56:28Z"
  },
  {
    "id": "cb140fdb-e208-48a7-83bf-181933bee8fd",
    "text": "Inspection Scheduled",
    "type": "urn:elli:epc:partner:appraisal:scheduled",
    "from": "Donald Duck",
    "sent": "2020-02-12T14:48:00Z",
    "comments": "Appraisal appointment scheduled for 02/14 at 16:00 PST"
  },
  {
    "id": "699a501b-2927-47cf-a69e-aafa263af54d",
    "text": "Transaction Response Updated",
    "type": "urn:elli:epc:transaction:response:updated",
    "from": "System",
    "sent": "2020-02-15T19:00:04Z",
    "resources": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "AppraisalReport.pdf",
        "mimeType": "application/pdf",
        "location": "https://int.streaming.us-west-2.skydrive.rd.elliemae.io/v1/clients/3010000024/fb276d5f-4132-4250-bd90-3769e59ee45a?validity=MTU4OTk0NzYwMzY3OQ%3D%3D",
        "authorization": "elli-signature 4D5ABB6321901B871A37DC04C7080DC26CDFB58F5186B6D006195498FE5A0F389E8ADBAF827DF59A756F3E13FE151DABF1D7CC6779DE58B9D40112129256111D"
      }
    ]
  },
  {
    "text": "Transaction response successfully processed",
    "type": "urn:elli:epc:transaction:response:processed",
    "from": "System",
    "sent": "2020-02-15T19:00:10Z",
    "comments": "Transaction response successfully processed"
  }
]

Transaction events are a flexible mechanism for ancillary communication in regards to the parent transaction. Although there are a couple of standard events in a transactions life-cycle that are generated by the System, custom events can be created by both the lender and the partner during the life of a transaction, even after it has been marked completed. All transaction events must belong to a supported type, and at a minimum contain a title (text) along with information about the sender. Events can optionally contain more detailed comments as well as resources - or file attachments.

👍

Try It!

Replace the access_token you generated using the oAuth2 RESTful API with the placeholder value in the Authorization request header inputs below, and click on the 🧭 Try It button to see the transactions API endpoints in action!