SureReceipts API Documentation

The SureReceipts API is a web service that allows AMCs/Lenders with existing third party software to utilize Mercury Networks ECOA compliant method of sending an electronic copy of an appraisal report to the borrower. SureReceipts securely sends any document to borrowers in compliance with disclosure requirements, and it automatically produces an audit trail on every send for compliance verification.

QA — https://www.mercurynetworkapiqa.com/mercuryapi.asmx?op=UploadPDF

Production — https://www.mercurynetworkapi.com/mercuryapi.asmx?op=UploadPDF

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

For additional API methods please refer to the URL for examples. (https://www.mercurynetworkapi.com/mercuryapi.asmx?op=UploadPDF)

Request:

<x>POST /mercuryapi.asmx HTTP/1.1</x>
<x>Host: www.mercurynetworkapi.com</x>
<x>Content‑Type: application/soap+xml; charset=utf‑8</x>
<x>Content‑Length: length</x>

<?xml version="1.0" encoding="utf‑8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema‑instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap‑envelope">
  <soap12:Body>
    <UploadPDF xmlns="http://mercuryvmp.com/">
      <UserName>string</UserName>
      <Password>;string</Password>
      <Base64PDF>string</Base64PDF>
      <bSendToBorrower>boolean</bSendToBorrower>
      <SendToBorrowerNotes>string</SendToBorrowerNotes>
      <SubjectAddress>string</SubjectAddress>
      <SubjectCity>string</SubjectCity>
      <SubjectState>string</SubjectState>
      <SubjectZip>string</SubjectZip>
      <LoanType>string</LoanType>
      <MajorForm>string</MajorForm>
      <BorrowerName>string</BorrowerName>
      <BorrowerEmail>string</BorrowerEmail>
      <AppraisedValue>decimal</AppraisedValue>
      <Neighborhood>string</Neighborhood>
      <AppraisalDate>dateTime</AppraisalDate>
      <SalePrice>decimal</SalePrice>
      <LoanPurpose>string</LoanPurpose>
      <PriorDate>dateTime</PriorDate>
      <LenderName>string</LenderName>
      <PriorPrice>decimal</PriorPrice>
      <LenderAddress>string</LenderAddress>
      <LenderCity>string</LenderCity>
      <LenderState>string</LenderState>
      <LenderZip>string</LenderZip>
      <AppraiserName>string</AppraiserName>
    </UploadPDF>
  </soap12:Body>
</soap12:Envelope>
<x>HTTP/1.1 200 OK</x>
<x>Content‑Type: application/soap+xml; charset=utf‑8</x>
<x>Content‑Length: length</x>

Request Parameters:

* — Indicates a required field.

Username: —; Mercury Network username *

Password: —; Mercury Network Password *

Base64PDF: —; base64 encoded string for the appraisal report PDF *

bSendToBorrower: —; True/False *

SubjectAddress: —; Street Address of the property *

SubjectCity: —; City of the subject property *

SubjectState: —; State of the subject property *

SubjectZip: —; Zip code of the subject property *

LoanType: —; must be a supported Loan Type (See attached spreadsheet for supported LoanTypes) *

MajorForm: —; This is the major form of the report

BorrowerName: —; Name of the borrower

BorrowerEmail: —; Email address of the borrower being sent appraisal

AppraisedValue: —; Appraised value of subject property *

Neighborhood: —; Neighborhood of the subject property

AppraisalDate: —; Date of Appraisal

SalePrice: —; Sale Price of Subject Property *

LoanPurpose: —; must be a supported Loan Purpose (see attached spreadsheet for supported LoanPurposes)

PriorDate: —; Date of Prior Appraisal

LenderName: —; Lender Company Name

PriorPrice: —; Prior Sales Price of subject property *

LenderAddress: —; Street Address of Lender

LenderCity: —; City of Lender Address

LenderState: —; State of Lender Address

LenderZip: —; Zip code of Lender Address

AppraiserName: —; Name of Appraiser that completed appraisal

These fields require a value, but pass zero (0) if you don't have one:

AppraisedValue
PriorPrice
SalePrice

Sample Request:

<UploadPDF xmlns="http://mercuryvmp.com/">
  <UserName>user@cwlogin.info.com</UserName>
  <Password>Password1</Password>
  <Base64PDF>string</Base64PDF>
  <bSendToBorrower>True</bSendToBorrower>
  <SendToBorrowerNotes>This is the completed appraisal report.</SendToBorrowerNotes>
  <SubjectAddress>3705 Subject Address</SubjectAddress>
  <SubjectCity>Oklahoma City</SubjectCity>
  <SubjectState>OK</SubjectState>
  <SubjectZip>73134</SubjectZip>
  <LoanType>Purchase</LoanType>
  <MajorForm>Uniform Residential Appraisal (FNMA 1004)</MajorForm>
  <BorrowerName>John Doe</BorrowerName>
  <BorrowerEmail>John.Doe@cwlogin.info</BorrowerEmail>
  <AppraisedValue>99500.00</AppraisedValue>
  <Neighborhood>Weston Hills</Neighborhood>
  <AppraisalDate>2014‑05‑14</AppraisalDate>
  <SalePrice>99500.00</SalePrice>
  <LoanPurpose>Purchase</LoanPurpose>
  <PriorDate>2014‑02‑06</PriorDate>
  <LenderName>John Lender</LenderName>
  <PriorPrice>100000.00</PriorPrice>
  <LenderAddress>123 Sample Address</LenderAddress>
  <LenderCity>Oklahoma City</LenderCity>
  <LenderState>OK</LenderState>
  <LenderZip>73127</LenderZip>
  <AppraiserName>Eric Appraiser</AppraiserName>
</UploadPDF>

Response:

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <UploadPDFResponse xmlns="http://mercuryvmp.com/">
      <UploadPDFResult>
        <iRet>int</iRet>
        <szError>string</szError>
        <DataCourierFileID>int</DataCourierFileID>
        <szErrorDetails>string</szErrorDetails>
      </UploadPDFResult>
    </UploadPDFResponse>
  </soap12:Body>
</soap12:Envelope>

Response Parameters

IRet: —; 0 for a success, otherwise return a unique error code

szError: —; This will provide an error description

DataCourierFileID: —; This will return the DataCourier FileID created for the report

szErrorDetails: —; This will return the details of the error message

Sample Response XML(ACK):

<UploadPDFResponse xmlns="http://mercuryvmp.com/">
  <UploadPDFResult>
    <iRet>0</iRet>
    <szError/>
    <DataCourierFileID>123456789</DataCourierFileID>
    <szErrorDetails/>
  </UploadPDFResult>
</UploadPDFResponse>

SampleResponse XML(NACK):

<UploadPDFResponse xmlns="http://mercuryvmp.com/">
  <UploadPDFResult>
    <iRet>‑999</iRet>
    <szError>Unknown Error Occurred</szError>
    <DataCourierFileID></DataCourierFileID>
    <szErrorDetails>An unknown error has occurred.</szErrorDetails>
  </UploadPDFResult>
</UploadPDFResponse>

Doc Details

SureReceipts API Documentation

Document 9601
Created: 06/18/2014 MJY

The Big Picture

This document outlines the methods used to utilize the SureReceipts API Web Service.