Purpose

Back To Home

This Client Integration Guide provides the information required for a successful implementation of receiving and returning stacked/indexed/audited Loan Packages and order status using the CLIENT API integration.

This document is created, maintained, and distributed by Avanze Tech Labs Inc. to communicate the implementation requirements to their vendors/MSATSs. Avanze supports the contents included in the Provider Implementation Guide when the document originates from Avanze.

Client ID

Client will be sending the order request and other respective events with the following ClientID’s. Client should confirm that all CLIENT ClientID’s are configured in their appropriate environment.

Production Environment

Client ID Client Name
XYZTEST123 XYZ

UAT Environment

Client ID Client Name
XYZPROD123 XYZ

Products

Client will be ordering the following products through CLIENT. This product listing contains all possible products that Avanze will deliver through the CLIENT platform. Customers should refer to their specific subscription agreement with Avanze and configure the products that are subscribed for this implementation

Product Code Product Name
1 Lien Release
2 Assignment

Connectivity Detail

HTTP Post

The HTTP Post Method may be implemented for the purpose of inbound event transmission. Client can send files via HTTP and will receive an XML Response informing them of the status of their submission. This is most frequently used in integrations for the posting. HTTP Posting can also be used as a delivery method for integration MSATSs who choose to receive files via HTTP. HTTPS or SSL (Secure Sockets Layer) is the most common implementation of this method, due to SSL’s security benefits.

Integration Clients may also choose to develop an HTTP Receiver of their own, in which they would receive via HTTP Post. Following URL will be used by integration to post inbound events to CLIENT API application which will route the events to CLIENT application.

UAT URL:

http://apistage.direct2title.com/mortgagesats/organization/integration

PRODUCTION URL:

https://avanzeapi.com/mortgagesats/organization/integration

Authorization through POST Parameters

Two parameters are required in order submit requests through HTTPs POST.

Username = [USER]

Password = [PASSWORD]

Username and password value used to authenticate incoming request. These values are defined in CLIENT API application for each integrator.

Authorization through Header

Instead of sending credentials in plain text through post parameters, an authenticated request includes the Authorization Header Variable. If this header is not included, the request is anonymous and may not succeed against API services.

To authenticate a request, you must encode the combined username and password in the request.

The format for the Authorization header is as follows:

Authorization: Basic [Encoded-Base64-String]

Constructing the Basic Authentication

Username and password are combined into a string “username:password”

The result string is then encoded using Base64.

In Header authorization, add “Basic” before the encoded string. There should be space in between “Basic” and encoded string

API Events

Event Code Event Description Event Originator MSATS Sending MSATS Receiving Event Definition
AT11 Order Placed CLIENT R* CLIENT sends this event to initiate an order request to MSATS.
AT12 Order Confirmed by MSATS MSATS R MSATS sends this event to CLIENT to inform CLIENT that MSATS accepts the order request.
AT13 Order Not Accepted by MSATS MSATS R MSATS sends this event to CLIENT to inform CLIENT that MSATS does not accept the order request.
AT14 Order Delivered by MSATS MSATS R* MSATS sends this event to CLIENT with the order documents.
AT15 Notes Both O O MSATS and/or CLIENT send this event to provide a note on an order request.
AT21 Order On-Hold Both O O MSATS and/or CLIENT send this event to place the order request on hold.
AT22 Order Cancelled Both R R MSATS and/or CLIENT send this event to cancel the order request.
AT23 Order Revoke Both O O MSATS or CLIENT sends this event to resume an order request that has been put on hold.
AT30 GetStatus CLIENT R The Client sends this event to the MSATS to get the current status of the order.
AT31 OrderStatus MSATS R The MSATS sends this event to the CLIENT to notify the current status of the order.
AT50 CompleteOrder MSATS R The MSats sends this event to the Client to notify the Client that the order request is complete.

*Mandatory
      R - Required Events that will occur on all Orders.
      O - Optional Events that if they occur on an Order, CLIENT is required to support.

Avanze API Workflow: MSATS receiving order from CLIENT

Order Placement
      1. CLIENT will create the Order Requests (CLIENT API Event AT11).
      2. CLIENTAPI will route the orders to MSATS.

Confirmation of the orders
      3. MSATS will confirm the request (CLIENTAPI Event AT12) for the order.
      4. If MSATS does not accept the order, MSATS will decline the order by sending Order Not Accepted by MSATS (CLIENTAPI Event AT13) on the order.

Order Process
      5. When the order is complete, MSATS will upload the documents using Document Delivered by MSATS with product data(CLIENTAPI Event AT14).

Completion of Order
      6. Upon completion of the order, MSATS will send Order Completed (CLIENTAPI Event AT50) to the order to indicate the order is complete.

General Use Events
      7. MSATS should post any notes or events to CLIENT by sending Notes (CLIENTAPI Event AT15) on the applicable order. Notes (CLIENTAPI Event AT15) will also be utilized by the CLIENT on the applicable order to relay information to CLIENT
      8. The MSATS and/or CLIENT may communicate that the order is on hold by sending Order On-Hold (CLIENTAPI Event AT21) event. The Order Resume (CLIENTAPI Event AT23) is sent to resume an order that has been put on hold (CLIENTAPI Event AT21).
      9. The Client sends this event to the MSATS to get the current status of the order (CLIENTAPI Event AT30) event.
      10. The MSATS sends this event to the CLIENT to notify the current status of the order (CLIENTAPI Event AT31) event
      11. If either the CLIENT or MSATS needs to cancel the order at any time, Order Cancelled(CLIENTAPI Event AT22) should be sent on the order to be cancelled.

