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.
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)
POST /mercuryapi.asmx HTTP/1.1 Host: www.mercurynetworkapi.com Content‑Type: application/soap+xml; charset=utf‑8 Content‑Length: length <?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> HTTP/1.1 200 OK Content‑Type: application/soap+xml; charset=utf‑8 Content‑Length: length
* — Indicates a required field.
These fields require a value, but pass zero (0) if you don't have one:
<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>
<?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>
<UploadPDFResponse xmlns="http://mercuryvmp.com/"> <UploadPDFResult> <iRet>0</iRet> <szError/> <DataCourierFileID>123456789</DataCourierFileID> <szErrorDetails/> </UploadPDFResult> </UploadPDFResponse>
<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>
SureReceipts API Documentation
This document outlines the methods used to utilize the SureReceipts API Web Service.