Appraisal Partners and Samples

Use the Services API to submit Appraisal requests and retrieve Appraisal reports from service partners and their affiliated Appraisal Management Companies (AMC's).

This page contains the common product attributes used by Appraisal service partners, as well as attributes and samples that are specific to each service partner.

Appraisal Partner Attributes

The attributes listed in the following table are required by all Appraisal service partners unless otherwise specified.

ATTRIBUTE	DESCRIPTION
entityRef object	References the entity ID and entity type. Since this is a loan-level service, a specific borrower pair does not need to be referenced in the service request. Both entity ID and entity type are returned by getLoan.
entityRef.entityId string	The entity identifier. For example, the loan ID: {loanId}
entityRef.entityType string	The type of entity expressed in URN format. For example: urn:elli:encompass:{loanId}
name string	Name of the service to order. See the Appraisal Partner Information section to get the correct name value for the partner; either the Transaction_Resource object or Transaction object name.

credentials object	Object that encapsulates credentials and/or verification information with the Appraisal service provider.
credentials.userName string	Username for the service provider account.
credentials.password string	Password for the service provider account.

credentialStore string	Optional. Indicates that the API user will use credentials stored in the Encompass Services Password Manager at a user-level. Currently, user is the only supported value. Note: The credentials object and the credentialStore attribute can not be passed simultaneously in a request - they are mutually exclusive.

options object	Important! The parameters defined by the options object may be different depending on the service provider you choose. To view options attributes and samples for Mercury Network, see Mercury Network Product Attributes.

resources object	Optional. This object contains the resources (documents and attachments) associated with the loan that are being shared with the service partner with respect to the service request. You may send documents and attachments if necessary.
resources.entityId string	Optional. The entity identifier for the resource. If the resource you are passing is an eFolder attachment, the attachmentId is required. If the resource you are passing is an eFolder document, the documentId is required. You can retrieve these from using the eFolder Attachment and eFolder Document APIs.
resources.entityType string	Optional. The entity type/format of the resource. Possible values include: For an Encompass eFolder attachment: urn:elli:encompass:attachment For and Encompass eFolder document: urn:elli:encompass:document

Appraisal Partner Information

Use the Product Name listed under the Transaction_Resource or Transaction columns to create transactions that follow the respective schema.

Partner Name	Partner ID	Product Name - Transaction_Resource	Product Name Transaction
Mercury Network	11158174	Appraisal-MercuryNetwork	Appraisal

Mercury Network Appraisal Service

Mercury Network Appraisal Service Product Attributes

The following section contains the request attributes used by the Mercury Network appraisal service and includes sample requests demonstrating their use.

ATTRIBUTE	DESCRIPTION
credentials.accountId string	The identifier that Mercury Network assigns to identify your organization on their platform. If you would like to retrieve your Mercury account ID, please contact Mercury Network .

options.requestType string	Type of appraisal service request. Possible values are: feeQuote: to request a rate quote for the appraisal service. The rate quote request itself is free of cost. newOrder: to request a new appraisal service for the property as listed on the loan. checkStatus: to retrieve the status of an existing order. existingOrder: to update an existing order with new product options. To make an update, the user must pass the tracking ID attribute of the existing order (options.trackingID).
options.trackingID string	Conditionally Required. Tracking ID of an existing appraisal service order with Mercury Network. The tracking ID is assigned by Mercury Network when a new service order is initiated. It is returned in the response. To place a new service order that refers to an existing order ("requestType": "existingOrder"), the Tracking ID must be provided.
options.productID string	The ID of the product to use from the Appraisal Management Company (AMC) via Mercury. Contact Mercury Network to obtain the list of product identifiers your organization is entitled to.
options.clientGroup string	Conditionally Required. An Appraisal Management Company that is exposing its services via Mercury Network has the option to group its clients so that it can differentiate its product offerings/services. This attribute is therefore an identifier assigned by Mercury Network to recognize the client group the lending organization belongs to. Contact Mercury Network to obtain the client group(s) your organization belongs to.
options.amc string	Conditionally Required. Identifier that Mercury Network assigns to the various Appraisal Management Companies that are exposing their appraisal services via Mercury. The list of AMC's that a client is entitled to place a service request with may differ across different client groups. Make sure you are using a valid combination of "clientGroup" and "amc", and contact Mercury Network to find which AMC's your client group(s) are entitled to.
options.intendToProceedReceivedDate string	Optional. The date on which the lending organization received intent from the borrower/consumer to proceed with the loan.
options.disclosureDate string	Optional. The date on which all loan related documents/fees are disclosed and acknowledged by the borrower/consumer.
options.earlyAppraisalConsent boolean	Optional. Whether or not consent for an early appraisal has been received by the lending organization from the borrower/consumer.
options.orderedBy string	Optional. The loan officer who has initiated the appraisal service request.
options.notificationEmail string	Optional. The lending organization's email that Mercury Network will send notifications to.
options.dueDate string	Optional. The date by which the lending organization would like to receive a completed appraisal report.
options.rushOrder boolean	Optional. Whether or not to place a rush order/expedited appraisal processing.
options.complex boolean	Optional. Whether or not to request a complex appraisal report with more valuation details.
options.loanPurpose string	Optional. The purpose of the loan. Possible values are: Construction Construction Permanent HELOC OREO/SAD Purchase Refinance Renewal Second Mortgage * Other
options.loanType string	Optional. The specific type of loan. Possible values are: All In One Alt QM Agency Alt QM Income Alt QM Investor Alt QM Jumbo CMBS CMHC Commercial - other Construction financing Conventional FHA FHA 203(k) Limited FHA 203(k) Standard FHA 223(f) FSA/RHS/FmHA HARP 2 Home Equity Home Ownership Accel HomeStyle Renovation Jumbo Mezzanine financing One Time Close Other Reverse Mortgage SBA 504 SBA 7A Section 184 USDA * VA
options.occupancy string	Optional. The occupancy type of the property being appraised. Possible values are: New Construction Not Applicable Owner Owner's Second Home Tenant Vacant
options.propertyType string	The type of property being appraised. Possible values are: 2 to 4 Unit Building 5+ Unit Building Agricultural Apartment Assembly/Meeting Place Attached Commercial (Non-Residential) Commercial (other) Condominium Condotel Cooperative Detached Detached PUD Duplex Healthcare Industrial Lodging & Hospitality Manufactured Home Mixed Use (Residential) Mobile Home (Moveable) Mobile Home (Permanent) Modular Home Multi Family Residence Office Other Planned Unit Development Platted Quad Retail/Restaurant Senior Housing Shopping Center Single Family Special Purpose Sports & Entertainment Townhouse Triplex UnPlatted Vacant Land * Vacant Lot
options.propertyRights string	Optional. The legal apparatus by which the occupant of the property rightfully resides within it
options.contacts object	Optional. Contact information to be made available to the Appraisal Management Company executing the service request. Note: Contact information that resides in the loan will not be used as a part of the appraisal request. Contact information needs to be passed in this object.
options.contacts.contact object	Optional. The primary contacts in the appraisal process - borrower, coborrower, agent, broker, occupant and/or other.
options.contacts.contact.borrower object	Optional. The borrower contact.
options.contacts.contact.borrower.name string	Optional. The borrower's name.
options.contacts.contact.borrower.workPhone string	Optional. The borrowers work phone number.
options.contacts.contact.borrower.homePhone string	Optional. The borrowers home phone number.
options.contacts.contact.borrower.cellPhone string	Optional. The borrowers cell phone number.
options.contacts.contact.borrower.email string	Optional. The borrowers email address.
options.contacts.contact.borrower.address string	Optional. The borrowers physical address.
options.contacts.contact.borrower.city string	Optional. The borrowers city.
options.contacts.contact.borrower.state string	Optional. The borrowers state.
options.contacts.contact.borrower.zip string	Optional. The borrowers zip code.
options.contacts.contact.coBorrower object	Optional. The co-borrower contact.
options.contacts.contact.coBorrower.name string	Optional. The co-borrowers name.
options.contacts.contact.coBorrower.workPhone string	Optional. The co-borrowers work phone number.
options.contacts.contact.coBorrower.homePhone string	Optional. The co-borrowers home phone number.
options.contacts.contact.coBorrower.cellPhone string	Optional. The co-borrowers cell phone number.
options.contacts.contact.coBorrower.email string	Optional. The co-borrowers email address.
options.contacts.contact.coBorrower.address string	Optional. The co-borrowers physical address
options.contacts.contact.coBorrower.city string	Optional. The co-borrowers city.
options.contacts.contact.coBorrower.state string	Optional. The co-borrowers state.
options.contacts.contact.coBorrower.zip string	Optional. The co-borrowers zip code.
options.contacts.contact.agent object	Optional. The agent contact.
options.contacts.contact.agent.name string	Optional. The agents name.
options.contacts.contact.agent.homePhone string	Optional. The agents home phone number.
options.contacts.contact.agent.workPhone string	Optional. The agents work phone number.
options.contacts.contact.agent.cellPhone string	Optional. The agents cell phone number.
options.contacts.contact.agent.email string	Optional. The agents email address.
options.contacts.contact.occupant object	Optional. The occupant contact.
options.contacts.contact.occupant.name string	Optional. The occupants name.
options.contacts.contact.occupant.homePhone string	Optional. The occupants home phone number.
options.contacts.contact.occupant.workPhone string	Optional. The occupants work phone number.
options.contacts.contact.occupant.cellPhone string	Optional. The Occupants cell phone number.
options.contacts.contact.occupant.email string	Optional. The occupants email address.
options.contacts.contact.owner object	Optional. The owner contact.
options.contacts.contact.owner.name string	Optional. The owners name.
options.contacts.contact.owner.homePhone string	Optional. The owners home phone number.
options.contacts.contact.owner.workPhone string	Optional. The owners work phone number.
options.contacts.contact.owner.cellPhone string	Optional. The owners cell phone number.
options.contacts.contact.owner.email string	Optional. The owners email address.
options.contacts.contact.broker object	Optional. The broker contact.
options.contacts.contact.broker.name string	Optional. The brokers name.
options.contacts.contact.broker.homePhone string	Optional. The brokers home phone number.
options.contacts.contact.broker.workPhone string	Optional. The brokers work phone number.
options.contacts.contact.broker.cellPhone string	Optional. The brokers cell phone number.
options.contacts.contact.broker.email string	Optional. The brokers email address.
options.contacts.contact.broker.branch string	Conditionally Required. The brokers branch identifier. This is required if the broker contact is being passed.
options.contacts.contact.other object	Optional. Any other contact you would like to add and send to the Appraisal Management Company
options.contacts.contact.other.name string	Optional. The contact's name.
options.contacts.contact.other.homePhone string	Optional. The contact's home phone number.
options.contacts.contact.other.workPhone string	Optional. The contact's work phone number.
options.contacts.contact.other.cellPhone string	Optional. The contact's cell phone number.
options.contacts.contact.other.email string	Optional. The contact's email address.
options.contacts.appointmentContact string	Optional. The main point of contact for the Appraisal Management Company from the contacts provided above.
options.payment object	Optional. Object that encapsulates payment information for the appraisal service request.
options.payment.paymentType string	Conditionally Required. The method of payment for the service. This is a mandatory field if the payment object is passed. The possible values for paymentType may be restricted by the client group you belong to and/or the AMC you are placing the appraisal service request with. Contact Mercury Network to see which payment types are supported for your organization. Possible values are: Check C.O.D. Credit Card Money order Net 30 PayPal Invoice Deferred CC
options.payment.accountHolderFirstName string	Optional. Account holder first name.
options.payment.accountHolderMiddleName string	Optional. Account holder middle name.
options.payment.accountHolderLastName string	Optional. Account holder last name.
options.payment.emailToSendReceipt string	Optional. Email where receipt of payment is to be sent.
options.payment.billingAddress string	Optional. Billing address for payment.
options.payment.city string	Optional. City under billing address.
options.payment.state string	Optional. State under billing address.
options.payment.zip string	Optional. Zip code under billing address.

Sample Appraisal Service API Workflow

Unlike other service requests, appraisal service orders are processed in few days and not done in few seconds. This depends upon the vendor's response time.

Notes:

The Order Service API is used to place the service order in Step 1 and also check the status of the vendor's tracking ID as shown in Step 3.
The Get Service Order Status API provides two different types of responses as shown in Step 2 and Step 4.

Step 1: Place a new Appraisal Service order.

{  
   "product":{  
      "entityRef":{  
         "entityId":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
         "entityType":"urn:elli:encompass:loan"
      },
      "name":"APPRAISAL",
      "credentials":{  
         "userName":"[email protected]",
         "password":"xxxxxx",
         "accountId":"xxxxxxx"
      },
      "options":{  
         "requestType":"newOrder",
        
         "productID":"Zero Fee 1004",
         "clientGroup":"297",
         "amc":"1046913",
        
         "intentToProceedReceivedDate":"",
         "disclosureDate":"2017-10-30",
         "earlyAppraisalConsent":true,
         "orderedBy":"Bhagsi",
         "notificationEmail":"[email protected]",
         "dueDate":"2017-10-30",
         "rushOrder":true,
         "complex":true,
        
         "loanPurpose":"Purchase",
         "loanType":"Conventional",
        
         "occupancy":"Owner",
         "propertyRights":"Fee Simple",
         "propertyType":"Apartment",
         "propertyCharacteristics":{  
            "characteristics":[  
               {  
                  "characteristic":"Golf Course"
               },
               {  
                  "characteristic":"Mountain View"
               },
               {  
                  "characteristic":"Waterfront"
               }
            ]
         },
         "contacts":{  
            "appointmentContact":"borrower",
            "contact":{  
               "borrower":{  
                  "name":"",
                  "homePhone":"",
                  "workPhone":"",
                  "cellPhone":"",
                  "email":"",
                  "address":"",
                  "city":"",
                  "state":"",
                  "zip":""
               },
               "coBorrower":{  
                  "name":"",
                  "homePhone":"",
                  "workPhone":"",
                  "cellPhone":"",
                  "email":"",
                  "address":"",
                  "city":"",
                  "state":"",
                  "zip":""
               },
               "agent":{  
                  "name":"AgentName",
                  "homePhone":"123-456-7890",
                  "workPhone":"",
                  "cellPhone":"",
                  "email":"[email protected]"
               },
               "occupant":{  
                  "name":"OccupantName",
                  "homePhone":"",
                  "workPhone":"987-654-3210",
                  "cellPhone":"555-555-5555",
                  "email":""
               },
               "owner":{  
                  "name":"OwnerName",
                  "homePhone":"666-666-6666",
                  "workPhone":"777-777-7777",
                  "cellPhone":"",
                  "email":""
               },
               "other":{  
                  "name":"OtherName",
                  "homePhone":"",
                  "workPhone":"",
                  "cellPhone":"333-333-3333",
                  "email":"[email protected]"
               },
               "broker":{  
                  "name":"BrokerName",
                  "homePhone":"",
                  "workPhone":"666-666-6666",
                  "cellPhone":"",
                  "email":"[email protected]",
                  "branch":"12345"
               }
            }
         },
         "payment":{  
            "paymentType":"Check",
            "paymentFor":"",
            "accountHolderFirstName":"",
            "accountHolderMiddleName":"",
            "accountHolderLastName":"",
            "emailToSendReceipt":null,
            "billingAddress":"",
            "city":"",
            "state":"",
            "zip":""
         }
      },
      "resources":[  
         {  
            "entityId":"Attachment-xxxxxxxx-xxx-xxxx-xxxx-xxxxxxxxxxxxx.pdf",
            "entityType":"urn:elli:encompass:document"
         }
      ]
   }
}

Step 2: Get service order details and tracking ID in response. This call is made using the transaction ID from the response "location" header returned Step 1.

{
  "status": "success",
  "partnerReference":{
    "trackingID": "273182"
  },
  "documents":{
    "id": "",
    "name": "",
    "attachments":[]
  },
  "product":{
    "partnerID": "11158174",
    "productName": "APPRAISAL",
    "displayName": "Mercury Network Software",
    "category": "APPRAISAL",
    "entityRef":{
      "entityId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "entityType": "urn:elli:encompass:loan"
    }
  }
}

Step 3: Submit a check status request with the given tracking ID. This is an "Order Service" API call with the requestType as checkStatus, along with trackingID from the response in Step 2.

{
    "product": {
        "entityRef": {
            "entityId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "entityType": "urn:elli:encompass:loan"
        },
        "name": "APPRAISAL",
        "credentials": {
        "userName": "[email protected]",
        "password": "xxxxxx",
        "mercuryID": "xxxxxxx"
        },
        "options": {
            "requestType": "checkStatus",
            "trackingID": "273182"
        },
        "resources": 
        [
            {
                "entityId": "Attachment-xxxxxxxx-xxx-xxxx-xxxx-xxxxxxxxxxxxx.pdf",
                "entityType": "urn:elli:encompass:document"
            }
        ]
    }
}

Step 4: Retrieve details of completed Appraisal service request. This call is made using the transaction ID in the response "location" header in Step 3. Repeat Steps 3 and 4 until the Appraisal order is available as in the response below.

{
  "status": "success",
  "documents": [
    {
      "id": "2bddcd27-b1c6-4fb0-b439-f2338904c005",
      "name": "Borrower Consent",
      "attachments": [
        {
          "mimeType": "application/pdf",
          "name": "AppraisalReport.PDF",
          "content": {
            "createdDateTime": "3/2/2018 4:58:24 PM",
            "attachmentFile": "Attachment-cbc8e096-6c6b-4195-a145-9db9725d8f41.PDF"
          }
        },
        {
          "mimeType": "application/pdf",
          "name": "Uniform Residential Appraisal Report.PDF",
          "content": {
            "createdDateTime": "3/2/2018 4:58:24 PM",
            "attachmentFile": "Attachment-dd4e8a57-6382-4de8-84ec-a26d974152d6.PDF"
          }
        },
        {
          "mimeType": "text",
          "name": "fnm_1607EM127058.TXT",
          "content": {
            "createdDateTime": "3/2/2018 4:58:24 PM",
            "attachmentFile": "Attachment-79e04fbb-dd27-4a2c-bcf4-8ba5b81b526e.TXT"
          }
        }
      ]
    },
    {
      "id": "dc056d23-3f75-4c3b-9f2a-60ae27cabd38",
      "name": "Appraisal Report1",
      "attachments": [
        {
          "mimeType": "application/pdf",
          "name": "AppraisalReport1.PDF",
          "content": {
            "createdDateTime": "3/2/2018 4:58:24 PM",
            "attachmentFile": "Attachment-cda670cb-ba99-43a5-9af5-ef29631d2255.PDF"
          }
        }
      ]
    }
  ],
  "identity": {
    "clientId": "wLNYae+QjJGSkj7+FO2mNwGx9fYhU3ZnowTlBef4QMBXwwRHHgt3QPPyyIpHX6rC+Tz+xn/4jIOm8dmuYcnmiw==",
    "userId": "wLNYae+QjJGSkj7+FO2mN9iRZDqqr40xy8PrnU7BVKmDzCr9Ubho3loP4QI8QJIgVRSaCHxX4oDIBwQ/CyCMJ+mCL2DCF3adZkFWQrscn/zOj6+jJAWaeuXVItcOoVWOH9e474r+ZFczuf8MQnBGHg=="
  },
  "product": {
    "partnerID": "11158174",
    "productName": "APPRAISAL",
    "displayName": "Mercury Network Software",
    "category": "APPRAISAL",
    "entityRef": {
      "entityId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "entityType": "urn:elli:encompass:loan:borrower"
    }
  }
}