AT11 Sample:

Field Name R/O Description
Header
Created R Request created date time (2021-06-10T14:18:42+00:00 (W3C))
SourceApp R Name of Source application
SourceVer R Application version
SourceEnv R Source application environment. Eg: UAT/DEV/PROD
EventCode R Requested Event Code. Eg: AT11
EventName O Name of the event. Eg: PlaceOrder
ClientID R ClientID (mentioned under purpose section)
CorrelationIdentifier R Unique number/Hash for the event
Transaction
TransactionID R Order number of the client application
Comments O Comments
LoanNumber R Loan Number
ProductCode R ProductCode is mentioned in Product Section
ProductName O ProductName is mentioned in Product Section
PaidInFullDate R Date of loan amount paid (yyyy-mm-dd)
OriginalLoanDate R Actual loan date (yyyy-mm-dd)
OriginalLoanBalance R Actual loan amount pending
BorrowerPaidFee R Borrower paid amount
CustodianOfRecord O Custodian Of Record
AssignmentDateTime R Assignment Date Time (yyyy-mm-dd)
BorrowerName R Borrower name
BorrowerEmail R Borrower email id
CoBorrowerName O Co-Borrower name
CoBorrowerEmail O Co-Borrower email id
Transaction > Property
Address1 R Property address
Address2 R Property address
State R Property state code
County R Property county
City R Property city
Zipcode R Property zipcode
Transaction > DocumentList
Count R No of documents count
Transaction > DocumentList > Document
FileName R File Name
FileType R Document type. Eg: PDF
If FileSource is Base 64
EncodingType R Encoded format. Eg: Base64
Content R Encoded content of the file
If FileSource is S3/SFTP/LINK
File Path R File path of the attachment
<?xml version="1.0"?> <result> <Header> <Created>2021-06-09T15:16:26-04:00</Created> <SourceApp>APPName</SourceApp> <SourceVer>1</SourceVer> <SourceEnv>DEV</SourceEnv> <EventCode>AT11</EventCode> <EventName>PlaceOrder</EventName> <ClientID>XYZTEST123</ClientID> <CorrelationIdentifier>c8721c77a72b7321c884eefcdd496d23</CorrelationIdentifier> </Header> <Transaction> <TransactionID>20210524-001</TransactionID> <Comments>PLACE ORDER NOTES</Comments> <LoanNumber>654654</LoanNumber> <ProductCode>1</ProductCode> <ProductName>Lien Release</ProductName> <PaidInFullDate>2021-06-08</PaidInFullDate> <OriginalLoanDate>2021-06-08</OriginalLoanDate> <OriginalLoanBalance>5000.00</OriginalLoanBalance> <BorrowerPaidFee>500.00</BorrowerPaidFee> <CustodianOfRecord>Test</CustodianOfRecord> <AssignmentDateTime>2021-06-08</AssignmentDateTime> <BorrowerName>John Doe</BorrowerName> <BorrowerEmail>johndoe@gmail.com</BorrowerEmail> <CoBorrowerName>Jane Doe</CoBorrowerName> <CoBorrowerEmail>janedoe@gmail.com</CoBorrowerEmail> <Property> <Address1>XPRESS Street</Address1> <Address2/> <State>FL</State> <County>PUTNAM</County> <City>BOSTWICK</City> <Zipcode>32007</Zipcode> </Property> <DocumentList> <Count>3</Count> <Document> <Document> <FileName>sample.pdf</FileName> <FileType>PDF</FileType> <Content>Base64 Encode Content</Content> <EncodeType>Base64</EncodeType> </Document> <Document> <FileName>sample1.pdf</FileName> <FileType>PDF</FileType> <Content>Base64 Encode Content</Content> <EncodeType>Base64</EncodeType> </Document> <Document> <FileName>sample-pdf-file.pdf</FileName> <FileType>PDF</FileType> <Content>Base64 Encode Content</Content> <EncodeType>Base64</EncodeType> </Document> </Document> </DocumentList> </Transaction> </result>
{ "Header": { "Created": "2021-06-09T15:16:26-04:00", "SourceApp": "APPName", "SourceVer": "1", "SourceEnv": "DEV", "EventCode": "AT11", "EventName": "PlaceOrder", "ClientID": "XYZTEST123", "CorrelationIdentifier": "c8721c77a72b7321c884eefcdd496d23" }, "Transaction": { "TransactionID": "20210524-001", "Comments": "PLACE ORDER NOTES", "LoanNumber": "654654", "ProductCode": "1", "ProductName": "Lien Release", "PaidInFullDate": "2021-06-08", "OriginalLoanDate": "2021-06-08", "OriginalLoanBalance": "5000.00", "BorrowerPaidFee": "500.00", "CustodianOfRecord": "Test", "AssignmentDateTime": "2021-06-08", "BorrowerName": "John Doe", "BorrowerEmail": "johndoe@gmail.com", "CoBorrowerName": "Jane Doe", "CoBorrowerEmail": "janedoe@gmail.com", "Property": { "Address1": "XPRESS Street", "Address2": "", "State": "FL", "County": "PUTNAM", "City": "BOSTWICK", "Zipcode": "32007" }, "DocumentList": { "Count": "3", "Document": [ { "FileName": "sample.pdf", "FileType": "PDF", "Content": "Base64 Encode Content", "EncodeType": "Base64" }, { "FileName": "sample1.pdf", "FileType": "PDF", "Content": "Base64 Encode Content", "EncodeType": "Base64" }, { "FileName": "sample-pdf-file.pdf", "FileType": "PDF", "Content": "Base64 Encode Content", "EncodeType": "Base64" } ] } } }

