"status": "completed",
  "referenceNumber": "TWX104356",
  "partnerStatus": "Appraisal Report Delivered",
  "respondingParty": {
    "name": "AAA Appraisers",
    "address": "3232 Loan Ave",
    "city": "Pleasanton",
    "state": "CA",
    "postalCode": "94588",
    "pointOfContact": {
      "name": "Scott Cooper",
      "email": "[email protected]",
      "phone": "343-555-1954"
  "loanFormat": "application/vnd.plm-2.0.0+json",
  "loan": {
    "propertyAppraisedValueAmount": "500000",
    "underwriterSummary": {
      "appraisalType": "Form 1004 appraisal with interior/exterior",
      "appraisalCompletedDate": "2020-04-24T19:00:04Z"
  "resources": [
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "AppraisalReport.pdf",
      "mimeType": "application/pdf"

The transaction response is owned and updated by the partner. It comprises of the partners canonical response status, the partners internal partnerStatus and referenceNumber for the transaction, response loan data and resources (file attachments), contact information for the fulfilling organization, or any errors and requests for input needed from the lender to continue with fulfillment.

As we covered earlier, partners can communicate the completion of a transaction by setting their response status to completed, along with sending response data/documents for the lender. If fulfillment is not an immediate process, partners can first acknowledge their intent to proceed with the transaction by setting their response status to processing - before eventually sending their completed response. Transactions can also be canceled, have failed due to processing errors on the partners end, or have lender inputRequired before continuing with fulfillment. Both cancellations and failures set the transaction status to completed, allowing no more updates to the request or response. However, communication in regards to the transactions resolution can still occur via transaction events, which we will cover next.


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!