AT12 Sample:

Field Name R/O Description
Header
Created R Request created date time (2021-06-10T14:18:42+00:00 (W3C))
SourceApp R Name of Source application
SourceVer R Application version
SourceEnv R Source application environment. Eg: UAT/DEV/PROD
EventCode R Requested Event Code. Eg: AT12
EventName O Name of the event. Eg: AcceptOrder
ClientID R ClientID (mentioned under purpose section)
CorrelationIdentifier R Unique number/Hash for the event
Transaction
TransactionID R Order number of the client application
OrderNumber R Order number of the MSATS application
Comments O Comments
<?xml version="1.0"?> <result> <Header> <Created>2021-06-09T15:16:26-04:00</Created> <SourceApp>APPName</SourceApp> <SourceVer>1</SourceVer> <SourceEnv>DEV</SourceEnv> <EventCode>AT12</EventCode> <EventName>AcceptOrder</EventName> <ClientID>XYZTEST123</ClientID> <CorrelationIdentifier>c8721c77a72b7321c884eefcdd496d23</CorrelationIdentifier> </Header> <Transaction> <TransactionID>20210524-001</TransactionID> <OrderNumber>654654</OrderNumber> <Comments>The Order has been accepted</Comments> </Transaction> </result>
{ "Header": { "Created": "2021-06-09T15:16:26-04:00", "SourceApp": "APPName", "SourceVer": "1", "SourceEnv": "DEV", "EventCode": "AT12", "EventName": "AcceptOrder", "ClientID": "XYZTEST123", "CorrelationIdentifier": "c8721c77a72b7321c884eefcdd496d23" }, "Transaction": { "TransactionID": "20210524-001", "OrderNumber": "654654", "Comments": "The Order has been accepted" } }

AT13 Sample:

Field Name R/O Description
Header
Created R Request created date time (2021-06-10T14:18:42+00:00 (W3C))
SourceApp R Name of Source application
SourceVer R Application version
SourceEnv R Source application environment. Eg: UAT/DEV/PROD
EventCode R Requested Event Code. Eg: AT13
EventName O Name of the event. Eg: RejectOrder
ClientID R ClientID (mentioned under purpose section)
CorrelationIdentifier R Unique number/Hash for the event
Transaction
TransactionID R Order number of the client application
Comments O Comments
<?xml version="1.0"?> <result> <Header> <Created>2021-06-09T15:16:26-04:00</Created> <SourceApp>APPName</SourceApp> <SourceVer>1</SourceVer> <SourceEnv>DEV</SourceEnv> <EventCode>AT13</EventCode> <EventName>RejectOrder</EventName> <ClientID>XYZTEST123</ClientID> <CorrelationIdentifier>c8721c77a72b7321c884eefcdd496d23</CorrelationIdentifier> </Header> <Transaction> <TransactionID>20210524-001</TransactionID> <Comments>The Order has been rejected</Comments> </Transaction> </result>
{ "Header": { "Created": "2021-06-09T15:16:26-04:00", "SourceApp": "APPName", "SourceVer": "1", "SourceEnv": "DEV", "EventCode": "AT13", "EventName": "RejectOrder", "ClientID": "XYZTEST123", "CorrelationIdentifier": "c8721c77a72b7321c884eefcdd496d23" }, "Transaction": { "TransactionID": "20210524-001", "Comments": "The Order has been rejected" } }

AT14 Sample:

Field Name R/O Description
Header
Created R Request created date time (2021-06-10T14:18:42+00:00 (W3C))
SourceApp R Name of Source application
SourceVer R Application version
SourceEnv R Source application environment. Eg: UAT/DEV/PROD
EventCode R Requested Event Code. Eg: AT14
EventName O Name of the event. Eg: ProductDelivery
ClientID R ClientID (mentioned under purpose section)
CorrelationIdentifier R Unique number/Hash for the event
Transaction
TransactionID R Order number of the client application
OrderNumber R Order number of the provider
Comments O Comments
Transaction > ProductData
PropertyAddress1 R Property address
PropertyAddress2 R Property address
PropertyCityName R Property located city
PropertyStateName R State code
PropertyCountyName R County
PropertyZipCode R Zipcode
BorrowerNameFirst R Borrower first name
BorrowerNameMiddle R Borrower middle name
BorrowerNameLast R Borrower last name
NoteDate R Date (yyyy-mm-dd)
LoanAmount R Loan amount
MaturityDate R Date (yyyy-mm-dd)
MERSDescription R MERS Description
ReturnToOrg R Return Organization
ReturnAddress1 R Address line 1
ReturnAddress2 R Address line 2
ReturnCityName R City
ReturnStateCode R State code
ReturnZipCode R Zip code
TaxID R Tax ID
MERSPhoneNo R Phone
AssignorName R Assignor name
MortgageDated R Mortgage Date
DocumentNumber R Document Number
Trustee R Trustee
MIN R MIN number
Lender R Lender
LenderName R Lender Name
LenderAddress R Lender Address
RecordedDate R Recorded Date
LegalDescription R Legal description
NotaryDateOfExpiration R Date
Notary R Notary Name
NotaryAck R Notary ACK Description
NotaryCountyName R County
SignorTitle R Signor Title Information
Signor R Signor Name
EndorserName R Endorser Name
AssignorAddress1 R Assignor Address1
AssignorAddress2 R Assignor Address2
AssignorCityName R Assignor city
AssignorStateName R Assignor state
AssignorZipCode R Assignor Zipcode
AssigneeName R Assignee Name
AssigneeAddress1 R Assignee Address1
AssigneeAddress2 R Assignee Address2
AssigneeCityName R Assignee city
AssigneeStateName R Assignee state
AssigneeZipCode R Assignee Zipcode
BorrowerName R Borrower Name
Book R Book
Page R Page
NotaryStateName R State
Witness1 R Witness Name1
PrintDate R Print Date (yyyy-mm-dd)
DeedOfTrustDated R Deed of Trust Dated (yyyy-mm-dd)
Witness2 R Witness Name2
SecurityDeedDate R Security Deed Date (yyyy-mm-dd)
LoanNumber R Loan number
SIS R SIS
Mortgagor R Mortgagor Name
Mortgagee R Mortgagee Name
Instrument R Instrument
DatedDate R Dated Date (yyyy-mm-dd)
ExecutedDate R Executed Date (yyyy-mm-dd)
OwnerName R Owner name
Designation R Designation
ReturnPhoneNo R Phone number
MERSMailingAddress R MERS Mailing Address
PreparedBy R The person who prepared the document
PreparedByOrg R The organization who prepared the document
PreparedByAddress1 R Address line1
PreparedByAddress2 R Address line2
PreparedByCityName R City name
PreparedByStateCode R State
PreparedZipCode R Zipcode
PreparedByPhoneNo R Phone number
Transaction > DocumentList
Count R No. of documents attached
Transaction > DocumentList > Document
FileName R File name
FileType R Document type. Eg: PDF
If FileSource is Base 64
EncodingType R Encoded format. Eg: Base64
Content R Encoded content of the file
If FileSource is S3/SFTP/LINK
File Path R File path of the attachment
<?xml version="1.0"?> <result> <Header> <Created>2021-06-09T15:16:26-04:00</Created> <SourceApp>APPName</SourceApp> <SourceVer>1</SourceVer> <SourceEnv>DEV</SourceEnv> <EventCode>AT14</EventCode> <EventName>ProductDelivery</EventName> <ClientID>XYZTEST123</ClientID> <CorrelationIdentifier>c8721c77a72b7321c884eefcdd496d23</CorrelationIdentifier> </Header> <Transaction> <TransactionID>20210524-001</TransactionID> <OrderNumber>654654</OrderNumber> <Comments>The Order has been rejected</Comments> <ProductData> <PropertyAddress1>Xpress Street</PropertyAddress1> <PropertyAddress2>Second Avenue</PropertyAddress2> <PropertyCityName>BOSTWICK</PropertyCityName> <PropertyStateName>FL</PropertyStateName> <PropertyCountyName>PUTNAM</PropertyCountyName> <PropertyZipCode>32007</PropertyZipCode> <BorrowerNameFirst>John</BorrowerNameFirst> <BorrowerNameMiddle>K</BorrowerNameMiddle> <BorrowerNameLast>Doe</BorrowerNameLast> <NoteDate>2021-06-09</NoteDate> <LoanAmount>50000.00</LoanAmount> <MaturityDate>2021-06-06</MaturityDate> <MERSDescription>Description</MERSDescription> <ReturnToOrg>Test Bank</ReturnToOrg> <ReturnAddress1>West Street</ReturnAddress1> <ReturnAddress2/> <ReturnCityName>BOSTWICK</ReturnCityName> <ReturnStateCode>FL</ReturnStateCode> <ReturnZipCode>32007</ReturnZipCode> <TaxID>TX0001</TaxID> <MERSPhoneNo>98912122345</MERSPhoneNo> <AssignorName>John Smith</AssignorName> <MortgageDated>2021-05-21</MortgageDated> <DocumentNumber>D0001</DocumentNumber> <Trustee>James Smith</Trustee> <MIN>Test</MIN> <Lender>Mike L. Johnson</Lender> <LenderName>Mike L. Johnson</LenderName> <LenderAddress>West Street</LenderAddress> <RecordedDate>2021-05-21</RecordedDate> <LegalDescription>legal description</LegalDescription> <NotaryDateOfExpiration>2021-04-21</NotaryDateOfExpiration> <Notary>Margret E. Smith</Notary> <NotaryAck/> <NotaryCountyName>PUTNAM</NotaryCountyName> <SignorTitle>Mr</SignorTitle> <Signor>Joe Morgon</Signor> <EndorserName/> <AssignorAddress1>North Street</AssignorAddress1> <AssignorAddress2/> <AssignorCityName>BOSTWICK</AssignorCityName> <AssignorStateName>FL</AssignorStateName> <AssignorZipCode>32007</AssignorZipCode> <AssigneeName>Jane Doe</AssigneeName> <AssigneeAddress1>South Street</AssigneeAddress1> <AssigneeAddress2/> <AssigneeCityName>BOSTWICK</AssigneeCityName> <AssigneeStateName>FL</AssigneeStateName> <AssigneeZipCode>32007</AssigneeZipCode> <BorrowerName>Joh Doe</BorrowerName> <Book>35</Book> <Page>12</Page> <NotaryStateName>FL</NotaryStateName> <Witness1>James Smith</Witness1> <PrintDate>2021-04-21</PrintDate> <DeedOfTrustDated>2021-04-26</DeedOfTrustDated> <Witness2/> <SecurityDeedDate>2021-05-10</SecurityDeedDate> <LoanNumber>LN03483940</LoanNumber> <SIS/> <Mortgagor>Ian Morgon</Mortgagor> <Mortgagee>Steve Waugh</Mortgagee> <Instrument>3533</Instrument> <DatedDate>2021-04-28</DatedDate> <ExecutedDate>2021-05-21</ExecutedDate> <OwnerName>John Doe</OwnerName> <Designation>Attorney</Designation> <ReturnPhoneNo>394839333</ReturnPhoneNo> <MERSMailingAddress>West Street</MERSMailingAddress> <PreparedBy>Margret E. Smith</PreparedBy> <PreparedByOrg>Test Bank</PreparedByOrg> <PreparedByAddress1>North Street</PreparedByAddress1> <PreparedByAddress2/> <PreparedByCityName>BOSTWICK</PreparedByCityName> <PreparedByStateCode>FL</PreparedByStateCode> <PreparedZipCode>32007</PreparedZipCode> <PreparedByPhoneNo>2293989</PreparedByPhoneNo> </ProductData> <DocumentList> <Count>3</Count> <Document> <Document> <FileName>sample.pdf</FileName> <FileType>PDF</FileType> <Content>Base64 Encode Content</Content> <EncodeType>Base64</EncodeType> </Document> <Document> <FileName>sample1.pdf</FileName> <FileType>PDF</FileType> <Content>Base64 Encode Content</Content> <EncodeType>Base64</EncodeType> </Document> <Document> <FileName>sample-pdf-file.pdf</FileName> <FileType>PDF</FileType> <Content>Base64 Encode Content</Content> <EncodeType>Base64</EncodeType> </Document> </Document> </DocumentList> </Transaction> </result>
{ "Header": { "Created": "2021-06-09T15:16:26-04:00", "SourceApp": "APPName", "SourceVer": "1", "SourceEnv": "DEV", "EventCode": "AT14", "EventName": "ProductDelivery", "ClientID": "XYZTEST123", "CorrelationIdentifier": "c8721c77a72b7321c884eefcdd496d23" }, "Transaction": { "TransactionID": "20210524-001", "OrderNumber": "654654", "Comments": "The Order has been rejected", "ProductData": { "PropertyAddress1": "Xpress Street", "PropertyAddress2": "Second Avenue", "PropertyCityName": "BOSTWICK", "PropertyStateName": "FL", "PropertyCountyName": "PUTNAM", "PropertyZipCode": "32007", "BorrowerNameFirst": "John", "BorrowerNameMiddle": "K", "BorrowerNameLast": "Doe", "NoteDate": "2021-06-09", "LoanAmount": "50000.00", "MaturityDate": "2021-06-06", "MERSDescription": "Description", "ReturnToOrg": "Test Bank", "ReturnAddress1": "West Street", "ReturnAddress2": "", "ReturnCityName": "BOSTWICK", "ReturnStateCode": "FL", "ReturnZipCode": "32007", "TaxID": "TX0001", "MERSPhoneNo": "98912122345", "AssignorName": "John Smith", "MortgageDated": "2021-05-21", "DocumentNumber": "D0001", "Trustee": "James Smith", "MIN": "Test", "Lender": "Mike L. Johnson", "LenderName": "Mike L. Johnson", "LenderAddress": "West Street", "RecordedDate": "2021-05-21", "LegalDescription": "legal description", "NotaryDateOfExpiration": "2021-04-21", "Notary": "Margret E. Smith", "NotaryAck": "", "NotaryCountyName": "PUTNAM", "SignorTitle": "Mr", "Signor": "Joe Morgon", "EndorserName": "", "AssignorAddress1": "North Street", "AssignorAddress2": "", "AssignorCityName": "BOSTWICK", "AssignorStateName": "FL", "AssignorZipCode": "32007", "AssigneeName": "Jane Doe", "AssigneeAddress1": "South Street", "AssigneeAddress2": "", "AssigneeCityName": "BOSTWICK", "AssigneeStateName": "FL", "AssigneeZipCode": "32007", "BorrowerName": "Joh Doe", "Book": "35", "Page": "12", "NotaryStateName": "FL", "Witness1": "James Smith", "PrintDate": "2021-04-21", "DeedOfTrustDated": "2021-04-26", "Witness2": "", "SecurityDeedDate": "2021-05-10", "LoanNumber": "LN03483940", "SIS": "", "Mortgagor": "Ian Morgon", "Mortgagee": "Steve Waugh", "Instrument": "3533", "DatedDate": "2021-04-28", "ExecutedDate": "2021-05-21", "OwnerName": "John Doe", "Designation": "Attorney", "ReturnPhoneNo": "394839333", "MERSMailingAddress": "West Street", "PreparedBy": "Margret E. Smith", "PreparedByOrg": "Test Bank", "PreparedByAddress1": "North Street", "PreparedByAddress2": "", "PreparedByCityName": "BOSTWICK", "PreparedByStateCode": "FL", "PreparedZipCode": "32007", "PreparedByPhoneNo": "2293989" }, "DocumentList": { "Count": "3", "Document": [ { "FileName": "sample.pdf", "FileType": "PDF", "Content": "Base64 Encode Content", "EncodeType": "Base64" }, { "FileName": "sample1.pdf", "FileType": "PDF", "Content": "Base64 Encode Content", "EncodeType": "Base64" }, { "FileName": "sample-pdf-file.pdf", "FileType": "PDF", "Content": "Base64 Encode Content", "EncodeType": "Base64" } ] } } }

AT15 Sample:

Field Name R/O Description
Header
Created R Request created date time (2021-06-10T14:18:42+00:00 (W3C))
SourceApp R Name of Source application
SourceVer R Application version
SourceEnv R Source application environment. Eg: UAT/DEV/PROD
EventCode R Requested Event Code. Eg: AT15
EventName O Name of the event. Eg: AddNotes
ClientID R ClientID (mentioned under purpose section)
CorrelationIdentifier R Unique number/Hash for the event
Transaction
TransactionID R Order number of the client application
OrderNumber R Order number of the MSATS application
Comments O Comments
<?xml version="1.0"?> <result> <Header> <Created>2021-06-09T15:16:26-04:00</Created> <SourceApp>APPName</SourceApp> <SourceVer>1</SourceVer> <SourceEnv>DEV</SourceEnv> <EventCode>AT15</EventCode> <EventName>AddNotes</EventName> <ClientID>XYZTEST123</ClientID> <CorrelationIdentifier>c8721c77a72b7321c884eefcdd496d23</CorrelationIdentifier> </Header> <Transaction> <TransactionID>20210524-001</TransactionID> <OrderNumber>654654</OrderNumber> <Comments>Sharing order notes</Comments> </Transaction> </result>
{ "Header": { "Created": "2021-06-09T15:16:26-04:00", "SourceApp": "APPName", "SourceVer": "1", "SourceEnv": "DEV", "EventCode": "AT15", "EventName": "AddNotes", "ClientID": "XYZTEST123", "CorrelationIdentifier": "c8721c77a72b7321c884eefcdd496d23" }, "Transaction": { "TransactionID": "20210524-001", "OrderNumber": "654654", "Comments": "Sharing order notes" } }

AT21 Sample:

Field Name R/O Description
Header
Created R Request created date time (2021-06-10T14:18:42+00:00 (W3C))
SourceApp R Name of Source application
SourceVer R Application version
SourceEnv R Source application environment. Eg: UAT/DEV/PROD
EventCode R Requested Event Code. Eg: AT21
EventName O Name of the event. Eg: HoldOrder
ClientID R ClientID (mentioned under purpose section)
CorrelationIdentifier R Unique number/Hash for the event
Transaction
TransactionID R Order number of the client application
OrderNumber R Order number of the MSATS application
Comments O Comments
<?xml version="1.0"?> <result> <Header> <Created>2021-06-09T15:16:26-04:00</Created> <SourceApp>APPName</SourceApp> <SourceVer>1</SourceVer> <SourceEnv>DEV</SourceEnv> <EventCode>AT21</EventCode> <EventName>HoldOrder</EventName> <ClientID>XYZTEST123</ClientID> <CorrelationIdentifier>c8721c77a72b7321c884eefcdd496d23</CorrelationIdentifier> </Header> <Transaction> <TransactionID>20210524-001</TransactionID> <OrderNumber>654654</OrderNumber> <Comments>On holding the order due to some reason</Comments> </Transaction> </result>
{ "Header": { "Created": "2021-06-09T15:16:26-04:00", "SourceApp": "APPName", "SourceVer": "1", "SourceEnv": "DEV", "EventCode": "AT21", "EventName": "HoldOrder", "ClientID": "XYZTEST123", "CorrelationIdentifier": "c8721c77a72b7321c884eefcdd496d23" }, "Transaction": { "TransactionID": "20210524-001", "OrderNumber": "654654", "Comments": "On holding the order due to some reason" } }

AT22 Sample:

Field Name R/O Description
Header
Created R Request created date time (2021-06-10T14:18:42+00:00 (W3C))
SourceApp R Name of Source application
SourceVer R Application version
SourceEnv R Source application environment. Eg: UAT/DEV/PROD
EventCode R Requested Event Code. Eg: AT22
EventName O Name of the event. Eg: CancelOrder
ClientID R ClientID (mentioned under purpose section)
CorrelationIdentifier R Unique number/Hash for the event
Transaction
TransactionID R Order number of the client application
OrderNumber R Order number of the MSATS application
Comments O Comments
<?xml version="1.0"?> <result> <Header> <Created>2021-06-09T15:16:26-04:00</Created> <SourceApp>APPName</SourceApp> <SourceVer>1</SourceVer> <SourceEnv>DEV</SourceEnv> <EventCode>AT22</EventCode> <EventName>CancelOrder</EventName> <ClientID>XYZTEST123</ClientID> <CorrelationIdentifier>c8721c77a72b7321c884eefcdd496d23</CorrelationIdentifier> </Header> <Transaction> <TransactionID>20210524-001</TransactionID> <OrderNumber>654654</OrderNumber> <Comments>The order has been cancelled</Comments> </Transaction> </result>
{ "Header": { "Created": "2021-06-09T15:16:26-04:00", "SourceApp": "APPName", "SourceVer": "1", "SourceEnv": "DEV", "EventCode": "AT22", "EventName": "CancelOrder", "ClientID": "XYZTEST123", "CorrelationIdentifier": "c8721c77a72b7321c884eefcdd496d23" }, "Transaction": { "TransactionID": "20210524-001", "OrderNumber": "654654", "Comments": "The order has been cancelled" } }

AT23 Sample:

Field Name R/O Description
Header
Created R Request created date time (2021-06-10T14:18:42+00:00 (W3C))
SourceApp R Name of Source application
SourceVer R Application version
SourceEnv R Source application environment. Eg: UAT/DEV/PROD
EventCode R Requested Event Code. Eg: AT23
EventName O Name of the event. Eg: ResumeOrder
ClientID R ClientID (mentioned under purpose section)
CorrelationIdentifier R Unique number/Hash for the event
Transaction
TransactionID R Order number of the client application
OrderNumber R Order number of the MSATS application
Comments O Comments
<?xml version="1.0"?> <result> <Header> <Created>2021-06-09T15:16:26-04:00</Created> <SourceApp>APPName</SourceApp> <SourceVer>1</SourceVer> <SourceEnv>DEV</SourceEnv> <EventCode>AT23</EventCode> <EventName>ResumeOrder</EventName> <ClientID>XYZTEST123</ClientID> <CorrelationIdentifier>c8721c77a72b7321c884eefcdd496d23</CorrelationIdentifier> </Header> <Transaction> <TransactionID>20210524-001</TransactionID> <OrderNumber>654654</OrderNumber> <Comments>Resuming the hold order</Comments> </Transaction> </result>
{ "Header": { "Created": "2021-06-09T15:16:26-04:00", "SourceApp": "APPName", "SourceVer": "1", "SourceEnv": "DEV", "EventCode": "AT23", "EventName": "ResumeOrder", "ClientID": "XYZTEST123", "CorrelationIdentifier": "c8721c77a72b7321c884eefcdd496d23" }, "Transaction": { "TransactionID": "20210524-001", "OrderNumber": "654654", "Comments": "Resuming the hold order" } }

AT30 Sample:

Field Name R/O Description
Header
Created R Request created date time (2021-06-10T14:18:42+00:00 (W3C))
SourceApp R Name of Source application
SourceVer R Application version
SourceEnv R Source application environment. Eg: UAT/DEV/PROD
EventCode R Requested Event Code. Eg: AT30
EventName O Name of the event. Eg: GetStatus
ClientID R ClientID (mentioned under purpose section)
CorrelationIdentifier R Unique number/Hash for the event
Transaction
TransactionID R Order number of the client application
OrderNumber R Order number of the MSATS application
Comments O Comments
<?xml version="1.0"?> <result> <Header> <Created>2021-06-09T15:16:26-04:00</Created> <SourceApp>APPName</SourceApp> <SourceVer>1</SourceVer> <SourceEnv>DEV</SourceEnv> <EventCode>AT30</EventCode> <EventName>GetStatus</EventName> <ClientID>XYZTEST123</ClientID> <CorrelationIdentifier>c8721c77a72b7321c884eefcdd496d23</CorrelationIdentifier> </Header> <Transaction> <TransactionID>20210524-001</TransactionID> <OrderNumber>654654</OrderNumber> <Comments>Get order status</Comments> </Transaction> </result>
{ "Header": { "Created": "2021-06-09T15:16:26-04:00", "SourceApp": "APPName", "SourceVer": "1", "SourceEnv": "DEV", "EventCode": "AT30", "EventName": "GetStatus", "ClientID": "XYZTEST123", "CorrelationIdentifier": "c8721c77a72b7321c884eefcdd496d23" }, "Transaction": { "TransactionID": "20210524-001", "OrderNumber": "654654", "Comments": "Get order status" } }

AT31 Sample:

Field Name R/O Description
Header
Created R Request created date time (2021-06-10T14:18:42+00:00 (W3C))
SourceApp R Name of Source application
SourceVer R Application version
SourceEnv R Source application environment. Eg: UAT/DEV/PROD
EventCode R Requested Event Code. Eg: AT31
EventName O Name of the event. Eg: OrderStatus
ClientID R ClientID (mentioned under purpose section)
CorrelationIdentifier R Unique number/Hash for the event
Transaction
TransactionID R Order number of the client application
OrderNumber R Order number of the MSATS application
OrderStatus O Current status of the order
Comments O Comments
<?xml version="1.0"?> <result> <Header> <Created>2021-06-09T15:16:26-04:00</Created> <SourceApp>APPName</SourceApp> <SourceVer>1</SourceVer> <SourceEnv>DEV</SourceEnv> <EventCode>AT31</EventCode> <EventName>OrderStatus</EventName> <ClientID>XYZTEST123</ClientID> <CorrelationIdentifier>c8721c77a72b7321c884eefcdd496d23</CorrelationIdentifier> </Header> <Transaction> <TransactionID>20210524-001</TransactionID> <OrderNumber>654654</OrderNumber> <OrderStatus>Work In Progress</OrderStatus> <Comments>Posting order status</Comments> </Transaction> </result>
{ "Header": { "Created": "2021-06-09T15:16:26-04:00", "SourceApp": "APPName", "SourceVer": "1", "SourceEnv": "DEV", "EventCode": "AT31", "EventName": "OrderStatus", "ClientID": "XYZTEST123", "CorrelationIdentifier": "c8721c77a72b7321c884eefcdd496d23" }, "Transaction": { "TransactionID": "20210524-001", "OrderNumber": "654654", "OrderStatus": "Work In Progress", "Comments": "Posting order status" } }

AT50 Sample:

Field Name R/O Description
Header
Created R Request created date time (2021-06-10T14:18:42+00:00 (W3C))
SourceApp R Name of Source application
SourceVer R Application version
SourceEnv R Source application environment. Eg: UAT/DEV/PROD
EventCode R Requested Event Code. Eg: AT50
EventName O Name of the event. Eg: OrderComplete
ClientID R ClientID (mentioned under purpose section)
CorrelationIdentifier R Unique number/Hash for the event
Transaction
TransactionID R Order number of the client application
OrderNumber R Order number of the MSATS application
Comments O Comments
<?xml version="1.0"?> <result> <Header> <Created>2021-06-09T15:16:26-04:00</Created> <SourceApp>APPName</SourceApp> <SourceVer>1</SourceVer> <SourceEnv>DEV</SourceEnv> <EventCode>AT50</EventCode> <EventName>OrderComplete</EventName> <ClientID>XYZTEST123</ClientID> <CorrelationIdentifier>c8721c77a72b7321c884eefcdd496d23</CorrelationIdentifier> </Header> <Transaction> <TransactionID>20210524-001</TransactionID> <OrderNumber>654654</OrderNumber> <Comments>The order has been completed</Comments> </Transaction> </result>
{ "Header": { "Created": "2021-06-09T15:16:26-04:00", "SourceApp": "APPName", "SourceVer": "1", "SourceEnv": "DEV", "EventCode": "AT50", "EventName": "OrderComplete", "ClientID": "XYZTEST123", "CorrelationIdentifier": "c8721c77a72b7321c884eefcdd496d23" }, "Transaction": { "TransactionID": "20210524-001", "OrderNumber": "654654", "Comments": "The order has been completed" } }

Acknowledgement Sample:

Field Name R/O Description
Header
Created R Request created date time (2021-06-10T14:18:42+00:00 (W3C))
SourceApp R Name of Source application
SourceVer R Application version
SourceEnv R Source application environment. Eg: UAT/DEV/PROD
EventCode R Requested Event Code. Eg: ACK
EventName O Name of the event. Eg: Acknowledgement
ClientID R ClientID (mentioned under purpose section)
CorrelationIdentifier R Unique number/Hash for the event
Transaction
TransactionID R Order number of the client application
<?xml version="1.0"?> <result> <Header> <Created>2021-06-09T15:16:26-04:00</Created> <SourceApp>APPName</SourceApp> <SourceVer>1</SourceVer> <SourceEnv>DEV</SourceEnv> <EventCode>ACK</EventCode> <EventName>Acknowledgement</EventName> <ClientID>XYZTEST123</ClientID> <CorrelationIdentifier>c8721c77a72b7321c884eefcdd496d23</CorrelationIdentifier> </Header> <Transaction> <TransactionID>20210524-001</TransactionID> </Transaction> </result>
{ "Header": { "Created": "2021-06-09T15:16:26-04:00", "SourceApp": "APPName", "SourceVer": "1", "SourceEnv": "DEV", "EventCode": "ACK", "EventName": "Acknowledgement", "ClientID": "XYZTEST123", "CorrelationIdentifier": "c8721c77a72b7321c884eefcdd496d23" }, "Transaction": { "TransactionID": "20210524-001" } }

Negative Acknowledgement Sample:

Field Name R/O Description
Header
Created R Request created date time (2021-06-10T14:18:42+00:00 (W3C))
SourceApp R Name of Source application
SourceVer R Application version
SourceEnv R Source application environment. Eg: UAT/DEV/PROD
EventCode R Requested Event Code. Eg: NACK
EventName O Name of the event. Eg: NegativeAcknowledgement
ClientID R ClientID (mentioned under purpose section)
CorrelationIdentifier R Unique number/Hash for the event
Transaction
TransactionID R Order number of the client application
Transaction > Errors
ErrorCode R Error code
ErrorType R Type of error received
Description R Describes about the error
<?xml version="1.0"?> <result> <Header> <Created>2021-06-09T15:16:26-04:00</Created> <SourceApp>APPName</SourceApp> <SourceVer>1</SourceVer> <SourceEnv>DEV</SourceEnv> <EventCode>NACK</EventCode> <EventName>NegativeAcknowledgement</EventName> <ClientID>XYZTEST123</ClientID> <CorrelationIdentifier>c8721c77a72b7321c884eefcdd496d23</CorrelationIdentifier> </Header> <Transaction> <TransactionID>20210524-001</TransactionID> <Errors> <ErrorCode>ER001</ErrorCode> <ErrorType>UnauthorizedAccessException</ErrorType> <Description>Login failed. Invalid password.</Description> </Errors> </Transaction> </result>
{ "Header": { "Created": "2021-06-09T15:16:26-04:00", "SourceApp": "APPName", "SourceVer": "1", "SourceEnv": "DEV", "EventCode": "NACK", "EventName": "NegativeAcknowledgement", "ClientID": "XYZTEST123", "CorrelationIdentifier": "c8721c77a72b7321c884eefcdd496d23" }, "Transaction": { "TransactionID": "20210524-001", "Errors": { "ErrorCode": "ER001", "ErrorType": "UnauthorizedAccessException", "Description": "Login failed. Invalid password." } } }

Samples Download: